aura/asset-bundle

Asset management for aura v2

2.1.0 2014-12-21 07:14 UTC

README

Asset management for PHP.

Foreword

Requirements

This package requires PHP 5.3 or later. Unlike Aura library packages, this asset package has userland dependencies:

Installation

This asset-bundle is installable and autoloadable via Composer with the following require element in your composer.json file:

"require": {
    "aura/asset-bundle": "2.*"
}

Tests

Build Status

composer install
phpunit -c tests/unit

PSR Compliance

This kernel attempts to comply with PSR-1, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch via pull request.

Community

To ask questions, provide feedback, or otherwise communicate with the Aura community, please join our Google Group, follow @auraphp on Twitter, or chat with us on #auraphp on Freenode.

Structure of Package

Assume you have a Vendor.Package. All your assets should be in the web folder. The folder names css, images, js can be according to your preffered name.

├── src
│   ├── Cli
│   └── Web
├── tests
└── web
    ├── css
    │   └── some.css
    ├── images
    │   ├── another.jpg
    │   └── some.png
    └── js
        └── hello.js

Assuming you have the same structure, now in your template you can point to /asset/vendor/package/css/some.css, /asset/vendor/package/js/hello.js, /asset/vendor/package/images/another.jpg.

Onething you still need to make sure in the name asset/vendor/package

vendor/package which is the composer package name.

Usage in any project

Add path to the router, according to the router you are using so that vendor, package and file name can be extracted from it.

An example of usage with Aura.Router and Aura.Dispatcher is given below. The dispacther is used for it need to recursively call the __invoke method. Else action will return responder, then you need to invoke responder to get the response and finally do send the response.

<?php
$map = array(
    'my/package' => '/path/to/web/where/css/js/etc/',
    'my/package2' => '/path/to/web/where/css/js/etc/of/packag2'
);
$types = array();
$router->add('aura.asset', '/asset/{vendor}/{package}/{file}')
    ->setValues([
        'action' => 'aura.asset',
    ])
    ->addTokens(array(
        'file' => '(.*)'
    ));

$dispatcher->setObject(
    'aura.asset',
    function () use ($map, $types) {
        $action = new \Aura\Asset_Bundle\AssetAction(
            new \Aura\Asset_Bundle\AssetService($map, $types),
            new \Aura\Asset_Bundle\AssetResponder()
        );
        return $action;
    }
);

In your layout or view

<link href="/asset/<vendor>/<package>/css/bootstrap.min.css" rel="stylesheet">

Usage in Aura.Web_Kernel

<?php
    // more code
    public function define(Container $di)
    {
        $di->params['Aura\Asset_Bundle\AssetService']['map']['cocoframework/example'] = dirname(__DIR__) . '/web';
    }

Make sure you have router helper defined for Aura.View.

<link rel="stylesheet" href="<?php echo $this->router()
      ->generateRaw('aura.asset',
          array(
              'vendor' => 'cocoframework',
              'package' => 'example',
              'file' => '/css/syntax.css'
          )
      ); ?>">