TcaSchema implements SchemaInterface

Read onlyYes

Main implementation class for TCA-based schema.

Internal

This is an experimental implementation and might change until TYPO3 v13 LTS

Table of Contents

Interfaces

SchemaInterface
A generic interface for any kind of schema

Properties

$fields  : FieldCollection
$name  : string
$passiveRelations  : array<string|int, PassiveRelation>
$schemaConfiguration  : array<string|int, mixed>
$subSchemata  : SchemaCollection|null

Methods

__construct()  : mixed
__set_state()  : self
getActiveRelations()  : array<string|int, ActiveRelation>
getCapability()  : mixed
getField()  : FieldTypeInterface
getFields()  : FieldCollection
getFieldsOfType()  : array<string|int, FieldTypeInterface>
getName()  : string
getPassiveRelations()  : array<string|int, PassiveRelation>
getRawConfiguration()  : array<string|int, mixed>
getSubSchema()  : TcaSchema
getSubSchemaDivisorField()  : FieldTypeInterface|null
getSubSchemata()  : SchemaCollection
getSubTypeDivisorField()  : FieldTypeInterface|null
hasCapability()  : bool
hasField()  : bool
hasFieldRestrictions()  : bool
hasSubSchema()  : bool
isLanguageAware()  : bool
isWorkspaceAware()  : bool
buildLabelCapability()  : LabelCapability
buildLanguageCapability()  : LanguageAwareSchemaCapability

Properties

$schemaConfiguration

protected array<string|int, mixed> $schemaConfiguration

Methods

__construct()

public __construct(string $name, FieldCollection $fields, array<string|int, mixed> $schemaConfiguration[, SchemaCollection|null $subSchemata = null ][, array<string|int, mixed> $passiveRelations = [] ]) : mixed
Parameters
$name : string
$fields : FieldCollection
$schemaConfiguration : array<string|int, mixed>
$subSchemata : SchemaCollection|null = null
$passiveRelations : array<string|int, mixed> = []

__set_state()

public static __set_state(array<string|int, mixed> $state) : self
Parameters
$state : array<string|int, mixed>
Return values
self

getName()

public getName() : string
Return values
string

getRawConfiguration()

public getRawConfiguration() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSubTypeDivisorField()

public getSubTypeDivisorField() : FieldTypeInterface|null
Deprecated

Remove in v14, when "sub types" are removed altogether

Internal

"subtype" is not considered as API of TcaSchema

Return values
FieldTypeInterface|null

hasField()

public hasField(string $fieldName) : bool
Parameters
$fieldName : string
Return values
bool

hasFieldRestrictions()

public hasFieldRestrictions() : bool
Return values
bool

hasSubSchema()

public hasSubSchema(string $subSchema) : bool
Parameters
$subSchema : string
Return values
bool

isLanguageAware()

public isLanguageAware() : bool
Return values
bool

isWorkspaceAware()

public isWorkspaceAware() : bool
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results