Documentation

ButtonBuilder
in package
implements IteratorAggregate, FormBuilderInterface

A builder for {@link Button} instances.

Tags
author

Bernhard Schussek bschussek@gmail.com

implements

\IteratorAggregate<string, FormBuilderInterface>

Table of Contents

Interfaces

IteratorAggregate
FormBuilderInterface

Properties

$locked  : mixed
$attributes  : array<string|int, mixed>
$disabled  : bool
$name  : string
$options  : array<string|int, mixed>
$type  : mixed

Methods

__construct()  : mixed
add()  : static
Unsupported method.
addEventListener()  : static
Unsupported method.
addEventSubscriber()  : static
Unsupported method.
addModelTransformer()  : static
Unsupported method.
addViewTransformer()  : static
Unsupported method.
all()  : array<string, self>
Returns the children.
count()  : int
Unsupported method.
create()  : FormBuilderInterface
Unsupported method.
get()  : FormBuilderInterface
Unsupported method.
getAction()  : string
Unsupported method.
getAttribute()  : mixed
Returns the value of the given attribute.
getAttributes()  : array<string|int, mixed>
Returns additional attributes of the button.
getAutoInitialize()  : bool
Unsupported method.
getByReference()  : bool
Unsupported method.
getCompound()  : bool
Unsupported method.
getData()  : mixed
Unsupported method.
getDataClass()  : string|null
Unsupported method.
getDataLocked()  : bool
Unsupported method.
getDataMapper()  : DataMapperInterface|null
Unsupported method.
getDisabled()  : bool
Returns whether the button is disabled.
getEmptyData()  : mixed
Unsupported method.
getErrorBubbling()  : bool
Unsupported method.
getEventDispatcher()  : EventDispatcherInterface
Unsupported method.
getForm()  : Button
Creates the button.
getFormConfig()  : FormConfigInterface
Builds and returns the button configuration.
getFormFactory()  : FormFactoryInterface
Unsupported method.
getInheritData()  : bool
Unsupported method.
getIsEmptyCallback()  : callable|null
Unsupported method.
getIterator()  : EmptyIterator
Unsupported method.
getMapped()  : bool
Unsupported method.
getMethod()  : string
Unsupported method.
getModelTransformers()  : array<string|int, mixed>
Unsupported method.
getName()  : string
{@inheritdoc}
getOption()  : mixed
Returns the value of a specific option.
getOptions()  : array<string|int, mixed>
Returns all options passed during the construction of the button.
getPropertyPath()  : PropertyPathInterface|null
Unsupported method.
getRequestHandler()  : RequestHandlerInterface
Unsupported method.
getRequired()  : bool
Unsupported method.
getType()  : ResolvedFormTypeInterface
Returns the form type used to construct the button.
getViewTransformers()  : array<string|int, mixed>
Unsupported method.
has()  : bool
Unsupported method.
hasAttribute()  : bool
Returns whether the attribute with the given name exists.
hasOption()  : bool
Returns whether a specific option exists.
remove()  : static
Unsupported method.
resetModelTransformers()  : static
Unsupported method.
resetViewTransformers()  : static
Unsupported method.
setAction()  : static
Unsupported method.
setAttribute()  : static
{@inheritdoc}
setAttributes()  : static
{@inheritdoc}
setAutoInitialize()  : $this
Unsupported method.
setByReference()  : static
Unsupported method.
setCompound()  : static
Unsupported method.
setData()  : static
Unsupported method.
setDataLocked()  : static
Unsupported method.
setDataMapper()  : static
Unsupported method.
setDisabled()  : $this
Set whether the button is disabled.
setEmptyData()  : static
Unsupported method.
setErrorBubbling()  : static
Unsupported method.
setFormFactory()  : mixed
Unsupported method.
setInheritData()  : static
Unsupported method.
setIsEmptyCallback()  : static
Unsupported method.
setMapped()  : static
Unsupported method.
setMethod()  : static
Unsupported method.
setPropertyPath()  : static
Unsupported method.
setRequestHandler()  : static
Unsupported method.
setRequired()  : static
Unsupported method.
setType()  : $this
Sets the type of the button.

Properties

$attributes

private array<string|int, mixed> $attributes = []

Methods

__construct()

public __construct(string|null $name[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$name : string|null
$options : array<string|int, mixed> = []
Tags
throws
InvalidArgumentException

if the name is empty

addEventListener()

Unsupported method.

public addEventListener(string $eventName, callable $listener[, int $priority = 0 ]) : static
Parameters
$eventName : string
$listener : callable
$priority : int = 0
Tags
throws
BadMethodCallException
Return values
static

all()

Returns the children.

public all() : array<string, self>
Return values
array<string, self>

count()

Unsupported method.

public count() : int
Return values
int

create()

Unsupported method.

public create(string $name[, string $type = null ][, array<string|int, mixed> $options = [] ]) : FormBuilderInterface
Parameters
$name : string

The name of the form or the name of the property

$type : string = null

The type of the form or null if name is a property

$options : array<string|int, mixed> = []
Tags
throws
BadMethodCallException
Return values
FormBuilderInterface

getAttribute()

Returns the value of the given attribute.

public getAttribute(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getAttributes()

Returns additional attributes of the button.

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

getAutoInitialize()

Unsupported method.

public getAutoInitialize() : bool
Return values
bool

getByReference()

Unsupported method.

public getByReference() : bool
Return values
bool

getCompound()

Unsupported method.

public getCompound() : bool
Return values
bool

getDataClass()

Unsupported method.

public getDataClass() : string|null
Return values
string|null

getDataLocked()

Unsupported method.

public getDataLocked() : bool
Return values
bool

getDisabled()

Returns whether the button is disabled.

public getDisabled() : bool
Return values
bool

getEmptyData()

Unsupported method.

public getEmptyData() : mixed

getErrorBubbling()

Unsupported method.

public getErrorBubbling() : bool
Return values
bool

getInheritData()

Unsupported method.

public getInheritData() : bool
Return values
bool

getIterator()

Unsupported method.

public getIterator() : EmptyIterator
Return values
EmptyIterator

getMapped()

Unsupported method.

public getMapped() : bool
Return values
bool

getModelTransformers()

Unsupported method.

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

getName()

{@inheritdoc}

public getName() : string
Return values
string

getOption()

Returns the value of a specific option.

public getOption(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getOptions()

Returns all options passed during the construction of the button.

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

getRequired()

Unsupported method.

public getRequired() : bool
Return values
bool

getViewTransformers()

Unsupported method.

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

has()

Unsupported method.

public has(string $name) : bool
Parameters
$name : string
Return values
bool

hasAttribute()

Returns whether the attribute with the given name exists.

public hasAttribute(string $name) : bool
Parameters
$name : string
Return values
bool

hasOption()

Returns whether a specific option exists.

public hasOption(string $name) : bool
Parameters
$name : string
Return values
bool

setAttribute()

{@inheritdoc}

public setAttribute(string $name, mixed $value) : static
Parameters
$name : string
$value : mixed
Return values
static

setAttributes()

{@inheritdoc}

public setAttributes(array<string|int, mixed> $attributes) : static
Parameters
$attributes : array<string|int, mixed>
Return values
static

setAutoInitialize()

Unsupported method.

public setAutoInitialize(bool $initialize) : $this
Parameters
$initialize : bool
Tags
throws
BadMethodCallException
Return values
$this

setByReference()

Unsupported method.

public setByReference(bool $byReference) : static
Parameters
$byReference : bool
Tags
throws
BadMethodCallException
Return values
static

setDisabled()

Set whether the button is disabled.

public setDisabled(bool $disabled) : $this
Parameters
$disabled : bool
Return values
$this

setErrorBubbling()

Unsupported method.

public setErrorBubbling(bool $errorBubbling) : static
Parameters
$errorBubbling : bool
Tags
throws
BadMethodCallException
Return values
static

setInheritData()

Unsupported method.

public setInheritData(bool $inheritData) : static
Parameters
$inheritData : bool
Tags
throws
BadMethodCallException
Return values
static

setIsEmptyCallback()

Unsupported method.

public setIsEmptyCallback(callable|null $isEmptyCallback) : static
Parameters
$isEmptyCallback : callable|null
Tags
throws
BadMethodCallException
Return values
static

        
On this page

Search results