eventSummary.php 1.26 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');
?>
21 22 23 24 25
<div class="summary docEvent">
<h2>Events</h2>

<p><a href="#" class="toggle">Hide inherited events</a></p>

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