PageRenderTime 50ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/xandra.org/www/modules/userguide/views/userguide/api/class.php

https://bitbucket.org/ekkl/tanora
PHP | 124 lines | 114 code | 10 blank | 0 comment | 13 complexity | 6872182bb9a5114940aa5b0eadd68ee6 MD5 | raw file
Possible License(s): GPL-2.0, BSD-3-Clause
  1. <h1>
  2. <?php echo $doc->modifiers, $doc->class->name ?>
  3. <?php foreach ($doc->parents as $parent): ?>
  4. <br/><small>extends <?php echo HTML::anchor($route->uri(array('class' => $parent->name)), $parent->name, NULL, NULL, TRUE) ?></small>
  5. <?php endforeach; ?>
  6. </h1>
  7. <?php if ($interfaces = $doc->class->getInterfaceNames()): ?>
  8. <p class="interfaces"><small>
  9. Implements:
  10. <?php
  11. for ($i = 0, $split = FALSE, $count = count($interfaces); $i < $count; $i++, $split = " | ")
  12. {
  13. echo $split . HTML::anchor($route->uri(array('class' => $interfaces[$i])), $interfaces[$i], NULL, NULL, TRUE);
  14. }
  15. ?></small>
  16. </p>
  17. <?php endif; ?>
  18. <?php if ($child = $doc->is_transparent($doc->class->name)):?>
  19. <p class="note">
  20. This class is a transparent base class for <?php echo HTML::anchor($route->uri(array('class'=>$child)),$child) ?> and
  21. should not be accessed directly.
  22. </p>
  23. <?php endif;?>
  24. <?php echo $doc->description() ?>
  25. <?php if ($doc->tags): ?>
  26. <dl class="tags">
  27. <?php foreach ($doc->tags() as $name => $set): ?>
  28. <dt><?php echo $name ?></dt>
  29. <?php foreach ($set as $tag): ?>
  30. <dd><?php echo $tag ?></dd>
  31. <?php endforeach ?>
  32. <?php endforeach ?>
  33. </dl>
  34. <?php endif; ?>
  35. <p class="note">
  36. <?php if ($path = $doc->class->getFilename()): ?>
  37. Class declared in <tt><?php echo Debug::path($path) ?></tt> on line <?php echo $doc->class->getStartLine() ?>.
  38. <?php else: ?>
  39. Class is not declared in a file, it is probably an internal <?php echo html::anchor('http://php.net/manual/class.'.strtolower($doc->class->name).'.php', 'PHP class') ?>.
  40. <?php endif ?>
  41. </p>
  42. <div class="toc">
  43. <div class="constants">
  44. <h3><?php echo 'Constants'; ?></h3>
  45. <ul>
  46. <?php if ($doc->constants): ?>
  47. <?php foreach ($doc->constants as $name => $value): ?>
  48. <li><a href="#constant:<?php echo $name ?>"><?php echo $name ?></a></li>
  49. <?php endforeach ?>
  50. <?php else: ?>
  51. <li><em><?php echo 'None'; ?></em></li>
  52. <?php endif ?>
  53. </ul>
  54. </div>
  55. <div class="properties">
  56. <h3><?php echo 'Properties'; ?></h3>
  57. <ul>
  58. <?php if ($properties = $doc->properties()): ?>
  59. <?php foreach ($properties as $prop): ?>
  60. <li><a href="#property:<?php echo $prop->property->name ?>">$<?php echo $prop->property->name ?></a></li>
  61. <?php endforeach ?>
  62. <?php else: ?>
  63. <li><em><?php echo 'None'; ?></em></li>
  64. <?php endif ?>
  65. </ul>
  66. </div>
  67. <div class="methods">
  68. <h3><?php echo 'Methods'; ?></h3>
  69. <ul>
  70. <?php if ($methods = $doc->methods()): ?>
  71. <?php foreach ($methods as $method): ?>
  72. <li><a href="#<?php echo $method->method->name ?>"><?php echo $method->method->name ?>()</a></li>
  73. <?php endforeach ?>
  74. <?php else: ?>
  75. <li><em><?php echo 'None'; ?></em></li>
  76. <?php endif ?>
  77. </ul>
  78. </div>
  79. </div>
  80. <div class="clearfix"></div>
  81. <?php if ($doc->constants): ?>
  82. <div class="constants">
  83. <h1 id="constants"><?php echo 'Constants'; ?></h1>
  84. <dl>
  85. <?php foreach ($doc->constants() as $name => $value): ?>
  86. <dt><h4 id="constant:<?php echo $name ?>"><?php echo $name ?></h4></dt>
  87. <dd><?php echo $value ?></dd>
  88. <?php endforeach; ?>
  89. </dl>
  90. </div>
  91. <?php endif ?>
  92. <?php if ($properties = $doc->properties()): ?>
  93. <h1 id="properties"><?php echo 'Properties'; ?></h1>
  94. <div class="properties">
  95. <dl>
  96. <?php foreach ($properties as $prop): ?>
  97. <dt><h4 id="property:<?php echo $prop->property->name ?>"><?php echo $prop->modifiers ?> <code><?php echo $prop->type ?></code> $<?php echo $prop->property->name ?></h4></dt>
  98. <dd><?php echo $prop->description ?></dd>
  99. <dd><?php echo $prop->value ?></dd>
  100. <?php if ($prop->default !== $prop->value): ?>
  101. <dd><small><?php echo __('Default value:') ?></small><br/><?php echo $prop->default ?></dd>
  102. <?php endif ?>
  103. <?php endforeach ?>
  104. </dl>
  105. </div>
  106. <?php endif ?>
  107. <?php if ($methods = $doc->methods()): ?>
  108. <h1 id="methods"><?php echo 'Methods'; ?></h1>
  109. <div class="methods">
  110. <?php foreach ($methods as $method): ?>
  111. <?php echo View::factory('userguide/api/method')->set('doc', $method)->set('route', $route) ?>
  112. <?php endforeach ?>
  113. </div>
  114. <?php endif ?>