eventSummary.php 1.31 KB
Newer Older
1 2
<?php

3
use yii\apidoc\helpers\ApiMarkdown;
4
use yii\apidoc\models\ClassDoc;
5 6
use yii\helpers\ArrayHelper;

7
/**
Carsten Brandt committed
8
 * @var ClassDoc $type
9
 * @var yii\web\View $this
10
 * @var \yii\apidoc\templates\html\ApiRenderer $renderer
11 12
 */

13 14
$renderer = $this->context;

Carsten Brandt committed
15
if (empty($type->events)) {
16
	return;
17 18 19 20
}
$events = $type->events;
ArrayHelper::multisort($events, 'name');
?>
Carsten Brandt committed
21 22
<div class="summary doc-event">
	<h2>Events</h2>
23

Carsten Brandt committed
24
	<p><a href="#" class="toggle">Hide inherited events</a></p>
25

Carsten Brandt committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
	<table class="summary-table table table-striped table-bordered table-hover">
	<colgroup>
		<col class="col-event" />
		<col class="col-type" />
		<col class="col-description" />
		<col class="col-defined" />
	</colgroup>
	<tr>
		<th>Event</th><th>Type</th><th>Description</th><th>Defined By</th>
	</tr>
	<?php foreach ($events as $event): ?>
	<tr<?= $event->definedBy != $type->name ? ' class="inherited"' : '' ?> id="<?= $event->name ?>">
		<td><?= $renderer->createSubjectLink($event) ?></td>
		<td><?= $renderer->createTypeLink($event->types) ?></td>
		<td>
			<?= ApiMarkdown::process($event->shortDescription, $event->definedBy, true) ?>
			<?php if (!empty($event->since)): ?>
				(available since version <?= $event->since ?>)
			<?php endif; ?>
		</td>
		<td><?= $renderer->createTypeLink($event->definedBy) ?></td>
	</tr>
	<?php endforeach; ?>
	</table>
Qiang Xue committed
50
</div>