iCalendar/vCard/jCal/jCard/xCal/xCard reader object. More...

Collaboration diagram for Sabre\VObject\Reader:

Static Public Member Functions
static	read ($data, $options=0, $charset='UTF-8')
	Parses a vCard or iCalendar object, and returns the top component. More...

static	readJson ($data, $options=0)
	Parses a jCard or jCal object, and returns the top component. More...

static	readXML ($data, $options=0)
	Parses a xCard or xCal object, and returns the top component. More...

Data Fields
const	OPTION_FORGIVING = 1
	If this option is passed to the reader, it will be less strict about the validity of the lines. 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...

Detailed Description

iCalendar/vCard/jCal/jCard/xCal/xCard reader object.

This object provides a few (static) convenience methods to quickly access the parsers.

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

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

Definition at line 15 of file Reader.php.

Member Function Documentation

◆ read()

static Sabre\VObject\Reader::read	(	$data,
		$options = `0`,
		$charset = `'UTF-8'`
	)

static

Parses a vCard or iCalendar object, and returns the top component.

The options argument is a bitfield. Pass any of the OPTIONS constant to alter the parsers' behaviour.

You can either supply a string, or a readable stream for input.

Parameters

string \| resource	$data
int	$options
string	$charset

Returns: Document

Definition at line 42 of file Reader.php.

References $data, PHPMailer\PHPMailer\$options, $parser, and $result.

                                                                   {
 
         $parser = new Parser\MimeDir();
         $parser->setCharset($charset);
         $result = $parser->parse($data, $options);
 
         return $result;
 
     }

Here is the caller graph for this function:

◆ readJson()

static Sabre\VObject\Reader::readJson	(	$data,
		$options = `0`
	)

static

Parses a jCard or jCal object, and returns the top component.

The options argument is a bitfield. Pass any of the OPTIONS constant to alter the parsers' behaviour.

You can either a string, a readable stream, or an array for it's input. Specifying the array is useful if json_decode was already called on the input.

Parameters

string \| resource \| array	$data
int	$options

Returns: Document

Definition at line 67 of file Reader.php.

References $data, PHPMailer\PHPMailer\$options, $parser, and $result.

Referenced by Sabre\VObject\Parser\JsonTest\testParseStreamArg(), Sabre\CalDAV\Plugin\validateICalendar(), and Sabre\CardDAV\Plugin\validateVCard().

                                                   {
 
         $parser = new Parser\Json();
         $result = $parser->parse($data, $options);
 
         return $result;
 
     }

Here is the caller graph for this function:

◆ readXML()

static Sabre\VObject\Reader::readXML	(	$data,
		$options = `0`
	)

static

Parses a xCard or xCal object, and returns the top component.

The options argument is a bitfield. Pass any of the OPTIONS constant to alter the parsers' behaviour.

You can either supply a string, or a readable stream for input.

Parameters

string \| resource	$data
int	$options

Returns: Document

Definition at line 89 of file Reader.php.

References $data, PHPMailer\PHPMailer\$options, $parser, and $result.

Referenced by Sabre\VObject\Parser\XmlTest\assertXMLEqualsToMimeDir(), Sabre\VObject\ReaderTest\testReadXMLComponent(), Sabre\VObject\ReaderTest\testReadXMLStream(), and Sabre\VObject\Parser\XmlTest\testRFC6321Example2().

                                                  {
 
         $parser = new Parser\XML();
         $result = $parser->parse($data, $options);
 
         return $result;
 
     }

Here is the caller graph for this function:

Field Documentation

◆ OPTION_FORGIVING

const Sabre\VObject\Reader::OPTION_FORGIVING = 1

If this option is passed to the reader, it will be less strict about the validity of the lines.

Definition at line 21 of file Reader.php.

Referenced by Sabre\VObject\Cli\readInput(), Sabre\VObject\Issue96Test\testRead(), Sabre\VObject\IssueUndefinedIndexTest\testRead(), Sabre\VObject\ReaderTest\testReadForgiving(), Sabre\VObject\Parser\QuotedPrintableTest\testReadQuotedPrintableCompatibilityMS(), and Sabre\VObject\Parser\QuotedPrintableTest\testReadQuotesPrintableCompoundValues().

◆ OPTION_IGNORE_INVALID_LINES

const Sabre\VObject\Reader::OPTION_IGNORE_INVALID_LINES = 2

If this option is turned on, any lines we cannot parse will be ignored by the reader.

Definition at line 27 of file Reader.php.

Referenced by Sabre\VObject\ReaderTest\testReadWithInvalidLine().

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

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

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ read()

◆ readJson()

◆ readXML()

Field Documentation

◆ OPTION_FORGIVING

◆ OPTION_IGNORE_INVALID_LINES