Class: File_IMC_Parse_Vcalendar

Source Location: /File_IMC-0.5.0/File/IMC/Parse/Vcalendar.php

Class Overview

File_IMC_Parse
   |
   --File_IMC_Parse_Vcalendar

Parser for vCalendars.

Author(s):

Till Klampaeckel <till at php.net>
Paul M. Jones <pjones at ciaweb.net>

Version:

Release: 0.5.0

Methods

Inherited Variables

Class: File_IMC_Parse

File_IMC_Parse::$count
File_IMC_Parse::$data

Inherited Methods

Class: File_IMC_Parse

File_IMC_Parse::fromFile(): Reads a file for parsing, then sends it to $this->fromText() and returns the results.
File_IMC_Parse::fromText(): Prepares a block of text for parsing, then sends it through and returns the results from $this->_fromArray().
File_IMC_Parse::getVersion()
File_IMC_Parse::_charset_conv(): Convert text to the specified charaster set
File_IMC_Parse::_convertLineEndings(): Converts line endings in text.
File_IMC_Parse::_decode(): Looks at a line's parameters; if ENCODING parameter is set and is QUOTED-PRINTABLE then decode the text in-place.
File_IMC_Parse::_fromArray(): Parses an array of source lines and returns an array of vCards.
File_IMC_Parse::_getGroup(): Takes a line and extracts the Group for the line (a group is identified as a prefix-with-dot to the Type-Definition; e.g., Group.ADR or Group.ORG).
File_IMC_Parse::_getParamName(): Returns the parameter name for parameters given without names.
File_IMC_Parse::_getParams(): Finds the Type-Definition parameters for a line.
File_IMC_Parse::_getTypeDef(): Takes a line and extracts the Type-Definition for the line (not including the Group portion; e.g., in Group.ADR, only ADR is returned).
File_IMC_Parse::_parseBlock(): Goes through the IMC file, recursively processing BEGIN-END blocks
File_IMC_Parse::_splitByColon(): Splits the line into types/parameters and values.
File_IMC_Parse::_splitByComma(): Splits a string into an array at commas.
File_IMC_Parse::_splitByDelim(): Splits a string into an array. Honors backslash-escaped delimiters, (i.e., splits at ';' not '\;') and double-quotes (will not break inside double-quotes ("")).
File_IMC_Parse::_splitBySemi(): Splits a string into an array at semicolons.
File_IMC_Parse::_unescape(): Used to make string human-readable after being a vCard value.

Class Details

[line 80]
Parser for vCalendars.

This class parses vCalendar sources from file or text into a structured array.

Usage:

     // include this class file

     require_once 'File/IMC.php';
 
     // instantiate a parser object
     $parse = new File_IMC::parse('vCalendar');
 
     // parse a vCalendar file and store the data
     // in $calinfo
     $calinfo = $parse->fromFile('sample.vcs');
 
     // view the card info array
     echo '<pre>';
     print_r($calinfo);
     echo '</pre>';

Author: Till Klampaeckel <till@php.net>
Author: Paul M. Jones <pjones@ciaweb.net>
Version: Release: 0.5.0
Link: http://pear.php.net/package/File_IMC
License: The BSD License

[ Top ]

Method Detail

getEvents [line 88]

File_IMC_Parse_Vcalendar getEvents(
)

Get all events, wrapped in a class.

Access: public
Uses: File_IMC_Parse::$data

[ Top ]

getVersion [line 99]

string getVersion(
)

Return the version.

Access: public

Overrides File_IMC_Parse::getVersion() (parent method not documented)

[ Top ]