README

PHP >= 5.6

Display the code version of the project.

Installation

Use Composer to install the package.

Update your composer.json

"require": {
    "jeffersonassilva/vcs-php": "*"
}

or use composer's require command:

$ composer require jeffersonassilva/vcs-php

Required

It is necessary that your variable $_SERVER["DOCUMENT_ROOT"] is correct, based in your project path. If it is not, you can pass the path as a parameter in all functions.

echo VcsPHP::isGIT('/var/www/my-project');

Usage Examples

use jeffersonassilva\VcsPHP\VcsPHP;

echo VcsPHP::branch();

Functions

Method	Description	GIT/SVN
`isGIT([string $dir = null])`	Check it if vcs is GIT	BOTH
`isSVN([string $dir = null])`	Check it if vcs is SVN	BOTH
`repository([string $dir = null])`	Show repository url	BOTH
`branch([string $dir = null])`	Show the branch name	BOTH
`tag([string $dir = null])`	Show the tag name	BOTH
`revision([bool $long = false], [string $dir = null])`	Show the revision code	BOTH
`authorDate(string $format = 'Y-m-d H:i:s', [string $dir = null])`	Show the date of author	BOTH
`authorName([string $dir = null])`	Show the name of author	BOTH
`authorEmail([string $dir = null])`	Show the email of author	GIT
`committerDate(string $format = 'Y-m-d H:i:s', [string $dir = null])`	Show the date of committer	GIT
`committerName([string $dir = null])`	Show the name of committer	GIT
`committerEmail([string $dir = null])`	Show the email of committer	GIT
`subject([string $dir = null])`	Show the subject commit	GIT
`commits([bool $merges = false], [string $dir = null])`	Show the quantity of commits	GIT
`uuid([string $dir = null])`	Show repository UUID	SVN
`nodeKind([string $dir = null])`	Show the node kind	SVN

Author

Jefferson Alessandro Santos da Silva - @jeffersonassilva

Contribute

Contributions to the package are always welcome!

Report any bugs or issues you find on the issue tracker.
You can grab the source code at the package's Git repository.

Support

If you are having problems, send a mail to jeffersonassilva@gmail.com.

License

The scripts and documentation in this project are released under the MIT License.

jeffersonassilva / vcs-php

Maintainers

Details