Zend_Gdata_Gapps_Extension_Nickname Class Reference

Inheritance diagram for Zend_Gdata_Gapps_Extension_Nickname:

Collaboration diagram for Zend_Gdata_Gapps_Extension_Nickname:

Public Member Functions
	__construct ($name=null)
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	getName ()
	setName ($value)
	__toString ()
Protected Member Functions
	takeAttributeFromDOM ($attribute)
Protected Attributes
	$_rootNamespace = 'apps'
	$_rootElement = 'nickname'
	$_name = null

---

Detailed Description

Definition at line 45 of file Nickname.php.

---

Constructor & Destructor Documentation

__construct

(

$

name = null

)

Constructs a new Zend_Gdata_Gapps_Extension_Nickname object.

Parameters:

string

$name

(optional) The nickname being represented.

Definition at line 63 of file Nickname.php.

Here is the call graph for this function:

---

Member Function Documentation

__toString

(

)

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

Reimplemented from Zend_Gdata_App_Base.

Definition at line 137 of file Nickname.php.

Here is the call graph for this function:

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

$doc

The DOMDocument used to construct DOMElements

Returns:

DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_App_Base.

Definition at line 80 of file Nickname.php.

getName

(

)

Get the value for this element's name attribute.

See also:

setName

Returns:

string The requested attribute.

Definition at line 113 of file Nickname.php.

Here is the caller graph for this function:

setName

(

$

value

)

Set the value for this element's name attribute. This name uniquely describes this nickname within the domain. Emails addressed to this name will be delivered to the user who owns this nickname.

Parameters:

string

$value

The desired value for this attribute.

Returns:

Zend_Gdata_Gapps_Extension_Nickname Provides a fluent interface.

Definition at line 127 of file Nickname.php.

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

$attribute

The DOMNode attribute needed to be handled

Reimplemented from Zend_Gdata_App_Base.

Definition at line 96 of file Nickname.php.

---

Field Documentation

$_name = null [protected]

Definition at line 57 of file Nickname.php.

$_rootElement = 'nickname' [protected]

Reimplemented from Zend_Gdata_App_Base.

Definition at line 49 of file Nickname.php.

$_rootNamespace = 'apps' [protected]

Reimplemented from Zend_Gdata_Extension.

Definition at line 48 of file Nickname.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/Gapps/Extension/Nickname.php