API Documentation

Gdata/Spreadsheets/ListEntry.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
Spreadsheets
version
$Id: ListEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Spreadsheets_ListEntry

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_Spreadsheets_ListEntry

Extends from
Zend_Gdata_Entry
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
Spreadsheets
Properties
$_entryClassName
$_custom
$_customByName
Methods
__construct
getDOM
takeChildFromDOM
getCustom
getCustomByName
setCustom
addCustom
removeCustom
removeCustomByName

Description

Concrete class for working with List entries.

Properties

$_custom

array $_custom = 'array'

List of custom row elements (Zend_Gdata_Spreadsheets_Extension_Custom), indexed by order added to this entry.

Details

$_custom
array
visibility
protected
default
array
final
false
static
false

$_customByName

array $_customByName = 'array'

List of custom row elements (Zend_Gdata_Spreadsheets_Extension_Custom), indexed by element name.

Details

$_customByName
array
visibility
protected
default
array
final
false
static
false

$_entryClassName

 $_entryClassName = 'Zend_Gdata_Spreadsheets_ListEntry'

Details

visibility
protected
default
Zend_Gdata_Spreadsheets_ListEntry
final
false
static
false

Methods

__construct

__construct( DOMElement $element = null ) :

Constructs a new Zend_Gdata_Spreadsheets_ListEntry object.

Arguments
$element
DOMElement
An existing XML element on which to base this new object.
Details
visibility
public
final
false
static
false

addCustom

addCustom( Zend_Gdata_Spreadsheets_Extension_Custom $custom ) : Zend_Gdata_Spreadsheets_ListEntry

Add an individual custom row element to this list entry.

Arguments
$custom
Zend_Gdata_Spreadsheets_Extension_Custom
The custom element to be added.
Output
Zend_Gdata_Spreadsheets_ListEntry
Provides a fluent interface.
Details
visibility
public
final
false
static
false

getCustom

getCustom( ) : array

Gets the row elements contained by this list entry.

Output
array
The custom row elements in this list entry
Details
visibility
public
final
false
static
false

getCustomByName

getCustomByName( string $name = null ) : mixed

Gets a single row element contained by this list entry using its name.

Arguments
$name
string
The name of a custom element to return. If null or not defined, an array containing all custom elements indexed by name will be returned.
Output
mixed
If a name is specified, the Zend_Gdata_Spreadsheets_Extension_Custom element requested, is returned or null if not found. Otherwise, an array of all Zend_Gdata_Spreadsheets_Extension_Custom elements is returned indexed by name.
Details
visibility
public
final
false
static
false

getDOM

getDOM(  $doc = null,  $majorVersion = 1,  $minorVersion = null ) :
Arguments
$doc
$majorVersion
$minorVersion
Details
visibility
public
final
false
static
false

removeCustom

removeCustom( int $index ) : Zend_Gdata_Spreadsheets_ListEntry

Remove an individual row element from this list entry by index. This will cause the array to be re-indexed.

Arguments
$index
int
The index of the custom element to be deleted.
Output
Zend_Gdata_Spreadsheets_ListEntry
Provides a fluent interface.
Details
visibility
public
final
false
static
false
throws

removeCustomByName

removeCustomByName( string $name ) : Zend_Gdata_Spreadsheets_ListEntry

Remove an individual row element from this list entry by name.

Arguments
$name
string
The name of the custom element to be deleted.
Output
Zend_Gdata_Spreadsheets_ListEntry
Provides a fluent interface.
Details
visibility
public
final
false
static
false
throws

setCustom

setCustom( array $custom ) : Zend_Gdata_Spreadsheets_ListEntry

Sets the row elements contained by this list entry. If any custom row elements were previously stored, they will be overwritten.

Arguments
$custom
array
The custom row elements to be contained in this list entry.
Output
Zend_Gdata_Spreadsheets_ListEntry
Provides a fluent interface.
Details
visibility
public
final
false
static
false

takeChildFromDOM

takeChildFromDOM(  $child ) :
Arguments
$child
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.