API Documentation

Zend/Gdata/Gapps/Extension/Name.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gapps  
Version
$Id: Name.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Gapps_Extension_Name

Package: Zend\Gdata\Gapps

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.

Parent(s)
\Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_familyName= 'null'

The associated user's family name.

Default valuenullDetails
Type
string
Propertyprotectedstring  $_givenName= 'null'

The associated user's given name.

Default valuenullDetails
Type
string
Propertyprotected  $_rootElement= ''name''
Default value'name'Details
Type
Propertyprotected  $_rootNamespace= ''apps''
Default value'apps'Details
Type

Methods

methodpublic__construct( string $familyName = null, string $givenName = null ) : void

Constructs a new Zend_Gdata_Gapps_Extension_Name object.

Parameters
Name Type Description
$familyName string

(optional) The familyName to be set for this object.

$givenName string

(optional) The givenName to be set for this object.

methodpublic__toString( ) : void

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

methodpublicgetDOM( \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.

Parameters
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The DOMElement representing this element and all child properties.
methodpublicgetFamilyName( ) : string

Get the value for this element's familyName attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setFamilyName  
methodpublicgetGivenName( ) : string

Get the value for this element's givenName attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setGivenName  
methodpublicsetFamilyName( string $value ) : \Zend_Gdata_Gapps_Extension_Name

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Name Provides a fluent interface..
methodpublicsetGivenName( string $value ) : \Zend_Gdata_Gapps_Extension_Name

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

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Name Provides a fluent interface.
methodprotectedtakeAttributeFromDOM( \DOMNode $attribute ) : void

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
Name Type Description
$attribute \DOMNode

The DOMNode attribute needed to be handled

Documentation was generated by DocBlox 0.15.1.