Documentation

VCard
in package
implements SplitterInterface

Splitter.

This class is responsible for splitting up VCard objects.

It is assumed that the input stream contains 1 or more VCARD objects. This class checks for BEGIN:VCARD and END:VCARD and parses each encountered component individually.

Tags
copyright

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

author

Dominik Tobschall (http://tobschall.de/)

author

Armin Hackmann

license

http://sabre.io/license/ Modified BSD License

Interfaces, Classes and Traits

SplitterInterface
VObject splitter.

Table of Contents

$input  : resource
File handle.
$parser  : MimeDir
Persistent parser.
__construct()  : mixed
Constructor.
getNext()  : Component|null
Every time getNext() is called, a new object will be parsed, until we hit the end of the stream.

Properties

$input

File handle.

protected resource $input

Methods

__construct()

Constructor.

public __construct(resource $input, int $options) : mixed

The splitter should receive an readable file stream as its input.

Parameters
$input : resource
$options : int

parser options, see the OPTIONS constants

Return values
mixed

getNext()

Every time getNext() is called, a new object will be parsed, until we hit the end of the stream.

public getNext() : Component|null

When the end is reached, null will be returned.

Return values
Component|null

Search results