API Documentation

Zend/Gdata/Calendar/Extension/Color.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
Calendar  
Version
$Id: Color.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Calendar_Extension_Color

Package: Zend\Gdata\Calendar

Represents the gCal:color element used by the Calendar data API to define the color of a calendar in the UI.

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

Propertyprotected  $_rootElement= ''color''
Default value'color'Details
Type
Propertyprotected  $_rootNamespace= ''gCal''
Default value'gCal'Details
Type
Propertyprotected  $_value= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct( string $value = null ) : void

Constructs a new Zend_Gdata_Calendar_Extension_Color object.

Parameters
Name Type Description
$value string

(optional) The text content of the element.

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.
methodpublicgetValue( ) : string

Get the value for this element's value attribute.

Returns
Type Description
string The value associated with this attribute.
methodpublicsetValue( string $value ) : \Zend_Gdata_Calendar_Extension_Color

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_Calendar_Extension_Color 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.