/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$access = array_shift($lines);
if ($access == Doc::ACCESS_PRIVATE || $access == Doc::ACCESS_PROTECTED || $access == Doc::ACCESS_PUBLIC) {
$doc->setAccess($access);
}
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$param = implode("\n", $lines);
$positionSpace = strpos($param, ' ');
if ($positionSpace === false) {
$type = $param;
$name = null;
$description = null;
} else {
$type = substr($param, 0, $positionSpace);
$positionDescription = strpos($param, ' ', $positionSpace + 1);
if ($positionDescription === false) {
$name = substr($param, $positionSpace + 1);
$description = null;
} else {
$positionName = $positionSpace + 1;
$name = substr($param, $positionName, $positionDescription - $positionName);
$description = substr($param, $positionDescription + 1);
}
if ($name && $name[0] != '$') {
$description = $name . ($description ? ' ' . $description : '');
$name = null;
}
}
$parameter = new DocParameter();
$parameter->setType($type);
$parameter->setName($name);
$parameter->setDescription($description);
$doc->addParameter($parameter);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$exception = implode("\n", $lines);
$positionSpace = strpos($exception, ' ');
if ($positionSpace === false) {
$type = $exception;
$description = null;
} else {
$type = substr($exception, 0, $positionSpace);
$description = substr($exception, $positionSpace + 1);
}
$exception = new DocParameter();
$exception->setType($type);
$exception->setDescription($description);
$doc->addException($exception);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$return = implode("\n", $lines);
$positionSpace = strpos($return, ' ');
if ($positionSpace === false) {
$type = trim($return);
$description = null;
} else {
$type = substr($return, 0, $positionSpace);
$description = trim(substr($return, $positionSpace));
}
if ($type == 'null' && !$description) {
return;
}
$parameter = new DocParameter();
$parameter->setType($type);
$parameter->setDescription($description);
$doc->setReturn($parameter);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$doc->setIsIgnore(true);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$name = implode("\n", $lines);
$doc->setName($name);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$version = implode("\n", $lines);
$doc->setVersion($version);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$example = implode("\n", $lines);
$doc->setExample($example);
}
/**
* Sets the long description to the Doc object and removes the lines containing it
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines Array with the lines of the doc comment
* @return array The remaining lines
*/
private function setLongDescription(Doc $doc, array $lines)
{
$description = '';
foreach ($lines as $lineNumber => $line) {
if ($this->tagParser->getTag($line)) {
break;
}
unset($lines[$lineNumber]);
$description .= $line . ' ';
}
if ($description) {
$doc->setLongDescription($description);
}
return $lines;
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$var = implode("\n", $lines);
$doc->setVar($var);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$todo = implode("\n", $lines);
$doc->addTodo($todo);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$doc->setIsAbstract(true);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$doc->setIsStatic(true);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$see = implode("\n", $lines);
$doc->setsee($see);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$copyright = implode("\n", $lines);
$doc->setCopyright($copyright);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$link = implode("\n", $lines);
$doc->setLink($link);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$subPackage = implode("\n", $lines);
$doc->setSubPackage($subPackage);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$author = implode("\n", $lines);
$doc->setAuthor($author);
}
/**
* Parse the lines for this tag into the Doc data container
* @param zibo\api\model\doc\Doc $doc Doc data container
* @param array $lines doc comment lines for this tag
* @return null
*/
public function parse(Doc $doc, array $lines)
{
$message = implode("\n", $lines);
$doc->setDeprecatedMessage($message);
$doc->setIsDeprecated(true);
}
