API Documentation

Gdata/Gapps/Extension/Nickname.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
version
$Id: Nickname.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Gapps_Extension_Nickname

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_Gapps_Extension_Nickname

Extends from
Zend_Gdata_Extension
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
Properties
$_rootNamespace
$_rootElement
$_name
Methods
__construct
getDOM
takeAttributeFromDOM
getName
setName
__toString

Description

Represents the apps:nickname element used by the Apps data API. This is used to describe a nickname's properties, and is usually contained within instances of Zend_Gdata_Gapps_NicknameEntry.

Properties

$_name

string $_name = 'null'

The name of the nickname. This name is used as the email address for this nickname.

Details

$_name
string
visibility
protected
default
null
final
false
static
false

$_rootElement

 $_rootElement = 'nickname'

Details

visibility
protected
default
nickname
final
false
static
false

$_rootNamespace

 $_rootNamespace = 'apps'

Details

visibility
protected
default
apps
final
false
static
false

Methods

__construct

__construct( string $name = null ) :

Constructs a new Zend_Gdata_Gapps_Extension_Nickname object.

Arguments
$name
string
(optional) The nickname being represented.
Details
visibility
public
final
false
static
false

__toString

__toString( ) :

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

Details
visibility
public
final
false
static
false

getDOM

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

getName

getName( ) : string

Get the value for this element's name attribute.

Output
string
The requested attribute.
Details
visibility
public
final
false
static
false
see
setName

setName

setName( string $value ) : Zend_Gdata_Gapps_Extension_Nickname

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.

Arguments
$value
string
The desired value for this attribute.
Output
Zend_Gdata_Gapps_Extension_Nickname
Provides a fluent interface.
Details
visibility
public
final
false
static
false

takeAttributeFromDOM

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
Documentation was generated by DocBlox.