Element index for package File_IMC
[ a ]
[ b ]
[ c ]
[ e ]
[ f ]
[ g ]
[ i ]
[ p ]
[ r ]
[ s ]
[ u ]
[ v ]
a
- $autoparam
- in file Build.php, variable File_IMC_Build::$autoparam
Tracks which component (N, ADR, TEL, etc) value was last set or added.
- addParam
- in file Build.php, method File_IMC_Build::addParam()
Adds a parameter value for a given component and parameter name.
- 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.
- addAddress
- in file vCard.php, method File_IMC_Build_vCard::addAddress() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Sets the full value of the ORG component. There can be only one ORG component in a vCard.
- addTelephone
- in file vCard.php, method File_IMC_Build_vCard::addTelephone() (subpackage: File_IMC-0.3)
Sets the value of one TEL component iteration. There can be zero, one, or more component iterations in a vCard.
top
top
top
e
- 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.
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.
- 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 Build.php, method File_IMC_Build::File_IMC_Build_vCard()
Constructor
- FILE_IMC_ERROR
- in file IMC.php, constant FILE_IMC_ERROR
- FILE_IMC_ERROR_INVALID_DRIVER
- in file IMC.php, constant FILE_IMC_ERROR_INVALID_DRIVER
- FILE_IMC_ERROR_INVALID_ITERATION
- in file IMC.php, constant FILE_IMC_ERROR_INVALID_ITERATION
- FILE_IMC_ERROR_INVALID_PARAM
- in file IMC.php, constant FILE_IMC_ERROR_INVALID_PARAM
- FILE_IMC_ERROR_INVALID_VCARD_VERSION
- in file IMC.php, constant FILE_IMC_ERROR_INVALID_VCARD_VERSION
- FILE_IMC_ERROR_PARAM_NOT_SET
- in file IMC.php, constant FILE_IMC_ERROR_PARAM_NOT_SET
- File_IMC_Parse
- in file Parse.php, class File_IMC_Parse
Common parser for IMC files (vCard, vCalendar, iCalendar)
- 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().
- fetch
- in file vCard.php, method File_IMC_Build_vCard::fetch() (subpackage: File_IMC-0.3)
Fetches a full vCard text block based on $this->value and
- File_IMC_Build_vCard
- in file vCard.php, class File_IMC_Build_vCard (subpackage: File_IMC-0.3)
This class helps build files in the vCard and vCalendar formats.
- File_IMC_Parse_vCalendar
- in file vCalendar.php, class File_IMC_Parse_vCalendar (subpackage: File_IMC-0.3)
Common parser for IMC files (vCard, vCalendar, iCalendar)
- File_IMC_Parse_vCard
- in file vCard.php, class File_IMC_Parse_vCard (subpackage: File_IMC-0.3)
Common parser for IMC files (vCard, vCalendar, iCalendar)
top
g
- 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.
- getParam
- in file Build.php, method File_IMC_Build::getParam()
Gets back the parameter string for a given component.
- 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.
- getAddress
- in file vCard.php, method File_IMC_Build_vCard::getAddress() (subpackage: File_IMC-0.3)
Gets back the value of one ADR component iteration.
- getAgent
- in file vCard.php, method File_IMC_Build_vCard::getAgent() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Gets back the value of one iteration of the LABEL component.
- getLogo
- in file vCard.php, method File_IMC_Build_vCard::getLogo() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Gets back the value of the MAILER component. There is only one allowed per vCard.
- getName
- in file vCard.php, method File_IMC_Build_vCard::getName() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Gets back the value of the ORG component.
- getPhoto
- in file vCard.php, method File_IMC_Build_vCard::getPhoto() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Gets back the data-source of the the vCard. Only one iteration.
- getSourceName
- in file vCard.php, method File_IMC_Build_vCard::getSourceName() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Gets back the value of the URL component. There is only one allowed per vCard.
top
i
- IMC.php
- procedural page IMC.php
- is_a
- in file Build.php, function is_a()
Emulate is_a() for PHP < 4.2.0
top
top
top
s
- 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.
- 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 Build.php, method File_IMC_Build::setVersion()
Sets the version of the specification to use. Only one iteration.
- splitByComma
- in file Parse.php, method File_IMC_Parse::splitByComma()
Splits a string into an array at commas. Honors backslash- escaped commas (i.e., splits at ',' not '\,').
- splitBySemi
- in file Parse.php, method File_IMC_Parse::splitBySemi()
Splits a string into an array at semicolons. Honors backslash- escaped semicolons (i.e., splits at ';' not '\;').
- setAgent
- in file vCard.php, method File_IMC_Build_vCard::setAgent() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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.
- setGeo
- in file vCard.php, method File_IMC_Build_vCard::setGeo() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Sets the data-source of the the vCard. Only one iteration.
- setSourceName
- in file vCard.php, method File_IMC_Build_vCard::setSourceName() (subpackage: File_IMC-0.3)
Sets the displayed name of the vCard data-source. Only one iteration.
- setTitle
- in file vCard.php, method File_IMC_Build_vCard::setTitle() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
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() (subpackage: File_IMC-0.3)
Sets the value of the URL component. There is only one allowed per vCard.
- setVersion
- in file vCard.php, method File_IMC_Build_vCard::setVersion() (subpackage: File_IMC-0.3)
Sets the version of the the vCard. Only one iteration.
top
top
v
- $value
- in file Build.php, variable File_IMC_Build::$value
Values for vCard components.
- vCard.php
- procedural page vCard.php
- vCalendar.php
- procedural page vCalendar.php
- vCard.php
- procedural page vCard.php
- 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
- validateParam
- in file Build.php, method File_IMC_Build::validateParam()
Validates parameter names and values
- VCARD_ADR_COUNTRY
- in file vCard.php, constant VCARD_ADR_COUNTRY
Part numbers for ADR components
- VCARD_ADR_EXTEND
- in file vCard.php, constant VCARD_ADR_EXTEND
Part numbers for ADR components
- VCARD_ADR_LOCALITY
- in file vCard.php, constant VCARD_ADR_LOCALITY
Part numbers for ADR components
- VCARD_ADR_POB
- in file vCard.php, constant VCARD_ADR_POB
Part numbers for ADR components
- VCARD_ADR_POSTCODE
- in file vCard.php, constant VCARD_ADR_POSTCODE
Part numbers for ADR components
- VCARD_ADR_REGION
- in file vCard.php, constant VCARD_ADR_REGION
Part numbers for ADR components
- VCARD_ADR_STREET
- in file vCard.php, constant VCARD_ADR_STREET
Part numbers for ADR components
- VCARD_GEO_LAT
- in file vCard.php, constant VCARD_GEO_LAT
Part numbers for GEO components
- VCARD_GEO_LON
- in file vCard.php, constant VCARD_GEO_LON
Part numbers for GEO components
- VCARD_N_ADDL
- in file vCard.php, constant VCARD_N_ADDL
Part numbers for N components
- VCARD_N_FAMILY
- in file vCard.php, constant VCARD_N_FAMILY
Part numbers for N components
- VCARD_N_GIVEN
- in file vCard.php, constant VCARD_N_GIVEN
Part numbers for N components
- VCARD_N_PREFIX
- in file vCard.php, constant VCARD_N_PREFIX
Part numbers for N components
- VCARD_N_SUFFIX
- in file vCard.php, constant VCARD_N_SUFFIX
Part numbers for N components
- validateParam
- in file vCard.php, method File_IMC_Build_vCard::validateParam() (subpackage: File_IMC-0.3)
Validates parameter names and values based on the vCard version (2.1 or 3.0).
top
Documentation generated on Sat, 1 May 2004 00:42:13 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.
|
|
