robertboloc/rbversion

为 Zend Framework 2 应用程序提供应用程序版本管理

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

This package is not auto-updated.

Last update: 2024-09-24 06:57:06 UTC


README

Build Status Scrutinizer Code Quality Code Coverage

为 Zend Framework 2 提供应用程序版本管理。

目录

关于

使用此模块将应用程序版本集成到您的开发实践中。它允许在每次发布时传播应用程序版本,而无需更改多个文件。

用例:

通过将版本号附加到您的样式表和 JavaScript 包含调用中,您可以确保用户始终获得您想要的版本(而不是旧的缓存版本)。

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

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

安装

配置

模块的默认配置可以在文件 config/module.config.php 中找到。要覆盖默认值,请在您的应用程序的 config/autoload/local.php 文件中添加您的值,并在 rb_version 键下使用与默认值相同的结构。

提供商

提供商是版本的来源。目前实现了两个提供商: 直接文件

直接

使用此提供商,版本直接来自配置数组。直接提供商配置的示例

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

文件

使用此提供商,配置来自磁盘上的某个位置的 PHP 文件。此提供商的配置如下

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

版本文件的內容应类似于以下示例

<?php

use RbVersion\Model\Version as RbVersion;

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

使用

提供了视图助手和控制器插件。

在视图或控制器内部调用 $this->rbVersion()。这将返回数字版本。如果您已定义了版本名称并希望将其附加到数字值上,请使用 $this->rbVersion(true),这将返回数字版本和名称的连接。

例如,如果您的版本是 1.2.3 Awesome Antilope,调用 $this->rbVersion() 将返回 1.2.3,而调用 $this->rbVersion(true) 将返回 1.2.3 Awesome Antilope

路线图

  • 添加 travis-CI 集成
  • 添加 scrutinizer 集成
  • 添加更多提供商(git)
  • 在 packagist/composer 上发布