debug()
dispatch()
executeQueryCopy()
getInstanceOf()
log()
transform()
isValidWriterClassname()
$event_dispatcher
$structure
$transformation
Writer containing file system operations.
The Query part of the transformation determines the action, currently supported is: * copy, copies a file or directory to the destination given in $artifact
| category | phpDocumentor |
|---|---|
| package | Transformer |
| subpackage | Writers |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
debug(string $message) : void
| inherited_from | \phpDocumentor_Transformer_Abstract::debug() |
|---|---|
| inherited_from | \phpDocumentor_Transformer_Writer_Abstract::debug() |
stringThe message to log.
dispatch(string $name, \string[] $arguments) : mixed | null
This method tries to dispatch an event; if no Event Dispatcher has been set than this method will explicitly not fail and return null. By not failing we make the Event Dispatcher optional and is it easier for people to re-use this component in their own application.
| inherited_from | \phpDocumentor_Transformer_Abstract::dispatch() |
|---|---|
| inherited_from | \phpDocumentor_Transformer_Writer_Abstract::dispatch() |
stringName of the event to dispatch.
\string[]Arguments for this event.
\phpDocumentor_Parser_Exception |
if there is a dispatcher but it is not of type sfEventDispatcher |
|---|
mixednull
executeQueryCopy(phpDocumentor_Transformer_Transformation $transformation) : void
getInstanceOf(string $writer) : \phpDocumentor_Transformer_Writer_Abstract
| inherited_from | \phpDocumentor_Transformer_Writer_Abstract::getInstanceOf() |
|---|
stringName of thr writer to get.
log(string $message, int $priority) : void
| inherited_from | \phpDocumentor_Transformer_Abstract::log() |
|---|---|
| inherited_from | \phpDocumentor_Transformer_Writer_Abstract::log() |
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
transform(DOMDocument $structure, phpDocumentor_Transformer_Transformation $transformation) : void
\phpDocumentor_Transformer_TransformationTransformation containing the meta-data for this request.
\InvalidArgumentException |
if the query is not supported. |
|---|
isValidWriterClassname(string $class_name) : bool
| inherited_from | \phpDocumentor_Transformer_Writer_Abstract::isValidWriterClassname() |
|---|
stringClass name of the writer to check.
bool$event_dispatcher : \sfEventDispatcher | null
| inherited_from | \phpDocumentor_Transformer_Abstract::$$event_dispatcher |
|---|---|
| inherited_from | \phpDocumentor_Transformer_Writer_Abstract::$$event_dispatcher |