diff options
Diffstat (limited to 'library/kzykhys/git/src/PHPGit/Command/DescribeCommand.php')
-rw-r--r-- | library/kzykhys/git/src/PHPGit/Command/DescribeCommand.php | 90 |
1 files changed, 0 insertions, 90 deletions
diff --git a/library/kzykhys/git/src/PHPGit/Command/DescribeCommand.php b/library/kzykhys/git/src/PHPGit/Command/DescribeCommand.php deleted file mode 100644 index affdd009b..000000000 --- a/library/kzykhys/git/src/PHPGit/Command/DescribeCommand.php +++ /dev/null @@ -1,90 +0,0 @@ -<?php - -namespace PHPGit\Command; - -use PHPGit\Command; -use Symfony\Component\OptionsResolver\OptionsResolverInterface; - -/** - * Show the most recent tag that is reachable from a commit - `git describe` - * - * @author Kazuyuki Hayashi <hayashi@valnur.net> - */ -class DescribeCommand extends Command -{ - - /** - * Returns the most recent tag that is reachable from a commit - * - * ``` php - * $git = new PHPGit\Git(); - * $git->setRepository('/path/to/repo'); - * $git->tag->create('v1.0.0'); - * $git->commit('Fixes #14'); - * echo $git->describe('HEAD', ['tags' => true]); - * ``` - * - * ##### Output Example - * - * ``` - * v1.0.0-1-g7049efc - * ``` - * - * ##### Options - * - * - **all** (_boolean_) Enables matching any known branch, remote-tracking branch, or lightweight tag - * - **tags** (_boolean_) Enables matching a lightweight (non-annotated) tag - * - **always** (_boolean_) Show uniquely abbreviated commit object as fallback - * - * @param string $committish [optional] Committish object names to describe. - * @param array $options [optional] An array of options {@see DescribeCommand::setDefaultOptions} - * - * @return string - */ - public function __invoke($committish = null, array $options = array()) - { - $options = $this->resolve($options); - $builder = $this->git->getProcessBuilder() - ->add('describe'); - - $this->addFlags($builder, $options, array()); - - if ($committish) { - $builder->add($committish); - } - - return trim($this->git->run($builder->getProcess())); - } - - /** - * Equivalent to $git->describe($committish, ['tags' => true]); - * - * @param string $committish [optional] Committish object names to describe. - * @param array $options [optional] An array of options {@see DescribeCommand::setDefaultOptions} - * - * @return string - */ - public function tags($committish = null, array $options = array()) - { - $options['tags'] = true; - - return $this->__invoke($committish, $options); - } - - /** - * {@inheritdoc} - * - * - **all** (_boolean_) Enables matching any known branch, remote-tracking branch, or lightweight tag - * - **tags** (_boolean_) Enables matching a lightweight (non-annotated) tag - * - **always** (_boolean_) Show uniquely abbreviated commit object as fallback - */ - public function setDefaultOptions(OptionsResolverInterface $resolver) - { - $resolver->setDefaults(array( - 'all' => false, - 'tags' => false, - 'always' => false, - )); - } - -} |