aist/aist-themes

Zend Framework 2 module that allows developers install & switch between various themes for their projects.

dev-master / 1.0.x-dev 2014-05-12 02:24 UTC

This package is not auto-updated.

Last update: 2024-11-09 16:58:30 UTC


README

Zend Framework 2 module that allows developers install & switch between various themes for their projects.

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

Features

  • Theme Installer

Requirements

  • php >= 5.3.3
  • zendframework >= 2.2.6
  • composer
  • See also the require, require-dev section of composer.json

Installation using Composer

  1. Open console (command prompt)
  2. Go to your application's directory.
  3. Run composer require aist/aist-themes:dev-master

Configuration

  1. Enable module in your application.config.php file.
<?php
return array(
    'modules' => array(
        // ...
        'AistThemes',
    ),
    // ...
);

Theme Installer

AistThemes relies on specific directory locations for templates and plugins. By default Composer is unable to install in an other directory than /vendor except when using a Custom Installer.

This Theme Installer for Composer will trigger on the following library types and provide custom behaviour for those.

  • aist-theme, install files into /data/themes instead of /vendor

Creating your own themes

In order to tell a theme to use this installer you need to add the following composer.json

{
    "name": "aist/theme-$NAME$",
    "type": "aist-theme",
    "require": {
        "aist/aist-themes": "*"
    }
}

The type element will instruct Composer to use this Theme Installer.

Contributing

Pull requests are welcome. Please include tests to prevent regressions whenever possible.

TODO

  • update tests
  • add travis
  • update composer.json
  • generate documentation