Gdata/Extension/Who.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Gdata
version: $Id: Who.php 23775 2011-03-01 17:25:24Z ralph $
Classes: Zend_Gdata_Extension_Who

Description

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.

Zend_Gdata_Extension_Who
jump to top

Extends from: Zend_Gdata_Extension
category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Gdata
Properties: $_rootElement; $_email; $_rel; $_valueString; $_attendeeStatus; $_attendeeType; $_entryLink
Methods: __construct; getDOM; takeAttributeFromDOM; takeChildFromDOM; __toString; getValueString; setValueString; getEmail; setEmail; getRel; setRel; getAttendeeStatus; setAttendeeStatus; getAttendeeType; setAttendeeType

Description

Data model class to represent a participant

Properties

$_attendeeStatus
jump to class

$_attendeeStatus = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_attendeeType
jump to class

$_attendeeType = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_email
jump to class

$_email = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_entryLink
jump to class

$_entryLink = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_rel
jump to class

$_rel = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_rootElement
jump to class

$_rootElement = 'who'

Details

visibility: protected
default: who
final: false
static: false

$_valueString
jump to class

$_valueString = 'null'

Details

visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Constructs a new Zend_Gdata_Extension_Who object.

Arguments

$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.

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

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

Output

string: The attribute value.

Details

visibility: public
final: false
static: false

getAttendeeStatus
jump to class

getAttendeeStatus(
          
          )
        
        :
        Zend_Gdata_Extension_AttendeeStatus

Get this entry's AttendeeStatus element.

Output

Zend_Gdata_Extension_AttendeeStatus: The requested entry.

Details

visibility: public
final: false
static: false

getAttendeeType
jump to class

getAttendeeType(
          
          )
        
        :
        Zend_Gdata_Extension_AttendeeType

Get this entry's AttendeeType element.

Output

Zend_Gdata_Extension_AttendeeType: The requested entry.

Details

visibility: public
final: false
static: false

getDOM
jump to class

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.

Arguments

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

Output

DOMElement: The DOMElement representing this element and all child properties.

Details

visibility: public
final: false
static: false

getEmail
jump to class

getEmail(
          
          )
        
        :
        string

Get the value for this element's Email attribute.

Output

string: The requested attribute.

Details

visibility: public
final: false
static: false

getRel
jump to class

getRel(
          
          )
        
        :
        string

Get the value for this element's Rel attribute.

Output

string: The requested attribute.

Details

visibility: public
final: false
static: false

getValueString
jump to class

getValueString(
          
          )
        
        :
        string

Get the value for this element's ValueString attribute.

Output

string: The requested attribute.

Details

visibility: public
final: false
static: false

setAttendeeStatus
jump to class

setAttendeeStatus(
          Zend_Gdata_Extension_AttendeeStatus $value
          )
        
        :
        Zend_Gdata_Extension_Who

Set the child's AttendeeStatus element.

Arguments

$value: Zend_Gdata_Extension_AttendeeStatus
The desired value for this attribute.

Output

Zend_Gdata_Extension_Who: The element being modified.

Details

visibility: public
final: false
static: false

setAttendeeType
jump to class

setAttendeeType(
          Zend_Gdata_Extension_AttendeeType $value
          )
        
        :
        Zend_Gdata_Extension_Who

Set the child's AttendeeType element.

Arguments

$value: Zend_Gdata_Extension_AttendeeType
The desired value for this attribute.

Output

Zend_Gdata_Extension_Who: The element being modified.

Details

visibility: public
final: false
static: false

setEmail
jump to class

setEmail(
          string $value
          )
        
        :
        Zend_Gdata_Extension_Who

Set the value for this element's Email attribute.

Arguments

$value: string
The desired value for this attribute.

Output

Zend_Gdata_Extension_Who: The element being modified.

Details

visibility: public
final: false
static: false

setRel
jump to class

setRel(
          string $value
          )
        
        :
        Zend_Gdata_Extension_Who

Set the value for this element's Rel attribute.

Arguments

$value: string
The desired value for this attribute.

Output

Zend_Gdata_Extension_Who: The element being modified.

Details

visibility: public
final: false
static: false

setValueString
jump to class

setValueString(
          string $value
          )
        
        :
        Zend_Gdata_Extension_Who

Set the value for this element's ValueString attribute.

Arguments

$value: string
The desired value for this attribute.

Output

Zend_Gdata_Extension_Who: The element being modified.

Details

visibility: public
final: false
static: false

takeAttributeFromDOM
jump to class

takeAttributeFromDOM(
          DOMNode $attribute
          )
        
        :

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.

Arguments

$attribute: DOMNode
The DOMNode attribute needed to be handled

Details

visibility: protected
final: false
static: false

takeChildFromDOM
jump to class

takeChildFromDOM(
          DOMNode $child
          )
        
        :

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

Arguments

$child: DOMNode
The DOMNode to process

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/Extension/Who.php

Description

Zend_Gdata_Extension_Whojump to top

Description

Properties

$_attendeeStatusjump to class

Details

$_attendeeTypejump to class

Details

$_emailjump to class

Details

$_entryLinkjump to class

Details

$_reljump to class

Details

$_rootElementjump to class

Details

$_valueStringjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

getAttendeeStatusjump to class

Output

Details

getAttendeeTypejump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getEmailjump to class

Output

Details

getReljump to class

Output

Details

getValueStringjump to class

Output

Details

setAttendeeStatusjump to class

Arguments

Output

Details

setAttendeeTypejump to class

Arguments

Output

Details

setEmailjump to class

Arguments

Output

Details

setReljump to class

Arguments

Output

Details

setValueStringjump to class

Arguments

Output

Details

takeAttributeFromDOMjump to class

Arguments

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_Extension_Who
jump to top

$_attendeeStatus
jump to class

$_attendeeType
jump to class

$_email
jump to class

$_entryLink
jump to class

$_rel
jump to class

$_rootElement
jump to class

$_valueString
jump to class

__construct
jump to class

__toString
jump to class

getAttendeeStatus
jump to class

getAttendeeType
jump to class

getDOM
jump to class

getEmail
jump to class

getRel
jump to class

getValueString
jump to class

setAttendeeStatus
jump to class

setAttendeeType
jump to class

setEmail
jump to class

setRel
jump to class

setValueString
jump to class

takeAttributeFromDOM
jump to class

takeChildFromDOM
jump to class