Skip to content

Uri

Uri element.

This represents a single uri. An example of how this may be encoded:

/foo/bar http://example.org/hi

If the uri is relative, it will be automatically expanded to an absolute url during writing and reading, if the contextUri property is set on the reader and/or writer.

Properties

value

Uri element value.

protected string $value

Methods

__construct

Constructor.

public __construct(string $value): mixed

Parameters:

Parameter Type Description
$value string

xmlSerialize

The xmlSerialize method is called during xml writing.

public xmlSerialize(\Sabre\Xml\Writer $writer): mixed

Use the $writer argument to write its own xml serialization.

An important note: do not create a parent element. Any element implementing XmlSerializable should only ever write what's considered its 'inner xml'.

The parent of the current element is responsible for writing a containing element.

This allows serializers to be re-used for different element names.

If you are opening new elements, you must also close them again.

Parameters:

Parameter Type Description
$writer \Sabre\Xml\Writer

xmlDeserialize

This method is called during xml parsing.

public static xmlDeserialize(\Sabre\Xml\Reader $reader): mixed

This method is called statically, this is because in theory this method may be used as a type of constructor, or factory method.

Often you want to return an instance of the current class, but you are free to return other data as well.

Important note 2: You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.

If you just want to skip parsing for this element altogether, you can just call $reader->next();

$reader->parseSubTree() will parse the entire sub-tree, and advance to the next element.

  • This method is static.

Parameters:

Parameter Type Description
$reader \Sabre\Xml\Reader


Automatically generated on 2025-03-18