propertyDetails.php 1.16 KB
Newer Older
1 2
<?php

3
use yii\apidoc\helpers\ApiMarkdown;
4 5
use yii\apidoc\models\ClassDoc;
use yii\apidoc\models\TraitDoc;
6 7
use yii\helpers\ArrayHelper;

8 9 10
/**
 * @var ClassDoc|TraitDoc $type
 * @var yii\web\View $this
11
 * @var \yii\apidoc\templates\html\ApiRenderer $renderer
12 13
 */

14 15
$renderer = $this->context;

16 17 18
$properties = $type->getNativeProperties();
if (empty($properties)) {
	return;
19 20 21
}
ArrayHelper::multisort($properties, 'name');
?>
22 23
<h2>Property Details</h2>

Alexander Mohorev committed
24
<?php foreach ($properties as $property): ?>
25

26
	<div class="detailHeader h3" id="<?= $property->name.'-detail' ?>">
Qiang Xue committed
27
		<?= $property->name ?>
28
		<span class="detailHeaderTag small">
29
			<?= $property->visibility ?>
30 31
			<?php if ($property->getIsReadOnly()) echo ' <em>read-only</em> '; ?>
			<?php if ($property->getIsWriteOnly()) echo ' <em>write-only</em> '; ?>
32
			property
33
			<?php if (!empty($property->since)): ?>
Alexander Mohorev committed
34
				(available since version <?= $property->since ?>)
35 36 37 38
			<?php endif; ?>
		</span>
	</div>

39
	<div class="signature"><?php echo $renderer->renderPropertySignature($property); ?></div>
40

41
	<?= ApiMarkdown::process($property->description, $type) ?>
42 43 44 45

	<?= $this->render('seeAlso', ['object' => $property]); ?>

<?php endforeach; ?>