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

107 lines
3 KiB
YAML

name: CsvEncoderContextBuilder
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: CsvEncoder
type: class
source: Symfony\Component\Serializer\Encoder\CsvEncoder
- name: InvalidArgumentException
type: class
source: Symfony\Component\Serializer\Exception\InvalidArgumentException
- name: ContextBuilderTrait
type: class
source: ContextBuilderTrait
properties: []
methods:
- name: withDelimiter
visibility: public
parameters:
- name: delimiter
comment: "# * A helper providing autocompletion for available CsvEncoder options.\n\
# *\n# * @author Mathias Arlaud <mathias.arlaud@gmail.com>\n# */\n# final class\
\ CsvEncoderContextBuilder implements ContextBuilderInterface\n# {\n# use ContextBuilderTrait;\n\
# \n# /**\n# * Configures the column delimiter character.\n# *\n# * Must be a\
\ single character.\n# *\n# * @throws InvalidArgumentException"
- name: withEnclosure
visibility: public
parameters:
- name: enclosure
comment: '# * Configures the field enclosure character.
# *
# * Must be a single character.
# *
# * @throws InvalidArgumentException'
- name: withEscapeChar
visibility: public
parameters:
- name: escapeChar
comment: '# * Configures the escape character.
# *
# * Must be empty or a single character.
# *
# * @throws InvalidArgumentException'
- name: withKeySeparator
visibility: public
parameters:
- name: keySeparator
comment: '# * Configures the key separator when (un)flattening arrays.'
- name: withHeaders
visibility: public
parameters:
- name: headers
comment: '# * Configures the headers.
# *
# * @param list<mixed>|null $headers'
- name: withEscapedFormulas
visibility: public
parameters:
- name: escapedFormulas
comment: '# * Configures whether formulas should be escaped.'
- name: withAsCollection
visibility: public
parameters:
- name: asCollection
comment: '# * Configures whether the decoded result should be considered as a collection
# * or as a single element.'
- name: withNoHeaders
visibility: public
parameters:
- name: noHeaders
comment: '# * Configures whether the input (or output) is containing (or will contain)
headers.'
- name: withEndOfLine
visibility: public
parameters:
- name: endOfLine
comment: '# * Configures the end of line characters.'
- name: withOutputUtf8Bom
visibility: public
parameters:
- name: outputUtf8Bom
comment: '# * Configures whether to add the UTF-8 Byte Order Mark (BOM)
# * at the beginning of the encoded result or not.'
traits:
- Symfony\Component\Serializer\Context\ContextBuilderInterface
- Symfony\Component\Serializer\Context\ContextBuilderTrait
- Symfony\Component\Serializer\Encoder\CsvEncoder
- Symfony\Component\Serializer\Exception\InvalidArgumentException
- ContextBuilderTrait
interfaces:
- ContextBuilderInterface