PHP Class FluidTYPO3\Flux\Form

Inheritance: extends FluidTYPO3\Flux\Form\AbstractFormContainer, implements FluidTYPO3\Flux\Form\FieldContainerInterface

Afficher le fichier Open project: fluidtypo3/flux Class Usage Examples

Protected Properties

Свойство	Type	Description
$compact	boolean	If TRUE, removes sheet wrappers if there is only a single sheet.
$description	string
$extensionName	string	Should be set to contain the extension name in UpperCamelCase of the extension implementing this form object.
$id	string	Machine-readable, lowerCamelCase ID of this form. DOM compatible.
$options	array
$outlet	FluidTYPO3\Flux\Outlet\OutletInterface

Méthodes publiques

Méthode	Description
add ( FluidTYPO3\Flux\Form\FormInterface $child ) : FluidTYPO3\Flux\Form\FormInterface
build ( ) : array
create ( array $settings = [] ) : FormInterface
getCompact ( ) : boolean
getDescription ( ) : string
getExtensionName ( ) : string
getFields ( ) : FluidTYPO3\Flux\Form\FieldInterface[]
getGroup ( ) : string
getIcon ( ) : string
getId ( ) : string
getOption ( string $name ) : mixed
getOptions ( ) : array
getOutlet ( ) : FluidTYPO3\Flux\Outlet\OutletInterface
getSheets ( boolean $includeEmpty = FALSE ) : Sheet[]
hasChildren ( ) : boolean
hasOption ( string $name ) : boolean
initializeObject ( ) : void
modify ( array $structure ) : ContainerInterface
setCompact ( boolean $compact ) : FluidTYPO3\Flux\Form\FormInterface
setDescription ( string $description ) : FluidTYPO3\Flux\Form\FormInterface
setExtensionName ( string $extensionName ) : FluidTYPO3\Flux\Form\FormInterface
setGroup ( string $group ) : FluidTYPO3\Flux\Form\FormInterface
setIcon ( string $icon ) : FluidTYPO3\Flux\Form\FormInterface
setId ( string $id ) : FluidTYPO3\Flux\Form\FormInterface
setOption ( string $name, mixed $value ) : FluidTYPO3\Flux\Form\FormInterface
setOptions ( array $options ) : FluidTYPO3\Flux\Form\FormInterface
setOutlet ( FluidTYPO3\Flux\Outlet\OutletInterface $outlet ) : FluidTYPO3\Flux\Form\FormInterface

Method Details

add() public méthode

public add ( FluidTYPO3\Flux\Form\FormInterface $child ) : FluidTYPO3\Flux\Form\FormInterface
$child	FluidTYPO3\Flux\Form\FormInterface
Résultat	FluidTYPO3\Flux\Form\FormInterface

build() public méthode

public build ( ) : array
Résultat	array

create() public static méthode

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

getCompact() public méthode

public getCompact ( ) : boolean
Résultat	boolean

getDescription() public méthode

public getDescription ( ) : string
Résultat	string

getExtensionName() public méthode

public getExtensionName ( ) : string
Résultat	string

getFields() public méthode

public getFields ( ) : FluidTYPO3\Flux\Form\FieldInterface[]
Résultat	FluidTYPO3\Flux\Form\FieldInterface[]

getGroup() public méthode

public getGroup ( ) : string
Résultat	string

getIcon() public méthode

Deprecation:

public getIcon ( ) : string
Résultat	string

getId() public méthode

public getId ( ) : string
Résultat	string

getOption() public méthode

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

getOptions() public méthode

public getOptions ( ) : array
Résultat	array

getOutlet() public méthode

public getOutlet ( ) : FluidTYPO3\Flux\Outlet\OutletInterface
Résultat	FluidTYPO3\Flux\Outlet\OutletInterface

getSheets() public méthode

public getSheets ( boolean $includeEmpty = FALSE ) : Sheet[]
$includeEmpty	boolean
Résultat	FluidTYPO3\Flux\Form\Container\Sheet[]

hasChildren() public méthode

public hasChildren ( ) : boolean
Résultat	boolean

hasOption() public méthode

public hasOption ( string $name ) : boolean
$name	string
Résultat	boolean

initializeObject() public méthode

public initializeObject ( ) : void
Résultat	void

modify() public méthode

public modify ( array $structure ) : ContainerInterface
$structure	array
Résultat	ContainerInterface

setCompact() public méthode

public setCompact ( boolean $compact ) : FluidTYPO3\Flux\Form\FormInterface
$compact	boolean
Résultat	FluidTYPO3\Flux\Form\FormInterface

setDescription() public méthode

public setDescription ( string $description ) : FluidTYPO3\Flux\Form\FormInterface
$description	string
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

setGroup() public méthode

public setGroup ( string $group ) : FluidTYPO3\Flux\Form\FormInterface
$group	string
Résultat	FluidTYPO3\Flux\Form\FormInterface

setIcon() public méthode

Deprecation:

public setIcon ( string $icon ) : FluidTYPO3\Flux\Form\FormInterface
$icon	string
Résultat	FluidTYPO3\Flux\Form\FormInterface

setId() public méthode

public setId ( string $id ) : FluidTYPO3\Flux\Form\FormInterface
$id	string
Résultat	FluidTYPO3\Flux\Form\FormInterface

setOption() public méthode

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

setOptions() public méthode

public setOptions ( array $options ) : FluidTYPO3\Flux\Form\FormInterface
$options	array
Résultat	FluidTYPO3\Flux\Form\FormInterface

setOutlet() public méthode

public setOutlet ( FluidTYPO3\Flux\Outlet\OutletInterface $outlet ) : FluidTYPO3\Flux\Form\FormInterface
$outlet	FluidTYPO3\Flux\Outlet\OutletInterface
Résultat	FluidTYPO3\Flux\Form\FormInterface

Property Details

$compact protected_oe property

If TRUE, removes sheet wrappers if there is only a single sheet.

protected bool $compact
Résultat	boolean

$description protected_oe property

protected string $description
Résultat	string

$extensionName protected_oe property

Should be set to contain the extension name in UpperCamelCase of the extension implementing this form object.

protected string $extensionName
Résultat	string

$id protected_oe property

Machine-readable, lowerCamelCase ID of this form. DOM compatible.

protected string $id
Résultat	string

$options protected_oe property

protected array $options
Résultat	array

$outlet protected_oe property

protected OutletInterface,FluidTYPO3\Flux\Outlet $outlet
Résultat	FluidTYPO3\Flux\Outlet\OutletInterface