<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Code\Reflection\DocBlock\Tag;
use function explode;
use function preg_match;
use function preg_replace;
use function trim;
class ParamTag implements TagInterface, PhpDocTypedTagInterface
{
/**
* @var array
*/
protected $types = [];
/**
* @var string
*/
protected $variableName;
/**
* @var string
*/
protected $description;
/**
* @return string
*/
public function getName()
{
return 'param';
}
/**
* Initializer
*
* @param string $tagDocBlockLine
*/
public function initialize($tagDocBlockLine)
{
$matches = [];
if (! preg_match('#((?:[\w|\\\]+(?:\[\])*\|?)+)(?:\s+(\$\S+))?(?:\s+(.*))?#s', $tagDocBlockLine, $matches)) {
return;
}
$this->types = explode('|', $matches[1]);
if (isset($matches[2])) {
$this->variableName = $matches[2];
}
if (isset($matches[3])) {
$this->description = trim(preg_replace('#\s+#', ' ', $matches[3]));
}
}
/**
* Get parameter variable type
*
* @return string
* @deprecated 2.0.4 use getTypes instead
*/
public function getType()
{
if (empty($this->types)) {
return '';
}
return $this->types[0];
}
public function getTypes()
{
return $this->types;
}
/**
* Get parameter name
*
* @return string
*/
public function getVariableName()
{
return $this->variableName;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
}