File_IMC
[ class tree: File_IMC ] [ index: File_IMC ] [ all elements ]
Packages:
File_IMC
File_Formats


Classes:
File_IMC
File_IMC_Build
File_IMC_Build_Vcard
File_IMC_Exception
File_IMC_Parse
File_IMC_Parse_Vcard
Files:
Build.php
Exception.php
IMC.php
Parse.php
vcalendar_parse_example.php
Vcard.php
Vcard.php
vcard_build_example.php
vcard_parse_example.php

Element index for package File_IMC

[ a ] [ b ] [ c ] [ e ] [ f ] [ g ] [ i ] [ p ] [ r ] [ s ] [ u ] [ v ] [ _ ]

_

_parseADR
in file Vcard.php, method File_IMC_Parse_Vcard::_parseADR()
    Parses a vCard line value identified as being of the "ADR" (structured address) type-defintion.
_parseCATEGORIES
in file Vcard.php, method File_IMC_Parse_Vcard::_parseCATEGORIES()
    Parses a vCard line value identified as being of the "CATEGORIES" (card-category) type-defintion.
_parseGEO
in file Vcard.php, method File_IMC_Parse_Vcard::_parseGEO()
    Parses a vCard line value identified as being of the "GEO" (geographic coordinate) type-defintion.
_parseN
in file Vcard.php, method File_IMC_Parse_Vcard::_parseN()
    Parses a vCard line value identified as being of the "N" (structured name) type-defintion.
_parseNICKNAME
in file Vcard.php, method File_IMC_Parse_Vcard::_parseNICKNAME()
    Parses a vCard line value identified as being of the "NICKNAME" (informal or descriptive name) type-defintion.
_parseORG
in file Vcard.php, method File_IMC_Parse_Vcard::_parseORG()
    Parses a vCard line value identified as being of the "ORG" (organizational info) type-defintion.
__construct
in file Vcard.php, method File_IMC_Build_Vcard::__construct()
    Constructor
top

a

$autoparam
in file Build.php, variable File_IMC_Build::$autoparam
    Tracks which component (N, ADR, TEL, etc) value was last set or added.
addAddress
in file Vcard.php, method File_IMC_Build_Vcard::addAddress()
    Sets the value of one entire ADR iteration. There can be zero, one, or more ADR components in a vCard.
addCategories
in file Vcard.php, method File_IMC_Build_Vcard::addCategories()
    Sets the full value of the CATEGORIES component. There is only one component iteration allowed per vCard, but there may be multiple value repetitions in the iteration.
addEmail
in file Vcard.php, method File_IMC_Build_Vcard::addEmail()
    Sets the value of one EMAIL component iteration. There can be zero, one, or more component iterations in a vCard.
addLabel
in file Vcard.php, method File_IMC_Build_Vcard::addLabel()
    Sets the value of one LABEL component iteration. There can be zero, one, or more component iterations in a vCard.
addNickname
in file Vcard.php, method File_IMC_Build_Vcard::addNickname()
    Sets the full value of the NICKNAME component. There is only one component iteration allowed per vCard, but there may be multiple value repetitions in the iteration.
addOrganization
in file Vcard.php, method File_IMC_Build_Vcard::addOrganization()
    Sets the full value of the ORG component. There can be only one ORG component in a vCard.
addParam
in file Build.php, method File_IMC_Build::addParam()
    Adds a parameter value for a given component and parameter name.
addTelephone
in file Vcard.php, method File_IMC_Build_Vcard::addTelephone()
    Sets the value of one TEL component iteration. There can be zero, one, or more component iterations in a vCard.
addValue
in file Build.php, method File_IMC_Build::addValue()
    Generic, all-purpose method to add a repetition of a string or array in $this->value, in a way suitable for later output as a vCard element. This appends the value to be the passed text or array value, leaving any prior values in place.
top

b

build
in file IMC.php, method File_IMC::build()
    Builder factory
Build.php
procedural page Build.php
top

c

$count
in file Parse.php, variable File_IMC_Parse::$count
    Keeps track of the current line being parsed
convertLineEndings
in file Parse.php, method File_IMC_Parse::convertLineEndings()
    Converts line endings in text.
top

e

ERROR
in file IMC.php, class constant File_IMC::ERROR
    Constants for File_IMC errors.
ERROR_INVALID_DRIVER
in file IMC.php, class constant File_IMC::ERROR_INVALID_DRIVER
ERROR_INVALID_ITERATION
in file IMC.php, class constant File_IMC::ERROR_INVALID_ITERATION
ERROR_INVALID_PARAM
in file IMC.php, class constant File_IMC::ERROR_INVALID_PARAM
ERROR_INVALID_VCARD_VERSION
in file IMC.php, class constant File_IMC::ERROR_INVALID_VCARD_VERSION
ERROR_PARAM_NOT_SET
in file IMC.php, class constant File_IMC::ERROR_PARAM_NOT_SET
escape
in file Build.php, method File_IMC_Build::escape()
    Prepares a string so it may be safely used as vCard values. DO NOT use this with binary encodings. Operates on text in-place; does not return a value. Recursively descends into arrays.
Exception.php
procedural page Exception.php
top

f

fetch
in file Vcard.php, method File_IMC_Build_Vcard::fetch()
    Fetches a full vCard text block based on $this->value and
fetch
in file Build.php, method File_IMC_Build::fetch()
    Fetches a full vCard/vCal text block based on $this->value and $this->param.
File_IMC
in file IMC.php, class File_IMC
    This class handles vCard and vCalendar files, formats designed by the Internet Mail Consortium (IMC).
File_IMC_Build
in file Build.php, class File_IMC_Build
    This class helps build files in the vCard and vCalendar formats.
File_IMC_Build_Vcard
in file Vcard.php, class File_IMC_Build_Vcard
    This class builds a single vCard (version 3.0 or 2.1).
File_IMC_Exception
in file Exception.php, class File_IMC_Exception
    File_IMC_Exception
File_IMC_Parse
in file Parse.php, class File_IMC_Parse
    Common parser for IMC files (vCard, vCalendar, iCalendar)
File_IMC_Parse_Vcard
in file Vcard.php, class File_IMC_Parse_Vcard
    This class is a parser for vCards.
fromFile
in file Parse.php, method File_IMC_Parse::fromFile()
    Reads a file for parsing, then sends it to $this->fromText() and returns the results.
fromText
in file Parse.php, method File_IMC_Parse::fromText()
    Prepares a block of text for parsing, then sends it through and returns the results from $this->_fromArray().
top

g

getAddress
in file Vcard.php, method File_IMC_Build_Vcard::getAddress()
    Gets back the value of one ADR component iteration.
getAgent
in file Vcard.php, method File_IMC_Build_Vcard::getAgent()
    Gets back the value of the AGENT component. There is only one allowed per vCard.
getBirthday
in file Vcard.php, method File_IMC_Build_Vcard::getBirthday()
    Gets back the value of the BDAY component. There is only one allowed per vCard.
getCategories
in file Vcard.php, method File_IMC_Build_Vcard::getCategories()
    Gets back the value of the CATEGORIES component. There is only one component allowed per vCard, but there may be multiple value repetitions in the iteration.
getClass
in file Vcard.php, method File_IMC_Build_Vcard::getClass()
    Gets back the value of the CLASS component. There is only one allowed per vCard.
getEmail
in file Vcard.php, method File_IMC_Build_Vcard::getEmail()
    Gets back the value of one iteration of the EMAIL component. There can be zero, one, or more component iterations in a vCard.
getFormattedName
in file Vcard.php, method File_IMC_Build_Vcard::getFormattedName()
    Gets back the full FN component value. Only ever returns iteration zero, because only one FN component is allowed per vCard.
getGeo
in file Vcard.php, method File_IMC_Build_Vcard::getGeo()
    Gets back the value of the GEO component. There is only one allowed per vCard.
getKey
in file Vcard.php, method File_IMC_Build_Vcard::getKey()
    Gets back the value of the KEY component. There is only one allowed per vCard.
getLabel
in file Vcard.php, method File_IMC_Build_Vcard::getLabel()
    Gets back the value of one iteration of the LABEL component.
getLogo
in file Vcard.php, method File_IMC_Build_Vcard::getLogo()
    Gets back the value of the LOGO component. There is only one allowed per vCard.
getMailer
in file Vcard.php, method File_IMC_Build_Vcard::getMailer()
    Gets back the value of the MAILER component. There is only one allowed per vCard.
getMeta
in file Build.php, method File_IMC_Build::getMeta()
    Gets the left-side/prefix/before-the-colon (metadata) part of a vCard line, including the component identifier, the parameter list, and a colon.
getName
in file Vcard.php, method File_IMC_Build_Vcard::getName()
    Gets back the full N component (first iteration only, since there can only be one N component per vCard).
getNickname
in file Vcard.php, method File_IMC_Build_Vcard::getNickname()
    Gets back the value of the NICKNAME component. There is only one component allowed per vCard, but there may be multiple value repetitions in the iteration.
getNote
in file Vcard.php, method File_IMC_Build_Vcard::getNote()
    Gets back the value of the NOTE component. There is only one allowed per vCard.
getOrganization
in file Vcard.php, method File_IMC_Build_Vcard::getOrganization()
    Gets back the value of the ORG component.
getParam
in file Build.php, method File_IMC_Build::getParam()
    Gets back the parameter string for a given component.
getPhoto
in file Vcard.php, method File_IMC_Build_Vcard::getPhoto()
    Gets back the value of the PHOTO component. There is only one allowed per vCard.
getProductID
in file Vcard.php, method File_IMC_Build_Vcard::getProductID()
    Gets back the value of the PRODID component. There is only one allowed per vCard.
getRevision
in file Vcard.php, method File_IMC_Build_Vcard::getRevision()
    Gets back the value of the REV component. There is only one allowed per vCard.
getRole
in file Vcard.php, method File_IMC_Build_Vcard::getRole()
    Gets back the value of the ROLE component. There is only one allowed per vCard.
getSortString
in file Vcard.php, method File_IMC_Build_Vcard::getSortString()
    Gets back the value of the SORT-STRING component. There is only one allowed per vCard.
getSound
in file Vcard.php, method File_IMC_Build_Vcard::getSound()
    Gets back the value of the SOUND component. There is only one allowed per vCard.
getSource
in file Vcard.php, method File_IMC_Build_Vcard::getSource()
    Gets back the data-source of the the vCard. Only one iteration.
getSourceName
in file Vcard.php, method File_IMC_Build_Vcard::getSourceName()
    Gets back the displayed data-source name of the the vCard. Only one iteration.
getTelephone
in file Vcard.php, method File_IMC_Build_Vcard::getTelephone()
    Gets back the value of one iteration of the TEL component. There can be zero, one, or more component iterations in a vCard.
getTitle
in file Vcard.php, method File_IMC_Build_Vcard::getTitle()
    Gets back the value of the TITLE component. There is only one allowed per vCard.
getTZ
in file Vcard.php, method File_IMC_Build_Vcard::getTZ()
    Gets back the value of the TZ component. There is only one allowed per vCard.
getUniqueID
in file Vcard.php, method File_IMC_Build_Vcard::getUniqueID()
    Gets back the value of the UID component. There is only one allowed per vCard.
getURL
in file Vcard.php, method File_IMC_Build_Vcard::getURL()
    Gets back the value of the URL component. There is only one allowed per vCard.
getValue
in file Build.php, method File_IMC_Build::getValue()
    Generic, all-purpose method to get back the data stored in $this->value.
getVersion
in file Build.php, method File_IMC_Build::getVersion()
    Gets back the version of the the vCard. Only one iteration.
top

i

IMC.php
procedural page IMC.php
top

p

$param
in file Build.php, variable File_IMC_Build::$param
    Parameters for vCard components.
Parse.php
procedural page Parse.php
parse
in file IMC.php, method File_IMC::parse()
    Parser factory
top

r

reset
in file Build.php, method File_IMC_Build::reset()
    Resets the vCard values and params to be blank.
top

s

setAgent
in file Vcard.php, method File_IMC_Build_Vcard::setAgent()
    Sets the value of the AGENT component. There is only one allowed per vCard.
setBirthday
in file Vcard.php, method File_IMC_Build_Vcard::setBirthday()
    Sets the value of the BDAY component. There is only one allowed per vCard. Date format is "yyyy-mm-dd[Thh:ii[:ss[Z|-06:00]]]".
setClass
in file Vcard.php, method File_IMC_Build_Vcard::setClass()
    Sets the value of the CLASS component. There is only one allowed per vCard.
setFormattedName
in file Vcard.php, method File_IMC_Build_Vcard::setFormattedName()
    Sets the FN component of the card. If no text is passed as the FN value, constructs an FN automatically from N components. There is only one FN iteration per vCard.
setFromArray
in file Build.php, method File_IMC_Build::setFromArray()
    Builds a vCard/vCal from a parser result array. Only send one vCard from the parse-results.
setGeo
in file Vcard.php, method File_IMC_Build_Vcard::setGeo()
    Sets the value of both parts of the GEO component. There is only one GEO component allowed per vCard.
setKey
in file Vcard.php, method File_IMC_Build_Vcard::setKey()
    Sets the value of the KEY component. There is only one allowed per vCard.
setLogo
in file Vcard.php, method File_IMC_Build_Vcard::setLogo()
    Sets the value of the LOGO component. There is only one allowed per vCard.
setMailer
in file Vcard.php, method File_IMC_Build_Vcard::setMailer()
    Sets the value of the MAILER component. There is only one allowed per vCard.
setName
in file Vcard.php, method File_IMC_Build_Vcard::setName()
    Sets the full N component of the vCard. Will replace all other values. There can only be one N component per vCard.
setNote
in file Vcard.php, method File_IMC_Build_Vcard::setNote()
    Sets the value of the NOTE component. There is only one allowed per vCard.
setPhoto
in file Vcard.php, method File_IMC_Build_Vcard::setPhoto()
    Sets the value of the PHOTO component. There is only one allowed per vCard.
setProductID
in file Vcard.php, method File_IMC_Build_Vcard::setProductID()
    Sets the value of the PRODID component. There is only one allowed per vCard.
setRevision
in file Vcard.php, method File_IMC_Build_Vcard::setRevision()
    Sets the value of the REV component. There is only one allowed per vCard.
setRole
in file Vcard.php, method File_IMC_Build_Vcard::setRole()
    Sets the value of the ROLE component. There is only one allowed per vCard.
setSortString
in file Vcard.php, method File_IMC_Build_Vcard::setSortString()
    Sets the value of the SORT-STRING component. There is only one allowed per vCard.
setSound
in file Vcard.php, method File_IMC_Build_Vcard::setSound()
    Sets the value of the SOUND component. There is only one allowed per vCard.
setSource
in file Vcard.php, method File_IMC_Build_Vcard::setSource()
    Sets the data-source of the the vCard. Only one iteration.
setSourceName
in file Vcard.php, method File_IMC_Build_Vcard::setSourceName()
    Sets the displayed name of the vCard data-source. Only one iteration.
setTitle
in file Vcard.php, method File_IMC_Build_Vcard::setTitle()
    Sets the value of the TITLE component. There is only one allowed per vCard.
setTZ
in file Vcard.php, method File_IMC_Build_Vcard::setTZ()
    Sets the value of the TZ component. There is only one allowed per vCard.
setUniqueID
in file Vcard.php, method File_IMC_Build_Vcard::setUniqueID()
    Sets the value of the UID component. There is only one allowed per vCard.
setURL
in file Vcard.php, method File_IMC_Build_Vcard::setURL()
    Sets the value of the URL component. There is only one allowed per vCard.
setValue
in file Build.php, method File_IMC_Build::setValue()
    Generic, all-purpose method to store a string or array in $this->value, in a way suitable for later output as a vCard element. This forces the value to be the passed text or array value, overriding any prior values.
setVersion
in file Vcard.php, method File_IMC_Build_Vcard::setVersion()
    Sets the version of the the vCard. Only one iteration.
setVersion
in file Build.php, method File_IMC_Build::setVersion()
    Sets the version of the specification to use. Only one iteration.
splitByColon
in file Parse.php, method File_IMC_Parse::splitByColon()
    Splits the line into types/parameters and values.
splitByComma
in file Parse.php, method File_IMC_Parse::splitByComma()
    Splits a string into an array at commas.
splitByDelim
in file Parse.php, method 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 ("")).
splitBySemi
in file Parse.php, method File_IMC_Parse::splitBySemi()
    Splits a string into an array at semicolons.
top

u

unescape
in file Parse.php, method File_IMC_Parse::unescape()
    Used to make string human-readable after being a vCard value.
top

v

$value
in file Build.php, variable File_IMC_Build::$value
    Values for vCard components.
vcalendar_parse_example.php
procedural page vcalendar_parse_example.php
vcard_build_example.php
procedural page vcard_build_example.php
vcard_parse_example.php
procedural page vcard_parse_example.php
Vcard.php
procedural page Vcard.php
Vcard.php
procedural page Vcard.php
validateParam
in file Build.php, method File_IMC_Build::validateParam()
    Validates parameter names and values
validateParam
in file Vcard.php, method File_IMC_Build_Vcard::validateParam()
    Validates parameter names and values based on the vCard version (2.1 or 3.0).
VCARD_ADR_COUNTRY
in file IMC.php, class constant File_IMC::VCARD_ADR_COUNTRY
VCARD_ADR_EXTEND
in file IMC.php, class constant File_IMC::VCARD_ADR_EXTEND
VCARD_ADR_LOCALITY
in file IMC.php, class constant File_IMC::VCARD_ADR_LOCALITY
VCARD_ADR_POB
in file IMC.php, class constant File_IMC::VCARD_ADR_POB
    Constants for File_IMC vCard "ADR" component positions.
VCARD_ADR_POSTCODE
in file IMC.php, class constant File_IMC::VCARD_ADR_POSTCODE
VCARD_ADR_REGION
in file IMC.php, class constant File_IMC::VCARD_ADR_REGION
VCARD_ADR_STREET
in file IMC.php, class constant File_IMC::VCARD_ADR_STREET
VCARD_GEO_LAT
in file IMC.php, class constant File_IMC::VCARD_GEO_LAT
    Constants for File_IMC vCard "GEO" component positions.
VCARD_GEO_LON
in file IMC.php, class constant File_IMC::VCARD_GEO_LON
VCARD_N_ADDL
in file IMC.php, class constant File_IMC::VCARD_N_ADDL
VCARD_N_FAMILY
in file IMC.php, class constant File_IMC::VCARD_N_FAMILY
    Constants for File_IMC vCard "N" component positions.
VCARD_N_GIVEN
in file IMC.php, class constant File_IMC::VCARD_N_GIVEN
VCARD_N_PREFIX
in file IMC.php, class constant File_IMC::VCARD_N_PREFIX
VCARD_N_SUFFIX
in file IMC.php, class constant File_IMC::VCARD_N_SUFFIX
top
Documentation generated on Mon, 11 Mar 2019 15:32:03 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.