robertboloc/rbversion

App versioning for Zend Framework 2 applications

dev-master / 0.0.x-dev 2014-07-18 21:08 UTC

Requires

• php: >=5.3.0
• zendframework/zend-loader: 2.*
• zendframework/zend-mvc: 2.*
• zendframework/zend-servicemanager: 2.*
• zendframework/zend-view: 2.*

Requires (Dev)

• phpunit/phpunit: 4.1.*
• robertboloc/zf2-components-list-generator: dev-master

MIT

• Robert Boloc

• zf2
• version

README

Application versioning for Zend Framework 2.

Table of contents

• About
• Installation
• Configuration
• Usage
• Roadmap

About

Use this module to integrate the application versioning into your development practices. It allows propagating the application version without changing multiple files with every release.

Use case:

By appending the version number to your stylesheets and javascript include calls, you can make sure that the user always gets the version you intended (and not an old cached one).

<!-- Stylesheets -->
<link href="//website.com/style.css?v=<?= $this->rbVersion() ?>"/>

<!-- Scripts -->
<script src="//website.com/script.js?v=<?= $this->rbVersion() ?>"></script>

Installation

Configuration

The default configuration of the module can be found in the file config/module.config.php. To override the defaults, add your values under the rb_version key in the config/autoload/local.php file of your application, using the same structure as in the defaults.

Provider

The provider is the source of the version. Two providers are implemented at the moment: direct and file.

Direct

With this provider the version comes directly from the configuration array. An example of direct provider configuration:

'rb_version' => array(
'provider' => array(
        'type' => 'direct',
        'number'=> '1.2.3',
        'name'=> 'Amazing',
    ),
)

File

With this provider the configuration comes from a php file located somewehere on the disk. The configuration for this provider is as follows:

'rb_version' => array(
'provider' => array(
        'type' => 'file',
        'file'=> '/tmp/version.php',
    ),
)

The content of the version file should be similar to the following example:

<?php

use RbVersion\Model\Version as RbVersion;

return new RbVersion('1.2.3', 'Amazing Antilope');

Usage

Both a view helper, and a controller plugin are available.

Call $this->rbVersion() inside a view or controller. This will return the numeric version. If you have defined a name for the version and want it to be appendend to the numeric value, use $this->rbVersion(true) which will return both the numeric version and the name of it concatenated by a space.

For example if your version is 1.2.3 Awesome Antilope calling $this->rbVersion() will return 1.2.3 and calling $this->rbVersion(true) will return 1.2.3 Awesome Antilope

Roadmap

• Add travis-CI integration
• Add scrutinizer integration
• Add more providers (git)
• Release on packagist/composer