API Documentation

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

\Zend_Gdata_Spreadsheets_ListEntry

Package: Zend\Gdata\Spreadsheets

Concrete class for working with List entries.

Parent(s)
\Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_custom= 'array()'

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

Default valuearray()Details
Type
array
Propertyprotectedarray  $_customByName= 'array()'

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

Default valuearray()Details
Type
array
Propertyprotected  $_entryClassName= ''Zend_Gdata_Spreadsheets_ListEntry''
Default value'Zend_Gdata_Spreadsheets_ListEntry'Details
Type

Methods

methodpublic__construct( \DOMElement $element = null ) : void

Constructs a new Zend_Gdata_Spreadsheets_ListEntry object.

Parameters
Name Type Description
$element \DOMElement

An existing XML element on which to base this new object.

methodpublicaddCustom( \Zend_Gdata_Spreadsheets_Extension_Custom $custom ) : \Zend_Gdata_Spreadsheets_ListEntry

Add an individual custom row element to this list entry.

Parameters
Name Type Description
$custom \Zend_Gdata_Spreadsheets_Extension_Custom

The custom element to be added.

Returns
Type Description
\Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.
methodpublicgetCustom( ) : array

Gets the row elements contained by this list entry.

Returns
Type Description
array The custom row elements in this list entry
methodpublicgetCustomByName( string $name = null ) : mixed

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

Parameters
Name Type Description
$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.

Returns
Type Description
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.
methodpublicgetDOM(  $doc = null,  $majorVersion = 1,  $minorVersion = null ) : void

Parameters
Name Type Description
$doc
$majorVersion
$minorVersion
methodpublicremoveCustom( 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.

Parameters
Name Type Description
$index int

The index of the custom element to be deleted.

Returns
Type Description
\Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicremoveCustomByName( string $name ) : \Zend_Gdata_Spreadsheets_ListEntry

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

Parameters
Name Type Description
$name string

The name of the custom element to be deleted.

Returns
Type Description
\Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetCustom( 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.

Parameters
Name Type Description
$custom array

The custom row elements to be contained in this list entry.

Returns
Type Description
\Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.
methodprotectedtakeChildFromDOM(  $child ) : void

Parameters
Name Type Description
$child
Documentation was generated by DocBlox 0.15.1.