API Documentation

Zend/Gdata/Gapps/Extension/Property.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: EmailList.php 20096 2010-01-06 02:05:09Z bkarwin $  

\Zend_Gdata_Gapps_Extension_Property

Package: Zend\Gdata\Gapps

Represents the apps:Property element used by the Apps data API.

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  $_name= 'null'

The name of the property

Default valuenullDetails
Type
string
Propertyprotected  $_rootElement= ''property''
Default value'property'Details
Type
Propertyprotected  $_rootNamespace= ''apps''
Default value'apps'Details
Type
Propertyprotectedstring  $_value= 'null'

The value of the property

Default valuenullDetails
Type
string

Methods

methodpublic__construct( string $name = null, string $value = null ) : void

Constructs a new Zend_Gdata_Gapps_Extension_Property object.

Parameters
Name Type Description
$name string

The name of the property

$value string

The value of the property

methodpublic__toString( ) : string

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

Returns
Type Description
string
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.
methodpublicgetName( ) : string

Get the value for this element's name attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setName  
methodpublicgetValue( ) : string

Get the value for this element's value attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setName  
methodpublicsetName( string $value ) : \Zend_Gdata_Gapps_Extension_Property

Set the value for this element's name attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Property The element being modified.
methodpublicsetValue( string $value ) : \Zend_Gdata_Gapps_Extension_Property

Set the value for this element's value attribute.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Property The element being modified.
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.