eventDetails.php 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  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. $events = $type->getNativeEvents();
  10. if (empty($events)) {
  11. return;
  12. }
  13. ArrayHelper::multisort($events, 'name');
  14. ?>
  15. <h2>Event Details</h2>
  16. <div class="event-doc">
  17. <?php foreach ($events as $event): ?>
  18. <div class="detail-header h3" id="<?= $event->name.'-detail' ?>">
  19. <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
  20. <?= $renderer->createSubjectLink($event, '<span class="glyphicon icon-hash"></span>', [
  21. 'title' => 'direct link to this method',
  22. 'class' => 'tool-link hash',
  23. ]) ?>
  24. <?php if (($sourceUrl = $renderer->getSourceUrl($event->definedBy, $event->startLine)) !== null): ?>
  25. <a href="<?= str_replace('/blob/', '/edit/', $sourceUrl) ?>" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
  26. <a href="<?= $sourceUrl ?>" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
  27. <?php endif; ?>
  28. <?= $event->name ?>
  29. <span class="detail-header-tag small">
  30. event
  31. of type <?= $renderer->createTypeLink($event->types) ?>
  32. <?php if (!empty($event->since)): ?>
  33. (available since version <?= $event->since ?>)
  34. <?php endif; ?>
  35. </span>
  36. </div>
  37. <?php if (!empty($event->deprecatedSince) || !empty($event->deprecatedReason)): ?>
  38. <div class="doc-description deprecated">
  39. <strong>Deprecated <?php
  40. if (!empty($event->deprecatedSince)) { echo 'since version ' . $event->deprecatedSince . ': '; }
  41. if (!empty($event->deprecatedReason)) { echo ApiMarkdown::process($event->deprecatedReason, $type, true); }
  42. ?></strong>
  43. </div>
  44. <?php endif; ?>
  45. <div class="doc-description">
  46. <?= ApiMarkdown::process($event->description, $type) ?>
  47. <?= $this->render('seeAlso', ['object' => $event]) ?>
  48. </div>
  49. <?php endforeach; ?>
  50. </div>