{if $class->interface}Interface{elseif $class->trait}Trait{else}Class{/if} {$class->shortName}
{if $class->valid}
{$class|longDescription|noescape}
- {if $item->documented} {last}{/last}{$item->name}{last}{/last} {else}{$item->name}{/if} {var $itemOwnInterfaces = $item->ownInterfaces} {if $itemOwnInterfaces} implements {foreach $itemOwnInterfaces as $interface} {$interface->name}{sep}, {/sep} {/foreach}{/if} {var $itemOwnTraits = $item->ownTraits} {if $itemOwnTraits} uses {foreach $itemOwnTraits as $trait} {if is_string($trait)} {$trait} (not available) {else} {$trait->name}{sep}, {/sep} {/} {/foreach}{/if}
Direct known subclasses
{include children, children => $directSubClasses}Indirect known subclasses
{include children, children => $indirectSubClasses}Direct known implementers
{include children, children => $directImplementers}Indirect known implementers
{include children, children => $indirectImplementers}Direct Known Users
{include children, children => $directUsers}Indirect Known Users
{include children, children => $indirectUsers}
{if !$class->interface && !$class->trait && ($class->abstract || $class->final)}{if $class->abstract}Abstract{else}Final{/if}
{/if} {if $class->internal}PHP Extension: {$class->extension->name|firstUpper}
{/if} {if $class->inNamespace()}Namespace: {$class->namespaceName|namespaceLinks|noescape}
{/if} {if $class->inPackage()}Package: {$class->packageName|packageLinks|noescape}
{/if} {foreach $template->annotationSort($template->annotationFilter($class->annotations)) as $annotation => $values} {foreach $values as $value} {$annotation|annotationBeautify}{if $value}:{/if} {$value|annotation:$annotation:$class|noescape}
{/foreach} {/foreach} {if $class->internal} Documented at php.net {else} Located at {$class->fileName|relativePath} {/if}
{var $ownMethods = $class->ownMethods}
{var $ownMagicMethods = $class->ownMagicMethods}
{define method}
{/if} {if $class->internal}PHP Extension: {$class->extension->name|firstUpper}
{/if} {if $class->inNamespace()}Namespace: {$class->namespaceName|namespaceLinks|noescape}
{/if} {if $class->inPackage()}Package: {$class->packageName|packageLinks|noescape}
{/if} {foreach $template->annotationSort($template->annotationFilter($class->annotations)) as $annotation => $values} {foreach $values as $value} {$annotation|annotationBeautify}{if $value}:{/if} {$value|annotation:$annotation:$class|noescape}
{/foreach} {/foreach} {if $class->internal} Documented at php.net {else} Located at {$class->fileName|relativePath} {/if}
{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|noescape}{/ifset}
{if $method->returnsReference()}&{/if}
#
{block|strip}
{if $class->internal}
{$method->name}(
{else}
{$method->name}(
{/if}
{foreach $method->parameters as $parameter}
{$parameter->typeHint|typeLinks:$method|noescape}
{if $parameter->passedByReference}& {/if}${$parameter->name}{if $parameter->defaultValueAvailable} = {$parameter->defaultValueDefinition|highlightPHP:$class|noescape}{elseif $parameter->unlimited},…{/if}{sep}, {/sep}
{/foreach}
){/block}
{if $config->template['options']['elementDetailsCollapsed']}
{$method|shortDescription:true|noescape}
{/if}
{$method|longDescription|noescape}
{if !$class->deprecated && $method->deprecated}
{/if}
{if isset($annotations['return']) && 'void' !== $annotations['return'][0]}
Deprecated
{ifset $annotations['deprecated']}
{foreach $annotations['deprecated'] as $description}
{if $description}
{$description|annotation:'deprecated':$method|noescape}
{/if} {/foreach}
{/ifset}
{/if}
{if $method->parameters && isset($annotations['param'])}
{/if} {/foreach}
Parameters
-
{foreach $method->parameters as $parameter}
- ${$parameter->name}{if $parameter->unlimited},…{/if}
- {$parameter->description|description:$method|noescape} {/foreach}
Returns
{foreach $annotations['return'] as $description}
{$description|annotation:'return':$method|noescape}{sep}
{/} {/foreach}
{/if}
{ifset $annotations['throws']}
{/} {/foreach}
Throws
{foreach $annotations['throws'] as $description}
{$description|annotation:'throws':$method|noescape}{sep}
{/} {/foreach}
{/ifset}
{foreach $template->annotationSort($template->annotationFilter($annotations, array('deprecated', 'param', 'return', 'throws'))) as $annotation => $descriptions}
{/} {/foreach}
{$annotation|annotationBeautify}
{foreach $descriptions as $description}
{if $description}
{$description|annotation:$annotation:$method|noescape}
{/if} {/foreach}
{/foreach}
{var $overriddenMethod = $method->overriddenMethod}
{if $overriddenMethod}
{/if} {/foreach}
Overrides
{/if} {var $implementedMethod = $method->implementedMethod} {if $implementedMethod}Implementation of
{/if}
{foreach $methods as $method}
{$method->name}(){sep}, {/sep}
{/foreach}
|
{foreach $methods as $data}
{$data['method']->name}(){if $data['aliases']}(as {foreach $data['aliases'] as $alias}{$alias->name}(){sep}, {/sep}{/foreach}){/if}{sep}, {/sep}
{/foreach}
|
{foreach $methods as $method}
{$method->name}(){sep}, {/sep}
{/foreach}
|
{foreach $methods as $data}
{$data['method']->originalName}(){if $data['aliases']}(as {foreach $data['aliases'] as $alias}{$alias->name}(){sep}, {/sep}{/foreach}){/if}{sep}, {/sep}
{/foreach}
|
{$constant->typeHint|typeLinks:$constant|noescape} |
{if $class->internal}
{$constant->name}
{else}
{$constant->name}
{/if}
{$constant|shortDescription:true|noescape}
{$constant|longDescription|noescape}
{foreach $template->annotationSort($template->annotationFilter($annotations, array('var'))) as $annotation => $descriptions}
{$annotation|annotationBeautify}
{foreach $descriptions as $description}
{if $description}
{$description|annotation:$annotation:$constant|noescape}
{/foreach}
{/if} {/foreach} |
#
{$constant->valueDefinition|highlightValue:$class|noescape}
|
{foreach $constants as $constant}
{$constant->name}{sep}, {/sep}
{/foreach}
|
{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|noescape}
{$property|shortDescription:true|noescape}
{$property|longDescription|noescape}
{foreach $template->annotationSort($template->annotationFilter($property->annotations, array('var'))) as $annotation => $descriptions}
{$annotation|annotationBeautify}
{foreach $descriptions as $description}
{if $description}
{$description|annotation:$annotation:$property|noescape}
{/if} {/foreach}
{/foreach}
{/if} {/foreach}
#
{$property->defaultValueDefinition|highlightValue:$class|noescape}
{foreach $properties as $property}
${$property->name}{sep}, {/sep}
{/foreach}
|
{foreach $properties as $property}
${$property->name}{sep}, {/sep}
{/foreach}
|
{foreach $properties as $property}
${$property->name}{sep}, {/sep}
{/foreach}
|
{foreach $properties as $property}
${$property->name}{sep}, {/sep}
{/foreach}
|
Documentation of this class could not be generated.
Class was originally declared in {$class->fileName|relativePath} and is invalid because of:
- Class was redeclared in {$reason->getSender()->getFileName()|relativePath}.