| Current Path : /home/rtorresani/www/vendor/laminas/laminas-code/src/Generator/DocBlock/Tag/ |
| Current File : //home/rtorresani/www/vendor/laminas/laminas-code/src/Generator/DocBlock/Tag/AuthorTag.php |
<?php
namespace Laminas\Code\Generator\DocBlock\Tag;
use Laminas\Code\Generator\AbstractGenerator;
use Laminas\Code\Generator\DocBlock\TagManager;
use Laminas\Code\Reflection\DocBlock\Tag\TagInterface as ReflectionTagInterface;
class AuthorTag extends AbstractGenerator implements TagInterface
{
/** @var string|null */
protected $authorName;
/** @var string|null */
protected $authorEmail;
/**
* @param string|null $authorName
* @param string|null $authorEmail
*/
public function __construct($authorName = null, $authorEmail = null)
{
if (! empty($authorName)) {
$this->setAuthorName($authorName);
}
if (! empty($authorEmail)) {
$this->setAuthorEmail($authorEmail);
}
}
/**
* @deprecated Deprecated in 2.3. Use TagManager::createTagFromReflection() instead
*
* @return AuthorTag
*/
public static function fromReflection(ReflectionTagInterface $reflectionTag)
{
$tagManager = new TagManager();
$tagManager->initializeDefaultTags();
return $tagManager->createTagFromReflection($reflectionTag);
}
/** @return 'author' */
public function getName()
{
return 'author';
}
/**
* @param string $authorEmail
* @return AuthorTag
*/
public function setAuthorEmail($authorEmail)
{
$this->authorEmail = $authorEmail;
return $this;
}
/** @return string|null */
public function getAuthorEmail()
{
return $this->authorEmail;
}
/**
* @param string $authorName
* @return AuthorTag
*/
public function setAuthorName($authorName)
{
$this->authorName = $authorName;
return $this;
}
/** @return string|null */
public function getAuthorName()
{
return $this->authorName;
}
/** @return non-empty-string */
public function generate()
{
return '@author'
. (! empty($this->authorName) ? ' ' . $this->authorName : '')
. (! empty($this->authorEmail) ? ' <' . $this->authorEmail . '>' : '');
}
}