\phpDocumentor\Plugin\Scrybe\Converter\MetadataAssets

This collection manages which assets were found during the discovery phase.

Each asset is represented by an entry containing the path to that asset relative to the project root.

Summary

Methods
Properties
Constants
setProjectRoot()
getProjectRoot()
set()
setLogger()
copyTo()
No public properties found
No constants found
No protected methods found
$project_root
$logger
N/A
No private methods found
No private properties found
N/A

Properties

$project_root

$project_root : string

Type

string — The root directory of the source documentation.

$logger

$logger : \Monolog\Logger

Type

\Monolog\Logger — A logging object used to write informational and debug messages to

Methods

setProjectRoot()

setProjectRoot(string  $project_root) : void

Sets the project root for the given assets.

Parameters

string $project_root

Throws

\RuntimeException

if the container already contains items.

getProjectRoot()

getProjectRoot() : string

Returns the project root for the given assets.

Returns

string

set()

set(string  $source_path, string  $destination_path) : void

Sets an asset to be copied to the given destination path.

Parameters

string $source_path
string $destination_path

setLogger()

setLogger(\Monolog\Logger  $logger) : void

Sets a logger with which to record warnings.

Parameters

\Monolog\Logger $logger

copyTo()

copyTo(string  $destination) : void

Copies all assets in this collection to their given destination location.

Parameters

string $destination