Gdata/Gapps/Extension/Name.php

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: Name.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Gapps_Extension_Name

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

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; $_familyName; $_givenName
Methods: __construct; getDOM; takeAttributeFromDOM; getFamilyName; setFamilyName; getGivenName; setGivenName; __toString

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.

Properties

$_familyName
jump to class

string $_familyName = 'null'

The associated user's family name.

Details

$_familyName: string
visibility: protected
default: null
final: false
static: false

$_givenName
jump to class

string $_givenName = 'null'

The associated user's given name.

Details

$_givenName: string
visibility: protected
default: null
final: false
static: false

$_rootElement
jump to class

$_rootElement = 'name'

Details

visibility: protected
default: name
final: false
static: false

$_rootNamespace
jump to class

$_rootNamespace = 'apps'

Details

visibility: protected
default: apps
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $familyName
              =
              null, string $givenName
              =
              null
          )
        
        :

Constructs a new Zend_Gdata_Gapps_Extension_Name object.

Arguments

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

Details

visibility: public
final: false
static: false

__toString
jump to class

__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
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 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

getFamilyName
jump to class

getFamilyName(
          
          )
        
        :
        string

Get the value for this element's familyName attribute.

Output

string: The requested attribute.

Details

visibility: public
final: false
static: false
see: setFamilyName

getGivenName
jump to class

getGivenName(
          
          )
        
        :
        string

Get the value for this element's givenName attribute.

Output

string: The requested attribute.

Details

visibility: public
final: false
static: false
see: setGivenName

setFamilyName
jump to class

setFamilyName(
          string $value
          )
        
        :
        Zend_Gdata_Gapps_Extension_Name

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

Arguments

$value: string
The desired value for this attribute.

Output

Zend_Gdata_Gapps_Extension_Name: Provides a fluent interface..

Details

visibility: public
final: false
static: false

setGivenName
jump to class

setGivenName(
          string $value
          )
        
        :
        Zend_Gdata_Gapps_Extension_Name

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

Arguments

$value: string
The desired value for this attribute.

Output

Zend_Gdata_Gapps_Extension_Name: Provides a fluent interface.

Details

visibility: public
final: false
static: false

takeAttributeFromDOM
jump to class

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

API Documentation

Gdata/Gapps/Extension/Name.php

Description

Zend_Gdata_Gapps_Extension_Namejump to top

Description

Properties

$_familyNamejump to class

Details

$_givenNamejump to class

Details

$_rootElementjump to class

Details

$_rootNamespacejump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Details

getDOMjump to class

Arguments

Output

Details

getFamilyNamejump to class

Output

Details

getGivenNamejump to class

Output

Details

setFamilyNamejump to class

Arguments

Output

Details

setGivenNamejump to class

Arguments

Output

Details

takeAttributeFromDOMjump to class

Arguments

Details

Zend_Gdata_Gapps_Extension_Name
jump to top

$_familyName
jump to class

$_givenName
jump to class

$_rootElement
jump to class

$_rootNamespace
jump to class

__construct
jump to class

__toString
jump to class

getDOM
jump to class

getFamilyName
jump to class

getGivenName
jump to class

setFamilyName
jump to class

setGivenName
jump to class

takeAttributeFromDOM
jump to class