API Documentation

Gdata/Gapps/NicknameEntry.php

Includes Classes 
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
Gapps
version
$Id: NicknameEntry.php 23775 2011-03-01 17:25:24Z ralph $
Classes
Zend_Gdata_Gapps_NicknameEntry

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_NicknameEntry
jump to top

Extends from
Zend_Gdata_Entry
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
Gapps
Properties
$_entryClassName
$_login
$_nickname
Methods
__construct
getDOM
takeChildFromDOM
getLogin
setLogin
getNickname
setNickname

Description

Data model class for a Google Apps Nickname Entry.

Each nickname entry describes a single nickname within a Google Apps hosted domain. Each user may own several nicknames, but each nickname may only belong to one user. Multiple entries are contained within instances of Zend_Gdata_Gapps_NicknameFeed.

To transfer nickname entries to and from the Google Apps servers, including creating new entries, refer to the Google Apps service class, Zend_Gdata_Gapps.

This class represents in the Google Data protocol.

Properties

$_entryClassName
jump to class

 $_entryClassName = 'Zend_Gdata_Gapps_NicknameEntry'

Details

visibility
protected
default
Zend_Gdata_Gapps_NicknameEntry
final
false
static
false

$_login
jump to class

Zend_Gdata_Gapps_Extension_Login $_login = 'null'

<apps:login> element used to hold information about the owner of this nickname, including their username.

Details

$_login
Zend_Gdata_Gapps_Extension_Login
visibility
protected
default
null
final
false
static
false

$_nickname
jump to class

Zend_Gdata_Gapps_Extension_Nickname $_nickname = 'null'

<apps:nickname> element used to hold the name of this nickname.

Details

$_nickname
Zend_Gdata_Gapps_Extension_Nickname
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( DOMElement $element = null ) :

Create a new instance.

Arguments
$element
DOMElement
(optional) DOMElement from which this object should be constructed.
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 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

getLogin
jump to class

getLogin( ) : Zend_Gdata_Gapps_Extension_Login

Get the value of the login property for this object.

Output
Zend_Gdata_Gapps_Extension_Login
The requested object.
Details
visibility
public
final
false
static
false
see
setLogin

getNickname
jump to class

getNickname( ) : Zend_Gdata_Gapps_Extension_Nickname

Get the value of the nickname property for this object.

Output
Zend_Gdata_Gapps_Extension_Nickname
The requested object.
Details
visibility
public
final
false
static
false
see
setNickname

setLogin
jump to class

setLogin( Zend_Gdata_Gapps_Extension_Login $value ) : Zend_Gdata_Gapps_NicknameEntry

Set the value of the login property for this object. This property is used to store the username address of the current user.

Arguments
$value
Zend_Gdata_Gapps_Extension_Login
The desired value for this instance&#039;s login property.
Output
Zend_Gdata_Gapps_NicknameEntry
Provides a fluent interface.
Details
visibility
public
final
false
static
false

setNickname
jump to class

setNickname( Zend_Gdata_Gapps_Extension_Nickname $value ) : Zend_Gdata_Gapps_NicknameEntry

Set the value of the nickname property for this object. This property is used to store the the name of the current nickname.

Arguments
$value
Zend_Gdata_Gapps_Extension_Nickname
The desired value for this instance&#039;s nickname property.
Output
Zend_Gdata_Gapps_NicknameEntry
Provides a fluent interface.
Details
visibility
public
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
Documentation was generated by DocBlox.