Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Gdata_Extension_Who Class Reference

Public Member Functions

 __construct ($email=null, $rel=null, $valueString=null, $attendeeStatus=null, $attendeeType=null, $entryLink=null)
 Constructs a new Zend_Gdata_Extension_Who object.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 __toString ()
 Retrieves a human readable string describing this attribute's value.
 
 getValueString ()
 Get the value for this element's ValueString attribute.
 
 setValueString ($value)
 Set the value for this element's ValueString attribute.
 
 getEmail ()
 Get the value for this element's Email attribute.
 
 setEmail ($value)
 Set the value for this element's Email attribute.
 
 getRel ()
 Get the value for this element's Rel attribute.
 
 setRel ($value)
 Set the value for this element's Rel attribute.
 
 getAttendeeStatus ()
 Get this entry's AttendeeStatus element.
 
 setAttendeeStatus ($value)
 Set the child's AttendeeStatus element.
 
 getAttendeeType ()
 Get this entry's AttendeeType element.
 
 setAttendeeType ($value)
 Set the child's AttendeeType element.
 
- Public Member Functions inherited from Zend_Gdata_Extension
 __construct ()
 

Protected Member Functions

 takeAttributeFromDOM ($attribute)
 Given a DOMNode representing an attribute, tries to map the data into instance members.
 
 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.
 

Protected Attributes

 $_rootElement = 'who'
 
 $_email = null
 
 $_rel = null
 
 $_valueString = null
 
 $_attendeeStatus = null
 
 $_attendeeType = null
 
 $_entryLink = null
 
- Protected Attributes inherited from Zend_Gdata_Extension
 $_rootNamespace = 'gd'
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Gdata_App_Base
static flushNamespaceLookupCache ()
 Flush namespace lookup cache.
 
- Static Protected Attributes inherited from Zend_Gdata_App_Base
static $_namespaceLookupCache = array()
 

Constructor & Destructor Documentation

__construct (   $email = null,
  $rel = null,
  $valueString = null,
  $attendeeStatus = null,
  $attendeeType = null,
  $entryLink = null 
)

Constructs a new Zend_Gdata_Extension_Who object.

Parameters
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$entryLinkURL pointing to an associated entry (Contact kind) describing this person.

Member Function Documentation

__toString ( )

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

Returns
string The attribute value.
getAttendeeStatus ( )

Get this entry's AttendeeStatus element.

Returns
Zend_Gdata_Extension_AttendeeStatus The requested entry.
getAttendeeType ( )

Get this entry's AttendeeType element.

Returns
Zend_Gdata_Extension_AttendeeType The requested entry.
getDOM (   $doc = null,
  $majorVersion = 1,
  $minorVersion = null 
)

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.

Parameters
DOMDocument$docThe DOMDocument used to construct DOMElements
Returns
DOMElement The DOMElement representing this element and all child properties.
getEmail ( )

Get the value for this element's Email attribute.

Returns
string The requested attribute.
getRel ( )

Get the value for this element's Rel attribute.

Returns
string The requested attribute.
getValueString ( )

Get the value for this element's ValueString attribute.

Returns
string The requested attribute.
setAttendeeStatus (   $value)

Set the child's AttendeeStatus element.

Parameters
Zend_Gdata_Extension_AttendeeStatus$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Who The element being modified.
setAttendeeType (   $value)

Set the child's AttendeeType element.

Parameters
Zend_Gdata_Extension_AttendeeType$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Who The element being modified.
setEmail (   $value)

Set the value for this element's Email attribute.

Parameters
string$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Who The element being modified.
setRel (   $value)

Set the value for this element's Rel attribute.

Parameters
string$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Who The element being modified.
setValueString (   $value)

Set the value for this element's ValueString attribute.

Parameters
string$valueThe desired value for this attribute.
Returns
Zend_Gdata_Extension_Who The element being modified.
takeAttributeFromDOM (   $attribute)
protected

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.

Parameters
DOMNode$attributeThe DOMNode attribute needed to be handled
takeChildFromDOM (   $child)
protected

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

Parameters
DOMNode$childThe DOMNode to process

Member Data Documentation

$_attendeeStatus = null
protected
$_attendeeType = null
protected
$_email = null
protected
$_entryLink = null
protected
$_rel = null
protected
$_rootElement = 'who'
protected
$_valueString = null
protected