PHP Class FluidTYPO3\Flux\Form\AbstractFormComponent

Inheritance: implements FluidTYPO3\Flux\Form\FormInterface
Afficher le fichier Open project: fluidtypo3/flux Class Usage Examples

Protected Properties

Свойство Type Description
$disableLocalLanguageLabels boolean If TRUE, disables LLL label usage and always returns the raw value of $label.
$enabled boolean
$extensionName string
$inherit boolean
$inheritEmpty boolean
$label string
$localLanguageFileRelativePath string Relative (from extension $extensionName) path to locallang file containing labels for the LLL values built by this class.
$name string
$parent FluidTYPO3\Flux\Form\ContainerInterface
$variables array

Méthodes publiques

Méthode Description
create ( array $settings = [] ) : FluidTYPO3\Flux\Form\FormInterface
createComponent ( string $namespace, string $type, string $name, string | null $label = NULL ) : FluidTYPO3\Flux\Form\FormInterface
createContainer ( string $type, string $name, string $label = NULL ) : FluidTYPO3\Flux\Form\ContainerInterface
createField ( string $type, string $name, string $label = NULL ) : FluidTYPO3\Flux\Form\FieldInterface
createWizard ( string $type, string $name, string $label = NULL ) : FluidTYPO3\Flux\Form\WizardInterface
getDisableLocalLanguageLabels ( ) : boolean
getEnabled ( ) : boolean
getExtensionName ( ) : string
getInherit ( ) : integer
getInheritEmpty ( ) : boolean
getLabel ( ) : string
getLocalLanguageFileRelativePath ( ) : string
getName ( ) : string
getParent ( ) : FluidTYPO3\Flux\Form\ContainerInterface
getPath ( ) : string
getRoot ( ) : FluidTYPO3\Flux\Form\ContainerInterface
getVariable ( string $name ) : mixed
getVariables ( ) : array
isChildOfType ( string $type ) : boolean
modify ( array $structure ) : FluidTYPO3\Flux\Form\FormInterface Modifies the current Form Component by changing any properties that were passed in $structure. If a component supports special indices in $structure (for example a "fields" property) then that component may specify its own modify() method and manually process each of the specially supported keywords.
setDisableLocalLanguageLabels ( boolean $disableLocalLanguageLabels ) : FluidTYPO3\Flux\Form\FormInterface
setEnabled ( boolean $enabled ) : FluidTYPO3\Flux\Form\FormInterface
setExtensionName ( string $extensionName ) : FluidTYPO3\Flux\Form\FormInterface
setInherit ( boolean $inherit ) : FluidTYPO3\Flux\Form\FormInterface
setInheritEmpty ( boolean $inheritEmpty ) : FluidTYPO3\Flux\Form\FormInterface
setLabel ( string $label ) : FluidTYPO3\Flux\Form\FormInterface
setLocalLanguageFileRelativePath ( string $localLanguageFileRelativePath ) : FluidTYPO3\Flux\Form\FormInterface
setName ( string $name ) : FluidTYPO3\Flux\Form\FormInterface
setParent ( FluidTYPO3\Flux\Form\ContainerInterface $parent ) : FluidTYPO3\Flux\Form\FormInterface
setVariable ( string $name, mixed $value ) : FluidTYPO3\Flux\Form\FormInterface
setVariables ( array $variables ) : FluidTYPO3\Flux\Form\FormInterface

Méthodes protégées

Méthode Description
buildChildren ( SplObjectStorage | array $children ) : array
createComponentClassName ( string $type, string $prefix ) : string
getConfigurationService ( ) : FluxService
getObjectManager ( ) : TYPO3\CMS\Extbase\Object\ObjectManagerInterface
resolveLocalLanguageValueOfLabel ( string $label, string $path = NULL ) : null | string

Method Details

buildChildren() protected méthode

protected buildChildren ( SplObjectStorage | array $children ) : array
$children SplObjectStorage | array
Résultat array

create() public static méthode

public static create ( array $settings = [] ) : FluidTYPO3\Flux\Form\FormInterface
$settings array
Résultat FluidTYPO3\Flux\Form\FormInterface

createComponent() public méthode

public createComponent ( string $namespace, string $type, string $name, string | null $label = NULL ) : FluidTYPO3\Flux\Form\FormInterface
$namespace string
$type string
$name string
$label string | null
Résultat FluidTYPO3\Flux\Form\FormInterface

createComponentClassName() protected méthode

protected createComponentClassName ( string $type, string $prefix ) : string
$type string
$prefix string
Résultat string

createContainer() public méthode

public createContainer ( string $type, string $name, string $label = NULL ) : FluidTYPO3\Flux\Form\ContainerInterface
$type string
$name string
$label string
Résultat FluidTYPO3\Flux\Form\ContainerInterface

createField() public méthode

public createField ( string $type, string $name, string $label = NULL ) : FluidTYPO3\Flux\Form\FieldInterface
$type string
$name string
$label string
Résultat FluidTYPO3\Flux\Form\FieldInterface

createWizard() public méthode

public createWizard ( string $type, string $name, string $label = NULL ) : FluidTYPO3\Flux\Form\WizardInterface
$type string
$name string
$label string
Résultat FluidTYPO3\Flux\Form\WizardInterface

getConfigurationService() protected méthode

protected getConfigurationService ( ) : FluxService
Résultat FluidTYPO3\Flux\Service\FluxService

getDisableLocalLanguageLabels() public méthode

public getDisableLocalLanguageLabels ( ) : boolean
Résultat boolean

getEnabled() public méthode

public getEnabled ( ) : boolean
Résultat boolean

getExtensionName() public méthode

public getExtensionName ( ) : string
Résultat string

getInherit() public méthode

public getInherit ( ) : integer
Résultat integer

getInheritEmpty() public méthode

public getInheritEmpty ( ) : boolean
Résultat boolean

getLabel() public méthode

public getLabel ( ) : string
Résultat string

getLocalLanguageFileRelativePath() public méthode

public getLocalLanguageFileRelativePath ( ) : string
Résultat string

getName() public méthode

public getName ( ) : string
Résultat string

getObjectManager() protected méthode

protected getObjectManager ( ) : TYPO3\CMS\Extbase\Object\ObjectManagerInterface
Résultat TYPO3\CMS\Extbase\Object\ObjectManagerInterface

getParent() public méthode

public getParent ( ) : FluidTYPO3\Flux\Form\ContainerInterface
Résultat FluidTYPO3\Flux\Form\ContainerInterface

getPath() public méthode

public getPath ( ) : string
Résultat string

getRoot() public méthode

public getRoot ( ) : FluidTYPO3\Flux\Form\ContainerInterface
Résultat FluidTYPO3\Flux\Form\ContainerInterface

getVariable() public méthode

public getVariable ( string $name ) : mixed
$name string
Résultat mixed

getVariables() public méthode

public getVariables ( ) : array
Résultat array

isChildOfType() public méthode

public isChildOfType ( string $type ) : boolean
$type string
Résultat boolean

modify() public méthode

For example, the AbstractFormContainer supports passing "fields" and each field is then attempted fetched from children. If not found, it is created (and the structure passed to the create() function which uses the same structure syntax). If it already exists, the modify() method is called on that object to trigger the recursive modification of all child components.
public modify ( array $structure ) : FluidTYPO3\Flux\Form\FormInterface
$structure array
Résultat FluidTYPO3\Flux\Form\FormInterface

resolveLocalLanguageValueOfLabel() protected méthode

protected resolveLocalLanguageValueOfLabel ( string $label, string $path = NULL ) : null | string
$label string
$path string
Résultat null | string

setDisableLocalLanguageLabels() public méthode

public setDisableLocalLanguageLabels ( boolean $disableLocalLanguageLabels ) : FluidTYPO3\Flux\Form\FormInterface
$disableLocalLanguageLabels boolean
Résultat FluidTYPO3\Flux\Form\FormInterface

setEnabled() public méthode

public setEnabled ( boolean $enabled ) : FluidTYPO3\Flux\Form\FormInterface
$enabled boolean
Résultat FluidTYPO3\Flux\Form\FormInterface

setExtensionName() public méthode

public setExtensionName ( string $extensionName ) : FluidTYPO3\Flux\Form\FormInterface
$extensionName string
Résultat FluidTYPO3\Flux\Form\FormInterface

setInherit() public méthode

public setInherit ( boolean $inherit ) : FluidTYPO3\Flux\Form\FormInterface
$inherit boolean
Résultat FluidTYPO3\Flux\Form\FormInterface

setInheritEmpty() public méthode

public setInheritEmpty ( boolean $inheritEmpty ) : FluidTYPO3\Flux\Form\FormInterface
$inheritEmpty boolean
Résultat FluidTYPO3\Flux\Form\FormInterface

setLabel() public méthode

public setLabel ( string $label ) : FluidTYPO3\Flux\Form\FormInterface
$label string
Résultat FluidTYPO3\Flux\Form\FormInterface

setLocalLanguageFileRelativePath() public méthode

public setLocalLanguageFileRelativePath ( string $localLanguageFileRelativePath ) : FluidTYPO3\Flux\Form\FormInterface
$localLanguageFileRelativePath string
Résultat FluidTYPO3\Flux\Form\FormInterface

setName() public méthode

public setName ( string $name ) : FluidTYPO3\Flux\Form\FormInterface
$name string
Résultat FluidTYPO3\Flux\Form\FormInterface

setParent() public méthode

public setParent ( FluidTYPO3\Flux\Form\ContainerInterface $parent ) : FluidTYPO3\Flux\Form\FormInterface
$parent FluidTYPO3\Flux\Form\ContainerInterface
Résultat FluidTYPO3\Flux\Form\FormInterface

setVariable() public méthode

public setVariable ( string $name, mixed $value ) : FluidTYPO3\Flux\Form\FormInterface
$name string
$value mixed
Résultat FluidTYPO3\Flux\Form\FormInterface

setVariables() public méthode

public setVariables ( array $variables ) : FluidTYPO3\Flux\Form\FormInterface
$variables array
Résultat FluidTYPO3\Flux\Form\FormInterface

Property Details

$disableLocalLanguageLabels protected_oe property

If TRUE, disables LLL label usage and always returns the raw value of $label.
protected bool $disableLocalLanguageLabels
Résultat boolean

$enabled protected_oe property

protected bool $enabled
Résultat boolean

$extensionName protected_oe property

protected string $extensionName
Résultat string

$inherit protected_oe property

protected bool $inherit
Résultat boolean

$inheritEmpty protected_oe property

protected bool $inheritEmpty
Résultat boolean

$label protected_oe property

protected string $label
Résultat string

$localLanguageFileRelativePath protected_oe property

Relative (from extension $extensionName) path to locallang file containing labels for the LLL values built by this class.
protected string $localLanguageFileRelativePath
Résultat string

$name protected_oe property

protected string $name
Résultat string

$parent protected_oe property

protected ContainerInterface,FluidTYPO3\Flux\Form $parent
Résultat FluidTYPO3\Flux\Form\ContainerInterface

$variables protected_oe property

protected array $variables
Résultat array