From bff6e67f9abaf69e1e9df1e55fee2bcc1ce46763 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 29 Jan 2014 00:57:38 +0100 Subject: [PATCH 1/6] added timestamp to apidocs template --- extensions/apidoc/templates/bootstrap/layouts/main.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/extensions/apidoc/templates/bootstrap/layouts/main.php b/extensions/apidoc/templates/bootstrap/layouts/main.php index 46b96c1289..1dca1ddb1f 100644 --- a/extensions/apidoc/templates/bootstrap/layouts/main.php +++ b/extensions/apidoc/templates/bootstrap/layouts/main.php @@ -60,7 +60,8 @@ $this->beginPage(); endBody() ?> From 3519c14e60a3e8f15b81811ecd2f95da985d6e38 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 29 Jan 2014 00:59:41 +0100 Subject: [PATCH 2/6] throw exceptions in case of invalid response content fixes #1842 --- framework/web/Response.php | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/framework/web/Response.php b/framework/web/Response.php index 0068afd01a..f84d2a0df2 100644 --- a/framework/web/Response.php +++ b/framework/web/Response.php @@ -870,9 +870,13 @@ class Response extends \yii\base\Response } if (is_array($this->content)) { - $this->content = 'array()'; + throw new InvalidParamException("Response content must not be an array."); } elseif (is_object($this->content)) { - $this->content = method_exists($this->content, '__toString') ? $this->content->__toString() : get_class($this->content); + if (method_exists($this->content, '__toString')) { + $this->content = $this->content->__toString(); + } else { + throw new InvalidParamException("Response content can only be an object when it implements __toString() method."); + } } } } From 7fa619feb3c7bb551775fee57cca3ccdfc99571f Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 29 Jan 2014 02:17:17 +0100 Subject: [PATCH 3/6] added extensions to API docs --- .../apidoc/commands/RenderController.php | 2 +- .../apidoc/templates/bootstrap/Renderer.php | 97 +++++++++++++++++++ .../templates/bootstrap/layouts/api.php | 1 + .../templates/bootstrap/layouts/main.php | 8 ++ .../templates/bootstrap/views/index.php | 4 + 5 files changed, 111 insertions(+), 1 deletion(-) diff --git a/extensions/apidoc/commands/RenderController.php b/extensions/apidoc/commands/RenderController.php index d6ae80f970..3c676e1da8 100644 --- a/extensions/apidoc/commands/RenderController.php +++ b/extensions/apidoc/commands/RenderController.php @@ -128,7 +128,7 @@ class RenderController extends Controller return new $rendererClass(); } - protected function findFiles($path, $except = ['/vendor/', '/tests/']) + protected function findFiles($path, $except = ['vendor/', 'tests/']) { $path = FileHelper::normalizePath($path); $options = [ diff --git a/extensions/apidoc/templates/bootstrap/Renderer.php b/extensions/apidoc/templates/bootstrap/Renderer.php index b40426dd5b..ef8d37b45a 100644 --- a/extensions/apidoc/templates/bootstrap/Renderer.php +++ b/extensions/apidoc/templates/bootstrap/Renderer.php @@ -28,6 +28,103 @@ class Renderer extends \yii\apidoc\templates\html\Renderer public $guideUrl; + public $extensions = [ + 'apidoc', + 'authclient', + 'bootstrap', + 'codeception', + 'composer', + 'debug', + 'elasticsearch', + 'faker', + 'gii', + 'imagine', + 'jui', + 'mongodb', + 'redis', + 'smarty', + 'sphinx', + 'swiftmailer', + 'twig', + ]; + + /** + * Renders a given [[Context]]. + * + * @param Context $context the api documentation context to render. + * @param Controller $controller the apidoc controller instance. Can be used to control output. + */ + public function renderApi($context, $controller) + { + parent::renderApi($context, $controller); + $dir = Yii::getAlias($this->targetDir); + $types = array_merge($context->classes, $context->interfaces, $context->traits); + + $controller->stdout('generating extension index files...'); + foreach($this->extensions as $ext) { + $readme = @file_get_contents("https://raw.github.com/yiisoft/yii2-$ext/master/README.md"); + $indexFileContent = $this->renderWithLayout($this->indexView, [ + 'docContext' => $context, + 'types' => $this->filterTypes($types, $ext), + 'readme' => $readme ?: null, + ]); + file_put_contents($dir . "/ext_{$ext}_index.html", $indexFileContent); + } + $controller->stdout('done.' . PHP_EOL, Console::FG_GREEN); + } + + public function getNavTypes($type, $types) + { + if ($type === null) { + return $types; + } + $extensions = $this->extensions; + $navClasses = 'app'; + if (isset($type)) { + if ($type->name == 'Yii') { + $navClasses = 'yii'; + } elseif (strncmp($type->name, 'yii\\', 4) == 0) { + $subName = substr($type->name, 4); + if (($pos = strpos($subName, '\\')) !== false) { + $subNamespace = substr($subName, 0, $pos); + if (in_array($subNamespace, $extensions)) { + $navClasses = $subNamespace; + } else { + $navClasses = 'yii'; + } + } + } + } + return $this->filterTypes($types, $navClasses); + } + + protected function filterTypes($types, $navClasses) + { + switch ($navClasses) + { + case 'app': + $types = array_filter($types, function($val) { + return strncmp($val->name, 'yii\\', 4) !== 0; + }); + break; + case 'yii': + $self = $this; + $types = array_filter($types, function($val) use ($self) { + if (strlen($val->name) < 5) { + return false; + } + $subName = substr($val->name, 4, strpos($val->name, '\\', 5) - 4); + return strncmp($val->name, 'yii\\', 4) === 0 && !in_array($subName, $self->extensions); + }); + break; + default: + $types = array_filter($types, function($val) use ($navClasses) { + return strncmp($val->name, "yii\\$navClasses\\", strlen("yii\\$navClasses\\")) === 0; + }); + } + return $types; + } + /** * Renders a given [[Context]]. * diff --git a/extensions/apidoc/templates/bootstrap/layouts/api.php b/extensions/apidoc/templates/bootstrap/layouts/api.php index 157e7fdb3e..935705d590 100644 --- a/extensions/apidoc/templates/bootstrap/layouts/api.php +++ b/extensions/apidoc/templates/bootstrap/layouts/api.php @@ -11,6 +11,7 @@ $this->beginContent('@yii/apidoc/templates/bootstrap/layouts/main.php'); ?>
context->getNavTypes(isset($type) ? $type : null, $types); ksort($types); $nav = []; foreach($types as $i=>$class) { diff --git a/extensions/apidoc/templates/bootstrap/layouts/main.php b/extensions/apidoc/templates/bootstrap/layouts/main.php index 1dca1ddb1f..90708ba986 100644 --- a/extensions/apidoc/templates/bootstrap/layouts/main.php +++ b/extensions/apidoc/templates/bootstrap/layouts/main.php @@ -37,9 +37,17 @@ $this->beginPage(); 'padded' => false, 'view' => $this, ]); + $extItems = []; + foreach($this->context->extensions as $ext) { + $extItems[] = [ + 'label' => $ext, + 'url' => "./ext_{$ext}_index.html", + ]; + } $nav = [ ['label' => 'Class reference', 'url' => './index.html'], // ['label' => 'Application API', 'url' => '/site/about'], + ['label' => 'Extensions', 'items' => $extItems], ]; if ($this->context->guideUrl !== null) { $nav[] = ['label' => 'Guide', 'url' => $this->context->guideUrl . 'guide_index.html']; diff --git a/extensions/apidoc/templates/bootstrap/views/index.php b/extensions/apidoc/templates/bootstrap/views/index.php index a8b29fc526..b971b8e9ed 100644 --- a/extensions/apidoc/templates/bootstrap/views/index.php +++ b/extensions/apidoc/templates/bootstrap/views/index.php @@ -8,6 +8,10 @@ use yii\apidoc\models\TraitDoc; * @var yii\web\View $this */ +if (isset($readme)) { + echo \yii\apidoc\helpers\Markdown::process($readme); +} + ?>

Class Reference

From 4f68b8a4bbb68e47b1d40c54cac8cd23726a534c Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 29 Jan 2014 02:27:20 +0100 Subject: [PATCH 4/6] added README to main framework docs --- extensions/apidoc/templates/bootstrap/Renderer.php | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/extensions/apidoc/templates/bootstrap/Renderer.php b/extensions/apidoc/templates/bootstrap/Renderer.php index ef8d37b45a..73dcb27082 100644 --- a/extensions/apidoc/templates/bootstrap/Renderer.php +++ b/extensions/apidoc/templates/bootstrap/Renderer.php @@ -70,6 +70,13 @@ class Renderer extends \yii\apidoc\templates\html\Renderer ]); file_put_contents($dir . "/ext_{$ext}_index.html", $indexFileContent); } + $readme = @file_get_contents("https://raw.github.com/yiisoft/yii2-framework/master/README.md"); + $indexFileContent = $this->renderWithLayout($this->indexView, [ + 'docContext' => $context, + 'types' => $this->filterTypes($types, 'yii'), + 'readme' => $readme ?: null, + ]); + file_put_contents($dir . '/index.html', $indexFileContent); $controller->stdout('done.' . PHP_EOL, Console::FG_GREEN); } From a7459c6aa2069aab04a73327df53b4b7952c30ce Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 29 Jan 2014 02:34:59 +0100 Subject: [PATCH 5/6] updated readmes --- README.md | 3 +++ framework/README.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d7020d9058..e6ba00d439 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,9 @@ DOCUMENTATION A draft of the [Definitive Guide](docs/guide/index.md) is available. +API docs and a (quite bad) rendering of the definitive guide are currently +available at http://stuff.cebe.cc/yii2docs/ (updated four times per hour). + For 1.1 users, you may refer to [Upgrading from Yii 1.1](docs/guide/upgrade-from-v1.md) to have a general idea of what has changed in 2.0. diff --git a/framework/README.md b/framework/README.md index 2e397421c7..22af4a42ee 100644 --- a/framework/README.md +++ b/framework/README.md @@ -7,7 +7,7 @@ This is the core framework code of [Yii 2](https://github.com/yiisoft/yii2). Installation ------------ -The preferred way to install this extension is through [composer](http://getcomposer.org/download/). +The preferred way to install the Yii framework is through [composer](http://getcomposer.org/download/). Either run From bad5a1199f6dc9f4b7ad3355bfc14a0d43ba9f84 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 29 Jan 2014 02:38:54 +0100 Subject: [PATCH 6/6] apidoc: static methods do not define properties --- extensions/apidoc/models/Context.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/extensions/apidoc/models/Context.php b/extensions/apidoc/models/Context.php index 5a9e57f33e..168bc01973 100644 --- a/extensions/apidoc/models/Context.php +++ b/extensions/apidoc/models/Context.php @@ -162,6 +162,9 @@ class Context extends Component return; } foreach($class->getPublicMethods() as $name => $method) { + if ($method->isStatic) { + continue; + } if (!strncmp($name, 'get', 3) && $this->paramsOptional($method)) { $propertyName = '$' . lcfirst(substr($method->name, 3)); if (isset($class->properties[$propertyName])) {