class XmlEncoderContextBuilder
A helper providing autocompletion for available XmlEncoder options.
@author Mathias Arlaud <mathias.arlaud@gmail.com>
Hierarchy
- class \Symfony\Component\Serializer\Context\Encoder\XmlEncoderContextBuilder implements \Symfony\Component\Serializer\Context\ContextBuilderInterface uses \Symfony\Component\Serializer\Context\ContextBuilderTrait
Expanded class hierarchy of XmlEncoderContextBuilder
File
-
vendor/
symfony/ serializer/ Context/ Encoder/ XmlEncoderContextBuilder.php, line 23
Namespace
Symfony\Component\Serializer\Context\EncoderView source
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);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ContextBuilderTrait::$context | private | property | |
ContextBuilderTrait::toArray | public | function | |
ContextBuilderTrait::with | protected | function | |
ContextBuilderTrait::withContext | public | function | |
XmlEncoderContextBuilder::withAsCollection | public | function | Configures whether the decoded result should be considered as a collection or as a single element. |
XmlEncoderContextBuilder::withCdataWrapping | public | function | Configures whether to wrap strings within CDATA sections. |
XmlEncoderContextBuilder::withCdataWrappingPattern | public | function | Configures the pattern used to evaluate if a CDATA section should be added. |
XmlEncoderContextBuilder::withDecoderIgnoredNodeTypes | public | function | Configures node types to ignore while decoding. |
XmlEncoderContextBuilder::withEncoderIgnoredNodeTypes | public | function | Configures node types to ignore while encoding. |
XmlEncoderContextBuilder::withEncoding | public | function | Configures the DOMDocument encoding. |
XmlEncoderContextBuilder::withFormatOutput | public | function | Configures whether to encode with indentation and extra space. |
XmlEncoderContextBuilder::withLoadOptions | public | function | Configures the DOMDocument::loadXml options bitmask. |
XmlEncoderContextBuilder::withRemoveEmptyTags | public | function | Configures whether to keep empty nodes. |
XmlEncoderContextBuilder::withRootNodeName | public | function | Configures name of the root node. |
XmlEncoderContextBuilder::withSaveOptions | public | function | Configures the DOMDocument::saveXml options bitmask. |
XmlEncoderContextBuilder::withStandalone | public | function | Configures whether the document will be standalone. |
XmlEncoderContextBuilder::withTypeCastAttributes | public | function | Configures whether casting numeric string attributes to integers or floats. |
XmlEncoderContextBuilder::withVersion | public | function | Configures the version number of the document. |