Class Zend_Gdata_Extension_Who

Description

Data model class to represent a participant

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

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

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_Extension
      |
      --Zend_Gdata_Extension
         |
         --Zend_Gdata_Extension_Who
Variable Summary
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])
 DOMElement getDOM ([DOMDocument $doc = 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 52)
  • access: protected
mixed $_attendeeType = null (line 53)
  • access: protected
mixed $_email = null (line 49)
  • access: protected
mixed $_entryLink = null (line 54)
  • access: protected
mixed $_rel = null (line 50)
  • access: protected
mixed $_rootElement = 'gd:who' (line 48)
  • access: protected

Redefinition of:
Zend_Gdata_App_Base::$_rootElement
mixed $_valueString = null (line 51)
  • 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::$_namespaces
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text
Methods
Constructor __construct (line 65)

Constructs a new Zend_Gdata_Extension_Who object.

  • access: public
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])
  • 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 238)

Get this entry's AttendeeStatus element.

  • return: The requested entry.
  • access: public
getAttendeeType (line 260)

Get this entry's AttendeeType element.

  • return: The requested entry.
  • access: public
getDOM (line 88)

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])
  • DOMDocument $doc: The DOMDocument used to construct DOMElements

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 194)

Get the value for this element's Email attribute.

  • return: The requested attribute.
  • access: public
string getEmail ()
getRel (line 216)

Get the value for this element's Rel attribute.

  • return: The requested attribute.
  • access: public
string getRel ()
getValueString (line 172)

Get the value for this element's ValueString attribute.

  • return: The requested attribute.
  • access: public
string getValueString ()
setAttendeeStatus (line 249)

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 271)

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 205)

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 227)

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 183)

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 113)

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 136)

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 162)

Retrieves a human redable 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

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::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::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 Sun, 27 May 2007 23:28:38 -0700 by phpDocumentor 1.3.2