{* 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) Copyright (c) 2012 Olivier Laviale (https://github.com/olvlvl) 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 = 'function'} {block #title}{if $function->deprecated}Deprecated {/if}Function {$function->name}{/block} {block #content}

Function {$function->shortName}

{if $function->valid}
{!$function|longDescription}
{if $function->inNamespace()}Namespace: {!$function->namespaceName|namespaceLinks}
{/if} {if $function->inPackage()}Package: {!$function->packageName|packageLinks}
{/if} {foreach $template->annotationSort($template->annotationFilter($function->annotations, array('param', 'return', 'throws'))) as $annotation => $values} {foreach $values as $value} {$annotation|annotationBeautify}{if $value}:{/if} {!$value|annotation:$annotation:$function}
{/foreach} {/foreach} Located at {$function->fileName|relativePath}
{var $annotations = $function->annotations} {if $function->numberOfParameters}

Parameters summary

{!$parameter->typeHint|typeLinks:$function} {block|strip} {if $parameter->passedByReference}& {/if}${$parameter->name}{if $parameter->defaultValueAvailable} = {!$parameter->defaultValueDefinition|highlightPHP:$function}{elseif $parameter->unlimited},…{/if} {/block} {ifset $annotations['param'][$parameter->position]}{!$annotations['param'][$parameter->position]|description:$parameter}{/ifset}
{/if} {if isset($annotations['return']) && 'void' !== $annotations['return'][0]}

Return value summary

{!$annotations['return'][0]|typeLinks:$function} {!$annotations['return'][0]|description:$function}
{/if} {if isset($annotations['throws'])}

Thrown exceptions summary

{!$throws|typeLinks:$function} {!$throws|description:$function}
{/if} {else}

Documentation of this function could not be generated.

Function was originally declared in {$function->fileName|relativePath} and is invalid because of:

{/if}
{/block}