Publisher

Publishes Stuff

class Publisher

use LoggerAwareTrait

use Producer

Copyright: 2016 Appertly

License: Apache-2.0

Instance Properties

Protected
Name	Type	Summary
`$commentParser`	`Parser`	The comment parser
`$mdParser`	`DocParser`	The markdown parser
`$writer`	`Writer`	The file writer

Static Properties

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

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`LoggerInterface $logger`) Create a new Publisher.

Instance Methods

Public
Returns	Signature and Description
`Awaitable`<`mixed`>	`doConstants`(`Job $job`, `string $namespace`, `Vector<ConstantDeclaration> $constants`) Exports the page for functions.
`Awaitable`<`mixed`>	`doFunctions`(`Job $job`, `string $namespace`, `Vector<FunctionDeclaration> $functions`) Exports the page for functions.
`void`	`publish`(`string $destination`, `ConstVector<ScannedBase> $tokens`) Publishes our documentation

Protected
Returns	Signature and Description
`Awaitable`<`mixed`>	`doClass`(`Job $job`, `ClassyDeclaration $c`) Exports the page for a class, interface, or trait.
`ConstVector`<`Awaitable`<`mixed`>>	`doNamespace`(`Job $job`, `string $namespace`, `ConstVector<ScannedBase> $tokens`) Exports a single namespace.
`ConstVector`<`Awaitable`<`mixed`>>	`doNamespaces`(`Job $job`) Exports namespace pages.
`string`	`getFilename`(`ScannedBase $c`) Cleans up a filename.
`Page`	`getPage`(`string $title`) Gets a page builder.
`ConstSet`<`string`>	`getSubNamespaces`(`Job $job`, `string $namespace`) Gets any sub-namespaces for a given namespace.
`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.

Property Details

$commentParser

protected Parser $commentParser

The comment parser

$mdParser

protected DocParser $mdParser

The markdown parser

$primitives

Inherited from Producer

static protected ImmSet<string> $primitives

$thisy

Inherited from Producer

static protected ImmSet<string> $thisy

$writer

protected Writer $writer

The file writer

Method Details

__construct

public function __construct(LoggerInterface $logger)

Create a new Publisher.

Parameters
Name	Type	Description
`$logger`	`LoggerInterface`	The logger

doClass

protected function doClass(Job $job, ClassyDeclaration $c)

Exports the page for a class, interface, or trait.

Parameters
Name	Type	Description
`$job`	`Job`	The export job
`$c`	`ClassyDeclaration`	The scanned token

Returns
Type	Description
`Awaitable`<`mixed`>	Awaitable for writing the class

doConstants

public function doConstants(Job $job, string $namespace, Vector<ConstantDeclaration> $constants)

Exports the page for functions.

Parameters
Name	Type	Description
`$job`	`Job`	The export job
`$namespace`	`string`	The namespace to scan
`$constants`	`Vector`<`ConstantDeclaration`>

Returns
Type	Description
`Awaitable`<`mixed`>	Awaitable for writing the class

doFunctions

public function doFunctions(Job $job, string $namespace, Vector<FunctionDeclaration> $functions)

Exports the page for functions.

Parameters
Name	Type	Description
`$job`	`Job`	The export job
`$namespace`	`string`	The namespace to scan
`$functions`	`Vector`<`FunctionDeclaration`>	The list of functions

Returns
Type	Description
`Awaitable`<`mixed`>	Awaitable for writing the class

doNamespace

protected function doNamespace(Job $job, string $namespace, ConstVector<ScannedBase> $tokens)

Exports a single namespace.

Parameters
Name	Type	Description
`$job`	`Job`	The file path to contain exported pages
`$namespace`	`string`	The namespace name
`$tokens`	`ConstVector`<`ScannedBase`>	The tokens in this namespace

Returns
Type	Description
`ConstVector`<`Awaitable`<`mixed`>>	The awaitables for each member of the namespace

doNamespaces

protected function doNamespaces(Job $job)

Exports namespace pages.

Parameters
Name	Type	Description
`$job`	`Job`	The job details

Returns
Type	Description
`ConstVector`<`Awaitable`<`mixed`>>	The awaitables for each namespace

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

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

getSubNamespaces

protected function getSubNamespaces(Job $job, string $namespace)

Gets any sub-namespaces for a given namespace.

Parameters
Name	Type	Description
`$job`	`Job`	The job
`$namespace`	`string`	The namespace

Returns
Type	Description
`ConstSet`<`string`>

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

publish

public function publish(string $destination, ConstVector<ScannedBase> $tokens)

Publishes our documentation

Parameters
Name	Type	Description
`$destination`	`string`
`$tokens`	`ConstVector`<`ScannedBase`>