c4pone/pagespeed-parser

php module to parse pagespeed insights api results

dev-master 2015-10-28 00:59 UTC

Requires

• php: >=5.3.0

Requires (Dev)

• phpunit/phpunit: 4.*
• scrutinizer/ocular: 1.1.1

MIT

• Florian Kirchner

• api
• parser
• google
• PageSpeedInsights

README

This simple php module parses the results from PageSpeed Insights API.

Installation

The best way to install the library is by using Composer. Add the following to composer.json in the root of your project:

{
    "require": {
        "c4pone/pagespeed-parser": "dev-master",
    }
}

Then, on the command line:

curl -s http://getcomposer.org/installer | php
php composer.phar install

Use the generated vendor/.composer/autoload.php file to autoload the library classes.

Basic usage

For easy usage we use the pagespeed insights api client from sgrodzicki

<?php

$url = 'http://www.codebuster.de';

$pageSpeed = new \PageSpeed\Insights\Service();
$pageSpeed->getResults($url, 'en_US', 'desktop', array('screenshot' => true));

$parser = new \c4pone\PageSpeed\Parser($pageSpeed->getResults());
$parser->getTitle();
$parser->getPageStats();
$parser->getRecommendations();

$screenshot = $parser->getScreenshot();
$screenshot->save('some/path/screenshot.jpg');

Tests

The client is tested with phpunit; you can run the tests, from the repository's root, by doing:

phpunit

Some tests may fail, due to requiring an internet connection (to test against a real API response). Make sure that you are connected to the internet before running the full test suite.