Gdata/Gapps/NicknameEntry.php
Show:
inherited
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Gapps
- Version
- $Id$
\Zend_Gdata_Gapps_NicknameEntry
Package: Zend_Gdata\Gapps
element used to hold information about the owner
of this nickname, including their username. element used to hold the name of this nickname.
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.
- Parent(s)
- \Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
$_entryClassName = 'Zend_Gdata_Gapps_NicknameEntry'Default value
'Zend_Gdata_Gapps_NicknameEntry'Details- Type
- n/a
\Zend_Gdata_Gapps_Extension_Login $_login = nullDefault value
nullDetails\Zend_Gdata_Gapps_Extension_Nickname $_nickname = nullDefault value
nullDetailsMethods
__construct(\DOMElement $element = null) : voidCreate a new instance.
Parameters
| Name | Type | Description |
|---|---|---|
| $element | \DOMElement | (optional) DOMElement from which this |
getDOM(\DOMDocument $doc = null, $majorVersion = 1, $minorVersion = null) : \DOMElementRetrieves 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.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $doc | \DOMDocument | The DOMDocument used to construct DOMElements |
| $majorVersion | ||
| $minorVersion |
| Type | Description |
|---|---|
| \DOMElement | The DOMElement representing this element and all child properties. |
getLogin() : \Zend_Gdata_Gapps_Extension_LoginGet the value of the login property for this object.
Returns
Details
| Type | Description |
|---|---|
| \Zend_Gdata_Gapps_Extension_Login | The requested object. |
getNickname() : \Zend_Gdata_Gapps_Extension_NicknameGet the value of the nickname property for this object.
Returns
Details
| Type | Description |
|---|---|
| \Zend_Gdata_Gapps_Extension_Nickname | The requested object. |
setLogin(\Zend_Gdata_Gapps_Extension_Login $value) : \Zend_Gdata_Gapps_NicknameEntrySet the value of the login property for this object. This property is used to store the username address of the current user.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | \Zend_Gdata_Gapps_Extension_Login | The desired value for |
| Type | Description |
|---|---|
| \Zend_Gdata_Gapps_NicknameEntry | Provides a fluent interface. |
setNickname(\Zend_Gdata_Gapps_Extension_Nickname $value) : \Zend_Gdata_Gapps_NicknameEntrySet the value of the nickname property for this object. This property is used to store the the name of the current nickname.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | \Zend_Gdata_Gapps_Extension_Nickname | The desired value for |
| Type | Description |
|---|---|
| \Zend_Gdata_Gapps_NicknameEntry | Provides a fluent interface. |