ApiController.php 4.1 KB
Newer Older
1 2
<?php
/**
3 4 5
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
6 7 8 9 10
 */

namespace yii\apidoc\commands;


11
use yii\apidoc\components\BaseController;
12
use yii\apidoc\models\Context;
13
use yii\apidoc\renderers\ApiRenderer;
14
use yii\apidoc\renderers\BaseRenderer;
15 16 17 18
use yii\helpers\ArrayHelper;
use yii\helpers\Console;
use yii\helpers\FileHelper;

19 20 21 22
/**
 * Generate class API documentation
 *
 */
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
class ApiController extends BaseController
{
	/**
	 * @var string url to where the guide files are located
	 */
	public $guide;

	// TODO add force update option

	/**
	 * Renders API documentation files
	 * @param array $sourceDirs
	 * @param string $targetDir
	 * @return int
	 */
	public function actionIndex(array $sourceDirs, $targetDir)
	{
		$renderer = $this->findRenderer($this->template);
		$targetDir = $this->normalizeTargetDir($targetDir);
		if ($targetDir === false || $renderer === false) {
			return 1;
		}

46 47
		$renderer->apiUrl = './';

48 49
		// setup reference to guide
		if ($this->guide !== null) {
50 51 52 53 54 55 56 57 58
			$guideUrl = $this->guide;
			$referenceFile = $guideUrl . '/' . BaseRenderer::GUIDE_PREFIX . 'references.txt';
		} else {
			$guideUrl = './';
			$referenceFile = $targetDir . '/' . BaseRenderer::GUIDE_PREFIX . 'references.txt';
		}
		if (file_exists($referenceFile)) {
			$renderer->guideUrl = $guideUrl;
			$renderer->guideReferences = [];
Luciano Baraglia committed
59
			foreach (explode("\n", file_get_contents($referenceFile)) as $reference) {
60
				$renderer->guideReferences[BaseRenderer::GUIDE_PREFIX . $reference]['url'] = $renderer->generateGuideUrl($reference);
61
			}
62 63 64
		}

		// search for files to process
65 66 67
		if (($files = $this->searchFiles($sourceDirs)) === false) {
			return 1;
		}
68 69 70 71

		// load context from cache
		$context = $this->loadContext($targetDir);
		$this->stdout('Checking for updated files... ');
Luciano Baraglia committed
72
		foreach ($context->files as $file => $sha) {
73 74 75
			if (!file_exists($file)) {
				$this->stdout('At least one file has been removed. Rebuilding the context...');
				$context = new Context();
76 77 78
				if (($files = $this->searchFiles($sourceDirs)) === false) {
					return 1;
				}
79 80
				break;
			}
81 82 83 84 85 86 87 88 89 90 91
			if (sha1_file($file) === $sha) {
				unset($files[$file]);
			}
		}
		$this->stdout('done.' . PHP_EOL, Console::FG_GREEN);

		// process files
		$fileCount = count($files);
		$this->stdout($fileCount . ' file' . ($fileCount == 1 ? '' : 's') . ' to update.' . PHP_EOL);
		Console::startProgress(0, $fileCount, 'Processing files... ', false);
		$done = 0;
Luciano Baraglia committed
92
		foreach ($files as $file) {
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
			$context->addFile($file);
			Console::updateProgress(++$done, $fileCount);
		}
		Console::endProgress(true);
		$this->stdout('done.' . PHP_EOL, Console::FG_GREEN);

		// save processed data to cache
		$this->storeContext($context, $targetDir);

		$this->updateContext($context);

		// render models
		$renderer->controller = $this;
		$renderer->render($context, $targetDir);

108 109 110 111 112
		if (!empty($context->errors)) {
			ArrayHelper::multisort($context->errors, 'file');
			file_put_contents($targetDir . '/errors.txt', print_r($context->errors, true));
			$this->stdout(count($context->errors) . " errors have been logged to $targetDir/errors.txt\n", Console::FG_RED, Console::BOLD);
		}
113 114
	}

115 116 117
	/**
	 * @inheritdoc
	 */
118
	protected function findFiles($path, $except = [])
119
	{
120 121 122
		if (empty($except)) {
			$except = ['vendor/', 'tests/'];
		}
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
		$path = FileHelper::normalizePath($path);
		$options = [
			'filter' => function ($path) {
					if (is_file($path)) {
						$file = basename($path);
						if ($file[0] < 'A' || $file[0] > 'Z') {
							return false;
						}
					}
					return null;
				},
			'only' => ['*.php'],
			'except' => $except,
		];
		return FileHelper::findFiles($path, $options);
	}

	/**
141
	 * @inheritdoc
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
	 * @return ApiRenderer
	 */
	protected function findRenderer($template)
	{
		$rendererClass = 'yii\\apidoc\\templates\\' . $template . '\\ApiRenderer';
		if (!class_exists($rendererClass)) {
			$this->stderr('Renderer not found.' . PHP_EOL);
			return false;
		}
		return new $rendererClass();
	}

	/**
	 * @inheritdoc
	 */
157
	public function options($id)
158
	{
159
		return array_merge(parent::options($id), ['template', 'guide']);
160
	}
Luciano Baraglia committed
161
}