API Documentation

Gdata/Extension/RecurrenceException.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gdata
version
$Id: RecurrenceException.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Extension_RecurrenceException

Description

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.

Zend_Gdata_Extension_RecurrenceException

Extends from
Zend_Gdata_Extension
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gdata
Properties
$_rootElement
$_specialized
$_entryLink
$_originalEvent
Methods
__construct
getDOM
takeAttributeFromDOM
takeChildFromDOM
getSpecialized
setSpecialized
getEntryLink
setEntryLink
getOriginalEvent
setOriginalEvent

Description

Data model class to represent an entry's recurrenceException

Properties

$_entryLink

 $_entryLink = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_originalEvent

 $_originalEvent = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_rootElement

 $_rootElement = 'recurrenceException'

Details

visibility
protected
default
recurrenceException
final
false
static
false

$_specialized

 $_specialized = 'null'

Details

visibility
protected
default
null
final
false
static
false

Methods

__construct

__construct( bool $specialized = null, Zend_Gdata_EntryLink $entryLink = null, Zend_Gdata_OriginalEvent $originalEvent = null ) :

Constructs a new Zend_Gdata_Extension_RecurrenceException object.

Arguments
$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.
Details
visibility
public
final
false
static
false

getDOM

getDOM( 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.

Arguments
$doc
DOMDocument
The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion
Output
DOMElement
The DOMElement representing this element and all child properties.
Details
visibility
public
final
false
static
false

getEntryLink

getEntryLink( ) : Zend_Gdata_Extension_EntryLink

Get the value for this element's EntryLink attribute.

Output
Zend_Gdata_Extension_EntryLink
The requested attribute.
Details
visibility
public
final
false
static
false

getOriginalEvent

getOriginalEvent( ) : Zend_Gdata_Extension_OriginalEvent

Get the value for this element's Specialized attribute.

Output
Zend_Gdata_Extension_OriginalEvent
The requested attribute.
Details
visibility
public
final
false
static
false

getSpecialized

getSpecialized( ) : bool

Get the value for this element's Specialized attribute.

Output
bool
The requested attribute.
Details
visibility
public
final
false
static
false

setEntryLink

setEntryLink( Zend_Gdata_Extension_EntryLink $value ) : Zend_Gdata_Extension_RecurrenceException

Set the value for this element's EntryLink attribute.

Arguments
$value
Zend_Gdata_Extension_EntryLink
The desired value for this attribute.
Output
Zend_Gdata_Extension_RecurrenceException
The element being modified.
Details
visibility
public
final
false
static
false

setOriginalEvent

setOriginalEvent( Zend_Gdata_Extension_OriginalEvent $value ) : Zend_Gdata_Extension_RecurrenceException

Set the value for this element's Specialized attribute.

Arguments
$value
Zend_Gdata_Extension_OriginalEvent
The desired value for this attribute.
Output
Zend_Gdata_Extension_RecurrenceException
The element being modified.
Details
visibility
public
final
false
static
false

setSpecialized

setSpecialized( bool $value ) : Zend_Gdata_Extension_RecurrenceException

Set the value for this element's Specialized attribute.

Arguments
$value
bool
The desired value for this attribute.
Output
Zend_Gdata_Extension_RecurrenceException
The element being modified.
Details
visibility
public
final
false
static
false

takeAttributeFromDOM

takeAttributeFromDOM( DOMNode $attribute ) :

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.

Arguments
$attribute
DOMNode
The DOMNode attribute needed to be handled
Details
visibility
protected
final
false
static
false

takeChildFromDOM

takeChildFromDOM( DOMNode $child ) :

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

Arguments
$child
DOMNode
The DOMNode to process
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.