Documentation

Payload extends Payload
in package

Table of Contents

$builder  : ProjectDescriptorBuilder
$config  : array{phpdocumentor: array{configVersion: string, title?: string, use-cache?: bool, paths?: array{output: \phpDocumentor\Dsn, cache: \phpDocumentor\Path}, versions?: array, settings?: array, templates?: non-empty-list}}
$files  : array<string|int, File>
__construct()  : mixed
getApiConfigs()  : array<int, ApiSpecification>
getBuilder()  : ProjectDescriptorBuilder
getConfig()  : array{phpdocumentor: array{configVersion: string, title?: string, use-cache?: bool, paths?: array{output: \phpDocumentor\Dsn, cache: \phpDocumentor\Path}, versions?: array, settings?: array, templates?: non-empty-list}}
getFiles()  : array<string|int, File>
withFiles()  : Payload

Properties

$config

private array{phpdocumentor: array{configVersion: string, title?: string, use-cache?: bool, paths?: array{output: \phpDocumentor\Dsn, cache: \phpDocumentor\Path}, versions?: array, settings?: array, templates?: non-empty-list}} $config

Methods

__construct()

public __construct(array{phpdocumentor: array{configVersion: string, title?: string, use-cache?: bool, paths?: array{output: \phpDocumentor\Dsn, cache: \phpDocumentor\Path}, versions?: array, settings?: array, templates?: non-empty-list}} $config, ProjectDescriptorBuilder $builder[, array<string|int, File> $files = [] ]) : mixed
Parameters
$config : array{phpdocumentor: array{configVersion: string, title?: string, use-cache?: bool, paths?: array{output: \phpDocumentor\Dsn, cache: \phpDocumentor\Path}, versions?: array, settings?: array, templates?: non-empty-list}}
$builder : ProjectDescriptorBuilder
$files : array<string|int, File> = []
Return values
mixed —

getConfig()

public getConfig() : array{phpdocumentor: array{configVersion: string, title?: string, use-cache?: bool, paths?: array{output: \phpDocumentor\Dsn, cache: \phpDocumentor\Path}, versions?: array, settings?: array, templates?: non-empty-list}}
Return values
array{phpdocumentor: array{configVersion: string, title?: string, use-cache?: bool, paths?: array{output: \phpDocumentor\Dsn, cache: \phpDocumentor\Path}, versions?: array, settings?: array, templates?: non-empty-list}} —

getFiles()

public getFiles() : array<string|int, File>
Return values
array<string|int, File> —

Search results