AGitTag.php

<?php
/**
 * Represents a git tag.
 *
 * @author Charles Pick
 * @author Jonas Girnatis <dermusterknabe@gmail.com>
 * @package packages.git
 */
class AGitTag extends CComponent
{
	/**
	 * The name of the tag
	 * @var string
	 */
	public $name;

	/**
	 * The repository this tag belongs to
	 * @var AGitRepository
	 */
	public $repository;

	/**
	 * The remote repository this tag belongs to, if any
	 * @var AGitRemote
	 */
	public $remote;

	/**
	 * The name of the author of the tag
	 * @var string
	 */
	protected $_authorName = null;

	/**
	 * The email address of the author of the tag
	 * @var string
	 */
	protected $_authorEmail = null;

	/**
	 * The message for this tag
	 * @var string
	 */
	protected $_message = null;

	/**
	 * The commit that this tag points to
	 * @var AGitCommit
	 */
	protected $_commit = null;

	/**
	 * Constructor.
	 * @param string $name the name of the tag
	 * @param AGitBranch|null $branch the branch this tag belongs to
	 */
	public function __construct($name, AGitRepository $repository, AGitRemote $remote = null)
	{
		$this->repository = $repository;
		$this->name = $name;
		$this->remote = $remote;
	}

	/**
	 * Loads the metadata for the tag
	 */
	protected function loadData()
	{
		$delimiter = '|||||-----|||||-----|||||';
 		$command = 'show --pretty=format:"'.$delimiter.'%H'.$delimiter.'" '.$this->name;

 		$response = explode($delimiter,$this->repository->run($command));
 		$tagData = $response[0];
 		$commitHash = $response[1];

		if (strpos($tagData, "tag $this->name") === 0) { //annotated tag
 			if(preg_match("/Tagger: (.*)\n/", $tagData, $matches)){
 				$tagger = $matches[1];
				if (preg_match("/(.*) <(.*)>/u", $tagger,$matches)) {
					$this->_authorEmail = trim(array_pop($matches));
					$this->_authorName = trim(array_pop($matches));
				}
				else {
					$this->_authorName = $tagger;
				}

				$this->_message = trim(preg_replace("/.*\nTagger: .*\n/", '', $tagData));
 			}
 		}

 		$this->_commit = new AGitCommit($commitHash, $this->repository);
	}
	
	/**
	 * Returns the name of the author of the tag
	 * @return string name of tag author
	 */
	public function getAuthorName()
	{
		if(is_null($this->_authorName)){
			$this->loadData();
		}
		return $this->_authorName;
	}

	/**
	 * Returns the email address of the author of the tag
	 * @return string email address of tag author
	 */
	public function getAuthorEmail()
	{
		if(is_null($this->_authorEmail)){
			$this->loadData();
		}
		return $this->_authorEmail;
	}

	/**
	 * Returns the tag description
	 * @return string description of the tag
	 */
	public function getMessage()
	{
		if(is_null($this->_message)){
			$this->loadData();
		}
		return $this->_message;
	}

	/**
	 * Gets the commit this tag points to
	 * @return AGitCommit the commit this tag points to
	 */
	public function getCommit()
	{
		if(is_null($this->_commit)){
			$this->loadData();
		}
		return $this->_commit;
	}
	
	/**
	 * Pushes a tag to a remote repository.
	 * @param null|string|AGitRemote $remote the remote repository to push to. If null, falls back to repository $defaultRemote.
	 * @return string the response from git
	 */
	public function push($remote = null)
	{
		if (is_null($remote)) {
			$remote = $this->repository->remote;
		}

		return $this->repository->run("push $remote tag $this->name");
	}
	
	/**
	 * @return string tag name
	 */
	public function __toString()
	{
		return $this->name;
	}
}