API Documentation

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

\Zend_Gdata_Extension_RecurrenceException

Package: Zend\Gdata\Gdata

Data model class to represent an entry's recurrenceException

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  $_entryLink= 'null'
Default valuenullDetails
Type
Propertyprotected  $_originalEvent= 'null'
Default valuenullDetails
Type
Propertyprotected  $_rootElement= ''recurrenceException''
Default value'recurrenceException'Details
Type
Propertyprotected  $_specialized= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct( bool $specialized = null, \Zend_Gdata_EntryLink $entryLink = null, \Zend_Gdata_OriginalEvent $originalEvent = null ) : void

Constructs a new Zend_Gdata_Extension_RecurrenceException object.

Parameters
Name Type Description
$specialized bool

(optional) Whether this is a specialized exception or not.

$entryLink \Zend_Gdata_EntryLink

(optional) An Event entry with details about the exception.

$originalEvent \Zend_Gdata_OriginalEvent

(optional) The origianl recurrent event this is an exeption to.

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.
methodpublicgetEntryLink( ) : \Zend_Gdata_Extension_EntryLink

Get the value for this element's EntryLink attribute.

Returns
Type Description
\Zend_Gdata_Extension_EntryLink The requested attribute.
methodpublicgetOriginalEvent( ) : \Zend_Gdata_Extension_OriginalEvent

Get the value for this element's Specialized attribute.

Returns
Type Description
\Zend_Gdata_Extension_OriginalEvent The requested attribute.
methodpublicgetSpecialized( ) : bool

Get the value for this element's Specialized attribute.

Returns
Type Description
bool The requested attribute.
methodpublicsetEntryLink( \Zend_Gdata_Extension_EntryLink $value ) : \Zend_Gdata_Extension_RecurrenceException

Set the value for this element's EntryLink attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Extension_EntryLink

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Extension_RecurrenceException The element being modified.
methodpublicsetOriginalEvent( \Zend_Gdata_Extension_OriginalEvent $value ) : \Zend_Gdata_Extension_RecurrenceException

Set the value for this element's Specialized attribute.

Parameters
Name Type Description
$value \Zend_Gdata_Extension_OriginalEvent

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Extension_RecurrenceException The element being modified.
methodpublicsetSpecialized( bool $value ) : \Zend_Gdata_Extension_RecurrenceException

Set the value for this element's Specialized attribute.

Parameters
Name Type Description
$value bool

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Extension_RecurrenceException 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

methodprotectedtakeChildFromDOM( \DOMNode $child ) : void

Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

Parameters
Name Type Description
$child \DOMNode

The DOMNode to process

Documentation was generated by DocBlox 0.15.1.