eventSummary.php 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?php
  2. use yii\apidoc\helpers\ApiMarkdown;
  3. use yii\apidoc\models\ClassDoc;
  4. use yii\helpers\ArrayHelper;
  5. /* @var $type ClassDoc */
  6. /* @var $this yii\web\View */
  7. /* @var $renderer \yii\apidoc\templates\html\ApiRenderer */
  8. $renderer = $this->context;
  9. if (empty($type->events)) {
  10. return;
  11. }
  12. $events = $type->events;
  13. ArrayHelper::multisort($events, 'name');
  14. ?>
  15. <div class="summary doc-event">
  16. <h2>Events</h2>
  17. <p><a href="#" class="toggle">Hide inherited events</a></p>
  18. <table class="summary-table table table-striped table-bordered table-hover">
  19. <colgroup>
  20. <col class="col-event" />
  21. <col class="col-type" />
  22. <col class="col-description" />
  23. <col class="col-defined" />
  24. </colgroup>
  25. <tr>
  26. <th>Event</th><th>Type</th><th>Description</th><th>Defined By</th>
  27. </tr>
  28. <?php foreach ($events as $event): ?>
  29. <tr<?= $event->definedBy != $type->name ? ' class="inherited"' : '' ?> id="<?= $event->name ?>">
  30. <td><?= $renderer->createSubjectLink($event) ?></td>
  31. <td><?= $renderer->createTypeLink($event->types) ?></td>
  32. <td>
  33. <?= ApiMarkdown::process($event->shortDescription, $event->definedBy, true) ?>
  34. <?php if (!empty($event->since)): ?>
  35. (available since version <?= $event->since ?>)
  36. <?php endif; ?>
  37. </td>
  38. <td><?= $renderer->createTypeLink($event->definedBy) ?></td>
  39. </tr>
  40. <?php endforeach; ?>
  41. </table>
  42. </div>