Docs For Class Zend_Gdata_Extension

Zend_Gdata_Extension_Who

Description

Data model class to represent a participant

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Gdata/Extension/Who.php (line 53)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_Extension
      |
      --Zend_Gdata_Extension
         |
         --Zend_Gdata_Extension_Who

Variable Summary

mixed $_attendeeStatus

mixed $_attendeeType

mixed $_email

mixed $_entryLink

mixed $_rel

mixed $_rootElement

mixed $_valueString

Method Summary

Zend_Gdata_Extension_Who __construct ([string $email = null], [string $rel = null], [string $valueString = null], [Zend_Gdata_Extension_AttendeeStatus $attendeeStatus = null], [Zend_Gdata_Extension_AttendeeType $attendeeType = null], [string $entryLink = null])

Zend_Gdata_Extension_AttendeeStatus getAttendeeStatus ()

Zend_Gdata_Extension_AttendeeType getAttendeeType ()

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

string getEmail ()

string getRel ()

string getValueString ()

Zend_Gdata_Extension_Who setAttendeeStatus (Zend_Gdata_Extension_AttendeeStatus $value)

Zend_Gdata_Extension_Who setAttendeeType (Zend_Gdata_Extension_AttendeeType $value)

Zend_Gdata_Extension_Who setEmail (string $value)

Zend_Gdata_Extension_Who setRel (string $value)

Zend_Gdata_Extension_Who setValueString (string $value)

void takeAttributeFromDOM (DOMNode $attribute)

void takeChildFromDOM (DOMNode $child)

string __toString ()

Variables

mixed $_attendeeStatus = null (line 60)

access: protected

mixed $_attendeeType = null (line 61)

access: protected

mixed $_email = null (line 57)

access: protected

mixed $_entryLink = null (line 62)

access: protected

mixed $_rel = null (line 58)

access: protected

mixed $_rootElement = 'who' (line 56)

access: protected

Redefinition of:

Zend_Gdata_App_Base::$_rootElement

mixed $_valueString = null (line 59)

access: protected

Inherited Variables

Inherited from Zend_Gdata_Extension

Zend_Gdata_Extension::$_rootNamespace

Inherited from Zend_Gdata_App_Base

Zend_Gdata_App_Base::$_extensionAttributes
Zend_Gdata_App_Base::$_extensionElements
Zend_Gdata_App_Base::$_namespaceLookupCache
Zend_Gdata_App_Base::$_namespaces
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text

Methods

Constructor __construct (line 73)

Constructs a new Zend_Gdata_Extension_Who object.

access: public

string $email: (optional) Email address.
string $rel: (optional) Relationship description.
string $valueString: (optional) Simple string describing this person.
Zend_Gdata_Extension_AttendeeStatus $attendeeStatus: (optional) The status of the attendee.
Zend_Gdata_Extension_AttendeeType $attendeeType: (optional) The type of the attendee.
string $entryLink: URL pointing to an associated entry (Contact kind) describing this person.

Redefinition of:

Zend_Gdata_Extension::__construct()

getAttendeeStatus (line 260)

Get this entry's AttendeeStatus element.

return: The requested entry.
access: public

Zend_Gdata_Extension_AttendeeStatus getAttendeeStatus ()

getAttendeeType (line 282)

Get this entry's AttendeeType element.

return: The requested entry.
access: public

Zend_Gdata_Extension_AttendeeType getAttendeeType ()

getDOM (line 95)

Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

return: The DOMElement representing this element and all child properties.
access: public

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

DOMDocument $doc: The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion

Redefinition of:

Zend_Gdata_App_Base::getDOM(): Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

getEmail (line 216)

Get the value for this element's Email attribute.

return: The requested attribute.
access: public

string getEmail ()

getRel (line 238)

Get the value for this element's Rel attribute.

return: The requested attribute.
access: public

string getRel ()

getValueString (line 194)

Get the value for this element's ValueString attribute.

return: The requested attribute.
access: public

string getValueString ()

setAttendeeStatus (line 271)

Set the child's AttendeeStatus element.

return: The element being modified.
access: public

Zend_Gdata_Extension_Who setAttendeeStatus (Zend_Gdata_Extension_AttendeeStatus $value)

Zend_Gdata_Extension_AttendeeStatus $value: The desired value for this attribute.

setAttendeeType (line 293)

Set the child's AttendeeType element.

return: The element being modified.
access: public

Zend_Gdata_Extension_Who setAttendeeType (Zend_Gdata_Extension_AttendeeType $value)

Zend_Gdata_Extension_AttendeeType $value: The desired value for this attribute.

setEmail (line 227)

Set the value for this element's Email attribute.

return: The element being modified.
access: public

Zend_Gdata_Extension_Who setEmail (string $value)

string $value: The desired value for this attribute.

setRel (line 249)

Set the value for this element's Rel attribute.

return: The element being modified.
access: public

Zend_Gdata_Extension_Who setRel (string $value)

string $value: The desired value for this attribute.

setValueString (line 205)

Set the value for this element's ValueString attribute.

return: The element being modified.
access: public

Zend_Gdata_Extension_Who setValueString (string $value)

string $value: The desired value for this attribute.

takeAttributeFromDOM (line 126)

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

access: protected

void takeAttributeFromDOM (DOMNode $attribute)

DOMNode $attribute: The DOMNode attribute needed to be handled

Redefinition of:

Zend_Gdata_App_Base::takeAttributeFromDOM(): Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

takeChildFromDOM (line 149)

Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

access: protected

void takeChildFromDOM (DOMNode $child)

DOMNode $child: The DOMNode to process

Redefinition of:

Zend_Gdata_App_Base::takeChildFromDOM(): Given a child DOMNode, tries to determine how to map the data into object instance members. If no mapping is defined, Extension_Element objects are created and stored in an array.

__toString (line 179)

Retrieves a human readable string describing this attribute's value.

return: The attribute value.
access: public

string __toString ()

Redefinition of:

Zend_Gdata_App_Base::__toString(): Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

Inherited Methods

Inherited From Zend_Gdata_Extension

Zend_Gdata_Extension::__construct()

Inherited From Zend_Gdata_App_Base

Zend_Gdata_App_Base::__construct()
Zend_Gdata_App_Base::encode()
Zend_Gdata_App_Base::flushNamespaceLookupCache()
Zend_Gdata_App_Base::getDOM()
Zend_Gdata_App_Base::getExtensionAttributes()
Zend_Gdata_App_Base::getExtensionElements()
Zend_Gdata_App_Base::getText()
Zend_Gdata_App_Base::getXML()
Zend_Gdata_App_Base::lookupNamespace()
Zend_Gdata_App_Base::registerAllNamespaces()
Zend_Gdata_App_Base::registerNamespace()
Zend_Gdata_App_Base::saveXML()
Zend_Gdata_App_Base::setExtensionAttributes()
Zend_Gdata_App_Base::setExtensionElements()
Zend_Gdata_App_Base::setText()
Zend_Gdata_App_Base::takeAttributeFromDOM()
Zend_Gdata_App_Base::takeChildFromDOM()
Zend_Gdata_App_Base::transferFromDOM()
Zend_Gdata_App_Base::transferFromXML()
Zend_Gdata_App_Base::__get()
Zend_Gdata_App_Base::__isset()
Zend_Gdata_App_Base::__set()
Zend_Gdata_App_Base::__toString()
Zend_Gdata_App_Base::__unset()

Documentation generated on Mon, 21 Jun 2010 15:52:51 -0400 by phpDocumentor 1.4.3