Download the PHP package fostam/buildinfo without Composer
On this page you can find all versions of the php package fostam/buildinfo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download fostam/buildinfo
More information about fostam/buildinfo
Files in fostam/buildinfo
Package buildinfo
Short Description Store and use build time information. Useful for automated builds where information like the application version needs to be retrieved at build time, e.g. from a Git tag.
License Apache-2.0
Informations about the package buildinfo
buildinfo
Store and use build time information. Useful for automated builds where information like the application version needs to be retrieved at build time, e.g. from a Git tag.
Features
- Create build information file
- Store information like version, build number, build time etc.
- Read build information in your application and easily use it
Install
The easiest way to install buildinfo is by using composer.
Library
With the BuildInfo library (buildinfo), the buildinfo parameters created with buildinfo-create can be read and used in the actual application.
Creation Tool
With the creation tool (buildinfo-create), the buildinfo parameter file is created while the application is built. This package is only required during build phase, not in the final application.
After installation, the build time tool can be called from the following location:
Usage Overview
Create build info file during the build phase for bundling it into the release (using buildinfo-create):
Reading build info file from the application (using buildinfo):
Build Info Creation
To create a build info file, pass the desired filename to the tool along with the build information you want to store.
The file location is relative to the current working directory, unless you give an absolute path.
Buildinfo File Types
Currently, two file types are supported, PHP and JSON. PHP is faster to read and cachable, whereas JSON is useful if the build info needs to be processed from outside PHP, too (e.g. JavaScript).
The file type is specified by the file extension. As you can give multiple build info targets, you can let both a PHP and JSON file be created.
Example:
Build Info Parameters
There are a couple of predefined build information parameters:
NOTE: if the time parameter is omitted, it is automatically set to a string of the current time in the RFC 3339 format.
Additionally, arbitrary custom parameters can be given using the --set
option:
Build Information Usage
The predefined build info parameters can be retrieved with the following methods:
The custom parameters can be retrieved with a generic get()
method:
For convenience, the build time can be also retrieved as DateTime
object:
All versions of buildinfo with dependencies
ext-json Version *