platform/api/symfony/Component/Form/ButtonBuilder.yaml

name: ButtonBuilder
class_comment: '# * A builder for {@link Button} instances.

  # *

  # * @author Bernhard Schussek <bschussek@gmail.com>

  # *

  # * @implements \IteratorAggregate<string, FormBuilderInterface>'
dependencies:
- name: EventSubscriberInterface
  type: class
  source: Symfony\Component\EventDispatcher\EventSubscriberInterface
- name: BadMethodCallException
  type: class
  source: Symfony\Component\Form\Exception\BadMethodCallException
- name: InvalidArgumentException
  type: class
  source: Symfony\Component\Form\Exception\InvalidArgumentException
- name: PropertyPathInterface
  type: class
  source: Symfony\Component\PropertyAccess\PropertyPathInterface
properties: []
methods:
- name: __construct
  visibility: public
  parameters:
  - name: name
  - name: options
    default: '[]'
  comment: "# * A builder for {@link Button} instances.\n# *\n# * @author Bernhard\
    \ Schussek <bschussek@gmail.com>\n# *\n# * @implements \\IteratorAggregate<string,\
    \ FormBuilderInterface>\n# */\n# class ButtonBuilder implements \\IteratorAggregate,\
    \ FormBuilderInterface\n# {\n# protected bool $locked = false;\n# \n# private\
    \ bool $disabled = false;\n# private ResolvedFormTypeInterface $type;\n# private\
    \ string $name;\n# private array $attributes = [];\n# \n# /**\n# * @throws InvalidArgumentException\
    \ if the name is empty"
- name: add
  visibility: public
  parameters:
  - name: child
  - name: type
    default: 'null'
  - name: options
    default: '[]'
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: create
  visibility: public
  parameters:
  - name: name
  - name: type
    default: 'null'
  - name: options
    default: '[]'
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: get
  visibility: public
  parameters:
  - name: name
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: remove
  visibility: public
  parameters:
  - name: name
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: has
  visibility: public
  parameters:
  - name: name
  comment: '# * Unsupported method.'
- name: all
  visibility: public
  parameters: []
  comment: '# * Returns the children.'
- name: getForm
  visibility: public
  parameters: []
  comment: '# * Creates the button.'
- name: addEventListener
  visibility: public
  parameters:
  - name: eventName
  - name: listener
  - name: priority
    default: '0'
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: addEventSubscriber
  visibility: public
  parameters:
  - name: subscriber
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: addViewTransformer
  visibility: public
  parameters:
  - name: viewTransformer
  - name: forcePrepend
    default: 'false'
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: resetViewTransformers
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: addModelTransformer
  visibility: public
  parameters:
  - name: modelTransformer
  - name: forceAppend
    default: 'false'
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: resetModelTransformers
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setAttribute
  visibility: public
  parameters:
  - name: name
  - name: value
  comment: '# * @return $this'
- name: setAttributes
  visibility: public
  parameters:
  - name: attributes
  comment: '# * @return $this'
- name: setDataMapper
  visibility: public
  parameters:
  - name: dataMapper
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setDisabled
  visibility: public
  parameters:
  - name: disabled
  comment: '# * Set whether the button is disabled.

    # *

    # * @return $this'
- name: setEmptyData
  visibility: public
  parameters:
  - name: emptyData
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setErrorBubbling
  visibility: public
  parameters:
  - name: errorBubbling
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setRequired
  visibility: public
  parameters:
  - name: required
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setPropertyPath
  visibility: public
  parameters:
  - name: propertyPath
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setMapped
  visibility: public
  parameters:
  - name: mapped
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setByReference
  visibility: public
  parameters:
  - name: byReference
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setCompound
  visibility: public
  parameters:
  - name: compound
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setType
  visibility: public
  parameters:
  - name: type
  comment: '# * Sets the type of the button.

    # *

    # * @return $this'
- name: setData
  visibility: public
  parameters:
  - name: data
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setDataLocked
  visibility: public
  parameters:
  - name: locked
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setFormFactory
  visibility: public
  parameters:
  - name: formFactory
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setAction
  visibility: public
  parameters:
  - name: action
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setMethod
  visibility: public
  parameters:
  - name: method
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setRequestHandler
  visibility: public
  parameters:
  - name: requestHandler
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: setAutoInitialize
  visibility: public
  parameters:
  - name: initialize
  comment: '# * Unsupported method.

    # *

    # * @return $this

    # *

    # * @throws BadMethodCallException'
- name: setInheritData
  visibility: public
  parameters:
  - name: inheritData
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: getFormConfig
  visibility: public
  parameters: []
  comment: '# * Builds and returns the button configuration.'
- name: setIsEmptyCallback
  visibility: public
  parameters:
  - name: isEmptyCallback
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: getEventDispatcher
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: getName
  visibility: public
  parameters: []
  comment: null
- name: getPropertyPath
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getMapped
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getByReference
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getCompound
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getType
  visibility: public
  parameters: []
  comment: '# * Returns the form type used to construct the button.'
- name: getViewTransformers
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getModelTransformers
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getDataMapper
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getRequired
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getDisabled
  visibility: public
  parameters: []
  comment: '# * Returns whether the button is disabled.'
- name: getErrorBubbling
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getEmptyData
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getAttributes
  visibility: public
  parameters: []
  comment: '# * Returns additional attributes of the button.'
- name: hasAttribute
  visibility: public
  parameters:
  - name: name
  comment: '# * Returns whether the attribute with the given name exists.'
- name: getAttribute
  visibility: public
  parameters:
  - name: name
  - name: default
    default: 'null'
  comment: '# * Returns the value of the given attribute.'
- name: getData
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getDataClass
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getDataLocked
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getFormFactory
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getAction
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: getMethod
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: getRequestHandler
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: getAutoInitialize
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getInheritData
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getOptions
  visibility: public
  parameters: []
  comment: '# * Returns all options passed during the construction of the button.'
- name: hasOption
  visibility: public
  parameters:
  - name: name
  comment: '# * Returns whether a specific option exists.'
- name: getOption
  visibility: public
  parameters:
  - name: name
  - name: default
    default: 'null'
  comment: '# * Returns the value of a specific option.'
- name: getIsEmptyCallback
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: count
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getIterator
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
traits:
- Symfony\Component\EventDispatcher\EventSubscriberInterface
- Symfony\Component\Form\Exception\BadMethodCallException
- Symfony\Component\Form\Exception\InvalidArgumentException
- Symfony\Component\PropertyAccess\PropertyPathInterface
interfaces:
- \IteratorAggregate
- \IteratorAggregate