TcaSchema
readonly class \
- Implements
- SchemaInterface
Main implementation class for TCA-based schema.
Table of Contents
Interfaces
- SchemaInterface
- A generic interface for any kind of schema
Properties
- $fields : FieldCollection
- $name : string
- $passiveRelations : PassiveRelation[]
- $schemaConfiguration : array
- $subSchemata : SchemaCollection|null
- $wizardSteps : array<int, WizardStep>
Methods
- __construct() : mixed
- __set_state() : self
- getActiveRelations() : ActiveRelation[]
- getCapability() : ($capability is TcaSchemaCapability::Language ? LanguageAwareSchemaCapability : ($capability is TcaSchemaCapability::RestrictionRootLevel ? RootLevelCapability : ($capability is TcaSchemaCapability::EditLock ? FieldCapability : ($capability is TcaSchemaCapability::InternalDescription ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionDisabledField ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionStartTime ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionEndTime ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionUserGroup ? FieldCapability : ($capability is TcaSchemaCapability::AccessReadOnly ? ScalarCapability : ($capability is TcaSchemaCapability::AccessAdminOnly ? ScalarCapability : ($capability is TcaSchemaCapability::HideRecordsAtCopy ? ScalarCapability : ($capability is TcaSchemaCapability::HideInUi ? ScalarCapability : ($capability is TcaSchemaCapability::PrependLabelTextAtCopy ? ScalarCapability : ($capability is TcaSchemaCapability::DefaultSorting ? ScalarCapability : ($capability is TcaSchemaCapability::Label ? LabelCapability : ($capability is TcaSchemaCapability::ExtbaseHistoryTracking ? ScalarCapability : ($capability is TcaSchemaCapability::AncestorReferenceField ? SystemInternalFieldCapability : SystemInternalFieldCapability)))))))))))))))))
- getField() : FieldTypeInterface
- getFields() : FieldCollection
- getFieldsOfType() : FieldTypeInterface[]
- getName() : string
- getPassiveRelations() : PassiveRelation[]
- getRawConfiguration() : array
- getSubSchema() : TcaSchema
- getSubSchemata() : SchemaCollection
- getSubSchemaTypeInformation() : SchemaTypeInformation
- getTitle() : string
- getWizardSteps() : array
- hasCapability() : bool
- hasField() : bool
- hasSubSchema() : bool
- isLanguageAware() : bool
- isWorkspaceAware() : bool
- supportsSubSchema() : bool
- buildLabelCapability() : LabelCapability
- buildLanguageCapability() : LanguageAwareSchemaCapability
- getLabelFieldNamesOfSubSchemata() : string[]
Properties
$fields
protected
FieldCollection
$fields
$name
protected
string
$name
$passiveRelations
protected
PassiveRelation[]
$passiveRelations
= []
$schemaConfiguration
protected
array
$schemaConfiguration
$subSchemata
protected
SchemaCollection|null
$subSchemata
= null
$wizardSteps
protected
array<int, WizardStep>
$wizardSteps
= []
Methods
__construct()
public
__construct(string $name, FieldCollection $fields, array $schemaConfiguration[, SchemaCollection|null $subSchemata = null ][, array $passiveRelations = [] ][, array $wizardSteps = [] ]) : mixed
Parameters
- $name : string
- $fields : FieldCollection
- $schemaConfiguration : array
- $subSchemata : SchemaCollection|null = null
- $passiveRelations : array = []
- $wizardSteps : array = []
__set_state()
public
static __set_state(array $state) : self
Parameters
- $state : array
Return values
selfgetActiveRelations()
public
getActiveRelations() : ActiveRelation[]
Return values
ActiveRelation[]getCapability()
public
getCapability(TcaSchemaCapability $capability) : ($capability is TcaSchemaCapability::Language ? LanguageAwareSchemaCapability : ($capability is TcaSchemaCapability::RestrictionRootLevel ? RootLevelCapability : ($capability is TcaSchemaCapability::EditLock ? FieldCapability : ($capability is TcaSchemaCapability::InternalDescription ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionDisabledField ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionStartTime ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionEndTime ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionUserGroup ? FieldCapability : ($capability is TcaSchemaCapability::AccessReadOnly ? ScalarCapability : ($capability is TcaSchemaCapability::AccessAdminOnly ? ScalarCapability : ($capability is TcaSchemaCapability::HideRecordsAtCopy ? ScalarCapability : ($capability is TcaSchemaCapability::HideInUi ? ScalarCapability : ($capability is TcaSchemaCapability::PrependLabelTextAtCopy ? ScalarCapability : ($capability is TcaSchemaCapability::DefaultSorting ? ScalarCapability : ($capability is TcaSchemaCapability::Label ? LabelCapability : ($capability is TcaSchemaCapability::ExtbaseHistoryTracking ? ScalarCapability : ($capability is TcaSchemaCapability::AncestorReferenceField ? SystemInternalFieldCapability : SystemInternalFieldCapability)))))))))))))))))
Parameters
- $capability : TcaSchemaCapability
Return values
($capability is TcaSchemaCapability::Language ? LanguageAwareSchemaCapability : ($capability is TcaSchemaCapability::RestrictionRootLevel ? RootLevelCapability : ($capability is TcaSchemaCapability::EditLock ? FieldCapability : ($capability is TcaSchemaCapability::InternalDescription ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionDisabledField ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionStartTime ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionEndTime ? FieldCapability : ($capability is TcaSchemaCapability::RestrictionUserGroup ? FieldCapability : ($capability is TcaSchemaCapability::AccessReadOnly ? ScalarCapability : ($capability is TcaSchemaCapability::AccessAdminOnly ? ScalarCapability : ($capability is TcaSchemaCapability::HideRecordsAtCopy ? ScalarCapability : ($capability is TcaSchemaCapability::HideInUi ? ScalarCapability : ($capability is TcaSchemaCapability::PrependLabelTextAtCopy ? ScalarCapability : ($capability is TcaSchemaCapability::DefaultSorting ? ScalarCapability : ($capability is TcaSchemaCapability::Label ? LabelCapability : ($capability is TcaSchemaCapability::ExtbaseHistoryTracking ? ScalarCapability : ($capability is TcaSchemaCapability::AncestorReferenceField ? SystemInternalFieldCapability : SystemInternalFieldCapability)))))))))))))))))getField()
public
getField(string $fieldName) : FieldTypeInterface
Parameters
- $fieldName : string
Return values
FieldTypeInterfacegetFields()
public
getFields([callable|null $filterFunction = null ]) : FieldCollection
Parameters
- $filterFunction : callable|null = null
Return values
FieldCollectiongetFieldsOfType()
public
getFieldsOfType(TableColumnType $type) : FieldTypeInterface[]
Parameters
- $type : TableColumnType
Internal
not part of TYPO3 Core API.
Return values
FieldTypeInterface[]getName()
public
getName() : string
Return values
stringgetPassiveRelations()
public
getPassiveRelations() : PassiveRelation[]
Return values
PassiveRelation[]getRawConfiguration()
public
getRawConfiguration() : array
Return values
arraygetSubSchema()
public
getSubSchema(string $subSchema) : TcaSchema
Parameters
- $subSchema : string
Return values
TcaSchemagetSubSchemata()
public
getSubSchemata() : SchemaCollection
Return values
SchemaCollectiongetSubSchemaTypeInformation()
public
getSubSchemaTypeInformation() : SchemaTypeInformation
Return values
SchemaTypeInformationgetTitle()
public
getTitle([callable|null $fn = null ]) : string
Parameters
- $fn : callable|null = null
Return values
stringgetWizardSteps()
public
getWizardSteps() : array
Return values
arrayhasCapability()
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
boolsupportsSubSchema()
public
supportsSubSchema() : bool
Return values
boolbuildLabelCapability()
protected
buildLabelCapability() : LabelCapability
Return values
LabelCapabilitybuildLanguageCapability()
protected
buildLanguageCapability() : LanguageAwareSchemaCapability
Return values
LanguageAwareSchemaCapabilitygetLabelFieldNamesOfSubSchemata()
protected
getLabelFieldNamesOfSubSchemata() : string[]