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

Index of all elements

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ k ] [ l ] [ n ] [ p ] [ q ] [ r ] [ s ] [ t ] [ v ] [ _ ]

a

addAddress
in file Vcard.php, method File_IMC_Build_Vcard::addAddress()
addCategories
in file Vcard.php, method File_IMC_Build_Vcard::addCategories()
addEmail
in file Vcard.php, method File_IMC_Build_Vcard::addEmail()
addLabel
in file Vcard.php, method File_IMC_Build_Vcard::addLabel()
addNickname
in file Vcard.php, method File_IMC_Build_Vcard::addNickname()
addOrganization
in file Vcard.php, method File_IMC_Build_Vcard::addOrganization()
addParam
in file Build.php, method File_IMC_Build::addParam()
    Adds a parameter value for a given property and parameter name.
addTelephone
in file Vcard.php, method File_IMC_Build_Vcard::addTelephone()
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.
append
in file Events.php, method File_IMC_Parse_Vcalendar_Events::append()
autoload
in file IMC.php, method File_IMC::autoload()
    SPL-compatible autoloader.
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
count
in file Events.php, method File_IMC_Parse_Vcalendar_Events::count()
current
in file Events.php, method File_IMC_Parse_Vcalendar_Events::current()
top

d

$data
in file Parse.php, variable File_IMC_Parse::$data
$data
in file Events.php, variable File_IMC_Parse_Vcalendar_Events::$data
$data
in file Event.php, variable File_IMC_Parse_Vcalendar_Event::$data
top

e

encode
in file Build.php, method File_IMC_Build::encode()
    Check if encoding parameter has been set for this property/iteration If so... it is assumed that the value has already been encoded as such Otherwide, encode the value if necessary and sets the encoding parameter
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
Event.php
procedural page Event.php
Events.php
procedural page Events.php
top

f

fetch
in file Build.php, method File_IMC_Build::fetch()
    Fetches a full vCard/vCal text block based on $this->value and $this->param.
fetch
in file Vcard.php, method File_IMC_Build_Vcard::fetch()
    Fetches a full vCard text block based on $this->value and
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_Vcalendar
in file Vcalendar.php, class File_IMC_Parse_Vcalendar
    Parser for vCalendars.
File_IMC_Parse_Vcalendar_Event
in file Event.php, class File_IMC_Parse_Vcalendar_Event
    File_IMC_Parse_Vcalendar_Event
File_IMC_Parse_Vcalendar_Events
in file Events.php, class File_IMC_Parse_Vcalendar_Events
    File_IMC_Parse_Vcalendar_Events
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

$group
in file Build.php, variable File_IMC_Build::$group
    Groups for vCard properties
get
in file Vcard.php, method File_IMC_Build_Vcard::get()
    Gets back the vcard line of the specified property (property name, params, & value) this func removes the need for all the public getXxx functions...
getAddress
in file Vcard.php, method File_IMC_Build_Vcard::getAddress()
getAgent
in file Vcard.php, method File_IMC_Build_Vcard::getAgent()
getBirthday
in file Vcard.php, method File_IMC_Build_Vcard::getBirthday()
getCategories
in file Vcard.php, method File_IMC_Build_Vcard::getCategories()
getClass
in file Vcard.php, method File_IMC_Build_Vcard::getClass()
getDescription
in file Event.php, method File_IMC_Parse_Vcalendar_Event::getDescription()
getEmail
in file Vcard.php, method File_IMC_Build_Vcard::getEmail()
getEnd
in file Event.php, method File_IMC_Parse_Vcalendar_Event::getEnd()
getEvents
in file Vcalendar.php, method File_IMC_Parse_Vcalendar::getEvents()
    Get all events, wrapped in a class.
getFormattedName
in file Vcard.php, method File_IMC_Build_Vcard::getFormattedName()
getGeo
in file Vcard.php, method File_IMC_Build_Vcard::getGeo()
getGroup
in file Build.php, method File_IMC_Build::getGroup()
    Gets back the group for a given property.
getKey
in file Vcard.php, method File_IMC_Build_Vcard::getKey()
getLabel
in file Vcard.php, method File_IMC_Build_Vcard::getLabel()
getLogo
in file Vcard.php, method File_IMC_Build_Vcard::getLogo()
getMailer
in file Vcard.php, method File_IMC_Build_Vcard::getMailer()
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 property identifier, the parameter list, and a colon.
getName
in file Vcard.php, method File_IMC_Build_Vcard::getName()
getNickname
in file Vcard.php, method File_IMC_Build_Vcard::getNickname()
getNote
in file Vcard.php, method File_IMC_Build_Vcard::getNote()
getOrganization
in file Vcard.php, method File_IMC_Build_Vcard::getOrganization()
getParam
in file Build.php, method File_IMC_Build::getParam()
    Gets back the parameter string for a given property.
getPhoto
in file Vcard.php, method File_IMC_Build_Vcard::getPhoto()
getProductID
in file Vcard.php, method File_IMC_Build_Vcard::getProductID()
getRevision
in file Vcard.php, method File_IMC_Build_Vcard::getRevision()
getRole
in file Vcard.php, method File_IMC_Build_Vcard::getRole()
getSortString
in file Vcard.php, method File_IMC_Build_Vcard::getSortString()
getSound
in file Vcard.php, method File_IMC_Build_Vcard::getSound()
getSource
in file Vcard.php, method File_IMC_Build_Vcard::getSource()
getSourceName
in file Vcard.php, method File_IMC_Build_Vcard::getSourceName()
getStart
in file Event.php, method File_IMC_Parse_Vcalendar_Event::getStart()
getSummary
in file Event.php, method File_IMC_Parse_Vcalendar_Event::getSummary()
getTelephone
in file Vcard.php, method File_IMC_Build_Vcard::getTelephone()
getTitle
in file Vcard.php, method File_IMC_Build_Vcard::getTitle()
getTZ
in file Vcard.php, method File_IMC_Build_Vcard::getTZ()
getUniqueID
in file Vcard.php, method File_IMC_Build_Vcard::getUniqueID()
getURL
in file Vcard.php, method File_IMC_Build_Vcard::getURL()
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 Vcard.php, method File_IMC_Parse_Vcard::getVersion()
    Return version.
getVersion
in file Build.php, method File_IMC_Build::getVersion()
    Gets back the version of the the vCard. Only one iteration.
getVersion
in file Vcalendar.php, method File_IMC_Parse_Vcalendar::getVersion()
    Return the version.
getVersion
in file Parse.php, method File_IMC_Parse::getVersion()
top

i

$index
in file Events.php, variable File_IMC_Parse_Vcalendar_Events::$index
IMC.php
procedural page IMC.php
top

k

key
in file Events.php, method File_IMC_Parse_Vcalendar_Events::key()
top

l

$lastIter
in file Build.php, variable File_IMC_Build::$lastIter
    Tracks which iteration was last used Used so that iteration need not be specified when adding parameters or groups
$lastProp
in file Build.php, variable File_IMC_Build::$lastProp
    Tracks which property (N, ADR, TEL, etc) value was last set or added.
top

n

next
in file Events.php, method File_IMC_Parse_Vcalendar_Events::next()
top

p

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

q

quoted_printable_encode
in file Build.php, function quoted_printable_encode()
    quoted_printable_encode()
top

r

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

s

seek
in file Events.php, method File_IMC_Parse_Vcalendar_Events::seek()
set
in file Vcard.php, method File_IMC_Build_Vcard::set()
    Sets the value of the specified property
setAgent
in file Vcard.php, method File_IMC_Build_Vcard::setAgent()
setBirthday
in file Vcard.php, method File_IMC_Build_Vcard::setBirthday()
setClass
in file Vcard.php, method File_IMC_Build_Vcard::setClass()
setFormattedName
in file Vcard.php, method File_IMC_Build_Vcard::setFormattedName()
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()
setGroup
in file Build.php, method File_IMC_Build::setGroup()
    Sets the group for a given property.
setKey
in file Vcard.php, method File_IMC_Build_Vcard::setKey()
setLogo
in file Vcard.php, method File_IMC_Build_Vcard::setLogo()
setMailer
in file Vcard.php, method File_IMC_Build_Vcard::setMailer()
setName
in file Vcard.php, method File_IMC_Build_Vcard::setName()
setNote
in file Vcard.php, method File_IMC_Build_Vcard::setNote()
setPhoto
in file Vcard.php, method File_IMC_Build_Vcard::setPhoto()
setProductID
in file Vcard.php, method File_IMC_Build_Vcard::setProductID()
setRevision
in file Vcard.php, method File_IMC_Build_Vcard::setRevision()
setRole
in file Vcard.php, method File_IMC_Build_Vcard::setRole()
setSortString
in file Vcard.php, method File_IMC_Build_Vcard::setSortString()
setSound
in file Vcard.php, method File_IMC_Build_Vcard::setSound()
setSource
in file Vcard.php, method File_IMC_Build_Vcard::setSource()
setSourceName
in file Vcard.php, method File_IMC_Build_Vcard::setSourceName()
setTitle
in file Vcard.php, method File_IMC_Build_Vcard::setTitle()
setTZ
in file Vcard.php, method File_IMC_Build_Vcard::setTZ()
setUniqueID
in file Vcard.php, method File_IMC_Build_Vcard::setUniqueID()
setURL
in file Vcard.php, method File_IMC_Build_Vcard::setURL()
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()
setVersion
in file Build.php, method File_IMC_Build::setVersion()
    Sets the version of the specification to use. Only one iteration.
top

t

toArray
in file Event.php, method File_IMC_Parse_Vcalendar_Event::toArray()
top

v

$value
in file Build.php, variable File_IMC_Build::$value
    Values for vCard properties
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
Vcalendar.php
procedural page Vcalendar.php
Vcard.php
procedural page Vcard.php
valid
in file Events.php, method File_IMC_Parse_Vcalendar_Events::valid()
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).
validateParam
in file Build.php, method File_IMC_Build::validateParam()
    Validates parameter names and values
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

_

_charset_conv
in file Parse.php, method File_IMC_Parse::_charset_conv()
    Convert text to the specified charaster set
_convertLineEndings
in file Parse.php, method File_IMC_Parse::_convertLineEndings()
    Converts line endings in text.
_decode
in file Vcard.php, method File_IMC_Parse_Vcard::_decode()
    Looks at a line's parameters; if ENCODING parameter is set -> decode the text in-place.
_decode
in file Parse.php, method 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.
_fromArray
in file Parse.php, method File_IMC_Parse::_fromArray()
    Parses an array of source lines and returns an array of vCards.
_getADR
in file Vcard.php, method File_IMC_Build_Vcard::_getADR()
    Gets back the value of one ADR property iteration.
_getGEO
in file Vcard.php, method File_IMC_Build_Vcard::_getGEO()
    Gets back the value of the GEO property.
_getGroup
in file Parse.php, method 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).
_getN
in file Vcard.php, method File_IMC_Build_Vcard::_getN()
    Gets back the full N property
_getORG
in file Vcard.php, method File_IMC_Build_Vcard::_getORG()
    Gets back the value of the ORG property.
_getParamName
in file Parse.php, method File_IMC_Parse::_getParamName()
    Returns the parameter name for parameters given without names.
_getParams
in file Parse.php, method File_IMC_Parse::_getParams()
    Finds the Type-Definition parameters for a line.
_getTypeDef
in file Parse.php, method 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).
_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.
_parseBlock
in file Parse.php, method File_IMC_Parse::_parseBlock()
    Goes through the IMC file, recursively processing BEGIN-END blocks
_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.
_setADR
in file Vcard.php, method File_IMC_Build_Vcard::_setADR()
    Sets the value of one entire ADR iteration.
_setFN
in file Vcard.php, method File_IMC_Build_Vcard::_setFN()
    Sets the FN property of the card. If no text is passed as the FN value, constructs an FN automatically from N property.
_setGEO
in file Vcard.php, method File_IMC_Build_Vcard::_setGEO()
    Sets the GEO property (both latitude and longitude)
_setLast
in file Build.php, method File_IMC_Build::_setLast()
_setN
in file Vcard.php, method File_IMC_Build_Vcard::_setN()
    Sets the full N property of the vCard.
_setORG
in file Vcard.php, method File_IMC_Build_Vcard::_setORG()
    Sets the full value of the ORG property.
_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.
_unescape
in file Parse.php, method File_IMC_Parse::_unescape()
    Used to make string human-readable after being a vCard value.
_validateParam21
in file Vcard.php, method File_IMC_Build_Vcard::_validateParam21()
    Validate parameters with 2.1 vcards.
_validateParam30
in file Vcard.php, method File_IMC_Build_Vcard::_validateParam30()
    Validate parameters with 3.0 vcards.
__construct
in file Vcard.php, method File_IMC_Build_Vcard::__construct()
    Constructor
__construct
in file Events.php, method File_IMC_Parse_Vcalendar_Events::__construct()
__construct
in file Event.php, method File_IMC_Parse_Vcalendar_Event::__construct()
__toString
in file Build.php, method File_IMC_Build::__toString()
    Magic method to display the vCard/vCal.
top
Documentation generated on Mon, 11 Mar 2019 15:49:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.