alepane21/php-google-spreadsheet-client

Google Spreadsheet PHP Client (forked to work on PHP 5.2.1+)

Monday, October 27, 2014
by alepane21
Repository
1 Watchers
0 Stars
1,771 Installations

PHP
0 Dependents
0 Suggesters
151 Forks
0 Open issues
23 Versions
2 % Grown

The README.md

Introduction

This library provides a simple interface to the Google Spreadsheet API. It's a fork of https://github.com/asimlqt/php-google-spreadsheet-client changed to be compatible with PHP 5.2.1+., _(*1)

There are a couple of important things to note., _(*2)

This library requires a valid OAuth access token to work but does not provide any means of generating one. The Google APIs Client Library for PHP has all the functionality required for for generating and refreshing tokens so it would have been a waste of time duplicating the official google library.
You can not create spreadsheets using this (PHP Google Spreadsheet Client) library, as creating spreadsheets is not part of the Spreadsheet API and the functionality already exists in the official Google Client Library.

I strongly recommend you read through the official Google Spreadsheet API documentation to get a grasp of the concepts., _(*3)

Usage

Installation

Using composer is the recommended way to install it., _(*4)

1 - Add "alepane21/php-google-spreadsheet-client" as a dependency in your project's composer.json file., _(*5)

{
    "require": {
        "alepane21/php-google-spreadsheet-client": "2.2.*"
    }
}

2 - Download and install Composer., _(*6)

curl -sS https://getcomposer.org/installer | php

3 - Install your dependencies., _(*7)

php composer.phar install

4 - Require Composer's autoloader., _(*8)

require 'vendor/autoload.php';

Bootstrapping

The first thing you will need to do is initialize the service request factory:, _(*9)

$serviceRequest = new Google_Spreadsheet_DefaultServiceRequest($accessToken);
Google_Spreadsheet_ServiceRequestFactory::setInstance($serviceRequest);

Retrieving a list of spreadsheets

$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();

SpreadsheetFeed implements ArrayIterator so you can iterate over it using a foreach loop or you can retrieve a single spreadsheet by name., _(*10)

$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');

Retrieving a list of worksheets

You can retrieve a list of worksheets from a spreadsheet by calling the getWorksheets() method., _(*11)

$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();
$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');
$worksheetFeed = $spreadsheet->getWorksheets();

You can loop over each worksheet or get a single worksheet by title., _(*12)

$worksheet = $worksheetFeed->getByTitle('Sheet 1');

Adding a worksheet

$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();
$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');
$spreadsheet->addWorksheet('New Worksheet', 50, 20);

The only required parameter is the worksheet name, The row and column count are optional. The default value for rows is 100 and columns is 10., _(*13)

Deleting a worksheet

$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();
$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');
$worksheetFeed = $spreadsheet->getWorksheets();
$worksheet = $worksheetFeed->getByTitle('New Worksheet');
$worksheet->delete();

Working with list-based feeds

Retrieving a list-based feed

$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();
$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');
$worksheetFeed = $spreadsheet->getWorksheets();
$worksheet = $worksheetFeed->getByTitle('Sheet 1');
$listFeed = $worksheet->getListFeed();

Once you have a list feed you can loop over each entry., _(*14)

foreach ($listFeed->getEntries() as $entry) {
    $values = $entry->getValues();
}

The getValues() method returns an associative array where the keys are the column names and the values are the cell content., _(*15)

Adding a list row

$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();
$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');
$worksheetFeed = $spreadsheet->getWorksheets();
$worksheet = $worksheetFeed->getByTitle('Sheet 1');
$listFeed = $worksheet->getListFeed();

$row = array('name'=>'John', 'age'=>25);
$listFeed->insert($row);

Updating a list row

$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();
$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');
$worksheetFeed = $spreadsheet->getWorksheets();
$worksheet = $worksheetFeed->getByTitle('Sheet 1');
$listFeed = $worksheet->getListFeed();
$entries = $listFeed->getEntries();
$listEntry = $entries[0];

$values = $listEntry->getValues();
$values['name'] = 'Joe';
$listEntry->update($values);

Adding headers to a new worksheet

The Google Spreadsheet API does not allow you to update a list row if headers are not already assigned. So, when you create a new worksheet, before you can add data to a worksheet using the 'Adding/Updating a list row' methods above, you need to add headers., _(*16)

To add headers to a worksheet, use the following:, _(*17)


$spreadsheetService = new Google_Spreadsheet_SpreadsheetService();
$spreadsheetFeed = $spreadsheetService->getSpreadsheets();
$spreadsheet = $spreadsheetFeed->getByTitle('MySpreadsheet');
$worksheetFeed = $spreadsheet->getWorksheets();
$worksheet = $worksheetFeed->getByTitle('Sheet 1');
$cellFeed = $worksheet->getCellFeed();

$cellFeed->editCell(1,1, "Row1Col1Header");
$cellFeed->editCell(1,2, "Row1Col2Header");
$cellFeed->editCell(1,3, "Row1Col3Header");
$cellFeed->editCell(1,4, "Row1Col4Header");

The Versions

27/10 2014

dev-master

9999999-dev https://github.com/alepane21/php-google-spreadsheet-client

Google Spreadsheet PHP Client (forked to work on PHP 5.2.1+)

library php-google-spreadsheet-client

Google Spreadsheet PHP Client (forked to work on PHP 5.2.1+)

alepane21/php-google-spreadsheet-client

The README.md

Introduction

Usage

Installation

Bootstrapping

Retrieving a list of spreadsheets

Retrieving a list of worksheets

Adding a worksheet

Deleting a worksheet

Working with list-based feeds

Retrieving a list-based feed

Adding a list row

Updating a list row

Adding headers to a new worksheet

The Versions

dev-master

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.8

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.7

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.6

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.5

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.4

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.3

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.1

The Requires

by Asim Liaquat

by Martin Czygan

by Alessandro Pagnin

2.2.0

The Requires

by Asim Liaquat

by Martin Czygan

dev-development

The Requires

by Asim Liaquat

by Martin Czygan

2.1.8

The Requires

by Asim Liaquat

by Martin Czygan

2.1.7

The Requires

by Asim Liaquat

by Martin Czygan

dev-dev-stream-request

The Requires

by Asim Liaquat

by Martin Czygan

2.1.6

The Requires