api/symfony/Component/Form/Button.yaml

name: Button
class_comment: '# * A form button.

  # *

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

  # *

  # * @implements \IteratorAggregate<string, FormInterface>'
dependencies:
- name: AlreadySubmittedException
  type: class
  source: Symfony\Component\Form\Exception\AlreadySubmittedException
- name: BadMethodCallException
  type: class
  source: Symfony\Component\Form\Exception\BadMethodCallException
- name: TransformationFailedException
  type: class
  source: Symfony\Component\Form\Exception\TransformationFailedException
- name: PropertyPathInterface
  type: class
  source: Symfony\Component\PropertyAccess\PropertyPathInterface
properties: []
methods:
- name: __construct
  visibility: public
  parameters:
  - name: config
  comment: "# * A form button.\n# *\n# * @author Bernhard Schussek <bschussek@gmail.com>\n\
    # *\n# * @implements \\IteratorAggregate<string, FormInterface>\n# */\n# class\
    \ Button implements \\IteratorAggregate, FormInterface\n# {\n# private ?FormInterface\
    \ $parent = null;\n# private bool $submitted = false;\n# \n# /**\n# * Creates\
    \ a new button from a form configuration."
- name: offsetExists
  visibility: public
  parameters:
  - name: offset
  comment: '# * Unsupported method.'
- name: offsetGet
  visibility: public
  parameters:
  - name: offset
  comment: '# * Unsupported method.

    # *

    # * This method should not be invoked.

    # *

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

    # *

    # * This method should not be invoked.

    # *

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

    # *

    # * This method should not be invoked.

    # *

    # * @throws BadMethodCallException'
- name: setParent
  visibility: public
  parameters:
  - name: parent
  comment: null
- name: getParent
  visibility: public
  parameters: []
  comment: null
- name: add
  visibility: public
  parameters:
  - name: child
  - name: type
    default: 'null'
  - name: options
    default: '[]'
  comment: '# * Unsupported method.

    # *

    # * This method should not be invoked.

    # *

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

    # *

    # * This method should not be invoked.

    # *

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

    # *

    # * This method should not be invoked.

    # *

    # * @throws BadMethodCallException'
- name: all
  visibility: public
  parameters: []
  comment: null
- name: getErrors
  visibility: public
  parameters:
  - name: deep
    default: 'false'
  - name: flatten
    default: 'true'
  comment: null
- name: setData
  visibility: public
  parameters:
  - name: modelData
  comment: '# * Unsupported method.

    # *

    # * This method should not be invoked.

    # *

    # * @return $this'
- name: getData
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getNormData
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getViewData
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getExtraData
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getConfig
  visibility: public
  parameters: []
  comment: '# * Returns the button''s configuration.'
- name: isSubmitted
  visibility: public
  parameters: []
  comment: '# * Returns whether the button is submitted.'
- name: getName
  visibility: public
  parameters: []
  comment: '# * Returns the name by which the button is identified in forms.'
- name: getPropertyPath
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: addError
  visibility: public
  parameters:
  - name: error
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: isValid
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: isRequired
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: isDisabled
  visibility: public
  parameters: []
  comment: null
- name: isEmpty
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: isSynchronized
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getTransformationFailure
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: initialize
  visibility: public
  parameters: []
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: handleRequest
  visibility: public
  parameters:
  - name: request
    default: 'null'
  comment: '# * Unsupported method.

    # *

    # * @throws BadMethodCallException'
- name: submit
  visibility: public
  parameters:
  - name: submittedData
  - name: clearMissing
    default: 'true'
  comment: '# * Submits data to the button.

    # *

    # * @return $this

    # *

    # * @throws AlreadySubmittedException if the button has already been submitted'
- name: getRoot
  visibility: public
  parameters: []
  comment: null
- name: isRoot
  visibility: public
  parameters: []
  comment: null
- name: createView
  visibility: public
  parameters:
  - name: parent
    default: 'null'
  comment: null
- name: count
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
- name: getIterator
  visibility: public
  parameters: []
  comment: '# * Unsupported method.'
traits:
- Symfony\Component\Form\Exception\AlreadySubmittedException
- Symfony\Component\Form\Exception\BadMethodCallException
- Symfony\Component\Form\Exception\TransformationFailedException
- Symfony\Component\PropertyAccess\PropertyPathInterface
interfaces:
- \IteratorAggregate
- \IteratorAggregate