FlexFormSchema implements SchemaInterface

Read onlyYes
FinalYes
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

$sheets  : array<string|int, FlexSheet>
$structIdentifier  : string

Methods

__construct()  : mixed
__set_state()  : self
getField()  : FieldTypeInterface|null
getName()  : string
getSheets()  : array<string|int, mixed>
getFieldFromSections()  : FieldTypeInterface|null
This method searches for a field name within all sections of a sheet.
getFieldFromSheet()  : FieldTypeInterface|null
This method attempts to find a field within a given sheet.

Properties

$structIdentifier

protected string $structIdentifier

Methods

__construct()

public __construct(string $structIdentifier, array<string|int, mixed> $sheets) : mixed
Parameters
$structIdentifier : string
$sheets : 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

getSheets()

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

getFieldFromSections()

This method searches for a field name within all sections of a sheet.

protected getFieldFromSections(string $sheetName, string $fieldName) : FieldTypeInterface|null

Any slashes in the field name, section name, or container name are replaced with dots to support field names such as:

  • settings.mysettings.67fb88e136a4a575936...
  • my_settings.67fb88e136a4a575936...
Parameters
$sheetName : string
$fieldName : string
Return values
FieldTypeInterface|null

getFieldFromSheet()

This method attempts to find a field within a given sheet.

protected getFieldFromSheet(string $sheetName, string $fieldName) : FieldTypeInterface|null

If the field is not set directly on the sheet, each section of the sheet will be checked for a matching field.

Parameters
$sheetName : string
$fieldName : string
Return values
FieldTypeInterface|null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results