api/symfony/Component/Serializer/Context/Encoder/XmlEncoderContextBuilder.yaml
2024-09-26 02:03:21 -07:00

148 lines
4.1 KiB
YAML

name: XmlEncoderContextBuilder
class_comment: null
dependencies:
- name: ContextBuilderInterface
type: class
source: Symfony\Component\Serializer\Context\ContextBuilderInterface
- name: ContextBuilderTrait
type: class
source: Symfony\Component\Serializer\Context\ContextBuilderTrait
- name: XmlEncoder
type: class
source: Symfony\Component\Serializer\Encoder\XmlEncoder
- name: ContextBuilderTrait
type: class
source: ContextBuilderTrait
properties: []
methods:
- name: withAsCollection
visibility: public
parameters:
- name: asCollection
comment: "# * A helper providing autocompletion for available XmlEncoder options.\n\
# *\n# * @author Mathias Arlaud <mathias.arlaud@gmail.com>\n# */\n# final class\
\ XmlEncoderContextBuilder implements ContextBuilderInterface\n# {\n# use ContextBuilderTrait;\n\
# \n# /**\n# * Configures whether the decoded result should be considered as a\
\ collection\n# * or as a single element."
- name: withDecoderIgnoredNodeTypes
visibility: public
parameters:
- name: decoderIgnoredNodeTypes
comment: '# * Configures node types to ignore while decoding.
# *
# * @see https://www.php.net/manual/en/dom.constants.php
# *
# * @param list<int>|null $decoderIgnoredNodeTypes'
- name: withEncoderIgnoredNodeTypes
visibility: public
parameters:
- name: encoderIgnoredNodeTypes
comment: '# * Configures node types to ignore while encoding.
# *
# * @see https://www.php.net/manual/en/dom.constants.php
# *
# * @param list<int>|null $encoderIgnoredNodeTypes'
- name: withEncoding
visibility: public
parameters:
- name: encoding
comment: '# * Configures the DOMDocument encoding.
# *
# * @see https://www.php.net/manual/en/class.domdocument.php#domdocument.props.encoding'
- name: withFormatOutput
visibility: public
parameters:
- name: formatOutput
comment: '# * Configures whether to encode with indentation and extra space.
# *
# * @see https://php.net/manual/en/class.domdocument.php#domdocument.props.formatoutput'
- name: withLoadOptions
visibility: public
parameters:
- name: loadOptions
comment: '# * Configures the DOMDocument::loadXml options bitmask.
# *
# * @see https://www.php.net/manual/en/libxml.constants.php
# *
# * @param positive-int|null $loadOptions'
- name: withSaveOptions
visibility: public
parameters:
- name: saveOptions
comment: '# * Configures the DOMDocument::saveXml options bitmask.
# *
# * @see https://www.php.net/manual/en/libxml.constants.php
# *
# * @param positive-int|null $saveOptions'
- name: withRemoveEmptyTags
visibility: public
parameters:
- name: removeEmptyTags
comment: '# * Configures whether to keep empty nodes.'
- name: withRootNodeName
visibility: public
parameters:
- name: rootNodeName
comment: '# * Configures name of the root node.'
- name: withStandalone
visibility: public
parameters:
- name: standalone
comment: '# * Configures whether the document will be standalone.
# *
# * @see https://php.net/manual/en/class.domdocument.php#domdocument.props.xmlstandalone'
- name: withTypeCastAttributes
visibility: public
parameters:
- name: typeCastAttributes
comment: '# * Configures whether casting numeric string attributes to integers or
floats.'
- name: withVersion
visibility: public
parameters:
- name: version
comment: '# * Configures the version number of the document.
# *
# * @see https://php.net/manual/en/class.domdocument.php#domdocument.props.xmlversion'
- name: withCdataWrapping
visibility: public
parameters:
- name: cdataWrapping
comment: '# * Configures whether to wrap strings within CDATA sections.'
- name: withCdataWrappingPattern
visibility: public
parameters:
- name: cdataWrappingPattern
comment: '# * Configures the pattern used to evaluate if a CDATA section should
be added.'
traits:
- Symfony\Component\Serializer\Context\ContextBuilderInterface
- Symfony\Component\Serializer\Context\ContextBuilderTrait
- Symfony\Component\Serializer\Encoder\XmlEncoder
- ContextBuilderTrait
interfaces:
- ContextBuilderInterface