1. class
  2. Bmatovu
  3. \
  4. LaravelXml
  5. \
  6. Support
  7. \
  8. ArrayToXml

ArrayToXml

class ArrayToXml (View source)

Convert PHP Array to XML

Class ArrayToXml

Properties

protected DOMDocument $document

The root DOM Document.
protected bool $replaceSpacesByUnderScoresInKeyNames

Set to enable replacing space with underscore.

Methods

__construct(array $array, string|array $rootElement = '', bool $replaceSpacesByUnderScoresInKeyNames = true, string $xmlEncoding = 'UTF-8', string $xmlVersion = '1.0')

Construct a new instance.

static string
convert(array $array, string $rootElementName = 'document', bool $replaceSpacesByUnderScoresInKeyNames = true, string $xmlEncoding = 'UTF-8', string $xmlVersion = '1.0')

Convert the given array to an xml string.

string
toXml()

Return as XML.

DOMDocument
toDom()

Return as DOM object.

addNode(DOMElement $element, string $key, string|string[] $value)

Add node.

addCollectionNode(DOMElement $element, string|string[] $value)

Add collection node.

addSequentialNode(DOMElement $element, string|string[] $value)

Add sequential node.

bool
isArrayAllKeySequential(array|string $value)

Check if array are all sequential.

addAttributes(DOMElement $element, string[] $data)

Add attributes.

DOMElement
createRootElement(string|array $rootElement)

Create the root element.

Details

at line 44
__construct(array $array, string|array $rootElement = '', bool $replaceSpacesByUnderScoresInKeyNames = true, string $xmlEncoding = 'UTF-8', string $xmlVersion = '1.0')

Construct a new instance.

Parameters

array $array
string|array $rootElement
bool $replaceSpacesByUnderScoresInKeyNames
string $xmlEncoding
string $xmlVersion

Exceptions

DOMException

at line 71
static string convert(array $array, string $rootElementName = 'document', bool $replaceSpacesByUnderScoresInKeyNames = true, string $xmlEncoding = 'UTF-8', string $xmlVersion = '1.0')

Convert the given array to an xml string.

Parameters

array $array
string $rootElementName
bool $replaceSpacesByUnderScoresInKeyNames
string $xmlEncoding
string $xmlVersion

Return Value

string

at line 83
string toXml()

Return as XML.

Return Value

string

at line 93
DOMDocument toDom()

Return as DOM object.

Return Value

DOMDocument

at line 140
protected addNode(DOMElement $element, string $key, string|string[] $value)

Add node.

Parameters

DOMElement $element
string $key
string|string[] $value

at line 159
protected addCollectionNode(DOMElement $element, string|string[] $value)

internal  param string $key
 

Add collection node.

Parameters

DOMElement $element
string|string[] $value

at line 180
protected addSequentialNode(DOMElement $element, string|string[] $value)

internal  param string $key
 

Add sequential node.

Parameters

DOMElement $element
string|string[] $value

at line 200
protected bool isArrayAllKeySequential(array|string $value)

Check if array are all sequential.

Parameters

array|string $value

Return Value

bool

at line 219
protected addAttributes(DOMElement $element, string[] $data)

Add attributes.

Parameters

DOMElement $element
string[] $data

at line 232
protected DOMElement createRootElement(string|array $rootElement)

Create the root element.

Parameters

string|array $rootElement

Return Value

DOMElement