Gdata/Calendar/Extension/Hidden.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Calendar  
Version
$Id$  

\Zend_Gdata_Calendar_Extension_Hidden

Package: Zend_Gdata\Calendar
Represents the gCal:hidden element used by the Calendar data API
Parent(s)
\Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_rootElement = 'hidden'
Default value'hidden'Details
Type
n/a
>VPropertyprotected$_rootNamespace = 'gCal'
Default value'gCal'Details
Type
n/a
>VPropertyprotected$_value = null
Default valuenullDetails
Type
n/a

Methods

methodpublic__construct(bool $value = null) : void

Constructs a new Zend_Gdata_Calendar_Extension_Hidden object.

Parameters
NameTypeDescription
$valuebool

(optional) The value 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
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetValue() : string

Get the value for this element's value attribute.

Returns
TypeDescription
stringThe requested attribute.
methodpublicsetValue(bool $value) : \Zend_Gdata_Calendar_Extension_Hidden

Set the value for this element's value attribute.

Parameters
NameTypeDescription
$valuebool

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Calendar_Extension_HiddenThe 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
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

Documentation was generated by phpDocumentor 2.2.0 .