Sabre\VObject\Parser\XML Class Reference

XML Parser. More...

Inheritance diagram for Sabre\VObject\Parser\XML:

Collaboration diagram for Sabre\VObject\Parser\XML:

Public Member Functions
	__construct ($input=null, $options=0)
	Creates the parser. More...
	parse ($input=null, $options=0)
	Parse xCal or xCard. More...
	setInput ($input)
	Sets the input data. More...
	__construct ($input=null, $options=0)
	Creates the parser. More...
	parse ($input=null, $options=0)
	This method starts the parsing process. More...
	setInput ($input)
	Sets the input data. More...

Data Fields
const	XCAL_NAMESPACE = 'urn:ietf:params:xml:ns:icalendar-2.0'
const	XCARD_NAMESPACE = 'urn:ietf:params:xml:ns:vcard-4.0'
Data Fields inherited from Sabre\VObject\Parser\Parser
const	OPTION_FORGIVING = 1
	Turning on this option makes the parser more forgiving. More...
const	OPTION_IGNORE_INVALID_LINES = 2
	If this option is turned on, any lines we cannot parse will be ignored by the reader. More...

Protected Member Functions
	parseVCalendarComponents (Component $parentComponent)
	Parse a xCalendar component. More...
	parseVCardComponents (Component $parentComponent)
	Parse a xCard component. More...
	parseProperties (Component $parentComponent, $propertyNamePrefix='')
	Parse xCalendar and xCard properties. More...
	parseComponent (Component $parentComponent)
	Parse a component. More...
	createProperty (Component $parentComponent, $name, $parameters, $type, $value)
	Create a property. More...

Static Protected Member Functions
static	getTagName ($clarkedTagName)
	Get tag name from a Clark notation. More...

Protected Attributes
	$input
	$root
Protected Attributes inherited from Sabre\VObject\Parser\Parser
	$options

Private Attributes
	$pointer

Detailed Description

XML Parser.

This parser parses both the xCal and xCard formats.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Ivan Enderlin @license http://sabre.io/license/ Modified BSD License

Definition at line 21 of file XML.php.

Constructor & Destructor Documentation

__construct()

Sabre\VObject\Parser\XML::__construct	(		$input = null,
			$options = 0
	)

Creates the parser.

Optionally, it's possible to parse the input stream here.

Parameters

mixed	$input
int	$options	Any parser options (OPTION constants).

Returns

void

Reimplemented from Sabre\VObject\Parser\Parser.

Definition at line 57 of file XML.php.

                                                      {
 
        if (0 === $options) {
            $options = parent::OPTION_FORGIVING;
        }
 
        parent::__construct($input, $options);
 
    }

References Sabre\VObject\Parser\XML\$input, and Sabre\VObject\Parser\Parser\$options.

Member Function Documentation

createProperty()

Sabre\VObject\Parser\XML::createProperty ( Component  $parentComponent,   $name,   $parameters,   $type,   $value  )

protected

Create a property.

Parameters

Component	$parentComponent
string	$name
array	$parameters
string	$type
mixed	$value

Returns

void

Definition at line 373 of file XML.php.

                                                                                                     {
 
        $property = $this->root->createProperty(
            $name,
            null,
            $parameters,
            $type
        );
        $parentComponent->add($property);
        $property->setXmlValue($value);
 
    }

References $name, $type, and Sabre\VObject\Component\add().

Referenced by Sabre\VObject\Parser\XML\parseProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

getTagName()

static Sabre\VObject\Parser\XML::getTagName (   $clarkedTagName )

staticprotected

Get tag name from a Clark notation.

Parameters

string

$clarkedTagName

Returns

string

Definition at line 422 of file XML.php.

                                                          {
 
        list(, $tagName) = SabreXml\Service::parseClarkNotation($clarkedTagName);
        return $tagName;
 
    }

References Sabre\Xml\Service\parseClarkNotation().

Here is the call graph for this function:

parse()

Sabre\VObject\Parser\XML::parse	(		$input = null,
			$options = 0
	)

Parse xCal or xCard.

Parameters

resource | string	$input
int	$options

Exceptions

Exception

Returns

Sabre\VObject\Document

Reimplemented from Sabre\VObject\Parser\Parser.

Definition at line 77 of file XML.php.

                                                {
 
        if (!is_null($input)) {
            $this->setInput($input);
        }
 
        if (0 !== $options) {
            $this->options = $options;
        }
 
        if (is_null($this->input)) {
            throw new EofException('End of input stream, or no input supplied');
        }
 
        switch ($this->input['name']) {
 
            case '{' . self::XCAL_NAMESPACE . '}icalendar':
                $this->root = new VCalendar([], false);
                $this->pointer = &$this->input['value'][0];
                $this->parseVCalendarComponents($this->root);
                break;
 
            case '{' . self::XCARD_NAMESPACE . '}vcards':
                foreach ($this->input['value'] as &$vCard) {
 
                    $this->root = new VCard(['version' => '4.0'], false);
                    $this->pointer = &$vCard;
                    $this->parseVCardComponents($this->root);
 
                    // We just parse the first <vcard /> element.
                    break;
 
                }
                break;
 
            default:
                throw new ParseException('Unsupported XML standard');
 
        }
 
        return $this->root;
    }

References Sabre\VObject\Parser\XML\$input, Sabre\VObject\Parser\Parser\$options, Sabre\VObject\Parser\XML\$root, input, Sabre\VObject\Parser\XML\parseVCalendarComponents(), Sabre\VObject\Parser\XML\parseVCardComponents(), and Sabre\VObject\Parser\XML\setInput().

Here is the call graph for this function:

parseComponent()

Sabre\VObject\Parser\XML::parseComponent ( Component  $parentComponent )

protected

Parse a component.

Parameters

Component

$parentComponent

Returns

void

Definition at line 340 of file XML.php.

                                                                  {
 
        $components = $this->pointer['value'] ?: [];
 
        foreach ($components as $component) {
 
            $componentName = static::getTagName($component['name']);
            $currentComponent = $this->root->createComponent(
                $componentName,
                null,
                false
            );
 
            $this->pointer = &$component;
            $this->parseVCalendarComponents($currentComponent);
 
            $parentComponent->add($currentComponent);
 
        }
 
    }

References Sabre\VObject\Component\add(), and Sabre\VObject\Parser\XML\parseVCalendarComponents().

Referenced by Sabre\VObject\Parser\XML\parseVCalendarComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

parseProperties()

Sabre\VObject\Parser\XML::parseProperties ( Component  $parentComponent,   $propertyNamePrefix = ''  )

protected

Parse xCalendar and xCard properties.

Parameters

Component	$parentComponent
string	$propertyNamePrefix

Returns

void

Definition at line 169 of file XML.php.

                                                                                             {
 
        foreach ($this->pointer ?: [] as $xmlProperty) {
 
            list($namespace, $tagName) = SabreXml\Service::parseClarkNotation($xmlProperty['name']);
 
            $propertyName = $tagName;
            $propertyValue = [];
            $propertyParameters = [];
            $propertyType = 'text';
 
            // A property which is not part of the standard.
            if ($namespace !== self::XCAL_NAMESPACE
                && $namespace !== self::XCARD_NAMESPACE) {
 
                $propertyName = 'xml';
                $value = '<' . $tagName . ' xmlns="' . $namespace . '"';
 
                foreach ($xmlProperty['attributes'] as $attributeName => $attributeValue) {
                    $value .= ' ' . $attributeName . '="' . str_replace('"', '\"', $attributeValue) . '"';
                }
 
                $value .= '>' . $xmlProperty['value'] . '</' . $tagName . '>';
 
                $propertyValue = [$value];
 
                $this->createProperty(
                    $parentComponent,
                    $propertyName,
                    $propertyParameters,
                    $propertyType,
                    $propertyValue
                );
 
                continue;
            }
 
            // xCard group.
            if ($propertyName === 'group') {
 
                if (!isset($xmlProperty['attributes']['name'])) {
                    continue;
                }
 
                $this->pointer = &$xmlProperty['value'];
                $this->parseProperties(
                    $parentComponent,
                    strtoupper($xmlProperty['attributes']['name']) . '.'
                );
 
                continue;
 
            }
 
            // Collect parameters.
            foreach ($xmlProperty['value'] as $i => $xmlPropertyChild) {
 
                if (!is_array($xmlPropertyChild)
                    || 'parameters' !== static::getTagName($xmlPropertyChild['name']))
                    continue;
 
                $xmlParameters = $xmlPropertyChild['value'];
 
                foreach ($xmlParameters as $xmlParameter) {
 
                    $propertyParameterValues = [];
 
                    foreach ($xmlParameter['value'] as $xmlParameterValues) {
                        $propertyParameterValues[] = $xmlParameterValues['value'];
                    }
 
                    $propertyParameters[static::getTagName($xmlParameter['name'])]
                        = implode(',', $propertyParameterValues);
 
                }
 
                array_splice($xmlProperty['value'], $i, 1);
 
            }
 
            $propertyNameExtended = ($this->root instanceof VCalendar
                                      ? 'xcal'
                                      : 'xcard') . ':' . $propertyName;
 
            switch ($propertyNameExtended) {
 
                case 'xcal:geo':
                    $propertyType = 'float';
                    $propertyValue['latitude'] = 0;
                    $propertyValue['longitude'] = 0;
 
                    foreach ($xmlProperty['value'] as $xmlRequestChild) {
                        $propertyValue[static::getTagName($xmlRequestChild['name'])]
                            = $xmlRequestChild['value'];
                    }
                    break;
 
                case 'xcal:request-status':
                    $propertyType = 'text';
 
                    foreach ($xmlProperty['value'] as $xmlRequestChild) {
                        $propertyValue[static::getTagName($xmlRequestChild['name'])]
                            = $xmlRequestChild['value'];
                    }
                    break;
 
                case 'xcal:freebusy':
                    $propertyType = 'freebusy';
                    // We don't break because we only want to set
                    // another property type.
 
                case 'xcal:categories':
                case 'xcal:resources':
                case 'xcal:exdate':
                    foreach ($xmlProperty['value'] as $specialChild) {
                        $propertyValue[static::getTagName($specialChild['name'])]
                            = $specialChild['value'];
                    }
                    break;
 
                case 'xcal:rdate':
                    $propertyType = 'date-time';
 
                    foreach ($xmlProperty['value'] as $specialChild) {
 
                        $tagName = static::getTagName($specialChild['name']);
 
                        if ('period' === $tagName) {
 
                            $propertyParameters['value'] = 'PERIOD';
                            $propertyValue[] = implode('/', $specialChild['value']);
 
                        }
                        else {
                            $propertyValue[] = $specialChild['value'];
                        }
                    }
                    break;
 
                default:
                    $propertyType = static::getTagName($xmlProperty['value'][0]['name']);
 
                    foreach ($xmlProperty['value'] as $value) {
                        $propertyValue[] = $value['value'];
                    }
 
                    if ('date' === $propertyType) {
                        $propertyParameters['value'] = 'DATE';
                    }
                    break;
            }
 
            $this->createProperty(
                $parentComponent,
                $propertyNamePrefix . $propertyName,
                $propertyParameters,
                $propertyType,
                $propertyValue
            );
 
        }
 
    }

References $i, $namespace, Sabre\VObject\Parser\XML\createProperty(), Sabre\Xml\Service\parseClarkNotation(), and Sabre\VObject\Parser\XML\parseProperties().

Referenced by Sabre\VObject\Parser\XML\parseProperties(), Sabre\VObject\Parser\XML\parseVCalendarComponents(), and Sabre\VObject\Parser\XML\parseVCardComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

parseVCalendarComponents()

Sabre\VObject\Parser\XML::parseVCalendarComponents ( Component  $parentComponent )

protected

Parse a xCalendar component.

Parameters

Component

$parentComponent

Returns

void

Definition at line 127 of file XML.php.

                                                                            {
 
        foreach ($this->pointer['value'] ?: [] as $children) {
 
            switch (static::getTagName($children['name'])) {
 
                case 'properties':
                    $this->pointer = &$children['value'];
                    $this->parseProperties($parentComponent);
                    break;
 
                case 'components':
                    $this->pointer = &$children;
                    $this->parseComponent($parentComponent);
                    break;
            }
        }
 
    }

References Sabre\VObject\Parser\XML\parseComponent(), and Sabre\VObject\Parser\XML\parseProperties().

Referenced by Sabre\VObject\Parser\XML\parse(), and Sabre\VObject\Parser\XML\parseComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

parseVCardComponents()

Sabre\VObject\Parser\XML::parseVCardComponents ( Component  $parentComponent )

protected

Parse a xCard component.

Parameters

Component

$parentComponent

Returns

void

Definition at line 154 of file XML.php.

                                                                        {
 
        $this->pointer = &$this->pointer['value'];
        $this->parseProperties($parentComponent);
 
    }

References Sabre\VObject\Parser\XML\parseProperties().

Referenced by Sabre\VObject\Parser\XML\parse().

Here is the call graph for this function:

Here is the caller graph for this function:

setInput()

Sabre\VObject\Parser\XML::setInput

(

$input

)

Sets the input data.

Parameters

resource | string

$input

Returns

void

Reimplemented from Sabre\VObject\Parser\Parser.

Definition at line 393 of file XML.php.

                              {
 
        if (is_resource($input)) {
            $input = stream_get_contents($input);
        }
 
        if (is_string($input)) {
 
            $reader = new SabreXml\Reader();
            $reader->elementMap['{' . self::XCAL_NAMESPACE . '}period']
                = 'Sabre\VObject\Parser\XML\Element\KeyValue';
            $reader->elementMap['{' . self::XCAL_NAMESPACE . '}recur']
                = 'Sabre\VObject\Parser\XML\Element\KeyValue';
            $reader->xml($input);
            $input = $reader->parse();
 
        }
 
        $this->input = $input;
 
    }

References Sabre\VObject\Parser\XML\$input, $reader, and input.

Referenced by Sabre\VObject\Parser\XML\parse().

Here is the caller graph for this function:

Field Documentation

$input

Sabre\VObject\Parser\XML::$input

protected

Definition at line 31 of file XML.php.

Referenced by Sabre\VObject\Parser\XML\__construct(), Sabre\VObject\Parser\XML\parse(), and Sabre\VObject\Parser\XML\setInput().

$pointer

Sabre\VObject\Parser\XML::$pointer

private

Definition at line 38 of file XML.php.

$root

Sabre\VObject\Parser\XML::$root

protected

Definition at line 45 of file XML.php.

Referenced by Sabre\VObject\Parser\XML\parse().

XCAL_NAMESPACE

const Sabre\VObject\Parser\XML::XCAL_NAMESPACE = 'urn:ietf:params:xml:ns:icalendar-2.0'

Definition at line 23 of file XML.php.

XCARD_NAMESPACE

const Sabre\VObject\Parser\XML::XCARD_NAMESPACE = 'urn:ietf:params:xml:ns:vcard-4.0'

Definition at line 24 of file XML.php.

---

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

• libs/composer/vendor/sabre/vobject/lib/Parser/XML.php