PHP Class FluidTYPO3\Flux\Form

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

Show file Open project: fluidtypo3/flux Class Usage Examples

Protected Properties

Property	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

Public Methods

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

public add ( FluidTYPO3\Flux\Form\FormInterface $child ) : FluidTYPO3\Flux\Form\FormInterface
$child	FluidTYPO3\Flux\Form\FormInterface
return	FluidTYPO3\Flux\Form\FormInterface

build() public method

public build ( ) : array
return	array

create() public static method

public static create ( array $settings = [] ) : FormInterface
$settings	array
return	FormInterface

getCompact() public method

public getCompact ( ) : boolean
return	boolean

getDescription() public method

public getDescription ( ) : string
return	string

getExtensionName() public method

public getExtensionName ( ) : string
return	string

getFields() public method

public getFields ( ) : FluidTYPO3\Flux\Form\FieldInterface[]
return	FluidTYPO3\Flux\Form\FieldInterface[]

getGroup() public method

public getGroup ( ) : string
return	string

getIcon() public method

Deprecation:

public getIcon ( ) : string
return	string

getId() public method

public getId ( ) : string
return	string

getOption() public method

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

getOptions() public method

public getOptions ( ) : array
return	array

getOutlet() public method

public getOutlet ( ) : FluidTYPO3\Flux\Outlet\OutletInterface
return	FluidTYPO3\Flux\Outlet\OutletInterface

getSheets() public method

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

hasChildren() public method

public hasChildren ( ) : boolean
return	boolean

hasOption() public method

public hasOption ( string $name ) : boolean
$name	string
return	boolean

initializeObject() public method

public initializeObject ( ) : void
return	void

modify() public method

public modify ( array $structure ) : ContainerInterface
$structure	array
return	ContainerInterface

setCompact() public method

public setCompact ( boolean $compact ) : FluidTYPO3\Flux\Form\FormInterface
$compact	boolean
return	FluidTYPO3\Flux\Form\FormInterface

setDescription() public method

public setDescription ( string $description ) : FluidTYPO3\Flux\Form\FormInterface
$description	string
return	FluidTYPO3\Flux\Form\FormInterface

setExtensionName() public method

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

setGroup() public method

public setGroup ( string $group ) : FluidTYPO3\Flux\Form\FormInterface
$group	string
return	FluidTYPO3\Flux\Form\FormInterface

setIcon() public method

Deprecation:

public setIcon ( string $icon ) : FluidTYPO3\Flux\Form\FormInterface
$icon	string
return	FluidTYPO3\Flux\Form\FormInterface

setId() public method

public setId ( string $id ) : FluidTYPO3\Flux\Form\FormInterface
$id	string
return	FluidTYPO3\Flux\Form\FormInterface

setOption() public method

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

setOptions() public method

public setOptions ( array $options ) : FluidTYPO3\Flux\Form\FormInterface
$options	array
return	FluidTYPO3\Flux\Form\FormInterface

setOutlet() public method

public setOutlet ( FluidTYPO3\Flux\Outlet\OutletInterface $outlet ) : FluidTYPO3\Flux\Form\FormInterface
$outlet	FluidTYPO3\Flux\Outlet\OutletInterface
return	FluidTYPO3\Flux\Form\FormInterface

Property Details

$compact protected property

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

protected bool $compact
return	boolean

$description protected property

protected string $description
return	string

$extensionName protected property

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

protected string $extensionName
return	string

$id protected property

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

protected string $id
return	string

$options protected property

protected array $options
return	array

$outlet protected property

protected OutletInterface,FluidTYPO3\Flux\Outlet $outlet
return	FluidTYPO3\Flux\Outlet\OutletInterface