Installation

• Prerequisites
• Installing via Composer
• Custom Installation
• Installing from tarball

Prerequisites

PHP PhantomJS requires PHP 5.3.0 or greater to run.

Installing via Composer

Install Composer for your project:

    #bash

    $ curl -s http://getcomposer.org/installer | php

Create a composer.json file in the root of your project:

    #composer.json

    {
        "require": {
            "jonnyw/php-phantomjs": "3.*"
        },
        "config": {
            "bin-dir": "bin"
        },
        "scripts": {
            "post-install-cmd": [
                "PhantomInstaller\\Installer::installPhantomJS"
            ],
            "post-update-cmd": [
                "PhantomInstaller\\Installer::installPhantomJS"
            ]
        }
    }

It is important that you have the ‘scripts’ section shown above in your composer.json file as it will install the latest version of PhantomJS for your system to your project’s bin folder. It is recommended that you create a bin folder in the root of your project as this is where the PHP PhantomJS library will look for your PhantomJS executable. If you would prefer to use a PhantomJS executable in a custom location, see the Custom Installation section.

Finally, install the composer depedencies for your project:

    
    #bash
    
    $ php composer.phar install

Custom Installation

If you would prefer to use a custom install location for the PhantomJS executable, you simply need to tell the client where to find the executable file:

    
    <?php
    
    use JonnyW\PhantomJs\Client;

    $client = Client::getInstance();
    $client->setPhantomJs('/path/to/phantomjs');

Important

The PHP PhantomJS library also requires a phantomloader file that comes bundled with the library and is installed to the bin folder defined in your composer.json file. If you are setting a custom path to the PhantomJS executable, you need to make sure that the phantomloader file can be found in the bin folder it was installed to.

See below if you wish to use a custom bin folder.

If you would like composer to install all executable files to a custom bin location when installing dependencies, set the bin dir location in your project’s composer.json file:

    #composer.json

    {
        "config": {
            "bin-dir": "/path/to/your/projects/bin/dir"
        }
    }

You will need to make sure that this directory exists and is writable by Composer before running the composer install.

Once you have updated your bin location run composer install to install PhantomJS:

    
    #bash
    
    $ php composer.phar install

This should install the correct PhantomJS executable for your system and the required phantomloader file to the bin locaiton you defined in your composer.json file.

Now you need to tell the client where to find your bin folder:

        
    <?php 
    
    use JonnyW\PhantomJs\Client;

    $client = Client::getInstance();
    $client->setBinDir('/path/to/bin/dir');

Installing from tarball

The PHP PhantomJS library contains several depedencies in order to function so it is recommended that you install it via composer as this will handle your dependencies for you. If you do wish to install it from a tarball release then you will need to install the dependencies manually.

The PHP PhantomJS library currently requires the following depdencies:

• Symfony Config Component ~2.5
• Symfony YAML Component ~2.5
• Symfony Dependency Injection Component ~2.5
• Symfony Filesystem Component ~2.5
• Twig templating Component ~1.16
• PhantomJS ~1.9

Make sure the components are in your include path and that the PhantomJS executable is installed to your projects bin folder as mentioned in the Custom Installation section.