TcaSchema

readonly class \TYPO3\CMS\Core\Schema\TcaSchema

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

$schemaConfiguration

protected array $schemaConfiguration

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

self

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)))))))))))))))))

getName()

public getName() : string

Return values

string

getRawConfiguration()

public getRawConfiguration() : array

Return values

array

getTitle()

public getTitle([callable|null $fn = null ]) : string

Parameters

$fn : callable|null = null

Return values

string

getWizardSteps()

public getWizardSteps() : array

Return values

array

hasField()

public hasField(string $fieldName) : bool

Parameters

$fieldName : string

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

supportsSubSchema()

public supportsSubSchema() : bool

Return values

bool

getLabelFieldNamesOfSubSchemata()

protected getLabelFieldNamesOfSubSchemata() : string[]

Return values

string[]
On this page