NamespaceIndexEmitter
Renders the index page for one namespace.
These pages are what the site’s navigation lists. Every class page is reached from the table on one of them rather than from the sidebar, because a sidebar naming all several hundred classes is rendered into every page of the site and would multiply its weight.
Synopsis
Section titled “Synopsis”final class NamespaceIndexEmitter
| Source | Emitter/NamespaceIndexEmitter.php |
Constructor
Section titled “Constructor”__construct()
Section titled “__construct()”public function __construct(ApiIndex $index, TypeLinker $linker, Markdown $markdown = new Markdown(…)): mixed
| Parameter | Type | Description |
|---|---|---|
$index | ApiIndex | |
$linker | TypeLinker | |
$markdown | Markdown |
Returns mixed
Methods
Section titled “Methods”| Method | Description |
|---|---|
emit(string $namespace): EmittedArtifact |
emit()
Section titled “emit()”public function emit(string $namespace): EmittedArtifact
| Parameter | Type | Description |
|---|---|---|
$namespace | string |
Returns EmittedArtifact