API Documentation

Zend/Gdata/Extension/Who.php

Show:

inherited

Classes
- \Zend_Gdata_Extension_Who

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Gdata
Version: $Id: Who.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Extension_Who
jump to top

Package: Zend\Gdata\Gdata

Data model class to represent a participant

Parent(s): \Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties


                 $_attendeeStatus= 'null'

Default valuenullDetails

Type


                 $_attendeeType= 'null'

Default valuenullDetails

Type


                 $_email= 'null'

Default valuenullDetails

Type


                 $_entryLink= 'null'

Default valuenullDetails

Type


                 $_rel= 'null'

Default valuenullDetails

Type


                 $_rootElement= ''who''

Default value'who'Details

Type


                 $_valueString= 'null'

Default valuenullDetails

Type

Methods

__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
          )
        
        :
          void

Constructs a new Zend_Gdata_Extension_Who object.

Parameters

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

__toString(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The attribute value.

getAttendeeStatus(
          
          )
        
        :
          \Zend_Gdata_Extension_AttendeeStatus

Get this entry's AttendeeStatus element.

Returns

Type	Description
\Zend_Gdata_Extension_AttendeeStatus	The requested entry.

getAttendeeType(
          
          )
        
        :
          \Zend_Gdata_Extension_AttendeeType

Get this entry's AttendeeType element.

Returns

Type	Description
\Zend_Gdata_Extension_AttendeeType	The requested entry.

getDOM(
          \DOMDocument $doc
              =
              null,  $majorVersion
              =
              1,  $minorVersion
              =
              null
          )
        
        :
          \DOMElement

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

Name	Type	Description
$doc	\DOMDocument	The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion

Returns

Type	Description
\DOMElement	The DOMElement representing this element and all child properties.

getEmail(
          
          )
        
        :
          string

Get the value for this element's Email attribute.

Returns

Type	Description
string	The requested attribute.

getRel(
          
          )
        
        :
          string

Get the value for this element's Rel attribute.

Returns

Type	Description
string	The requested attribute.

getValueString(
          
          )
        
        :
          string

Get the value for this element's ValueString attribute.

Returns

Type	Description
string	The requested attribute.

setAttendeeStatus(
          \Zend_Gdata_Extension_AttendeeStatus $value
          )
        
        :
          \Zend_Gdata_Extension_Who

Set the child's AttendeeStatus element.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Extension_AttendeeStatus	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_Extension_Who	The element being modified.

setAttendeeType(
          \Zend_Gdata_Extension_AttendeeType $value
          )
        
        :
          \Zend_Gdata_Extension_Who

Set the child's AttendeeType element.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Extension_AttendeeType	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_Extension_Who	The element being modified.

setEmail(
          string $value
          )
        
        :
          \Zend_Gdata_Extension_Who

Set the value for this element's Email attribute.

Parameters

Name	Type	Description
$value	string	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_Extension_Who	The element being modified.

setRel(
          string $value
          )
        
        :
          \Zend_Gdata_Extension_Who

Set the value for this element's Rel attribute.

Parameters

Name	Type	Description
$value	string	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_Extension_Who	The element being modified.

setValueString(
          string $value
          )
        
        :
          \Zend_Gdata_Extension_Who

Set the value for this element's ValueString attribute.

Parameters

Name	Type	Description
$value	string	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_Extension_Who	The element being modified.

takeAttributeFromDOM(
          \DOMNode $attribute
          )
        
        :
          void

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

Name	Type	Description
$attribute	\DOMNode	The DOMNode attribute needed to be handled

takeChildFromDOM(
          \DOMNode $child
          )
        
        :
          void

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

Parameters

Name	Type	Description
$child	\DOMNode	The DOMNode to process