The Reader class expands upon PHP's built-in XMLReader. More...

Inheritance diagram for Sabre\Xml\Reader:

Collaboration diagram for Sabre\Xml\Reader:

Public Member Functions
	getClark ()
	Returns the current nodename in clark-notation. More...

	parse ()
	Reads the entire document. More...

	parseGetElements (array $elementMap=null)
	parseGetElements parses everything in the current sub-tree, and returns a an array of elements. More...

	parseInnerTree (array $elementMap=null)
	Parses all elements below the current element. More...

	readText ()
	Reads all text below the current element, and returns this as a string. More...

	parseCurrentElement ()
	Parses the current XML element. More...

	parseAttributes ()
	Grabs all the attributes from the current element, and returns them as a key-value array. More...

	getDeserializerForElementName ($name)
	Returns the function that should be used to parse the element identified by it's clark-notation name. More...

Detailed Description

The Reader class expands upon PHP's built-in XMLReader.

The intended usage, is to assign certain XML elements to PHP classes. These need to be registered using the $elementMap public property.

After this is done, a single call to parse() will parse the entire document, and delegate sub-sections of the document to element classes.

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 20 of file Reader.php.

Member Function Documentation

◆ getClark()

Sabre\Xml\Reader::getClark ( )

Returns the current nodename in clark-notation.

For example: "{http://www.w3.org/2005/Atom}feed". Or if no namespace is defined: "{}feed".

This method returns null if we're not currently on an element.

Returns: string|null

Definition at line 34 of file Reader.php.

Referenced by Sabre\Xml\Deserializer\enum(), Sabre\Xml\Deserializer\keyValue(), Sabre\Xml\Reader\parseAttributes(), Sabre\DAV\Xml\Element\Prop\parseCurrentElement(), Sabre\Xml\Reader\parseCurrentElement(), Sabre\DAV\Xml\Element\Prop\xmlDeserialize(), and Sabre\DAV\Xml\Element\Response\xmlDeserialize().

                         {
 
         if (! $this->localName) {
             return null;
         }
 
         return '{' . $this->namespaceURI . '}' . $this->localName;
 
     }

Here is the caller graph for this function:

◆ getDeserializerForElementName()

Sabre\Xml\Reader::getDeserializerForElementName ( $name )

Returns the function that should be used to parse the element identified by it's clark-notation name.

Parameters

string $name

Returns: callable

Definition at line 300 of file Reader.php.

References $name, and $type.

Referenced by Sabre\Xml\Reader\parseCurrentElement().

                                                   {
 
 
         if (!array_key_exists($name, $this->elementMap)) {
             if (substr($name, 0, 2) == '{}' && array_key_exists(substr($name, 2), $this->elementMap)) {
                 $name = substr($name, 2);
             } else {
                 return ['Sabre\\Xml\\Element\\Base', 'xmlDeserialize'];
             }
         }
 
         $deserializer = $this->elementMap[$name];
         if (is_subclass_of($deserializer, 'Sabre\\Xml\\XmlDeserializable')) {
             return [$deserializer, 'xmlDeserialize'];
         }
 
         if (is_callable($deserializer)) {
             return $deserializer;
         }
 
         $type = gettype($deserializer);
         if ($type === 'string') {
             $type .= ' (' . $deserializer . ')';
         } elseif ($type === 'object') {
             $type .= ' (' . get_class($deserializer) . ')';
         }
         throw new \LogicException('Could not use this type as a deserializer: ' . $type . ' for element: ' . $name);
 
     }

Here is the caller graph for this function:

◆ parse()

Sabre\Xml\Reader::parse ( )

Reads the entire document.

This function returns an array with the following three elements:

name - The root element name.
value - The value for the root element.
attributes - An array of attributes.

This function will also disable the standard libxml error handler (which usually just results in PHP errors), and throw exceptions instead.

Returns: array

Definition at line 57 of file Reader.php.

References $errors, $result, and Sabre\Xml\Reader\parseCurrentElement().

Referenced by Sabre\Xml\ReaderTest\testParseGetElements(), and Sabre\Xml\ReaderTest\testParseGetElementsNoElements().

                      {
 
         $previousEntityState = libxml_disable_entity_loader(true);
         $previousSetting = libxml_use_internal_errors(true);
 
         try {
 
             // Really sorry about the silence operator, seems like I have no
             // choice. See:
             //
             // https://bugs.php.net/bug.php?id=64230
             while ($this->nodeType !== self::ELEMENT && @$this->read()) {
                 // noop
             }
             $result = $this->parseCurrentElement();
 
             $errors = libxml_get_errors();
             libxml_clear_errors();
             if ($errors) {
                 throw new LibXMLException($errors);
             }
 
         } finally {
             libxml_use_internal_errors($previousSetting);
             libxml_disable_entity_loader($previousEntityState);
         }
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseAttributes()

Sabre\Xml\Reader::parseAttributes ( )

Grabs all the attributes from the current element, and returns them as a key-value array.

If the attributes are part of the same namespace, they will simply be short keys. If they are defined on a different namespace, the attribute name will be retured in clark-notation.

Returns: array

Definition at line 268 of file Reader.php.

References $attributes, $name, and Sabre\Xml\Reader\getClark().

Referenced by Sabre\Xml\Reader\parseCurrentElement(), Sabre\CalDAV\Xml\Filter\ParamFilter\xmlDeserialize(), Sabre\CardDAV\Xml\Filter\PropFilter\xmlDeserialize(), Sabre\CardDAV\Xml\Filter\ParamFilter\xmlDeserialize(), Sabre\CalDAV\Xml\Filter\PropFilter\xmlDeserialize(), and Sabre\CalDAV\Xml\Filter\CompFilter\xmlDeserialize().

                                {
 
         $attributes = [];
 
         while ($this->moveToNextAttribute()) {
             if ($this->namespaceURI) {
 
                 // Ignoring 'xmlns', it doesn't make any sense.
                 if ($this->namespaceURI === 'http://www.w3.org/2000/xmlns/') {
                     continue;
                 }
 
                 $name = $this->getClark();
                 $attributes[$name] = $this->value;
 
             } else {
                 $attributes[$this->localName] = $this->value;
             }
         }
         $this->moveToElement();
 
         return $attributes;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseCurrentElement()

Sabre\Xml\Reader::parseCurrentElement ( )

Parses the current XML element.

This method returns arn array with 3 properties:

name - A clark-notation XML element name.
value - The parsed value.
attributes - A key-value list of attributes.

Returns: array

Definition at line 235 of file Reader.php.

References $attributes, $name, Sabre\Xml\Reader\getClark(), Sabre\Xml\Reader\getDeserializerForElementName(), and Sabre\Xml\Reader\parseAttributes().

Referenced by Sabre\Xml\Deserializer\keyValue(), Sabre\Xml\Reader\parse(), Sabre\Xml\Reader\parseInnerTree(), Sabre\Xml\Deserializer\valueObject(), and Sabre\DAV\Xml\Element\Response\xmlDeserialize().

                                    {
 
         $name = $this->getClark();
 
         $attributes = [];
 
         if ($this->hasAttributes) {
             $attributes = $this->parseAttributes();
         }
 
         $value = call_user_func(
             $this->getDeserializerForElementName($name),
             $this
         );
 
         return [
             'name'       => $name,
             'value'      => $value,
             'attributes' => $attributes,
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseGetElements()

Sabre\Xml\Reader::parseGetElements ( array $elementMap = null )

parseGetElements parses everything in the current sub-tree, and returns a an array of elements.

Each element has a 'name', 'value' and 'attributes' key.

If the the element didn't contain sub-elements, an empty array is always returned. If there was any text inside the element, it will be discarded.

If the $elementMap argument is specified, the existing elementMap will be overridden while parsing the tree, and restored after this process.

Parameters

array $elementMap

Returns: array

Definition at line 105 of file Reader.php.

References $result, and Sabre\Xml\Reader\parseInnerTree().

Referenced by Sabre\Xml\Deserializer\repeatingElements(), Sabre\Xml\ReaderTest\testParseGetElements(), Sabre\Xml\ReaderTest\testParseGetElementsNoElements(), and Sabre\CalDAV\Xml\Request\Share\xmlDeserialize().

                                                         {
 
         $result = $this->parseInnerTree($elementMap);
         if (!is_array($result)) {
             return [];
         }
         return $result;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseInnerTree()

Sabre\Xml\Reader::parseInnerTree ( array $elementMap = null )

Parses all elements below the current element.

This method will return a string if this was a text-node, or an array if there were sub-elements.

If there's both text and sub-elements, the text will be discarded.

If the $elementMap argument is specified, the existing elementMap will be overridden while parsing the tree, and restored after this process.

Parameters

array $elementMap

Returns: array|string

Definition at line 129 of file Reader.php.

References $errors, $text, Sabre\Xml\Reader\parseCurrentElement(), Sabre\Xml\popContext(), and Sabre\Xml\pushContext().

                                                       {
 
         $text = null;
         $elements = [];
 
         if ($this->nodeType === self::ELEMENT && $this->isEmptyElement) {
             // Easy!
             $this->next();
             return null;
         }
 
         if (!is_null($elementMap)) {
             $this->pushContext();
             $this->elementMap = $elementMap;
         }
 
         try {
 
             // Really sorry about the silence operator, seems like I have no
             // choice. See:
             //
             // https://bugs.php.net/bug.php?id=64230
             if (!@$this->read()) {
                 $errors = libxml_get_errors();
                 libxml_clear_errors();
                 if ($errors) {
                     throw new LibXMLException($errors);
                 }
                 throw new ParseException('This should never happen (famous last words)');
             }
 
             while (true) {
 
                 if (!$this->isValid()) {
 
                     $errors = libxml_get_errors();
 
                     if ($errors) {
                         libxml_clear_errors();
                         throw new LibXMLException($errors);
                     }
                 }
 
                 switch ($this->nodeType) {
                     case self::ELEMENT :
                         $elements[] = $this->parseCurrentElement();
                         break;
                     case self::TEXT :
                     case self::CDATA :
                         $text .= $this->value;
                         $this->read();
                         break;
                     case self::END_ELEMENT :
                         // Ensuring we are moving the cursor after the end element.
                         $this->read();
                         break 2;
                     case self::NONE :
                         throw new ParseException('We hit the end of the document prematurely. This likely means that some parser "eats" too many elements. Do not attempt to continue parsing.');
                     default :
                         // Advance to the next element
                         $this->read();
                         break;
                 }
 
             }
 
         } finally {
 
             if (!is_null($elementMap)) {
                 $this->popContext();
             }
 
         }
         return ($elements ? $elements : $text);
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readText()

Sabre\Xml\Reader::readText ( )

Reads all text below the current element, and returns this as a string.

Returns: string

Definition at line 211 of file Reader.php.

References $result.

                         {
 
         $result = '';
         $previousDepth = $this->depth;
 
         while ($this->read() && $this->depth != $previousDepth) {
             if (in_array($this->nodeType, [XMLReader::TEXT, XMLReader::CDATA, XMLReader::WHITESPACE])) {
                 $result .= $this->value;
             }
         }
         return $result;
 
     }

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

libs/composer/vendor/sabre/xml/lib/Reader.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ getClark()

◆ getDeserializerForElementName()

◆ parse()

◆ parseAttributes()

◆ parseCurrentElement()

◆ parseGetElements()

◆ parseInnerTree()

◆ readText()