Contact_Vcard_Build
[ class tree: Contact_Vcard_Build ] [ index: Contact_Vcard_Build ] [ all elements ]

Element index for package Contact_Vcard_Build

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

_

_setParam
in file Build.php, method Contact_Vcard_Build::_setParam()
    _setParam
_setValue
in file Build.php, method Contact_Vcard_Build::_setValue()
    _setValue
top

a

$autoparam
in file Build.php, variable Contact_Vcard_Build::$autoparam
    Tracks which component (N, ADR, TEL, etc) value was last set or added.
addAddress
in file Build.php, method Contact_Vcard_Build::addAddress()
    Sets the value of one entire ADR iteration. There can be zero, one, or more ADR components in a vCard.
addCategories
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::addEmail()
    Sets the value of one EMAIL component iteration. There can be zero, one, or more component iterations in a vCard.
addLabel
in file Build.php, method Contact_Vcard_Build::addLabel()
    Sets the value of one LABEL component iteration. There can be zero, one, or more component iterations in a vCard.
addNickname
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::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 Contact_Vcard_Build::addParam()
    Adds a parameter value for a given component and parameter name.
addTelephone
in file Build.php, method Contact_Vcard_Build::addTelephone()
    Sets the value of one component iteration. There can be zero, one, or more component iterations in a vCard. This function also takes a type argument to be able to add mobiles, fax and voice as well.
addValue
in file Build.php, method Contact_Vcard_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.php
procedural page Build.php
top

c

Contact_Vcard_Build
in file Build.php, class Contact_Vcard_Build
    This class builds a single vCard (version 3.0 or 2.1).
Contact_Vcard_Build
in file Build.php, method Contact_Vcard_Build::Contact_Vcard_Build()
    Constructor.
Contact_Vcard_Build.php
procedural page Contact_Vcard_Build.php
countIter
in file Build.php, method Contact_Vcard_Build::countIter()
    Count the number of iterations for an element type.
countRept
in file Build.php, method Contact_Vcard_Build::countRept()
    Count the number of repetitions for an element type and iteration number.
top

e

escape
in file Build.php, method Contact_Vcard_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 Contact_Vcard_Build::fetch()
    Fetches a full vCard text block based on $this->value and
top

g

getAddress
in file Build.php, method Contact_Vcard_Build::getAddress()
    Gets back the value of one ADR component iteration.
getAgent
in file Build.php, method Contact_Vcard_Build::getAgent()
    Gets back the value of the AGENT component. There is only one allowed per vCard.
getBirthday
in file Build.php, method Contact_Vcard_Build::getBirthday()
    Gets back the value of the BDAY component. There is only one allowed per vCard.
getCategories
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::getClass()
    Gets back the value of the CLASS component. There is only one allowed per vCard.
getEmail
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::getGeo()
    Gets back the value of the GEO component. There is only one allowed per vCard.
getKey
in file Build.php, method Contact_Vcard_Build::getKey()
    Gets back the value of the KEY component. There is only one allowed per vCard.
getLabel
in file Build.php, method Contact_Vcard_Build::getLabel()
    Gets back the value of one iteration of the LABEL component.
getLogo
in file Build.php, method Contact_Vcard_Build::getLogo()
    Gets back the value of the LOGO component. There is only one allowed per vCard.
getMailer
in file Build.php, method Contact_Vcard_Build::getMailer()
    Gets back the value of the MAILER component. There is only one allowed per vCard.
getMeta
in file Build.php, method Contact_Vcard_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 Build.php, method Contact_Vcard_Build::getName()
    Gets back the full N component (first iteration only, since there can only be one N component per vCard).
getNickname
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::getNote()
    Gets back the value of the NOTE component. There is only one allowed per vCard.
getOrganization
in file Build.php, method Contact_Vcard_Build::getOrganization()
    Gets back the value of the ORG component.
getParam
in file Build.php, method Contact_Vcard_Build::getParam()
    Gets back the parameter string for a given component.
getPhoto
in file Build.php, method Contact_Vcard_Build::getPhoto()
    Gets back the value of the PHOTO component. There is only one allowed per vCard.
getProductID
in file Build.php, method Contact_Vcard_Build::getProductID()
    Gets back the value of the PRODID component. There is only one allowed per vCard.
getRevision
in file Build.php, method Contact_Vcard_Build::getRevision()
    Gets back the value of the REV component. There is only one allowed per vCard.
getRole
in file Build.php, method Contact_Vcard_Build::getRole()
    Gets back the value of the ROLE component. There is only one allowed per vCard.
getSortString
in file Build.php, method Contact_Vcard_Build::getSortString()
    Gets back the value of the SORT-STRING component. There is only one allowed per vCard.
getSound
in file Build.php, method Contact_Vcard_Build::getSound()
    Gets back the value of the SOUND component. There is only one allowed per vCard.
getSource
in file Build.php, method Contact_Vcard_Build::getSource()
    Gets back the data-source of the the vCard. Only one iteration.
getSourceName
in file Build.php, method Contact_Vcard_Build::getSourceName()
    Gets back the displayed data-source name of the the vCard. Only one iteration.
getTelephone
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::getTitle()
    Gets back the value of the TITLE component. There is only one allowed per vCard.
getTZ
in file Build.php, method Contact_Vcard_Build::getTZ()
    Gets back the value of the TZ component. There is only one allowed per vCard.
getUniqueID
in file Build.php, method Contact_Vcard_Build::getUniqueID()
    Gets back the value of the UID component. There is only one allowed per vCard.
getURL
in file Build.php, method Contact_Vcard_Build::getURL()
    Gets back the value of the URL component. There is only one allowed per vCard.
getValue
in file Build.php, method Contact_Vcard_Build::getValue()
    Generic, all-purpose method to get back the data stored in $this->value.
getVersion
in file Build.php, method Contact_Vcard_Build::getVersion()
    Gets back the version of the the vCard. Only one iteration.
top

p

$param
in file Build.php, variable Contact_Vcard_Build::$param
    Parameters for vCard components.
top

r

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

s

send
in file Build.php, method Contact_Vcard_Build::send()
    Send the vCard as a downloadable file.
setAgent
in file Build.php, method Contact_Vcard_Build::setAgent()
    Sets the value of the AGENT component. There is only one allowed per vCard.
setBirthday
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::setClass()
    Sets the value of the CLASS component. There is only one allowed per vCard.
setFormattedName
in file Build.php, method Contact_Vcard_Build::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 Contact_Vcard_Build::setFromArray()
    Builds a vCard from a Contact_Vcard_Parse result array. Only send one vCard from the parse-results.
setGeo
in file Build.php, method Contact_Vcard_Build::setGeo()
    Sets the value of both parts of the GEO component. There is only one GEO component allowed per vCard.
setKey
in file Build.php, method Contact_Vcard_Build::setKey()
    Sets the value of the KEY component. There is only one allowed per vCard.
setLogo
in file Build.php, method Contact_Vcard_Build::setLogo()
    Sets the value of the LOGO component. There is only one allowed per vCard.
setMailer
in file Build.php, method Contact_Vcard_Build::setMailer()
    Sets the value of the MAILER component. There is only one allowed per vCard.
setName
in file Build.php, method Contact_Vcard_Build::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 Build.php, method Contact_Vcard_Build::setNote()
    Sets the value of the NOTE component. There is only one allowed per vCard.
setPhoto
in file Build.php, method Contact_Vcard_Build::setPhoto()
    Sets the value of the PHOTO component. There is only one allowed per vCard.
setProductID
in file Build.php, method Contact_Vcard_Build::setProductID()
    Sets the value of the PRODID component. There is only one allowed per vCard.
setRevision
in file Build.php, method Contact_Vcard_Build::setRevision()
    Sets the value of the REV component. There is only one allowed per vCard. This value is free and should reflect whatever you use for control - e.g. a DATETIME value.
setRole
in file Build.php, method Contact_Vcard_Build::setRole()
    Sets the value of the ROLE component. There is only one allowed per vCard.
setSortString
in file Build.php, method Contact_Vcard_Build::setSortString()
    Sets the value of the SORT-STRING component. There is only one allowed per vCard.
setSound
in file Build.php, method Contact_Vcard_Build::setSound()
    Sets the value of the SOUND component. There is only one allowed per vCard.
setSource
in file Build.php, method Contact_Vcard_Build::setSource()
    Sets the data-source of the the vCard. Only one iteration.
setSourceName
in file Build.php, method Contact_Vcard_Build::setSourceName()
    Sets the displayed name of the vCard data-source. Only one iteration.
setTitle
in file Build.php, method Contact_Vcard_Build::setTitle()
    Sets the value of the TITLE component. There is only one allowed per vCard.
setTZ
in file Build.php, method Contact_Vcard_Build::setTZ()
    Sets the value of the TZ component. There is only one allowed per vCard.
setUniqueID
in file Build.php, method Contact_Vcard_Build::setUniqueID()
    Sets the value of the UID component. There is only one allowed per vCard.
setURL
in file Build.php, method Contact_Vcard_Build::setURL()
    Sets the value of the URL component. There is only one allowed per vCard.
setValue
in file Build.php, method Contact_Vcard_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 Contact_Vcard_Build::setVersion()
    Sets the version of the the vCard. Only one iteration.
top

t

test.php
procedural page test.php
top

v

$value
in file Build.php, variable Contact_Vcard_Build::$value
    Values for vCard components.
validateParam
in file Build.php, method Contact_Vcard_Build::validateParam()
    Validates parameter names and values based on the vCard version (2.1 or 3.0).
VCARD_ADR_COUNTRY
in file Build.php, constant VCARD_ADR_COUNTRY
VCARD_ADR_EXTEND
in file Build.php, constant VCARD_ADR_EXTEND
VCARD_ADR_LOCALITY
in file Build.php, constant VCARD_ADR_LOCALITY
VCARD_ADR_POB
in file Build.php, constant VCARD_ADR_POB
VCARD_ADR_POSTCODE
in file Build.php, constant VCARD_ADR_POSTCODE
VCARD_ADR_REGION
in file Build.php, constant VCARD_ADR_REGION
VCARD_ADR_STREET
in file Build.php, constant VCARD_ADR_STREET
VCARD_GEO_LAT
in file Build.php, constant VCARD_GEO_LAT
VCARD_GEO_LON
in file Build.php, constant VCARD_GEO_LON
VCARD_N_ADDL
in file Build.php, constant VCARD_N_ADDL
VCARD_N_FAMILY
in file Build.php, constant VCARD_N_FAMILY
VCARD_N_GIVEN
in file Build.php, constant VCARD_N_GIVEN
VCARD_N_PREFIX
in file Build.php, constant VCARD_N_PREFIX
VCARD_N_SUFFIX
in file Build.php, constant VCARD_N_SUFFIX
top

Documentation generated on Wed, 01 Jul 2009 00:00:02 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.