Index

  1. \com\setasign\Konquadrat
    1. Object
      1. AbstractCachingDocument
      2. AbstractObject
      3. AbstractObjectInterface
      4. AbstractObjectSet
      5. Action
      6. ActionResolver
      7. ActionResolverInterface
      8. Custom
      9. Database
      10. DocumentInterface
      11. DocumentResolver
      12. DocumentResolverInterface
      13. GlobalDiWakeupObjectResolver
      14. History
      15. ImportInterface
      16. InitTraitResolver
      17. InitTraitResolverInterface
      18. InstancePool
      19. InstancePoolInterface
      20. InstancePoolManager
      21. ManualQueryBuilder
      22. MassActionResolver
      23. MassActionResolverInterface
      24. MessageList
      25. MissingConfigurationException
      26. ObjectConfig
      27. ObjectFactory
      28. ObjectFactoryInterface
      29. ObjectFinder
      30. ObjectManager
      31. ObjectSaveException
      32. ObjectSet
      33. ObjectSet
      34. ObjectTableManager
      35. Scope
      36. Selector
      37. SmartObjectSet
      38. TemporaryReference
      39. TransactionManager
      40. UnknownObjectException
      41. WakeupObjectResolverInterface

com\setasign\Konquadrat\Object

ObjectConfig

File: /Konquadrat/src/Object/ObjectConfig.php

Class hierarchy

Summary

Methods

Properties

Properties

$cache

protected array ObjectConfig::$cache

Not a real cache, just keep the results in memory.

$objects

protected \com\setasign\SetaFramework\Config\Config[] ObjectConfig::$objects

$templates

protected \com\setasign\SetaFramework\Config\Config[] ObjectConfig::$templates

Methods

__construct()

public ObjectConfig::__construct (
\com\setasign\SetaFramework\Config\Config $config
)
Parameters
$config : \com\setasign\SetaFramework\Config\Config
 

findNeededFields()

protected ObjectConfig::findNeededFields (
\com\setasign\SetaFramework\Config\Config $config
): array
Parameters
$config : \com\setasign\SetaFramework\Config\Config
 

getAllDirectlyReferencingFields()

public ObjectConfig::getAllDirectlyReferencingFields (
string $type
): array

This method returns all fields that can reference directly on $type.

Parameters
$type : string
 
Return Values

Key: ObjectType Value: Array with all FieldNames

getAllDirectlyReferencingFieldsOfTemplates()

public ObjectConfig::getAllDirectlyReferencingFieldsOfTemplates (
string $type
): array
Parameters
$type : string
 

getAllFieldnames()

public ObjectConfig::getAllFieldnames (
string $name
): array

Returns the field names of an object or a template.

Parameters
$name : string

Name of the object or template.

getAllFields()

public ObjectConfig::getAllFields (
string $name
): array

Returns all fields of an object or a template.

Parameters
$name : string

Name of the object or template.

getAllImplemented()

public ObjectConfig::getAllImplemented (
string $name,
bool $recursive = true
): array

Return all names of the templates that the template/object $name uses.

The order is in the order of implementation.

Parameters
$name : string

Name of the template or object

$recursive : bool
 

getAllImplementing()

public ObjectConfig::getAllImplementing (
string $name
): array

Returns all object names that implementing the template $name

Parameters
$name : string

Name of the template

getAllImplementingTemplates()

public ObjectConfig::getAllImplementingTemplates (
string $name
): array

Returns all templates which implement the template $name.

Parameters
$name : string
 

getAllNotDefaultObjectsAndTemplates()

public ObjectConfig::getAllNotDefaultObjectsAndTemplates (
void
): array

getAllObjects()

public ObjectConfig::getAllObjects (
void
): array

getAllReferenceFieldnames()

public ObjectConfig::getAllReferenceFieldnames (
string $name
): array

Returns the names of the reference fields of an object or a template.

Parameters
$name : string

Name of the object or template.

getAllReferenceFields()

public ObjectConfig::getAllReferenceFields (
void
): array
Return Values

Key: ObjectType Value: array with all reference fields

getAllReferenceFieldsOfTemplates()

public ObjectConfig::getAllReferenceFieldsOfTemplates (
void
): array

getAllReferencingFields()

public ObjectConfig::getAllReferencingFields (
string $type
): array
Parameters
$type : string
 

getAllTableNames()

public ObjectConfig::getAllTableNames (
string $type
): array

Returns all table names for the template/object $name.

Parameters
$type : string

Name of the template or object

getAllTableNamesAndColumnNames()

public ObjectConfig::getAllTableNamesAndColumnNames (
string $type
): array
Parameters
$type : string
 

getAllTemplates()

public ObjectConfig::getAllTemplates (
void
): array

getAllViews()

public ObjectConfig::getAllViews (
string $type
): array
Parameters
$type : string
 

getAllowedParent()

public ObjectConfig::getAllowedParent (
string $type
): string
Parameters
$type : string
 

getAllowedReference()

public ObjectConfig::getAllowedReference (
string $type,
string $fieldName
): string
Parameters
$type : string
 
$fieldName : string
 

getColumnNameByFieldName()

public ObjectConfig::getColumnNameByFieldName (
string $type,
string $fieldName
): string
Parameters
$type : string
 
$fieldName : string
 

getConfigOfObjectType()

protected ObjectConfig::getConfigOfObjectType (
string $type
): \com\setasign\SetaFramework\Config\Config
Parameters
$type : string
 

getDescription()

public ObjectConfig::getDescription (
string $type
): array|string|null
Parameters
$type : string
 

getDetailsConfig()

public ObjectConfig::getDetailsConfig (
string $type
): \com\setasign\SetaFramework\Config\Config
Parameters
$type : string
 

getField()

public ObjectConfig::getField (
string $type,
string $name
): array
Parameters
$type : string
 
$name : string
 

getFieldImplementor()

public ObjectConfig::getFieldImplementor (
string $type,
string $fieldName
): string

Returns the type which implements the field $fieldName.

Parameters
$type : string
 
$fieldName : string
 

getFieldNameByColumnName()

public ObjectConfig::getFieldNameByColumnName (
string $type,
string $columnNameAndTableName
): string
Parameters
$type : string
 
$columnNameAndTableName : string
 

getGridConfig()

public ObjectConfig::getGridConfig (
string $type
): string
Parameters
$type : string
 

getHideChilds()

public ObjectConfig::getHideChilds (
string $type
): bool
Parameters
$type : string
 

getHideInTree()

public ObjectConfig::getHideInTree (
string $type
): bool
Parameters
$type : string
 

getIdentifier()

public ObjectConfig::getIdentifier (
void
): string

Generates an identifier for the actual configuration.

getName()

public ObjectConfig::getName (
string $type
): ?array
Parameters
$type : string
 

getNeededFieldsForDetails()

public ObjectConfig::getNeededFieldsForDetails (
string $type
): array
Parameters
$type : string
 

getTableNameByFieldName()

public ObjectConfig::getTableNameByFieldName (
string $type,
string $fieldName
): string
Parameters
$type : string
 
$fieldName : string
 

getUseHistory()

public ObjectConfig::getUseHistory (
string $type
): bool
Parameters
$type : string
 

hasField()

public ObjectConfig::hasField (
string $type,
string $fieldName
): bool

Checks whether the field exists.

Parameters
$type : string

Name of the template or object

$fieldName : string

Name of the field

hasGridConfig()

public ObjectConfig::hasGridConfig (
string $type
): bool
Parameters
$type : string
 

isConfigured()

public ObjectConfig::isConfigured (
string $name
): bool
Parameters
$name : string
 

isDefault()

public ObjectConfig::isDefault (
string $type
): bool
Parameters
$type : string
 

isDeprecated()

public ObjectConfig::isDeprecated (
string $name
): bool
Parameters
$name : string
 

isImplemented()

public ObjectConfig::isImplemented (
string $objectType,
string $subType
): bool

Checks whether $subType is implemented by $objectType

Parameters
$objectType : string
 
$subType : string
 

isInstanceOf()

public ObjectConfig::isInstanceOf (
AbstractObjectInterface $object,
class-string<subType> $subType
): bool
Parameters
$object : AbstractObjectInterface
 
$subType : class-string<subType>
 

isObject()

public ObjectConfig::isObject (
string $name
): bool
Parameters
$name : string
 

isParentRequired()

public ObjectConfig::isParentRequired (
string $objectName
): bool
Parameters
$objectName : string
 

isTemplate()

public ObjectConfig::isTemplate (
string $name
): bool
Parameters
$name : string
 

replaceFieldsReferences()

protected ObjectConfig::replaceFieldsReferences (
\com\setasign\SetaFramework\Config\Config $detailsConfig
): \com\setasign\SetaFramework\Config\Config
Parameters
$detailsConfig : \com\setasign\SetaFramework\Config\Config
 

resolveReferenceFieldNames()

public ObjectConfig::resolveReferenceFieldNames (
string|array<string, string>|string[] $fieldNames
): array
Parameters
$fieldNames : string|array<string, string>|string[]
 

resolveTypeListToObjects()

public ObjectConfig::resolveTypeListToObjects (
string[] $types
): array

Resolves a list of types to only the final objects.

Parameters
$types : string[]
 

sanitizeType()

public ObjectConfig::sanitizeType (
string $type
): string

This method doesn't validate the type!

Parameters
$type : string
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)