php:phpdocumentor

Note:This goal should be used as a Maven report.

Full name:

org.phpmaven:maven-php-plugin:2.0-SNAPSHOT:phpdocumentor

Description:

A maven 2.0 plugin for generating phpdocumentor documentations. This plugin is used in the site phase.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: site.

Required Parameters

Name Type Since Description
outputApiDocDirectory File - The output directory of doxygen generated documentation.
phpDocConfigFile File - The phpdoc configuraton file. The default is ${project.basedir}/src/site/phpdoc/phpdoc.config
Default value is: ${project.basedir}/src/site/phpdoc/phpdoc.config.

Optional Parameters

Name Type Since Description
additionalPhpParameters String - PHP arguments. Use php -h to get a list of all php compile arguments.
dependenciesTargetDirectory File - Where the php dependency files will be written to.
Default value is: ${project.basedir}/target/php-deps.
excludes String[] - Files and directories to exclude.
ignoreIncludeErrors boolean - If true, errors triggered because of missing includes will be ignored.
Default value is: false.
includes String[] - Files and directories to include.
logPhpOutput boolean - If the output of the php scripts will be written to the console.
Default value is: false.
phpDocFilePath String - Path to phpDoc. If nothing is configured phpdoc is expected in the path.
Default value is: phpdoc.
phpExecutable String - Path to the php executable.
Default value is: php.
phpFileEnding String - How php files will be identified after the last point.
Default value is: php.
targetClassesDirectory File - The directory containing generated classes of the project being tested. This will be included after the test classes in the test classpath.
Default value is: ${project.build.outputDirectory}.
targetTestClassesDirectory File - The directory containing generated test classes of the project being tested. This will be included at the beginning of the test classpath.
Default value is: ${project.build.testOutputDirectory}.
temporaryScriptFile File - A temporary script file that can be used for php execution of small code snippets.
Default value is: ${project.basedir}/target/snippet.php.
testDependenciesTargetDirectory File - Where the php test dependency files will be written to.
Default value is: ${project.basedir}/target/php-test-deps.

Parameter Details

additionalPhpParameters:

PHP arguments. Use php -h to get a list of all php compile arguments.
  • Type: java.lang.String
  • Required: No
  • Expression: ${additionalPhpParameters}

dependenciesTargetDirectory:

Where the php dependency files will be written to.
  • Type: java.io.File
  • Required: No
  • Expression: ${dependenciesTargetDirectory}
  • Default: ${project.basedir}/target/php-deps

excludes:

Files and directories to exclude.
  • Type: java.lang.String[]
  • Required: No

ignoreIncludeErrors:

If true, errors triggered because of missing includes will be ignored.
  • Type: boolean
  • Required: No
  • Expression: ${ignoreIncludeErrors}
  • Default: false

includes:

Files and directories to include.
  • Type: java.lang.String[]
  • Required: No

logPhpOutput:

If the output of the php scripts will be written to the console.
  • Type: boolean
  • Required: No
  • Expression: ${logPhpOutput}
  • Default: false

outputApiDocDirectory:

The output directory of doxygen generated documentation.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/site/apidocs

phpDocConfigFile:

The phpdoc configuraton file. The default is ${project.basedir}/src/site/phpdoc/phpdoc.config
  • Type: java.io.File
  • Required: Yes
  • Expression: ${phpDocConfigFile}
  • Default: ${project.basedir}/src/site/phpdoc/phpdoc.config

phpDocFilePath:

Path to phpDoc. If nothing is configured phpdoc is expected in the path.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phpDocFilePath}
  • Default: phpdoc

phpExecutable:

Path to the php executable.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phpExecutable}
  • Default: php

phpFileEnding:

How php files will be identified after the last point.
  • Type: java.lang.String
  • Required: No
  • Expression: ${phpFileEnding}
  • Default: php

targetClassesDirectory:

The directory containing generated classes of the project being tested. This will be included after the test classes in the test classpath.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.outputDirectory}

targetTestClassesDirectory:

The directory containing generated test classes of the project being tested. This will be included at the beginning of the test classpath.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.testOutputDirectory}

temporaryScriptFile:

A temporary script file that can be used for php execution of small code snippets.
  • Type: java.io.File
  • Required: No
  • Expression: ${temporaryScriptFile}
  • Default: ${project.basedir}/target/snippet.php

testDependenciesTargetDirectory:

Where the php test dependency files will be written to.
  • Type: java.io.File
  • Required: No
  • Expression: ${testDependenciesTargetDirectory}
  • Default: ${project.basedir}/target/php-test-deps