Gdata/Spreadsheets/WorksheetEntry.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
Spreadsheets  
Version
$Id$  

\Zend_Gdata_Spreadsheets_WorksheetEntry
jump to top

Package: Zend_Gdata\Spreadsheets
Concrete class for working with Worksheet 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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_colCount = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_entryClassName = 'Zend_Gdata_Spreadsheets_WorksheetEntry'
Default value'Zend_Gdata_Spreadsheets_WorksheetEntry'Details
Type
n/a
>VPropertyprotected$_rowCount = null
Default valuenullDetails
Type
n/a

Methods

methodpublic__construct(\DOMElement $element = null) : void

Constructs a new Zend_Gdata_Spreadsheets_WorksheetEntry object.

Parameters
NameTypeDescription
$element\DOMElement

(optional) The DOMElement on which to base this object.

methodpublicgetColumnCount() : string

Gets the column count for this entry.

Returns
TypeDescription
stringThe column count for the entry.
methodpublicgetContentsAsCells(string $range = null, boolean $empty = false) : array

Returns the content of all cells as an associative array, indexed off the cell location (ie 'A1', 'D4', etc). Each element of the array is an associative array with a 'value' and a 'function'.

Only non-empty cells are returned by default. 'range' is the value of the 'range' query parameter specified at: http://code.google.com/apis/spreadsheets/reference.html#cells_Parameters
Parameters
NameTypeDescription
$rangestring

The range of cells to retrieve

$emptyboolean

Whether to retrieve empty cells

Returns
TypeDescription
arrayAn associative array of cells
methodpublicgetContentsAsRows() : array

Returns the content of all rows as an associative array

Returns
TypeDescription
arrayAn array of rows. Each element of the array is an associative array of data
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.
methodpublicgetRowCount() : string

Gets the row count for this entry.

Returns
TypeDescription
stringThe row count for the entry.
methodpublicsetColumnCount(string $colCount) : void

Sets the column count for this entry.

Parameters
NameTypeDescription
$colCountstring

The new column count for the entry.

methodpublicsetRowCount(string $rowCount) : void

Sets the row count for this entry.

Parameters
NameTypeDescription
$rowCountstring

The new row count for the entry.

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

Documentation was generated by phpDocumentor 2.2.0 .