summaryrefslogtreecommitdiff
path: root/buildscripts/apigen/pradosoft/class.latte
diff options
context:
space:
mode:
Diffstat (limited to 'buildscripts/apigen/pradosoft/class.latte')
-rw-r--r--buildscripts/apigen/pradosoft/class.latte149
1 files changed, 76 insertions, 73 deletions
diff --git a/buildscripts/apigen/pradosoft/class.latte b/buildscripts/apigen/pradosoft/class.latte
index 36b3804c..4555d79d 100644
--- a/buildscripts/apigen/pradosoft/class.latte
+++ b/buildscripts/apigen/pradosoft/class.latte
@@ -1,26 +1,16 @@
-{*
-ApiGen 2.8.0 - API documentation generator for PHP 5.3+
-
-Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com)
-Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich)
-Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville)
-
-For the full copyright and license information, please view
-the file LICENSE.md that was distributed with this source code.
-*}
{layout '@layout.latte'}
{var $active = 'class'}
-{block #title}{if $class->deprecated}Deprecated {/if}{if $class->interface}Interface{elseif $class->trait}Trait{else}Class{/if} {$class->name}{/block}
+{block title}{if $class->deprecated}Deprecated {/if}{if $class->interface}Interface{elseif $class->trait}Trait{else}Class{/if} {$class->name}{/block}
-{block #content}
+{block content}
<div id="content" class="class">
<h1 n:class="$class->deprecated ? deprecated">{if $class->interface}Interface{elseif $class->trait}Trait{else}Class{/if} {$class->shortName}</h1>
{if $class->valid}
<div class="description" n:if="$template->longDescription($class)">
- {!$class|longDescription}
+ {$class|longDescription|noescape}
</div>
<dl class="tree" n:if="$class->parentClass || $class->ownInterfaces || $class->ownTraits">
@@ -35,12 +25,17 @@ the file LICENSE.md that was distributed with this source code.
{/foreach}{/if}
{var $itemOwnTraits = $item->ownTraits}
{if $itemOwnTraits} uses {foreach $itemOwnTraits as $trait}
- <a href="{$trait|classUrl}" n:tag-if="$trait->documented"><span n:class="$trait->deprecated ? deprecated, !$trait->valid ? invalid">{$trait->name}</span></a>{sep}, {/sep}
+ {if is_string($trait)}
+ {$trait} (not available)
+
+ {else}
+ <a href="{$trait|classUrl}" n:tag-if="$trait->documented"><span n:class="$trait->deprecated ? deprecated, !$trait->valid ? invalid">{$trait->name}</span></a>{sep}, {/sep}
+ {/}
{/foreach}{/if}
</dd>
</dl>
- {define #children}
+ {define children}
{foreach $children as $child}
<a href="{$child|classUrl}" n:tag-if="$child->documented"><span n:tag-if="$child->deprecated" class="deprecated">{$child->name}</span></a>{sep}, {/sep}
{/foreach}
@@ -48,59 +43,65 @@ the file LICENSE.md that was distributed with this source code.
<div n:if="$directSubClasses">
<h4>Direct known subclasses</h4>
- {include #children, children => $directSubClasses}
+ {include children, children => $directSubClasses}
</div>
<div n:if="$indirectSubClasses">
<h4>Indirect known subclasses</h4>
- {include #children, children => $indirectSubClasses}
+ {include children, children => $indirectSubClasses}
</div>
<div n:if="$directImplementers">
<h4>Direct known implementers</h4>
- {include #children, children => $directImplementers}
+ {include children, children => $directImplementers}
</div>
<div n:if="$indirectImplementers">
<h4>Indirect known implementers</h4>
- {include #children, children => $indirectImplementers}
+ {include children, children => $indirectImplementers}
</div>
<div n:if="$directUsers">
<h4>Direct Known Users</h4>
- {include #children, children => $directUsers}
+ {include children, children => $directUsers}
</div>
<div n:if="$indirectUsers">
<h4>Indirect Known Users</h4>
- {include #children, children => $indirectUsers}
+ {include children, children => $indirectUsers}
</div>
<div class="info">
{if !$class->interface && !$class->trait && ($class->abstract || $class->final)}<b>{if $class->abstract}Abstract{else}Final{/if}</b><br>{/if}
{if $class->internal}<b>PHP Extension:</b> <a href="{$class->extension|manualUrl}" title="Go to PHP documentation">{$class->extension->name|firstUpper}</a><br>{/if}
- {if $class->inNamespace()}<b>Namespace:</b> {!$class->namespaceName|namespaceLinks}<br>{/if}
- {if $class->inPackage()}<b>Package:</b> {!$class->packageName|packageLinks}<br>{/if}
+ {if $class->inNamespace()}<b>Namespace:</b> {$class->namespaceName|namespaceLinks|noescape}<br>{/if}
+ {if $class->inPackage()}<b>Package:</b> {$class->packageName|packageLinks|noescape}<br>{/if}
{foreach $template->annotationSort($template->annotationFilter($class->annotations)) as $annotation => $values}
{foreach $values as $value}
<b>{$annotation|annotationBeautify}{if $value}:{/if}</b>
- {!$value|annotation:$annotation:$class}<br>
+ {$value|annotation:$annotation:$class|noescape}<br>
{/foreach}
{/foreach}
- {if $class->internal}<b>Documented at</b> <a href="{$class|manualUrl}" title="Go to PHP documentation">php.net</a>{else}<b>Located at</b> <a n:tag-if="$config->sourceCode" href="{$class|sourceUrl}" title="Go to source code">{$class->fileName|relativePath}</a>{/if}<br>
+ {if $class->internal}
+ <b>Documented at</b> <a href="{$class|manualUrl}" title="Go to PHP documentation">php.net</a>
+ {else}
+ <b>Located at</b> <a n:tag-if="$config->sourceCode" href="{$class|sourceUrl}" title="Go to source code">{$class->fileName|relativePath}</a>
+ {/if}
+ <br>
</div>
{var $ownMethods = $class->ownMethods}
{var $ownMagicMethods = $class->ownMagicMethods}
- {define #method}
- <tr data-order="{$method->name}" id="{if $method->magic}m{/if}_{$method->name}">
+ {define method}
+ <tr data-order="{$method->name}" id="{if $method->magic}m{/if}_{$method->name}" n:class="$method->deprecated ? deprecated">
{var $annotations = $method->annotations}
<td class="attributes"><code>
{if !$class->interface && $method->abstract}abstract{elseif $method->final}final{/if} {if $method->protected}protected{elseif $method->private}private{else}public{/if} {if $method->static}static{/if}
- {ifset $annotations['return']}{!$annotations['return'][0]|typeLinks:$method}{/ifset}
+
+ {ifset $annotations['return']}{$annotations['return'][0]|typeLinks:$method|noescape}{/ifset}
{if $method->returnsReference()}&amp;{/if}
</code>
</td>
@@ -114,19 +115,19 @@ the file LICENSE.md that was distributed with this source code.
<a n:tag-if="$config->sourceCode" href="{$method|sourceUrl}" title="Go to source code">{$method->name}</a>(
{/if}
{foreach $method->parameters as $parameter}
- <span>{!$parameter->typeHint|typeLinks:$method}
- <var>{if $parameter->passedByReference}&amp; {/if}${$parameter->name}</var>{if $parameter->defaultValueAvailable} = {!$parameter->defaultValueDefinition|highlightPHP:$class}{elseif $parameter->unlimited},…{/if}</span>{sep}, {/sep}
+ <span>{$parameter->typeHint|typeLinks:$method|noescape}
+ <var>{if $parameter->passedByReference}&amp; {/if}${$parameter->name}</var>{if $parameter->defaultValueAvailable} = {$parameter->defaultValueDefinition|highlightPHP:$class|noescape}{elseif $parameter->unlimited},…{/if}</span>{sep}, {/sep}
{/foreach}
){/block}</code>
{if $config->template['options']['elementDetailsCollapsed']}
<div class="description short">
- {!$method|shortDescription:true}
+ {$method|shortDescription:true|noescape}
</div>
{/if}
<div n:class="description, detailed, $config->template['options']['elementDetailsCollapsed'] ? hidden">
- {!$method|longDescription}
+ {$method|longDescription|noescape}
{if !$class->deprecated && $method->deprecated}
<h4>Deprecated</h4>
@@ -134,7 +135,7 @@ the file LICENSE.md that was distributed with this source code.
<div class="list">
{foreach $annotations['deprecated'] as $description}
{if $description}
- {!$description|annotation:'deprecated':$method}<br>
+ {$description|annotation:'deprecated':$method|noescape}<br>
{/if}
{/foreach}
</div>
@@ -146,7 +147,7 @@ the file LICENSE.md that was distributed with this source code.
<div class="list"><dl>
{foreach $method->parameters as $parameter}
<dt><var>${$parameter->name}</var>{if $parameter->unlimited},…{/if}</dt>
- <dd>{ifset $annotations['param'][$parameter->position]}{!$annotations['param'][$parameter->position]|annotation:'param':$method}{/ifset}</dd>
+ <dd>{$parameter->description|description:$method|noescape}</dd>
{/foreach}
</dl></div>
{/if}
@@ -155,7 +156,7 @@ the file LICENSE.md that was distributed with this source code.
<h4>Returns</h4>
<div class="list">
{foreach $annotations['return'] as $description}
- {!$description|annotation:'return':$method}<br>
+ {$description|annotation:'return':$method|noescape}{sep}<br>{/}
{/foreach}
</div>
{/if}
@@ -164,7 +165,7 @@ the file LICENSE.md that was distributed with this source code.
<h4>Throws</h4>
<div class="list">
{foreach $annotations['throws'] as $description}
- {!$description|annotation:'throws':$method}<br>
+ {$description|annotation:'throws':$method|noescape}{sep}<br>{/}
{/foreach}
</div>
{/ifset}
@@ -174,7 +175,7 @@ the file LICENSE.md that was distributed with this source code.
<div class="list">
{foreach $descriptions as $description}
{if $description}
- {!$description|annotation:$annotation:$method}<br>
+ {$description|annotation:$annotation:$method|noescape}<br>
{/if}
{/foreach}
</div>
@@ -196,10 +197,10 @@ the file LICENSE.md that was distributed with this source code.
</tr>
{/define}
- <table class="summary" id="methods" n:if="$ownMethods">
+ <table class="summary methods" id="methods" n:if="$ownMethods">
<caption>Methods summary</caption>
{foreach $ownMethods as $method}
- {include #method, method => $method}
+ {include method, method => $method}
{/foreach}
</table>
@@ -219,16 +220,16 @@ the file LICENSE.md that was distributed with this source code.
<tr>
<td><code>
{foreach $methods as $data}
- <a href="{$data['method']|methodUrl:$data['method']->declaringTrait}" n:tag-if="$template->getClass($traitName)"><span n:tag-if="$data['method']->deprecated" class="deprecated">{$data['method']->originalName}()</span></a>{if $data['aliases']}(as {foreach $data['aliases'] as $alias}<span n:tag-if="$data['method']->deprecated" class="deprecated">{$alias->name}()</span>{sep}, {/sep}{/foreach}){/if}{sep}, {/sep}
+ <a href="{$data['method']|methodUrl:$data['method']->declaringTrait}" n:tag-if="$template->getClass($traitName)"><span n:tag-if="$data['method']->deprecated" class="deprecated">{$data['method']->name}()</span></a>{if $data['aliases']}(as {foreach $data['aliases'] as $alias}<span n:tag-if="$data['method']->deprecated" class="deprecated">{$alias->name}()</span>{sep}, {/sep}{/foreach}){/if}{sep}, {/sep}
{/foreach}
</code></td>
</tr>
</table>
- <table class="summary" id="methods" n:if="$ownMagicMethods">
+ <table class="summary methods" id="magicMethods" n:if="$ownMagicMethods">
<caption>Magic methods summary</caption>
{foreach $ownMagicMethods as $method}
- {include #method, method => $method}
+ {include method, method => $method}
{/foreach}
</table>
@@ -257,44 +258,46 @@ the file LICENSE.md that was distributed with this source code.
{var $ownConstants = $class->ownConstants}
- <table class="summary" id="constants" n:if="$ownConstants">
+ <table class="summary constants" id="constants" n:if="$ownConstants">
<caption>Constants summary</caption>
<tr n:foreach="$ownConstants as $constant" data-order="{$constant->name}" id="{$constant->name}">
{var $annotations = $constant->annotations}
- <td class="attributes"><code>{!$constant->typeHint|typeLinks:$constant}</code></td>
- <td class="name"><code>
+ <td class="attributes"><code>{$constant->typeHint|typeLinks:$constant|noescape}</code></td>
+ <td class="name">
+ <code>
{if $class->internal}
<a href="{$constant|manualUrl}" title="Go to PHP documentation"><b>{$constant->name}</b></a>
{else}
<a n:tag-if="$config->sourceCode" href="{$constant|sourceUrl}" title="Go to source code"><b>{$constant->name}</b></a>
{/if}
- </code></td>
- <td class="value"><code>{!$constant->valueDefinition|highlightValue:$class}</code></td>
- <td class="description"><div>
- <a href="#{$constant->name}" class="anchor">#</a>
+ </code>
- {if $config->template['options']['elementDetailsCollapsed']}
- <div class="description short">
- {!$constant|shortDescription:true}
+ <div n:if="$config->template['options']['elementDetailsCollapsed']" class="description short">
+ {$constant|shortDescription:true|noescape}
</div>
- {/if}
<div n:class="description, detailed, $config->template['options']['elementDetailsCollapsed'] ? hidden">
- {!$constant|longDescription}
+ {$constant|longDescription|noescape}
{foreach $template->annotationSort($template->annotationFilter($annotations, array('var'))) as $annotation => $descriptions}
<h4>{$annotation|annotationBeautify}</h4>
<div class="list">
{foreach $descriptions as $description}
{if $description}
- {!$description|annotation:$annotation:$constant}<br>
+ {$description|annotation:$annotation:$constant|noescape}<br>
{/if}
{/foreach}
</div>
{/foreach}
</div>
- </div></td>
+ </td>
+ <td class="value">
+ <div>
+ <a href="#{$constant->name}" class="anchor">#</a>
+ <code>{$constant->valueDefinition|highlightValue:$class|noescape}</code>
+ </div>
+ </td>
</tr>
</table>
@@ -309,11 +312,11 @@ the file LICENSE.md that was distributed with this source code.
</tr>
</table>
- {define #property}
+ {define property}
<tr data-order="{$property->name}" id="{if $property->magic}m{/if}${$property->name}">
<td class="attributes"><code>
{if $property->protected}protected{elseif $property->private}private{else}public{/if} {if $property->static}static{/if} {if $property->readOnly}read-only{elseif $property->writeOnly}write-only{/if}
- {!$property->typeHint|typeLinks:$property}
+ {$property->typeHint|typeLinks:$property|noescape}
</code></td>
<td class="name">
@@ -322,42 +325,42 @@ the file LICENSE.md that was distributed with this source code.
{else}
<a n:tag-if="$config->sourceCode" href="{$property|sourceUrl}" title="Go to source code"><var>${$property->name}</var></a>
{/if}
- </td>
- <td n:if="!$property->magic" class="value"><code>{!$property->defaultValueDefinition|highlightValue:$class}</code></td>
- <td class="description"><div>
- <a href="#{if $property->magic}m{/if}${$property->name}" class="anchor">#</a>
- {if $config->template['options']['elementDetailsCollapsed']}
- <div class="description short">
- {!$property|shortDescription:true}
+ <div n:if="$config->template['options']['elementDetailsCollapsed']" class="description short">
+ {$property|shortDescription:true|noescape}
</div>
- {/if}
<div n:class="description, detailed, $config->template['options']['elementDetailsCollapsed'] ? hidden">
- {!$property|longDescription}
+ {$property|longDescription|noescape}
{foreach $template->annotationSort($template->annotationFilter($property->annotations, array('var'))) as $annotation => $descriptions}
<h4>{$annotation|annotationBeautify}</h4>
<div class="list">
{foreach $descriptions as $description}
{if $description}
- {!$description|annotation:$annotation:$property}<br>
+ {$description|annotation:$annotation:$property|noescape}<br>
{/if}
{/foreach}
</div>
{/foreach}
</div>
- </div></td>
+ </td>
+ <td n:if="!$property->magic" class="value">
+ <div>
+ <a href="#{if $property->magic}m{/if}${$property->name}" class="anchor">#</a>
+ <code>{$property->defaultValueDefinition|highlightValue:$class|noescape}</code>
+ </div>
+ </td>
</tr>
{/define}
{var $ownProperties = $class->ownProperties}
{var $ownMagicProperties = $class->ownMagicProperties}
- <table class="summary" id="properties" n:if="$ownProperties">
+ <table class="summary properties" id="properties" n:if="$ownProperties">
<caption>Properties summary</caption>
{foreach $ownProperties as $property}
- {include #property, property => $property}
+ {include property, property => $property}
{/foreach}
</table>
@@ -383,10 +386,10 @@ the file LICENSE.md that was distributed with this source code.
</tr>
</table>
- <table class="summary" id="magicProperties" n:if="$ownMagicProperties">
+ <table class="summary properties" id="magicProperties" n:if="$ownMagicProperties">
<caption>Magic properties summary</caption>
{foreach $ownMagicProperties as $property}
- {include #property, property => $property}
+ {include property, property => $property}
{/foreach}
</table>
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-27 16:23:18 +0000