Gdata/Spreadsheets/WorksheetEntry.php

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: WorksheetEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Spreadsheets_WorksheetEntry

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_WorksheetEntry
jump to top

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; $_rowCount; $_colCount
Methods: __construct; getDOM; takeChildFromDOM; getRowCount; getColumnCount; setRowCount; setColumnCount; getContentsAsRows; getContentsAsCells

Description

Concrete class for working with Worksheet entries.

Properties

$_colCount
jump to class

$_colCount = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_entryClassName
jump to class

$_entryClassName = 'Zend_Gdata_Spreadsheets_WorksheetEntry'

Details

visibility: protected
default: Zend_Gdata_Spreadsheets_WorksheetEntry
final: false
static: false

$_rowCount
jump to class

$_rowCount = 'null'

Details

visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          DOMElement $element
              =
              null
          )
        
        :

Constructs a new Zend_Gdata_Spreadsheets_WorksheetEntry object.

Arguments

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

Details

visibility: public
final: false
static: false

getColumnCount
jump to class

getColumnCount(
          
          )
        
        :
        string

Gets the column count for this entry.

Output

string: The column count for the entry.

Details

visibility: public
final: false
static: false

getContentsAsCells
jump to class

getContentsAsCells(
          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

Arguments

$range: string
The range of cells to retrieve
$empty: boolean
Whether to retrieve empty cells

Output

array: An associative array of cells

Details

visibility: public
final: false
static: false

getContentsAsRows
jump to class

getContentsAsRows(
          
          )
        
        :
        array

Returns the content of all rows as an associative array

Output

array: An array of rows. Each element of the array is an associative array of data

Details

visibility: public
final: false
static: false

getDOM
jump to class

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

getRowCount
jump to class

getRowCount(
          
          )
        
        :
        string

Gets the row count for this entry.

Output

string: The row count for the entry.

Details

visibility: public
final: false
static: false

setColumnCount
jump to class

setColumnCount(
          string $colCount
          )
        
        :

Sets the column count for this entry.

Arguments

$colCount: string
The new column count for the entry.

Details

visibility: public
final: false
static: false

setRowCount
jump to class

setRowCount(
          string $rowCount
          )
        
        :

Sets the row count for this entry.

Arguments

$rowCount: string
The new row count for the entry.

Details

visibility: public
final: false
static: false

takeChildFromDOM
jump to class

takeChildFromDOM(
          DOMNode $child
          )
        
        :

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

Arguments

$child: DOMNode
The DOMNode to process

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/Spreadsheets/WorksheetEntry.php

Description

Zend_Gdata_Spreadsheets_WorksheetEntryjump to top

Description

Properties

$_colCountjump to class

Details

$_entryClassNamejump to class

Details

$_rowCountjump to class

Details

Methods

__constructjump to class

Arguments

Details

getColumnCountjump to class

Output

Details

getContentsAsCellsjump to class

Arguments

Output

Details

getContentsAsRowsjump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getRowCountjump to class

Output

Details

setColumnCountjump to class

Arguments

Details

setRowCountjump to class

Arguments

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_Spreadsheets_WorksheetEntry
jump to top

$_colCount
jump to class

$_entryClassName
jump to class

$_rowCount
jump to class

__construct
jump to class

getColumnCount
jump to class

getContentsAsCells
jump to class

getContentsAsRows
jump to class

getDOM
jump to class

getRowCount
jump to class

setColumnCount
jump to class

setRowCount
jump to class

takeChildFromDOM
jump to class