PHP Class FluidTYPO3\Flux\Form\AbstractFormComponent

Inheritance: implements FluidTYPO3\Flux\Form\FormInterface

Mostra file Open project: fluidtypo3/flux Class Usage Examples

Protected Properties

Property	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

Public Methods

Method	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

Protected Methods

Method	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 method

protected buildChildren ( SplObjectStorage \| array $children ) : array
$children	SplObjectStorage \| array
return	array

create() public static method

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

createComponent() public method

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
return	FluidTYPO3\Flux\Form\FormInterface

createComponentClassName() protected method

protected createComponentClassName ( string $type, string $prefix ) : string
$type	string
$prefix	string
return	string

createContainer() public method

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

createField() public method

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

createWizard() public method

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

getConfigurationService() protected method

protected getConfigurationService ( ) : FluxService
return	FluidTYPO3\Flux\Service\FluxService

getDisableLocalLanguageLabels() public method

public getDisableLocalLanguageLabels ( ) : boolean
return	boolean

getEnabled() public method

public getEnabled ( ) : boolean
return	boolean

getExtensionName() public method

public getExtensionName ( ) : string
return	string

getInherit() public method

public getInherit ( ) : integer
return	integer

getInheritEmpty() public method

public getInheritEmpty ( ) : boolean
return	boolean

getLabel() public method

public getLabel ( ) : string
return	string

getLocalLanguageFileRelativePath() public method

public getLocalLanguageFileRelativePath ( ) : string
return	string

getName() public method

public getName ( ) : string
return	string

getObjectManager() protected method

protected getObjectManager ( ) : TYPO3\CMS\Extbase\Object\ObjectManagerInterface
return	TYPO3\CMS\Extbase\Object\ObjectManagerInterface

getParent() public method

public getParent ( ) : FluidTYPO3\Flux\Form\ContainerInterface
return	FluidTYPO3\Flux\Form\ContainerInterface

getPath() public method

public getPath ( ) : string
return	string

getRoot() public method

public getRoot ( ) : FluidTYPO3\Flux\Form\ContainerInterface
return	FluidTYPO3\Flux\Form\ContainerInterface

getVariable() public method

public getVariable ( string $name ) : mixed
$name	string
return	mixed

getVariables() public method

public getVariables ( ) : array
return	array

isChildOfType() public method

public isChildOfType ( string $type ) : boolean
$type	string
return	boolean

modify() public method

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
return	FluidTYPO3\Flux\Form\FormInterface

resolveLocalLanguageValueOfLabel() protected method

protected resolveLocalLanguageValueOfLabel ( string $label, string $path = NULL ) : null \| string
$label	string
$path	string
return	null \| string

setDisableLocalLanguageLabels() public method

public setDisableLocalLanguageLabels ( boolean $disableLocalLanguageLabels ) : FluidTYPO3\Flux\Form\FormInterface
$disableLocalLanguageLabels	boolean
return	FluidTYPO3\Flux\Form\FormInterface

setEnabled() public method

public setEnabled ( boolean $enabled ) : FluidTYPO3\Flux\Form\FormInterface
$enabled	boolean
return	FluidTYPO3\Flux\Form\FormInterface

setExtensionName() public method

public setExtensionName ( string $extensionName ) : FluidTYPO3\Flux\Form\FormInterface
$extensionName	string
return	FluidTYPO3\Flux\Form\FormInterface

setInherit() public method

public setInherit ( boolean $inherit ) : FluidTYPO3\Flux\Form\FormInterface
$inherit	boolean
return	FluidTYPO3\Flux\Form\FormInterface

setInheritEmpty() public method

public setInheritEmpty ( boolean $inheritEmpty ) : FluidTYPO3\Flux\Form\FormInterface
$inheritEmpty	boolean
return	FluidTYPO3\Flux\Form\FormInterface

setLabel() public method

public setLabel ( string $label ) : FluidTYPO3\Flux\Form\FormInterface
$label	string
return	FluidTYPO3\Flux\Form\FormInterface

setLocalLanguageFileRelativePath() public method

public setLocalLanguageFileRelativePath ( string $localLanguageFileRelativePath ) : FluidTYPO3\Flux\Form\FormInterface
$localLanguageFileRelativePath	string
return	FluidTYPO3\Flux\Form\FormInterface

setName() public method

public setName ( string $name ) : FluidTYPO3\Flux\Form\FormInterface
$name	string
return	FluidTYPO3\Flux\Form\FormInterface

setParent() public method

public setParent ( FluidTYPO3\Flux\Form\ContainerInterface $parent ) : FluidTYPO3\Flux\Form\FormInterface
$parent	FluidTYPO3\Flux\Form\ContainerInterface
return	FluidTYPO3\Flux\Form\FormInterface

setVariable() public method

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

setVariables() public method

public setVariables ( array $variables ) : FluidTYPO3\Flux\Form\FormInterface
$variables	array
return	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
return	boolean

$enabled protected_oe property

protected bool $enabled
return	boolean

$extensionName protected_oe property

protected string $extensionName
return	string

$inherit protected_oe property

protected bool $inherit
return	boolean

$inheritEmpty protected_oe property

protected bool $inheritEmpty
return	boolean

$label protected_oe property

protected string $label
return	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
return	string

$name protected_oe property

protected string $name
return	string

$parent protected_oe property

protected ContainerInterface,FluidTYPO3\Flux\Form $parent
return	FluidTYPO3\Flux\Form\ContainerInterface

$variables protected_oe property

protected array $variables
return	array