forked from symfony/symfony
-
Notifications
You must be signed in to change notification settings - Fork 0
/
XmlEncoderContextBuilder.php
163 lines (145 loc) · 4.81 KB
/
XmlEncoderContextBuilder.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Serializer\Context\Encoder;
use Symfony\Component\Serializer\Context\ContextBuilderInterface;
use Symfony\Component\Serializer\Context\ContextBuilderTrait;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
/**
* A helper providing autocompletion for available XmlEncoder options.
*
* @author Mathias Arlaud <mathias.arlaud@gmail.com>
*/
final class XmlEncoderContextBuilder implements ContextBuilderInterface
{
use ContextBuilderTrait;
/**
* Configures whether the decoded result should be considered as a collection
* or as a single element.
*/
public function withAsCollection(?bool $asCollection): static
{
return $this->with(XmlEncoder::AS_COLLECTION, $asCollection);
}
/**
* Configures node types to ignore while decoding.
*
* @see https://www.php.net/manual/en/dom.constants.php
*
* @param list<int>|null $decoderIgnoredNodeTypes
*/
public function withDecoderIgnoredNodeTypes(?array $decoderIgnoredNodeTypes): static
{
return $this->with(XmlEncoder::DECODER_IGNORED_NODE_TYPES, $decoderIgnoredNodeTypes);
}
/**
* Configures node types to ignore while encoding.
*
* @see https://www.php.net/manual/en/dom.constants.php
*
* @param list<int>|null $encoderIgnoredNodeTypes
*/
public function withEncoderIgnoredNodeTypes(?array $encoderIgnoredNodeTypes): static
{
return $this->with(XmlEncoder::ENCODER_IGNORED_NODE_TYPES, $encoderIgnoredNodeTypes);
}
/**
* Configures the DOMDocument encoding.
*
* @see https://www.php.net/manual/en/class.domdocument.php#domdocument.props.encoding
*/
public function withEncoding(?string $encoding): static
{
return $this->with(XmlEncoder::ENCODING, $encoding);
}
/**
* Configures whether to encode with indentation and extra space.
*
* @see https://php.net/manual/en/class.domdocument.php#domdocument.props.formatoutput
*/
public function withFormatOutput(?bool $formatOutput): static
{
return $this->with(XmlEncoder::FORMAT_OUTPUT, $formatOutput);
}
/**
* Configures the DOMDocument::loadXml options bitmask.
*
* @see https://www.php.net/manual/en/libxml.constants.php
*
* @param positive-int|null $loadOptions
*/
public function withLoadOptions(?int $loadOptions): static
{
return $this->with(XmlEncoder::LOAD_OPTIONS, $loadOptions);
}
/**
* Configures the DOMDocument::saveXml options bitmask.
*
* @see https://www.php.net/manual/en/libxml.constants.php
*
* @param positive-int|null $saveOptions
*/
public function withSaveOptions(?int $saveOptions): static
{
return $this->with(XmlEncoder::SAVE_OPTIONS, $saveOptions);
}
/**
* Configures whether to keep empty nodes.
*/
public function withRemoveEmptyTags(?bool $removeEmptyTags): static
{
return $this->with(XmlEncoder::REMOVE_EMPTY_TAGS, $removeEmptyTags);
}
/**
* Configures name of the root node.
*/
public function withRootNodeName(?string $rootNodeName): static
{
return $this->with(XmlEncoder::ROOT_NODE_NAME, $rootNodeName);
}
/**
* Configures whether the document will be standalone.
*
* @see https://php.net/manual/en/class.domdocument.php#domdocument.props.xmlstandalone
*/
public function withStandalone(?bool $standalone): static
{
return $this->with(XmlEncoder::STANDALONE, $standalone);
}
/**
* Configures whether casting numeric string attributes to integers or floats.
*/
public function withTypeCastAttributes(?bool $typeCastAttributes): static
{
return $this->with(XmlEncoder::TYPE_CAST_ATTRIBUTES, $typeCastAttributes);
}
/**
* Configures the version number of the document.
*
* @see https://php.net/manual/en/class.domdocument.php#domdocument.props.xmlversion
*/
public function withVersion(?string $version): static
{
return $this->with(XmlEncoder::VERSION, $version);
}
/**
* Configures whether to wrap strings within CDATA sections.
*/
public function withCdataWrapping(?bool $cdataWrapping): static
{
return $this->with(XmlEncoder::CDATA_WRAPPING, $cdataWrapping);
}
/**
* Configures the pattern used to evaluate if a CDATA section should be added.
*/
public function withCdataWrappingPattern(?string $cdataWrappingPattern): static
{
return $this->with(XmlEncoder::CDATA_WRAPPING_PATTERN, $cdataWrappingPattern);
}
}