eventSummary.php 1.18 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 10 11
 * @var yii\web\View $this
 */

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

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

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