Sabre\Xml\Element\Uri Class Reference

Uri element. More...

Inheritance diagram for Sabre\Xml\Element\Uri:

Collaboration diagram for Sabre\Xml\Element\Uri:

Public Member Functions
	__construct ($value)
	Constructor. More...
	xmlSerialize (Xml\Writer $writer)
	The xmlSerialize metod is called during xml writing. More...
Public Member Functions inherited from Sabre\Xml\XmlSerializable
	xmlSerialize (Writer $writer)
	The xmlSerialize method is called during xml writing. More...

Static Public Member Functions
static	xmlDeserialize (Xml\Reader $reader)
	This method is called during xml parsing. More...
Static Public Member Functions inherited from Sabre\Xml\XmlDeserializable
static	xmlDeserialize (Reader $reader)
	The deserialize method is called during xml parsing. More...

Protected Attributes
	$value

Detailed Description

Uri element.

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

<link>/foo/bar</link> <d:href xmlns:d="DAV:">http://example.org/hi</d:href>

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.

Copyright

Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 23 of file Uri.php.

Constructor & Destructor Documentation

__construct()

Sabre\Xml\Element\Uri::__construct

(

$value

)

Constructor.

Parameters

string

$value

Definition at line 37 of file Uri.php.

References Sabre\Xml\Element\Uri\$value.

    {
        $this->value = $value;
    }

Member Function Documentation

xmlDeserialize()

static Sabre\Xml\Element\Uri::xmlDeserialize ( Xml\Reader  $reader )

static

This method is called during xml parsing.

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.

Parameters

Xml\Reader

$reader

Returns

mixed

Definition at line 93 of file Uri.php.

References Sabre\Event\Promise\resolve().

                                                       {

        return new self(
            \Sabre\Uri\resolve(
                $reader->contextUri,
                $reader->readText()
            )
        );

    }

Here is the call graph for this function:

xmlSerialize()

Sabre\Xml\Element\Uri::xmlSerialize

(

Xml\Writer

$writer

)

The xmlSerialize metod is called during xml writing.

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

An important note: do not create a parent element. Any element implementing XmlSerializble 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

Writer

$writer

Returns

void

Definition at line 61 of file Uri.php.

References Sabre\Event\Promise\resolve().

                                              {

        $writer->text(
            \Sabre\Uri\resolve(
                $writer->contextUri,
                $this->value
            )
        );

    }

Here is the call graph for this function:

Field Documentation

$value

Sabre\Xml\Element\Uri::$value

protected

Definition at line 30 of file Uri.php.

Referenced by Sabre\Xml\Element\Uri\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/xml/lib/Element/Uri.php