Assets

Extends \ArrayObject

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.

package

Default

Methods

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

copyTo(string $destination) : void

Arguments

$destination

string

Returns the project root for the given assets.

getProjectRoot() : string

Response

string

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

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

Arguments

$source_path

string

$destination_path

string

Sets a logger with which to record warnings.

setLogger(\Monolog\Logger $logger) : void

Arguments

$logger

\Monolog\Logger

Sets the project root for the given assets.

setProjectRoot(string $project_root) : void
Throws
\RuntimeException

if the container already contains items.

Arguments

$project_root

string

Properties

The root directory of the source documentation.

project_root : string
var

The root directory of the source documentation.

Type(s)

string

A logging object used to write informational and debug messages to

logger : \Monolog\Logger
var

A logging object used to write informational and debug messages to

Type(s)

\Monolog\Logger