Gitee
\
Cilex
Provider
phpDocumentor
Command
Helper
Phar
Project
Compiler
Linker
Pass
Configuration
Merger
Annotation
Console
Input
Output
Descriptor
Builder
Reflector
Tags
Cache
Example
Exception
Filter
Interfaces
ProjectDescriptor
Tag
BaseTypes
Type
Validator
Event
Parser
Command
Project
Configuration
Event
Exception
Util
Partials
Exception
Plugin
Core
Descriptor
Validator
Constraints
Classes
Functions
Property
Functions
Transformer
Behaviour
Tag
Writer
Xml
Xslt
Graphs
Writer
LegacyNamespaceConverter
Tests
Scrybe
Command
Manual
Converter
Definition
Exception
Format
Exception
Metadata
TableOfContents
RestructuredText
Directives
Roles
Visitors
Template
Twig
Writer
Transformer
Behaviour
Command
Project
Template
Configuration
Transformations
Event
Exception
Router
Matcher
UrlGenerator
Standard
Template
Writer
Exception
Translator

\phpDocumentor\Plugin\Core\Transformer\WriterFileIo

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

Summary

Methods
Properties
Constants
checkRequirements()
transform()
executeQueryCopy()
No public properties found
No constants found
checkForSpacesInPath()
$transformation
N/A
No private methods found
No private properties found
N/A

Properties

Methods

checkRequirements()

checkRequirements() : void

This method verifies whether PHP has all requirements needed to run this writer.

If one of the requirements is missing for this Writer then an exception of type RequirementMissing should be thrown; this indicates to the calling process that this writer will not function.

Throws

\phpDocumentor\Transformer\Writer\Exception\RequirementMissing

when a requirements is missing stating which one.

transform()

transform(\phpDocumentor\Descriptor\ProjectDescriptor  $project, \phpDocumentor\Transformer\Transformation  $transformation) : void

Invokes the query method contained in this class.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Document containing the structure.
\phpDocumentor\Transformer\Transformation $transformation

Transformation to execute.

Throws

\InvalidArgumentException

if the query is not supported.

executeQueryCopy()

executeQueryCopy(\phpDocumentor\Transformer\Transformation  $transformation) : void

Copies files or folders to the Artifact location.

Parameters

\phpDocumentor\Transformer\Transformation $transformation

Transformation to use as data source.

Throws

\phpDocumentor\Transformer\Exception

checkForSpacesInPath()

checkForSpacesInPath(string  $path) : void

Checks if there is a space in the path.

Parameters

string $path

Throws

\InvalidArgumentException

if path contains a space.