|
|
|
<?php
|
|
|
|
|
|
|
|
use yii\apidoc\helpers\ApiMarkdown;
|
|
|
|
use yii\apidoc\models\ClassDoc;
|
|
|
|
use yii\apidoc\models\TraitDoc;
|
|
|
|
use yii\helpers\ArrayHelper;
|
|
|
|
|
|
|
|
/* @var $type ClassDoc|TraitDoc */
|
|
|
|
/* @var $protected boolean */
|
|
|
|
/* @var $this yii\web\View */
|
|
|
|
/* @var $renderer \yii\apidoc\templates\html\ApiRenderer */
|
|
|
|
|
|
|
|
$renderer = $this->context;
|
|
|
|
|
|
|
|
if ($protected && count($type->getProtectedProperties()) == 0 || !$protected && count($type->getPublicProperties()) == 0) {
|
|
|
|
return;
|
|
|
|
} ?>
|
|
|
|
|
|
|
|
<div class="summary doc-property">
|
|
|
|
<h2><?= $protected ? 'Protected Properties' : 'Public Properties' ?></h2>
|
|
|
|
|
|
|
|
<p><a href="#" class="toggle">Hide inherited properties</a></p>
|
|
|
|
|
|
|
|
<table class="summary-table table table-striped table-bordered table-hover">
|
|
|
|
<colgroup>
|
|
|
|
<col class="col-property" />
|
|
|
|
<col class="col-type" />
|
|
|
|
<col class="col-description" />
|
|
|
|
<col class="col-defined" />
|
|
|
|
</colgroup>
|
|
|
|
<tr>
|
|
|
|
<th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
|
|
|
|
</tr>
|
|
|
|
<?php
|
|
|
|
$properties = $type->properties;
|
|
|
|
ArrayHelper::multisort($properties, 'name');
|
|
|
|
foreach ($properties as $property): ?>
|
|
|
|
<?php if ($protected && $property->visibility == 'protected' || !$protected && $property->visibility != 'protected'): ?>
|
|
|
|
<tr<?= $property->definedBy != $type->name ? ' class="inherited"' : '' ?> id="<?= $property->name ?>">
|
|
|
|
<td><?= $renderer->createSubjectLink($property) ?></td>
|
|
|
|
<td><?= $renderer->createTypeLink($property->types) ?></td>
|
|
|
|
<td><?= ApiMarkdown::process($property->shortDescription, $property->definedBy, true) ?></td>
|
|
|
|
<td><?= $renderer->createTypeLink($property->definedBy) ?></td>
|
|
|
|
</tr>
|
|
|
|
<?php endif; ?>
|
|
|
|
<?php endforeach; ?>
|
|
|
|
</table>
|
|
|
|
</div>
|