TcaSchema implements SchemaInterface
Read onlyYes
Main implementation class for TCA-based schema.
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() : SchemaCapabilityInterface
- 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
- hasSubSchema() : bool
- isLanguageAware() : bool
- isWorkspaceAware() : bool
- buildLabelCapability() : LabelCapability
- buildLanguageCapability() : LanguageAwareSchemaCapability
Properties
$fields
protected
FieldCollection
$fields
$name
protected
string
$name
$passiveRelations
protected
array<string|int, PassiveRelation>
$passiveRelations
= []
$schemaConfiguration
protected
array<string|int, mixed>
$schemaConfiguration
$subSchemata
protected
SchemaCollection|null
$subSchemata
= null
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
selfgetActiveRelations()
public
getActiveRelations() : array<string|int, ActiveRelation>
Return values
array<string|int, ActiveRelation>getCapability()
public
getCapability(TcaSchemaCapability $capability) : SchemaCapabilityInterface
Parameters
- $capability : TcaSchemaCapability
Tags
Return values
SchemaCapabilityInterfacegetField()
public
getField(string $fieldName) : FieldTypeInterface
Parameters
- $fieldName : string
Return values
FieldTypeInterfacegetFields()
public
getFields(mixed ...$fieldNames) : FieldCollection
Parameters
- $fieldNames : mixed
Return values
FieldCollectiongetFieldsOfType()
public
getFieldsOfType(TableColumnType $type) : array<string|int, FieldTypeInterface>
Parameters
- $type : TableColumnType
Return values
array<string|int, FieldTypeInterface>getName()
public
getName() : string
Return values
stringgetPassiveRelations()
public
getPassiveRelations() : array<string|int, PassiveRelation>
Return values
array<string|int, PassiveRelation>getRawConfiguration()
public
getRawConfiguration() : array<string|int, mixed>
Return values
array<string|int, mixed>getSubSchema()
public
getSubSchema(string $subSchema) : TcaSchema
Parameters
- $subSchema : string
Return values
TcaSchemagetSubSchemaDivisorField()
public
getSubSchemaDivisorField() : FieldTypeInterface|null
Return values
FieldTypeInterface|nullgetSubSchemata()
public
getSubSchemata() : SchemaCollection
Return values
SchemaCollectiongetSubTypeDivisorField()
public
getSubTypeDivisorField() : FieldTypeInterface|null
"subtype" is not considered as API of TcaSchema since this feature will most likely be deprecated in upcoming versions
Return values
FieldTypeInterface|nullhasCapability()
public
hasCapability(TcaSchemaCapability $capability) : bool
Parameters
- $capability : TcaSchemaCapability
Return values
boolhasField()
public
hasField(string $fieldName) : bool
Parameters
- $fieldName : string
Return values
boolhasSubSchema()
public
hasSubSchema(string $subSchema) : bool
Parameters
- $subSchema : string
Return values
boolisLanguageAware()
public
isLanguageAware() : bool
Return values
boolisWorkspaceAware()
public
isWorkspaceAware() : bool
Return values
boolbuildLabelCapability()
protected
buildLabelCapability() : LabelCapability
Return values
LabelCapabilitybuildLanguageCapability()
protected
buildLanguageCapability() : LanguageAwareSchemaCapability