Docs For Class Zend_Gdata_Gapps_Extension

Description

Represents the apps:name element used by the Apps data API. This is used to represent a user's full name. This class is usually contained within instances of Zend_Gdata_Gapps_UserEntry.

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

Located in /Gdata/Gapps/Extension/Name.php (line 45)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_Extension
      |
      --Zend_Gdata_Extension
         |
         --Zend_Gdata_Gapps_Extension_Name

Variable Summary

string $_familyName

string $_givenName

mixed $_rootElement

mixed $_rootNamespace

Method Summary

Zend_Gdata_Gapps_Extension_Name __construct ([string $familyName = null], [string $givenName = null])

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

string getFamilyName ()

string getGivenName ()

Zend_Gdata_Gapps_Extension_Name setFamilyName (string $value)

Zend_Gdata_Gapps_Extension_Name setGivenName (string $value)

void takeAttributeFromDOM (DOMNode $attribute)

void __toString ()

Variables

string $_familyName = null (line 56)

The associated user's family name.

access: protected

string $_givenName = null (line 63)

The associated user's given name.

access: protected

mixed $_rootElement = 'name' (line 49)

access: protected

Redefinition of:

Zend_Gdata_App_Base::$_rootElement

mixed $_rootNamespace = 'apps' (line 48)

access: protected

Redefinition of:

Zend_Gdata_Extension::$_rootNamespace

Inherited Variables

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_Gapps_Extension_Name object.

access: public

Zend_Gdata_Gapps_Extension_Name __construct ([string $familyName = null], [string $givenName = null])

string $familyName: (optional) The familyName to be set for this object.
string $givenName: (optional) The givenName to be set for this object.

Redefinition of:

Zend_Gdata_Extension::__construct()

getDOM (line 91)

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.

getFamilyName (line 130)

Get the value for this element's familyName attribute.

return: The requested attribute.
see: Zend_Gdata_Gapps_Extension_Name::setFamilyName()
access: public

string getFamilyName ()

getGivenName (line 154)

Get the value for this element's givenName attribute.

return: The requested attribute.
see: Zend_Gdata_Gapps_Extension_Name::setGivenName()
access: public

string getGivenName ()

setFamilyName (line 142)

Set the value for this element's familyName attribute. This represents a user's family name.

return: Provides a fluent interface..
access: public

Zend_Gdata_Gapps_Extension_Name setFamilyName (string $value)

string $value: The desired value for this attribute.

setGivenName (line 166)

Set the value for this element's givenName attribute. This represents a user's given name.

return: Provides a fluent interface.
access: public

Zend_Gdata_Gapps_Extension_Name setGivenName (string $value)

string $value: The desired value for this attribute.

takeAttributeFromDOM (line 110)

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.

__toString (line 176)

Magic toString method allows using this directly via echo

Works best in PHP >= 4.2.0

access: public

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