PHP Class Google\Spreadsheet\Spreadsheet

Author: Asim Liaquat ([email protected])
Mostrar archivo Open project: asimlqt/php-google-spreadsheet-client Class Usage Examples

Protected Properties

Property Type Description
$xml SimpleXMLElement The spreadsheet xml object

Public Methods

Method Description
__construct ( SimpleXMLElement $xml ) Initializes the spreadsheet object
addWorksheet ( string $title, integer $rowCount = 100, integer $colCount = 10 ) : Worksheet Add a new worksheet to this spreadsheet
getId ( ) : string Get the spreadsheet id
getTitle ( ) : string Returns the title (name) of the spreadsheet
getUpdated ( ) : DateTime Get the updated date
getWorksheetByTitle ( $title ) : Worksheet Get a single worksheet by it's title. If there is more than one worksheet with the same title then the first one matched will be returned.
getWorksheetFeed ( ) : WorksheetFeed Get all the worksheets which belong to this spreadsheet
getWorksheetsFeedUrl ( ) : string Returns the feed url of the spreadsheet
getXml ( ) : integer Get the raw XML

Method Details

__construct() public method

Initializes the spreadsheet object
public __construct ( SimpleXMLElement $xml )
$xml SimpleXMLElement

addWorksheet() public method

Add a new worksheet to this spreadsheet
public addWorksheet ( string $title, integer $rowCount = 100, integer $colCount = 10 ) : Worksheet
$title string
$rowCount integer default is 100
$colCount integer default is 10
return Worksheet

getId() public method

Get the spreadsheet id
public getId ( ) : string
return string

getTitle() public method

Returns the title (name) of the spreadsheet
public getTitle ( ) : string
return string

getUpdated() public method

Get the updated date
public getUpdated ( ) : DateTime
return DateTime

getWorksheetByTitle() public method

Get a single worksheet by it's title. If there is more than one worksheet with the same title then the first one matched will be returned.
public getWorksheetByTitle ( $title ) : Worksheet
return Worksheet

getWorksheetFeed() public method

Get all the worksheets which belong to this spreadsheet
public getWorksheetFeed ( ) : WorksheetFeed
return WorksheetFeed

getWorksheetsFeedUrl() public method

Returns the feed url of the spreadsheet
public getWorksheetsFeedUrl ( ) : string
return string

getXml() public method

Get the raw XML
public getXml ( ) : integer
return integer

Property Details

$xml protected_oe property

The spreadsheet xml object
protected SimpleXMLElement $xml
return SimpleXMLElement