GuideSetDescriptor

in package
extends DocumentationSetDescriptor

GuideSetDescriptor.php

Properties

protected$source  : (\phpDocumentor\Dsn|\phpDocumentor\Descriptor\list<string>)[]

Inherited from
\phpDocumentor\Descriptor\DocumentationSetDescriptor
phpstan-var

array{dsn?: Dsn, paths?: list}

Methods

publicgetName() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\DocumentationSetDescriptor

Returns the source location for this set of documentation.

publicgetSource() : (\phpDocumentor\Dsn|\phpDocumentor\Descriptor\list)[]

The returned array contains an element 'dsn' (of type DSN) and 'paths'; where each path represents one part of the documentation set relative to the DSN.

Returns

(\phpDocumentor\Dsn|\phpDocumentor\Descriptor\list)[] —
Inherited from
\phpDocumentor\Descriptor\DocumentationSetDescriptor
todo:

should the source location be included in a Descriptor? This couples it to the file system upon which it was ran and makes it uncacheable. But should this be cached? In any case, I need it for the RenderGuide writer at the moment; so refactor this once that becomes clearer.

phpstan-return

array{dsn?: Dsn, paths?: list}

publicgetOutput() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\DocumentationSetDescriptor

public__construct(string $name, (\phpDocumentor\Dsn|\phpDocumentor\Descriptor\list)[] $source, string $output) : mixed

Parameters

$name : string
$source : (\phpDocumentor\Dsn|\phpDocumentor\Descriptor\list)[]
$output : string

Returns

mixed —
phpstan-param

array{dsn: Dsn, paths: list} $source