README

Laravel应用程序的基础帮助函数集合。

安装

在您的 composer.json 文件中要求此包

{
	"require": {
		"antarctica/laravel-base-helpers": "~0.1"
	}
}

运行 composer update。

用法

• 帮助函数被组织成多个文件，位于 src/Helpers 目录中，如下所述
• 所有帮助函数都使用 DocBlocks 进行了文档化，以提供使用信息。

注意：所有帮助函数目前都加载到全局作用域中。这可能在将来发生变化。

utils.php

通用函数。这些函数也可以在其他函数中使用，包括在此包中。

贡献

本项目欢迎贡献，请参阅 CONTRIBUTING 了解我们的通用政策。

开发

为了帮助开发并保持您的本地计算机整洁，使用一个虚拟机（由 Vagrant 管理）创建一个带有所有必要工具/库的隔离环境。

要求

• Mac OS X
• Ansible brew install ansible
• VMware Fusion
• Vagrant brew cask install vmware-fusion vagrant
• Host manager 和 Vagrant VMware 插件 vagrant plugin install vagrant-hostmanager && vagrant plugin install vagrant-vmware-fusion
• 您在 ~/.ssh/ 中有一个私钥 id_rsa 和公钥 id_rsa.pub
• 您在 ~/.ssh/config 中有一个类似 [1] 的条目

[1] SSH 配置条目

Host bslweb-*
    ForwardAgent yes
    User app
    IdentityFile ~/.ssh/id_rsa
    Port 22

配置开发虚拟机

使用 Vagrant 管理虚拟机，并由 Ansible 配置。

$ git clone ssh://git@stash.ceh.ac.uk:7999/basweb/laravel-base-helpers.git
$ cp ~/.ssh/id_rsa.pub laravel-base-helpers/provisioning/public_keys/
$ cd laravel-base-helpers
$ ./armadillo_standin.sh

$ vagrant up

$ ssh bslweb-laravel-base-helpers-dev-node1
$ cd /app

$ composer install

$ logout

提交更改

使用 Git flow 工作流程来管理此包的开发。

应在 feature 分支中进行离散更改，从 develop 创建，并合并回 develop（其中可以直接进行一行小更改）。

准备好发布一系列功能/更改时，从 develop 创建一个 release 分支，根据需要更新文档，并与带有标记的 master 合并，使用 语义版本（例如 v1.2.3）。

发布后，应将 master 分支与 develop 合并，以重新启动过程。高影响度的错误可以在 hotfix 分支中解决，直接从 master 创建并合并，然后合并到 develop。

问题跟踪

与此包相关的问题、错误、改进、问题、建议和其他任务都通过 BAS Web & Applications Team Jira 项目（BASWEB）进行管理。

清理

要删除开发虚拟机

vagrant halt
vagrant destroy

然后可以安全地像平常一样删除 laravel-base-helpers 目录。

许可

版权所有 2015 NERC BAS。在 MIT 许可证下授权，有关详细信息，请参阅 LICENSE。