BaseDoc.php

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\apidoc\models;

use phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag;
use phpDocumentor\Reflection\DocBlock\Tag\SinceTag;
use yii\base\Object;

/**
 * Base class for API documentation information.
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
class BaseDoc extends Object
{
	/**
	 * @var \phpDocumentor\Reflection\DocBlock\Context
	 */
	public $phpDocContext;

	public $name;

	public $sourceFile;
	public $startLine;
	public $endLine;

	public $shortDescription;
	public $description;
	public $since;
	public $deprecatedSince;
	public $deprecatedReason;

	/**
	 * @var \phpDocumentor\Reflection\DocBlock\Tag[]
	 */
	public $tags = [];


	/**
	 * @param \phpDocumentor\Reflection\BaseReflector $reflector
	 * @param array $config
	 */
	public function __construct($reflector = null, $config = [])
	{
		parent::__construct($config);

		if ($reflector === null) {
			return;
		}

		// base properties
		$this->name = ltrim($reflector->getName(), '\\');
		$this->startLine = $reflector->getNode()->getAttribute('startLine');
		$this->endLine = $reflector->getNode()->getAttribute('endLine');

		$docblock = $reflector->getDocBlock();
		if ($docblock !== null) {
			$this->shortDescription = ucfirst($docblock->getShortDescription());
			$this->description = $docblock->getLongDescription();

			$this->phpDocContext = $docblock->getContext();

			$this->tags = $docblock->getTags();
			foreach($this->tags as $i => $tag) {
				if ($tag instanceof SinceTag) {
					$this->since = $tag->getVersion();
					unset($this->tags[$i]);
				} elseif ($tag instanceof DeprecatedTag) {
					$this->deprecatedSince = $tag->getVersion();
					$this->deprecatedReason = $tag->getDescription();
					unset($this->tags[$i]);
				}
			}
		}
	}


	// TODO
	public function loadSource($reflection)
	{
		$this->sourcePath = str_replace('\\', '/', str_replace(YII_PATH, '', $reflection->getFileName()));
		$this->startLine = $reflection->getStartLine();
		$this->endLine = $reflection->getEndLine();
	}

	public function getSourceUrl($baseUrl, $line=null)
	{
		if($line === null)
			return $baseUrl . $this->sourcePath;
		else
			return $baseUrl . $this->sourcePath . '#' . $line;
	}

	public function getSourceCode()
	{
		$lines = file(YII_PATH . $this->sourcePath);
		return implode("", array_slice($lines, $this->startLine - 1, $this->endLine - $this->startLine + 1));
	}
}