README

This library is intended to make it easy to parse out the services metadata for use in your PHP application. In addition, it provides the ability to load configuration files to supply the services values for development, when not running on Paasmaker. This allows your code to use the exact same code paths regardless of where it is running.

Installation and Use

If you're using composer, you can just add "paasmaker/interface" to your project dependencies, and then update as normal.

If you're not using composer, you can just grab the single file - PmInterface.php

and drop that into your project. If you add it to your autoloader, you're all good to go.

By default, it will not attempt to parse Yaml files. You will need the Symfony YAML component to parse YAML files - if you're working with Symfony you'll already have it and can use YAML overrides. Otherwise, it will fall back to the always supported JSON format.

Once you're set up, you can do the following in your startup code:

<?php

$interface = new \Paasmaker\PmInterface(array('../my-project.json'));
// Or to allow loading YAML files:
$interface = new \Paasmaker\PmInterface(array('../my-project.yml'), TRUE);

// This returns true if running on Paasmaker.
$interface.isOnPaasmaker();

// Throws \Paasmaker\PmInterfaceException if no such service exists.
$service = $interface->getService('named-service');

// $service now contains an array of parameters. Typically this will
// have the keys 'hostname', 'username', 'password', etc. Use this to
// connect to the relevant services.

// Get other application metadata.
$application = $interface->getApplicationName();

Symfony2

To make it even easier to use with Symfony2, the interface can unpack the services into variables that you can use directly in the YAML configuration files. To make this happen, follow these steps:

Add the interface to your composer.json file for your project, and then install.

$ composer.phar require paasmaker/interface dev-master

Now edit app/AppKernel.php, and in the construct method, add the following lines. This is for Symfony 2.2. If you've already overridden __construct(), or it was already present, you'll need to adjust this for your installation.

<?php
// In file app/AppKernel.php
// ...
class AppKernel extends Kernel
{
    public function __construct($environment, $debug)
    {
        $interface = new \Paasmaker\PmInterface(array(), FALSE);
        $interface->symfonyUnpack();

        $paasmakerEnvironment = $interface->getSymfonyEnvironment('prod');
        $paasmakerDebug = FALSE;
        if($paasmakerEnvironment == 'dev')
        {
            $paasmakerDebug = TRUE;
        }

        parent::__construct($paasmakerEnvironment, $paasmakerDebug);
    }
// ...

You can adjust which environment it runs in by setting the SYMFONY_ENV tag on your Paasmaker workspace. Otherwise, it assumes the prod environment.

A services section in your Paasmaker manifest.yml might look like this:

services:
  - name: symfonysql
    plugin: paasmaker.service.mysql

Then, in your YML files, you can refer to the services values by inserting values in the format "%pm..". For example, the contents of app/config/parameters.yml may look like this:

parameters:
    database_driver:   pdo_mysql
    database_host:     %pm.symfonysql.hostname%
    database_port:     %pm.symfonysql.port%
    database_name:     %pm.symfonysql.database%
    database_user:     %pm.symfonysql.username%
    database_password: %pm.symfonysql.password%

    mailer_transport:  smtp
    mailer_host:       127.0.0.1
    mailer_user:       ~
    mailer_password:   ~

    locale:            en
    secret:            ThisTokenIsNotSoSecretChangeIt

These values are available to all the YAML files.

See the Paasmaker documentation for a full guide on how to use this library with Symfony 2.

Example YAML configuration file

services:
  parameters:
    foo: bar

application:
  name: test
  version: 1
  workspace: Test
  workspace_stub: test

Example JSON configuration file

{
	"services": {
		"parameters": {
			"foo": "bar"
		}
	},
	"application": {
		"name": "test",
		"version": 1,
		"workspace": "Test",
		"workspace_stub": "test"
	}
}

Testing

To run the unit tests, install the dev dependencies and then invoke PHPUnit.

# composer.phar install --dev
# vendor/bin/phpunit

paasmaker / interface

Maintainers