Class: File_IMC_Parse_Vcard

Source Location: /File_IMC-0.4.0/File/IMC/Parse/Vcard.php

Class Overview

File_IMC_Parse
   |
   --File_IMC_Parse_Vcard

This class is a parser for vCards.

Author(s):

Paul M. Jones <pmjones at ciaweb.net>

Methods

Inherited Variables

Class: File_IMC_Parse

File_IMC_Parse::$count

Inherited Methods

Class: File_IMC_Parse

File_IMC_Parse::convertLineEndings(): Converts line endings in text.
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::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 82]
This class is a parser for vCards.

Parses vCard 2.1 and 3.0 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('vCard');
 
     // parse a vCard file and store the data
     // in $cardinfo
     $cardinfo = $parse->fromFile('sample.vcf');
 
     // view the card info array
     echo '<pre>';
     print_r($cardinfo);
     echo '</pre>';

Author: Paul M. Jones <pmjones@ciaweb.net>

[ Top ]

Method Detail

_parseADR [line 126]

array _parseADR(
string
$text)

Parses a vCard line value identified as being of the "ADR" (structured address) type-defintion.

Return: An array of key-value pairs where the key is the portion-name and the value is the portion-value. The value itself may be an array as well if multiple comma-separated values were indicated in the vCard source.
Access: protected

Parameters:

string $text — The right-part (after-the-colon part) of a vCard line.

[ Top ]

_parseCATEGORIES [line 195]

mixed _parseCATEGORIES(
string
$text)

Parses a vCard line value identified as being of the "CATEGORIES" (card-category) type-defintion.

Return: An array of categories.
Access: protected

Parameters:

string $text — The right-part (after-the-colon part) of a vCard line.

[ Top ]

_parseGEO [line 212]

mixed _parseGEO(
string
$text)

Parses a vCard line value identified as being of the "GEO" (geographic coordinate) type-defintion.

Return: An array of lat-lon geocoords.
Access: protected

Parameters:

string $text — The right-part (after-the-colon part) of a vCard line.

[ Top ]

_parseN [line 98]

array _parseN(
string
$text)

Parses a vCard line value identified as being of the "N" (structured name) type-defintion.

Return: An array of key-value pairs where the key is the portion-name and the value is the portion-value. The value itself may be an array as well if multiple comma-separated values were indicated in the vCard source.
Access: protected

Parameters:

string $text — The right-part (after-the-colon part) of a vCard line.

[ Top ]

_parseNICKNAME [line 153]

array _parseNICKNAME(
string
$text)

Parses a vCard line value identified as being of the "NICKNAME" (informal or descriptive name) type-defintion.

Return: An array of nicknames.
Access: protected

Parameters:

string $text — The right-part (after-the-colon part) of a vCard line.

[ Top ]

_parseORG [line 172]

array _parseORG(
string
$text)

Parses a vCard line value identified as being of the "ORG" (organizational info) type-defintion.

Return: An array of organizations; each element of the array is itself an array, which indicates primary organization and sub-organizations.
Access: protected

Parameters:

string $text — The right-part (after-the-colon part) of a vCard line.

[ Top ]