xhp_hphpdoc__classlike

Renders a class

class xhp_hphpdoc__classlike extends xhp_x__element implements HasXHPHelpers

use XHPHelpers

use Producer

use MarkdownHelper

Copyright: 2016 Appertly

License: Apache-2.0

Static Properties

Protected
Name	Type	Summary
`$primitives`	`ImmSet`<`string`>
`$thisy`	`ImmSet`<`string`>

Instance Methods

Protected
Returns	Signature and Description
`void`	`appendConstants`(`xhp_main $main`, `ConstMap<string,ConstantDeclaration> $constants`)
`void`	`appendMethods`(`xhp_main $main`, `ConstMap<string,MethodDeclaration> $membersByName`)
`void`	`appendProperties`(`xhp_main $main`, `ConstMap<string,PropertyDeclaration> $membersByName`)
`void`	`appendTypeConstants`(`xhp_main $main`, `ConstMap<string,TypeConstantDeclaration> $typeConstants`)
`string`	`getFilename`(`ScannedBase $c`) Cleans up a filename.
`DocParser`	`getMarkdownParser`() Gets the Markdown parser
`Page`	`getPage`(`string $title`) Gets a page builder.
`bool`	`isPrimitive`(`string $type`) Gets whether the provided type is primitive.
`bool`	`isThisy`(`?ScannedTypehint $type`) Gets whether the provided typehint refers to `$this`
`bool`	`isVoid`(`?ScannedTypehint $type`) Gets whether the provided typehint is void.
`XHPRoot`	`render`()

Property Details

$primitives

Inherited from Producer

static protected ImmSet<string> $primitives

$thisy

Inherited from Producer

static protected ImmSet<string> $thisy

Method Details

appendConstants

protected function appendConstants(xhp_main $main, ConstMap<string,ConstantDeclaration> $constants)

Parameters
Name	Type	Description
`$main`	`xhp_main`
`$constants`	`ConstMap`<`string`,`ConstantDeclaration`>

appendMethods

protected function appendMethods(xhp_main $main, ConstMap<string,MethodDeclaration> $membersByName)

Parameters
Name	Type	Description
`$main`	`xhp_main`
`$membersByName`	`ConstMap`<`string`,`MethodDeclaration`>

appendProperties

protected function appendProperties(xhp_main $main, ConstMap<string,PropertyDeclaration> $membersByName)

Parameters
Name	Type	Description
`$main`	`xhp_main`
`$membersByName`	`ConstMap`<`string`,`PropertyDeclaration`>

appendTypeConstants

protected function appendTypeConstants(xhp_main $main, ConstMap<string,TypeConstantDeclaration> $typeConstants)

Parameters
Name	Type	Description
`$main`	`xhp_main`
`$typeConstants`	`ConstMap`<`string`,`TypeConstantDeclaration`>

getFilename

Inherited from Producer

protected function getFilename(ScannedBase $c)

Cleans up a filename.

Parameters
Name	Type	Description
`$c`	`ScannedBase`	The scanned token

Returns
Type	Description
`string`	The cleaned up filename

getMarkdownParser

Inherited from MarkdownHelper

protected function getMarkdownParser()

Gets the Markdown parser

Returns
Type	Description
`DocParser`	The Markdown parser

getPage

Inherited from Producer

protected function getPage(string $title)

Gets a page builder.

Parameters
Name	Type	Description
`$title`	`string`	The page title

Returns
Type	Description
`Page`	The page builder

isPrimitive

Inherited from Producer

protected function isPrimitive(string $type)

Gets whether the provided type is primitive.

Parameters
Name	Type	Description
`$type`	`string`	The type to test

Returns
Type	Description
`bool`	`true` if the type is primitive.

isThisy

Inherited from Producer

protected function isThisy(?ScannedTypehint $type)

Gets whether the provided typehint refers to $this

Parameters
Name	Type	Description
`$type`	`?ScannedTypehint`	The typehint to test

Returns
Type	Description
`bool`	`true` if the typehint is thisy

isVoid

Inherited from Producer

protected function isVoid(?ScannedTypehint $type)

Gets whether the provided typehint is void.

Parameters
Name	Type	Description
`$type`	`?ScannedTypehint`	The typehint to test

Returns
Type	Description
`bool`	`true` if the typehint is void

render

protected function render()

Returns
Type	Description
`XHPRoot`