From 33b53fa55d9035c8d604759ee2d663c27baa3f5a Mon Sep 17 00:00:00 2001
From: Carsten Brandt <mail@cebe.cc>
Date: Thu, 23 Jan 2014 15:27:35 +0100
Subject: [PATCH] added apidoc template based on twitter bootstrap
issue #1797
---
extensions/apidoc/composer.json | 1 +
extensions/apidoc/templates/bootstrap/Renderer.php | 26 ++++++++++++++++++++++++++
extensions/apidoc/templates/bootstrap/SideNavWidget.php | 178 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
extensions/apidoc/templates/bootstrap/assets/AssetBundle.php | 33 +++++++++++++++++++++++++++++++++
extensions/apidoc/templates/bootstrap/assets/css/api.css | 99 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
extensions/apidoc/templates/bootstrap/assets/css/style.css | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
extensions/apidoc/templates/bootstrap/views/bootstrap.php | 128 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
extensions/apidoc/templates/bootstrap/views/index.php | 32 ++++++++++++++++++++++++++++++++
extensions/apidoc/templates/html/Renderer.php | 7 ++++---
extensions/apidoc/templates/html/views/constSummary.php | 2 +-
extensions/apidoc/templates/html/views/eventDetails.php | 4 ++--
extensions/apidoc/templates/html/views/eventSummary.php | 2 +-
extensions/apidoc/templates/html/views/methodDetails.php | 10 ++++------
extensions/apidoc/templates/html/views/methodSummary.php | 2 +-
extensions/apidoc/templates/html/views/propertyDetails.php | 8 +++-----
extensions/apidoc/templates/html/views/propertySummary.php | 2 +-
extensions/apidoc/templates/html/views/type.php | 2 +-
extensions/apidoc/templates/online/Renderer.php | 8 ++++----
18 files changed, 571 insertions(+), 25 deletions(-)
create mode 100644 extensions/apidoc/templates/bootstrap/Renderer.php
create mode 100644 extensions/apidoc/templates/bootstrap/SideNavWidget.php
create mode 100644 extensions/apidoc/templates/bootstrap/assets/AssetBundle.php
create mode 100644 extensions/apidoc/templates/bootstrap/assets/css/api.css
create mode 100644 extensions/apidoc/templates/bootstrap/assets/css/style.css
create mode 100644 extensions/apidoc/templates/bootstrap/views/bootstrap.php
create mode 100644 extensions/apidoc/templates/bootstrap/views/index.php
diff --git a/extensions/apidoc/composer.json b/extensions/apidoc/composer.json
index e488f84..b5a1c9e 100644
--- a/extensions/apidoc/composer.json
+++ b/extensions/apidoc/composer.json
@@ -20,6 +20,7 @@
"minimum-stability": "dev",
"require": {
"yiisoft/yii2": "*",
+ "yiisoft/yii2-bootstrap": "*",
"phpdocumentor/reflection": "dev-master | >1.0.2"
},
"autoload": {
diff --git a/extensions/apidoc/templates/bootstrap/Renderer.php b/extensions/apidoc/templates/bootstrap/Renderer.php
new file mode 100644
index 0000000..1bb1bf5
--- /dev/null
+++ b/extensions/apidoc/templates/bootstrap/Renderer.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\templates\bootstrap;
+use yii\apidoc\models\Context;
+use yii\console\Controller;
+use Yii;
+use yii\helpers\Console;
+use yii\helpers\FileHelper;
+
+/**
+ *
+ * @author Carsten Brandt <mail@cebe.cc>
+ * @since 2.0
+ */
+class Renderer extends \yii\apidoc\templates\html\Renderer
+{
+ public $layout = '@yii/apidoc/templates/bootstrap/views/bootstrap.php';
+ public $indexView = '@yii/apidoc/templates/bootstrap/views/index.php';
+
+ public $pageTitle = 'Yii Framework 2.0 API Documentation';
+}
\ No newline at end of file
diff --git a/extensions/apidoc/templates/bootstrap/SideNavWidget.php b/extensions/apidoc/templates/bootstrap/SideNavWidget.php
new file mode 100644
index 0000000..2e346a2
--- /dev/null
+++ b/extensions/apidoc/templates/bootstrap/SideNavWidget.php
@@ -0,0 +1,178 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\templates\bootstrap;
+
+use Yii;
+use yii\base\InvalidConfigException;
+use yii\bootstrap\BootstrapAsset;
+use yii\helpers\ArrayHelper;
+use yii\helpers\Html;
+
+/**
+ * Nav renders a nav HTML component.
+ *
+ * For example:
+ *
+ * ```php
+ * echo Nav::widget([
+ * 'items' => [
+ * [
+ * 'label' => 'Home',
+ * 'url' => ['site/index'],
+ * 'linkOptions' => [...],
+ * ],
+ * [
+ * 'label' => 'Dropdown',
+ * 'items' => [
+ * ['label' => 'Level 1 - Dropdown A', 'url' => '#'],
+ * '<li class="divider"></li>',
+ * '<li class="dropdown-header">Dropdown Header</li>',
+ * ['label' => 'Level 1 - Dropdown B', 'url' => '#'],
+ * ],
+ * ],
+ * ],
+ * ]);
+ * ```
+ *
+ * Note: Multilevel dropdowns beyond Level 1 are not supported in Bootstrap 3.
+ *
+ * @see http://getbootstrap.com/components.html#dropdowns
+ * @see http://getbootstrap.com/components/#nav
+ *
+ * @author Antonio Ramirez <amigo.cobos@gmail.com>
+ * @since 2.0
+ */
+class SideNavWidget extends \yii\bootstrap\Widget
+{
+ /**
+ * @var array list of items in the nav widget. Each array element represents a single
+ * menu item which can be either a string or an array with the following structure:
+ *
+ * - label: string, required, the nav item label.
+ * - url: optional, the item's URL. Defaults to "#".
+ * - visible: boolean, optional, whether this menu item is visible. Defaults to true.
+ * - linkOptions: array, optional, the HTML attributes of the item's link.
+ * - options: array, optional, the HTML attributes of the item container (LI).
+ * - active: boolean, optional, whether the item should be on active state or not.
+ * - items: array|string, optional, the configuration array for creating a [[Dropdown]] widget,
+ * or a string representing the dropdown menu. Note that Bootstrap does not support sub-dropdown menus.
+ *
+ * If a menu item is a string, it will be rendered directly without HTML encoding.
+ */
+ public $items = [];
+ /**
+ * @var boolean whether the nav items labels should be HTML-encoded.
+ */
+ public $encodeLabels = true;
+ /**
+ * @var string the route used to determine if a menu item is active or not.
+ * If not set, it will use the route of the current request.
+ * @see params
+ * @see isItemActive
+ */
+ public $activeUrl;
+
+
+ /**
+ * Initializes the widget.
+ */
+ public function init()
+ {
+ parent::init();
+ if (!isset($this->options['class'])) {
+ Html::addCssClass($this->options, 'list-group');
+ }
+ }
+
+ /**
+ * Renders the widget.
+ */
+ public function run()
+ {
+ echo $this->renderItems();
+ BootstrapAsset::register($this->getView());
+ }
+
+ /**
+ * Renders widget items.
+ */
+ public function renderItems()
+ {
+ $items = [];
+ foreach ($this->items as $i => $item) {
+ if (isset($item['visible']) && !$item['visible']) {
+ unset($items[$i]);
+ continue;
+ }
+ $items[] = $this->renderItem($item);
+ }
+
+ return Html::tag('div', implode("\n", $items), $this->options);
+ }
+
+ /**
+ * Renders a widget's item.
+ * @param string|array $item the item to render.
+ * @return string the rendering result.
+ * @throws InvalidConfigException
+ */
+ public function renderItem($item)
+ {
+ if (is_string($item)) {
+ return $item;
+ }
+ if (!isset($item['label'])) {
+ throw new InvalidConfigException("The 'label' option is required.");
+ }
+
+ $label = $this->encodeLabels ? Html::encode($item['label']) : $item['label'];
+// $options = ArrayHelper::getValue($item, 'options', []);
+ $items = ArrayHelper::getValue($item, 'items');
+ $url = Html::url(ArrayHelper::getValue($item, 'url', '#'));
+ $linkOptions = ArrayHelper::getValue($item, 'linkOptions', []);
+ Html::addCssClass($linkOptions, 'list-group-item');
+
+ if (isset($item['active'])) {
+ $active = ArrayHelper::remove($item, 'active', false);
+ } else {
+ $active = ($url == $this->activeUrl);
+ }
+
+ if ($items !== null) {
+ $linkOptions['data-toggle'] = 'collapse';
+ $linkOptions['data-parent'] = '#' . $this->id;
+ $id = $this->id . '-' . static::$counter++;
+ $url = '#' . $id;
+ $label .= ' ' . Html::tag('b', '', ['class' => 'caret']);
+ if (is_array($items)) {
+ if ($active === false) {
+ foreach($items as $subItem) {
+ if (isset($subItem['active']) && $subItem['active']) {
+ $active = true;
+ }
+ }
+ }
+ $items = static::widget([
+ 'id' => $id,
+ 'items' => $items,
+ 'encodeLabels' => $this->encodeLabels,
+ 'view' => $this->getView(),
+ 'options' => [
+ 'class' => "submenu panel-collapse collapse" . ($active ? ' in' : '')
+ ]
+ ]);
+ }
+ }
+
+ if ($active) {
+ Html::addCssClass($linkOptions, 'active');
+ }
+
+ return Html::a($label, $url, $linkOptions) . $items;
+ }
+}
diff --git a/extensions/apidoc/templates/bootstrap/assets/AssetBundle.php b/extensions/apidoc/templates/bootstrap/assets/AssetBundle.php
new file mode 100644
index 0000000..0aef5eb
--- /dev/null
+++ b/extensions/apidoc/templates/bootstrap/assets/AssetBundle.php
@@ -0,0 +1,33 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\templates\bootstrap\assets;
+use yii\web\JqueryAsset;
+use yii\web\View;
+
+/**
+ * The asset bundle for the offline template.
+ *
+ * @author Carsten Brandt <mail@cebe.cc>
+ * @since 2.0
+ */
+class AssetBundle extends \yii\web\AssetBundle
+{
+ public $sourcePath = '@yii/apidoc/templates/bootstrap/assets/css';
+ public $css = [
+// 'api.css',
+ 'style.css',
+ ];
+ public $depends = [
+ 'yii\web\JqueryAsset',
+ 'yii\bootstrap\BootstrapAsset',
+ 'yii\bootstrap\BootstrapPluginAsset',
+ ];
+ public $jsOptions = [
+ 'position' => View::POS_HEAD,
+ ];
+}
diff --git a/extensions/apidoc/templates/bootstrap/assets/css/api.css b/extensions/apidoc/templates/bootstrap/assets/css/api.css
new file mode 100644
index 0000000..a3f53ec
--- /dev/null
+++ b/extensions/apidoc/templates/bootstrap/assets/css/api.css
@@ -0,0 +1,99 @@
+pre {
+ color: #000000;
+ background-color: #FFF5E6;
+ font-family: "courier new", "times new roman", monospace;
+ line-height: 1.3em;
+ /* Put a nice border around it. */
+ padding: 1px;
+ width: 90%;
+ /* Don't wrap its contents, and show scrollbars. */
+ /* white-space: nowrap;*/
+ overflow: auto;
+ /* Stop after about 24 lines, and just show a scrollbar. */
+ /* max-height: 24em; */
+ margin: 5px;
+ padding-left: 20px;
+ border: 1px solid #FFE6BF;
+ border-left: 6px solid #FFE6BF;
+}
+
+code {
+ color: #000000;
+ background-color: #FFF5E6;
+ padding: 1px;
+}
+
+div.code {
+ display: none;
+ color: #000000;
+ background-color: #FFF5E6;
+ font-family: "courier new", "times new roman", monospace;
+ line-height: 1.3em;
+ /* Put a nice border around it. */
+ padding: 1px;
+ width: 90%;
+ /* Don't wrap its contents, and show scrollbars. */
+ /* white-space: nowrap;*/
+ overflow: auto;
+ /* Stop after about 24 lines, and just show a scrollbar. */
+ /* max-height: 24em; */
+ margin: 5px;
+ padding-left: 20px;
+ border-left: 6px solid #FFE6BF;
+}
+
+table.summaryTable {
+ background: #E6ECFF;
+ border-collapse: collapse;
+ width: 100%;
+}
+
+table.summaryTable th, table.summaryTable td {
+ border: 1px #BFCFFF solid;
+ padding: 0.2em;
+}
+
+table.summaryTable th {
+ background: #CCD9FF;
+ text-align: left;
+}
+
+#nav {
+ padding: 3px;
+ margin: 0 0 10px 0;
+ border-top: 1px #BFCFFF solid;
+}
+
+#classDescription {
+ padding: 5px;
+ margin: 10px 0 20px 0;
+ border-bottom: 1px solid #BFCFFF;
+}
+
+.detailHeader {
+ font-weight: bold;
+ font-size: 12pt;
+ margin: 30px 0 5px 0;
+ border-bottom: 1px solid #BFCFFF;
+}
+
+.detailHeaderTag {
+ font-weight: normal;
+ font-size: 10pt;
+}
+
+
+.paramNameCol {
+ width: 12%;
+ font-weight: bold;
+}
+
+.paramTypeCol {
+ width: 12%;
+}
+
+.sourceCode {
+ margin: 5px 0;
+ padding:5px;
+ background:#FFF5E6;
+}
\ No newline at end of file
diff --git a/extensions/apidoc/templates/bootstrap/assets/css/style.css b/extensions/apidoc/templates/bootstrap/assets/css/style.css
new file mode 100644
index 0000000..57e3de9
--- /dev/null
+++ b/extensions/apidoc/templates/bootstrap/assets/css/style.css
@@ -0,0 +1,52 @@
+html,
+body {
+ height: 100%;
+}
+
+.wrap {
+ min-height: 100%;
+ height: auto;
+ width: auto;
+ margin: 60px 30px 0 30px;
+ padding: 0;
+}
+
+.footer {
+ height: 60px;
+ background-color: #f5f5f5;
+ border-top: 1px solid #ddd;
+ padding: 20px 30px;
+}
+
+#navigation {
+ margin-top: 20px;
+}
+
+.submenu a {
+ background: #f5f5f5;
+ border-radius: 0;
+}
+
+.submenu a:hover, .submenu a:active,
+.submenu a.active, .submenu a.active:hover, .submenu a.active:active {
+ background: #44b5f6;
+ border-color: #44b5f6;
+ border-radius: 0;
+ color: #fff;
+}
+
+.signature, .signature2 {
+ padding: 3px;
+ color: #000000;
+ font-family: "courier new", "times new roman", monospace;
+ line-height: 1.3em;
+ white-space: pre-line;
+ word-wrap: break-word;
+ word-break: break-all;
+}
+
+.signature {
+ margin: 10px 0 10px 0;
+ background: #E6ECFF;
+ border: 1px #BFCFFF solid;
+}
diff --git a/extensions/apidoc/templates/bootstrap/views/bootstrap.php b/extensions/apidoc/templates/bootstrap/views/bootstrap.php
new file mode 100644
index 0000000..8e2c0d6
--- /dev/null
+++ b/extensions/apidoc/templates/bootstrap/views/bootstrap.php
@@ -0,0 +1,128 @@
+<?php
+use yii\apidoc\templates\bootstrap\SideNavWidget;
+use yii\bootstrap\Nav;
+use yii\bootstrap\NavBar;
+use yii\helpers\Html;
+use yii\helpers\StringHelper;
+use yii\widgets\Menu;
+
+/**
+ * @var yii\web\View $this
+ */
+
+\yii\apidoc\templates\bootstrap\assets\AssetBundle::register($this);
+
+$this->beginPage();
+?>
+<!DOCTYPE html>
+<html lang="<?= Yii::$app->language ?>">
+<head>
+ <meta charset="<?= Yii::$app->charset ?>"/>
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <meta name="language" content="en" />
+ <?php $this->head() ?>
+ <title><?= Html::encode($this->context->pageTitle) ?></title>
+</head>
+<body>
+
+<?php $this->beginBody() ?>
+<div class="wrap">
+ <?php
+ NavBar::begin([
+ 'brandLabel' => $this->context->pageTitle,
+ 'brandUrl' => './index.html',
+ 'options' => [
+ 'class' => 'navbar-inverse navbar-fixed-top',
+ ],
+ 'padded' => false,
+ 'view' => $this,
+ ]);
+ echo Nav::widget([
+ 'options' => ['class' => 'navbar-nav'],
+ 'items' => [
+ ['label' => 'Class reference', 'url' => './index.html'],
+// ['label' => 'Application API', 'url' => '/site/about'],
+// ['label' => 'Guide', 'url' => './guide_index.html'],
+ ],
+ 'view' => $this,
+ ]);
+ NavBar::end();
+ ?>
+<!-- <div class="container">-->
+ <div class="row">
+ <div class="col-md-2">
+ <?php
+ ksort($types);
+ $nav = [];
+ foreach($types as $i=>$class) {
+ $namespace = $class->namespace;
+ if (empty($namespace)) {
+ $namespace = 'Not namespaced classes';
+ }
+ if (!isset($nav[$namespace])) {
+ $nav[$namespace] = [
+ 'label' => $namespace,
+ 'url' => '#',
+ 'items' => [],
+ ];
+ }
+ $nav[$namespace]['items'][] = [
+ 'label' => StringHelper::basename($class->name),
+ 'url' => './' . $this->context->generateUrl($class->name),
+ 'active' => isset($type) && ($class->name == $type->name),
+ ];
+ } ?>
+ <?= SideNavWidget::widget([
+ 'id' => 'navigation',
+ 'items' => $nav,
+ // 'route' => 'wtf',
+ 'view' => $this,
+ ])?>
+ </div>
+ <div class="col-md-9" role="main">
+ <?= $content ?>
+ </div>
+ </div>
+<!-- </div>-->
+
+</div>
+
+<footer class="footer">
+ <?php /* <p class="pull-left">© My Company <?= date('Y') ?></p> */ ?>
+ <p class="pull-right"><?= Yii::powered() ?></p>
+</footer>
+
+<script type="text/javascript">
+ /*<![CDATA[*/
+ $("a.toggle").on('click', function() {
+ var $this = $(this);
+ if ($this.hasClass('properties-hidden')) {
+ $this.text($this.text().replace(/Show/,'Hide'));
+ $this.parents(".summary").find(".inherited").show();
+ $this.removeClass('properties-hidden');
+ } else {
+ $this.text($this.text().replace(/Hide/,'Show'));
+ $this.parents(".summary").find(".inherited").hide();
+ $this.addClass('properties-hidden');
+ }
+ return false;
+ });
+ /*
+ $(".sourceCode a.show").toggle(function(){
+ $(this).text($(this).text().replace(/show/,'hide'));
+ $(this).parents(".sourceCode").find("div.code").show();
+ },function(){
+ $(this).text($(this).text().replace(/hide/,'show'));
+ $(this).parents(".sourceCode").find("div.code").hide();
+ });
+ $("a.sourceLink").click(function(){
+ $(this).attr('target','_blank');
+ });
+ */
+ /*]]>*/
+</script>
+
+<?php $this->endBody() ?>
+</body>
+</html>
+<?php $this->endPage() ?>
\ No newline at end of file
diff --git a/extensions/apidoc/templates/bootstrap/views/index.php b/extensions/apidoc/templates/bootstrap/views/index.php
new file mode 100644
index 0000000..a8b29fc
--- /dev/null
+++ b/extensions/apidoc/templates/bootstrap/views/index.php
@@ -0,0 +1,32 @@
+<?php
+
+use yii\apidoc\models\ClassDoc;
+use yii\apidoc\models\InterfaceDoc;
+use yii\apidoc\models\TraitDoc;
+/**
+ * @var ClassDoc[]|InterfaceDoc[]|TraitDoc[] $types
+ * @var yii\web\View $this
+ */
+
+?><h1>Class Reference</h1>
+
+<table class="summaryTable docIndex table table-bordered table-striped table-hover">
+ <colgroup>
+ <col class="col-package" />
+ <col class="col-class" />
+ <col class="col-description" />
+ </colgroup>
+ <tr>
+ <th>Class</th>
+ <th>Description</th>
+ </tr>
+<?php
+ksort($types);
+foreach($types as $i=>$class):
+?>
+ <tr>
+ <td><?= $this->context->typeLink($class, $class->name) ?></td>
+ <td><?= \yii\apidoc\helpers\Markdown::process($class->shortDescription, $class) ?></td>
+ </tr>
+<?php endforeach; ?>
+</table>
diff --git a/extensions/apidoc/templates/html/Renderer.php b/extensions/apidoc/templates/html/Renderer.php
index df7d18e..4cca122 100644
--- a/extensions/apidoc/templates/html/Renderer.php
+++ b/extensions/apidoc/templates/html/Renderer.php
@@ -107,6 +107,7 @@ abstract class Renderer extends BaseRenderer implements ViewContextInterface
$fileContent = $this->renderWithLayout($this->typeView, [
'type' => $type,
'docContext' => $context,
+ 'types' => $types,
]);
file_put_contents($dir . '/' . $this->generateFileName($type->name), $fileContent);
Console::updateProgress(++$done, $typeCount);
@@ -166,7 +167,7 @@ abstract class Renderer extends BaseRenderer implements ViewContextInterface
$links[] = Html::a(
$type->name,
null,
- ['href' => $this->generateLink($type->name)]
+ ['href' => $this->generateUrl($type->name)]
) . $postfix;
}
}
@@ -191,7 +192,7 @@ abstract class Renderer extends BaseRenderer implements ViewContextInterface
if (($type = $this->context->getType($subject->definedBy)) === null) {
return $subject->name;
} else {
- $link = $this->generateLink($type->name);
+ $link = $this->generateUrl($type->name);
if ($subject instanceof MethodDoc) {
$link .= '#' . $subject->name . '()';
} else {
@@ -336,7 +337,7 @@ abstract class Renderer extends BaseRenderer implements ViewContextInterface
. ' )';
}
- protected function generateLink($typeName)
+ public function generateUrl($typeName)
{
return $this->generateFileName($typeName);
}
diff --git a/extensions/apidoc/templates/html/views/constSummary.php b/extensions/apidoc/templates/html/views/constSummary.php
index b7d5516..56200a6 100644
--- a/extensions/apidoc/templates/html/views/constSummary.php
+++ b/extensions/apidoc/templates/html/views/constSummary.php
@@ -15,7 +15,7 @@ if (empty($type->constants)) {
<p><a href="#" class="toggle">Hide inherited constants</a></p>
-<table class="summaryTable">
+<table class="summaryTable table table-striped table-bordered table-hover">
<colgroup>
<col class="col-const" />
<col class="col-description" />
diff --git a/extensions/apidoc/templates/html/views/eventDetails.php b/extensions/apidoc/templates/html/views/eventDetails.php
index a5b3091..b869122 100644
--- a/extensions/apidoc/templates/html/views/eventDetails.php
+++ b/extensions/apidoc/templates/html/views/eventDetails.php
@@ -13,9 +13,9 @@ if (empty($events)) {
} ?>
<h2>Event Details</h2>
<?php foreach($events as $event): ?>
- <div class="detailHeader" id="<?= $event->name.'-detail' ?>">
+ <div class="detailHeader h3" id="<?= $event->name.'-detail' ?>">
<?php echo $event->name; ?>
- <span class="detailHeaderTag">
+ <span class="detailHeaderTag small">
event
<?php if(!empty($event->since)): ?>
(available since version <?= $event->since ?>)
diff --git a/extensions/apidoc/templates/html/views/eventSummary.php b/extensions/apidoc/templates/html/views/eventSummary.php
index 0c179b6..956ca43 100644
--- a/extensions/apidoc/templates/html/views/eventSummary.php
+++ b/extensions/apidoc/templates/html/views/eventSummary.php
@@ -15,7 +15,7 @@ if (empty($type->events)) {
<p><a href="#" class="toggle">Hide inherited events</a></p>
-<table class="summaryTable">
+<table class="summaryTable table table-striped table-bordered table-hover">
<colgroup>
<col class="col-event" />
<col class="col-description" />
diff --git a/extensions/apidoc/templates/html/views/methodDetails.php b/extensions/apidoc/templates/html/views/methodDetails.php
index 5501133..0eb7a4b 100644
--- a/extensions/apidoc/templates/html/views/methodDetails.php
+++ b/extensions/apidoc/templates/html/views/methodDetails.php
@@ -16,9 +16,9 @@ if (empty($methods)) {
<?php foreach($methods as $method): ?>
- <div class="detailHeader" id="<?= $method->name . '()-detail' ?>">
+ <div class="detailHeader h3" id="<?= $method->name . '()-detail' ?>">
<?= $method->name ?>()
- <span class="detailHeaderTag">
+ <span class="detailHeaderTag small">
method
<?php if (!empty($method->since)): ?>
(available since version <?php echo $method->since; ?>)
@@ -26,11 +26,9 @@ if (empty($methods)) {
</span>
</div>
- <table class="summaryTable">
+ <table class="summaryTable table table-striped table-bordered table-hover">
<tr><td colspan="3">
- <div class="signature2">
- <?= $this->context->renderMethodSignature($method) ?>
- </div>
+ <div class="signature2"><?= $this->context->renderMethodSignature($method) ?></div>
</td></tr>
<?php if(!empty($method->params) || !empty($method->return) || !empty($method->exceptions)): ?>
<?php foreach($method->params as $param): ?>
diff --git a/extensions/apidoc/templates/html/views/methodSummary.php b/extensions/apidoc/templates/html/views/methodSummary.php
index c3ca6d5..3791b00 100644
--- a/extensions/apidoc/templates/html/views/methodSummary.php
+++ b/extensions/apidoc/templates/html/views/methodSummary.php
@@ -19,7 +19,7 @@ if ($protected && count($type->getProtectedMethods()) == 0 || !$protected && cou
<p><a href="#" class="toggle">Hide inherited methods</a></p>
-<table class="summaryTable">
+<table class="summaryTable table table-striped table-bordered table-hover">
<colgroup>
<col class="col-method" />
<col class="col-description" />
diff --git a/extensions/apidoc/templates/html/views/propertyDetails.php b/extensions/apidoc/templates/html/views/propertyDetails.php
index 628f9bd..ab0afb3 100644
--- a/extensions/apidoc/templates/html/views/propertyDetails.php
+++ b/extensions/apidoc/templates/html/views/propertyDetails.php
@@ -16,9 +16,9 @@ if (empty($properties)) {
<?php foreach($properties as $property): ?>
- <div class="detailHeader" id="<?= $property->name.'-detail' ?>">
+ <div class="detailHeader h3" id="<?= $property->name.'-detail' ?>">
<?php echo $property->name; ?>
- <span class="detailHeaderTag">
+ <span class="detailHeaderTag small">
property
<?php if($property->getIsReadOnly()) echo ' <em>read-only</em> '; ?>
<?php if($property->getIsWriteOnly()) echo ' <em>write-only</em> '; ?>
@@ -28,9 +28,7 @@ if (empty($properties)) {
</span>
</div>
- <div class="signature">
- <?php echo $this->context->renderPropertySignature($property); ?>
- </div>
+ <div class="signature"><?php echo $this->context->renderPropertySignature($property); ?></div>
<p><?= Markdown::process($property->description, $type) ?></p>
diff --git a/extensions/apidoc/templates/html/views/propertySummary.php b/extensions/apidoc/templates/html/views/propertySummary.php
index 3730431..99bd09d 100644
--- a/extensions/apidoc/templates/html/views/propertySummary.php
+++ b/extensions/apidoc/templates/html/views/propertySummary.php
@@ -18,7 +18,7 @@ if ($protected && count($type->getProtectedProperties()) == 0 || !$protected &&
<p><a href="#" class="toggle">Hide inherited properties</a></p>
-<table class="summaryTable">
+<table class="summaryTable table table-striped table-bordered table-hover">
<colgroup>
<col class="col-property" />
<col class="col-type" />
diff --git a/extensions/apidoc/templates/html/views/type.php b/extensions/apidoc/templates/html/views/type.php
index 64de2d1..d4721b5 100644
--- a/extensions/apidoc/templates/html/views/type.php
+++ b/extensions/apidoc/templates/html/views/type.php
@@ -44,7 +44,7 @@ $renderer = $this->context;
<?php endif; ?>
</div>
-<table class="summaryTable docClass">
+<table class="summaryTable docClass table table-bordered">
<colgroup>
<col class="col-name" />
<col class="col-value" />
diff --git a/extensions/apidoc/templates/online/Renderer.php b/extensions/apidoc/templates/online/Renderer.php
index cc599e1..3e38444 100644
--- a/extensions/apidoc/templates/online/Renderer.php
+++ b/extensions/apidoc/templates/online/Renderer.php
@@ -21,8 +21,8 @@ use yii\helpers\StringHelper;
*/
class Renderer extends \yii\apidoc\templates\html\Renderer
{
- public $layout = false;//'@yii/apidoc/templates/offline/views/offline.php';
- public $indexView = '@yii/apidoc/templates/offline/views/index.php';
+ public $layout = false;
+ public $indexView = '@yii/apidoc/templates/online/views/index.php';
public $pageTitle = 'Yii Framework 2.0 API Documentation';
@@ -56,13 +56,13 @@ class Renderer extends \yii\apidoc\templates\html\Renderer
$controller->stdout('done.' . PHP_EOL, Console::FG_GREEN);
}
- protected function generateLink($typeName)
+ protected function generateUrl($typeName)
{
return strtolower(str_replace('\\', '-', $typeName));
}
protected function generateFileName($typeName)
{
- return $this->generateLink($typeName) . '.html';
+ return $this->generateUrl($typeName) . '.html';
}
}
\ No newline at end of file
--
libgit2 0.27.1