Edit
In Place Editing Advanced Editing

ButtonBuilder

class ButtonBuilder implements IteratorAggregate, FormBuilderInterface

A builder for {@link Button} instances.

Methods

__construct(string $name, array $options = array())

Creates a new button builder.
FormBuilderInterface add(string|int|FormBuilderInterface $child, string|null $type = null, array $options = array())

Unsupported method.
FormBuilderInterface create(string $name, string|null $type = null, array $options = array())

Unsupported method.
FormBuilderInterface get(string $name)

Unsupported method.
FormBuilderInterface remove(string $name)

Unsupported method.
bool has(string $name)

Unsupported method.
array all()

Returns the children.
FormInterface getForm()

Creates the button.
FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $priority)

Unsupported method.
FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

Unsupported method.
FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Unsupported method.
FormConfigBuilderInterface resetViewTransformers()

Unsupported method.
FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Unsupported method.
FormConfigBuilderInterface resetModelTransformers()

Unsupported method.
FormConfigBuilderInterface setAttribute(string $name, mixed $value)

Sets the value for an attribute.
FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.
FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

Unsupported method.
FormConfigBuilderInterface setDisabled(bool $disabled)

Set whether the button is disabled.
FormConfigBuilderInterface setEmptyData(mixed $emptyData)

Unsupported method.
FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

Unsupported method.
FormConfigBuilderInterface setRequired(bool $required)

Unsupported method.
FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

Unsupported method.
FormConfigBuilderInterface setMapped(bool $mapped)

Unsupported method.
FormConfigBuilderInterface setByReference(bool $byReference)

Unsupported method.
FormConfigBuilderInterface setCompound(bool $compound)

Unsupported method.
FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Sets the type of the button.
FormConfigBuilderInterface setData(mixed $data)

Unsupported method.
FormConfigBuilderInterface setDataLocked(bool $locked)

Unsupported method.
setFormFactory(FormFactoryInterface $formFactory)

Unsupported method.
FormConfigBuilderInterface setAction(string $action)

Unsupported method.
FormConfigBuilderInterface setMethod(string $method)

Unsupported method.
FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

Unsupported method.
FormConfigBuilderInterface setAutoInitialize(bool $initialize)

Unsupported method.
FormConfigBuilderInterface setInheritData(bool $inheritData)

Unsupported method.
FormConfigInterface getFormConfig()

Builds and returns the button configuration.
EventDispatcherInterface getEventDispatcher()

Unsupported method.
string getName()

Returns the name of the form used as HTTP parameter.
null|PropertyPathInterface getPropertyPath()

Unsupported method.
bool getMapped()

Unsupported method.
bool getByReference()

Unsupported method.
bool getCompound()

Unsupported method.
ResolvedFormTypeInterface getType()

Returns the form type used to construct the button.
DataTransformerInterface[] getViewTransformers()

Unsupported method.
DataTransformerInterface[] getModelTransformers()

Unsupported method.
DataMapperInterface getDataMapper()

Unsupported method.
bool getRequired()

Unsupported method.
bool getDisabled()

Returns whether the button is disabled.
bool getErrorBubbling()

Unsupported method.
mixed getEmptyData()

Unsupported method.
array getAttributes()

Returns additional attributes of the button.
bool hasAttribute(string $name)

Returns whether the attribute with the given name exists.
mixed getAttribute(string $name, mixed $default = null)

Returns the value of the given attribute.
mixed getData()

Unsupported method.
string getDataClass()

Unsupported method.
bool getDataLocked()

Unsupported method.
FormFactoryInterface getFormFactory()

Unsupported method.
string getAction()

Unsupported method.
string getMethod()

Unsupported method.
RequestHandlerInterface getRequestHandler()

Unsupported method.
bool getAutoInitialize()

Unsupported method.
bool getInheritData()

Unsupported method.
array getOptions()

Returns all options passed during the construction of the button.
bool hasOption(string $name)

Returns whether a specific option exists.
mixed getOption(string $name, mixed $default = null)

Returns the value of a specific option.
int count()

Unsupported method.
EmptyIterator getIterator()

Unsupported method.

Details

__construct(string $name, array $options = array())

Creates a new button builder.

Parameters

string $name The name of the button
array $options The button's options

Exceptions

InvalidArgumentException If the name is empty.

FormBuilderInterface add(string|int|FormBuilderInterface $child, string|null $type = null, array $options = array())

Unsupported method.

This method should not be invoked.

Parameters

string|int|FormBuilderInterface $child
string|null $type
array $options

Return Value

FormBuilderInterface The builder object

Exceptions

BadMethodCallException

FormBuilderInterface create(string $name, string|null $type = null, array $options = array())

Unsupported method.

This method should not be invoked.

Parameters

string $name The name of the form or the name of the property
string|null $type The type of the form or null if name is a property
array $options The options

Return Value

FormBuilderInterface The created builder

Exceptions

BadMethodCallException

FormBuilderInterface get(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name The name of the child

Return Value

FormBuilderInterface The builder for the child

Exceptions

BadMethodCallException

FormBuilderInterface remove(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name

Return Value

FormBuilderInterface The builder object

Exceptions

BadMethodCallException

bool has(string $name)

Unsupported method.

Parameters

string $name

Return Value

bool

array all()

Returns the children.

Return Value

array

FormInterface getForm()

Creates the button.

Return Value

FormInterface The form

FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $priority)

Unsupported method.

This method should not be invoked.

Parameters

string $eventName The name of the event to listen to
callable $listener The listener to execute
int $priority The priority of the listener. Listeners with a higher priority are called before listeners with a lower priority.

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

Unsupported method.

This method should not be invoked.

Parameters

EventSubscriberInterface $subscriber The subscriber to attach

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Unsupported method.

This method should not be invoked.

Parameters

DataTransformerInterface $viewTransformer
bool $forcePrepend if set to true, prepend instead of appending

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface resetViewTransformers()

Unsupported method.

This method should not be invoked.

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Unsupported method.

This method should not be invoked.

Parameters

DataTransformerInterface $modelTransformer
bool $forceAppend if set to true, append instead of prepending

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface resetModelTransformers()

Unsupported method.

This method should not be invoked.

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setAttribute(string $name, mixed $value)

Sets the value for an attribute.

Parameters

string $name The name of the attribute
mixed $value The value of the attribute

Return Value

FormConfigBuilderInterface The configuration object

FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.

Parameters

array $attributes The attributes

Return Value

FormConfigBuilderInterface The configuration object

FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

Unsupported method.

This method should not be invoked.

Parameters

DataMapperInterface $dataMapper

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setDisabled(bool $disabled)

Set whether the button is disabled.

Parameters

bool $disabled Whether the form is disabled

Return Value

FormConfigBuilderInterface The configuration object

FormConfigBuilderInterface setEmptyData(mixed $emptyData)

Unsupported method.

This method should not be invoked.

Parameters

mixed $emptyData The empty data

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

Unsupported method.

This method should not be invoked.

Parameters

bool $errorBubbling

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setRequired(bool $required)

Unsupported method.

This method should not be invoked.

Parameters

bool $required

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

Unsupported method.

This method should not be invoked.

Parameters

null|string|PropertyPathInterface $propertyPath The property path or null if the path should be set automatically based on the form's name.

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setMapped(bool $mapped)

Unsupported method.

This method should not be invoked.

Parameters

bool $mapped Whether the form should be mapped

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setByReference(bool $byReference)

Unsupported method.

This method should not be invoked.

Parameters

bool $byReference Whether the data should be modified by reference.

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setCompound(bool $compound)

Unsupported method.

This method should not be invoked.

Parameters

bool $compound Whether the form should be compound

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Sets the type of the button.

Parameters

ResolvedFormTypeInterface $type The type of the form

Return Value

FormConfigBuilderInterface The configuration object

FormConfigBuilderInterface setData(mixed $data)

Unsupported method.

This method should not be invoked.

Parameters

mixed $data The data of the form in application format

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setDataLocked(bool $locked)

Unsupported method.

This method should not be invoked.

Parameters

bool $locked Whether to lock the default data

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

setFormFactory(FormFactoryInterface $formFactory)

Unsupported method.

This method should not be invoked.

Parameters

FormFactoryInterface $formFactory The form factory

Exceptions

BadMethodCallException

FormConfigBuilderInterface setAction(string $action)

Unsupported method.

Parameters

string $action The target URL of the form

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setMethod(string $method)

Unsupported method.

Parameters

string $method The HTTP method of the form

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

Unsupported method.

Parameters

RequestHandlerInterface $requestHandler

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setAutoInitialize(bool $initialize)

Unsupported method.

Parameters

bool $initialize True to initialize the form automatically, false to suppress automatic initialization. In the second case, you need to call {@link FormInterface::initialize()} manually.

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigBuilderInterface setInheritData(bool $inheritData)

Unsupported method.

Parameters

bool $inheritData Whether the form should inherit its parent's data

Return Value

FormConfigBuilderInterface The configuration object

Exceptions

BadMethodCallException

FormConfigInterface getFormConfig()

Builds and returns the button configuration.

Return Value

FormConfigInterface

EventDispatcherInterface getEventDispatcher()

Unsupported method.

Return Value

EventDispatcherInterface The dispatcher

string getName()

Returns the name of the form used as HTTP parameter.

Return Value

string The form name

null|PropertyPathInterface getPropertyPath()

Unsupported method.

Return Value

null|PropertyPathInterface The property path

bool getMapped()

Unsupported method.

Return Value

bool Whether the form is mapped

bool getByReference()

Unsupported method.

Return Value

bool Whether to modify the form's data by reference

bool getCompound()

Unsupported method.

Return Value

bool Whether the form is compound

ResolvedFormTypeInterface getType()

Returns the form type used to construct the button.

Return Value

ResolvedFormTypeInterface The form's type

DataTransformerInterface[] getViewTransformers()

Unsupported method.

Return Value

DataTransformerInterface[] An array of {@link DataTransformerInterface} instances

DataTransformerInterface[] getModelTransformers()

Unsupported method.

Return Value

DataTransformerInterface[] An array of {@link DataTransformerInterface} instances

DataMapperInterface getDataMapper()

Unsupported method.

Return Value

DataMapperInterface The data mapper

bool getRequired()

Unsupported method.

Return Value

bool Whether the form is required

bool getDisabled()

Returns whether the button is disabled.

Return Value

bool Whether the form is disabled

bool getErrorBubbling()

Unsupported method.

Return Value

bool Whether errors will bubble up

mixed getEmptyData()

Unsupported method.

Return Value

mixed The data returned if the form is empty

array getAttributes()

Returns additional attributes of the button.

Return Value

array An array of key-value combinations

bool hasAttribute(string $name)

Returns whether the attribute with the given name exists.

Parameters

string $name The attribute name

Return Value

bool Whether the attribute exists

mixed getAttribute(string $name, mixed $default = null)

Returns the value of the given attribute.

Parameters

string $name The attribute name
mixed $default The value returned if the attribute does not exist

Return Value

mixed The attribute value

mixed getData()

Unsupported method.

Return Value

mixed The initial form data

string getDataClass()

Unsupported method.

Return Value

string The data class or null

bool getDataLocked()

Unsupported method.

Return Value

bool Whether the data is locked

FormFactoryInterface getFormFactory()

Unsupported method.

Return Value

FormFactoryInterface The form factory

string getAction()

Unsupported method.

Return Value

string The target URL of the form

string getMethod()

Unsupported method.

Return Value

string The HTTP method of the form

RequestHandlerInterface getRequestHandler()

Unsupported method.

Return Value

RequestHandlerInterface The request handler

bool getAutoInitialize()

Unsupported method.

Return Value

bool Returns true if the form should be initialized when created, false otherwise.

bool getInheritData()

Unsupported method.

Return Value

bool Whether the form should inherit its parent's data

array getOptions()

Returns all options passed during the construction of the button.

Return Value

array The passed options

bool hasOption(string $name)

Returns whether a specific option exists.

Parameters

string $name The option name,

Return Value

bool Whether the option exists

mixed getOption(string $name, mixed $default = null)

Returns the value of a specific option.

Parameters

string $name The option name
mixed $default The value returned if the option does not exist

Return Value

mixed The option value

int count()

Unsupported method.

Return Value

int Always returns 0

EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator Always returns an empty iterator
doc_Symfony
doc_Symfony
2016-10-28 06:07:46
Comments
Leave a Comment

Please login to continue.