B.18 EchoPropertiesTask

Displays all the current properties in the project. The output can be sent to a file if desired. This task can be used as a somewhat contrived means of returning data from an <phing> invocation, but is really for debugging build files.

Table B.18: Attributes

NameTypeDescriptionDefaultRequired
destfileStringIf specified, the value indicates the name of the file to send the output of the statement to. If not specified, then the output will go to the Phing log.n/ano
srcfileStringIf specified, the value indicates the name of the property file to read from. If not specified, then the system properties will be taken.n/ano
prefixStringa prefix which is used to filter the properties only those properties starting with this prefix will be echoed.n/ano
regexStringa regular expression which is used to filter the properties only those properties whose names match it will be echoed.n/ano
failonerrorBooleanBy default, the "failonerror" attribute is enabled. If an error occurs while writing the properties to a file, and this attribute is enabled, then a BuildException will be thrown, causing the build to fail. If disabled, then IO errors will be reported as a log statement, and the build will continue without failure from this task.n/ano
formatStringOne of text or xml. Determines the output format. Defaults to text.n/ano

B.18.1 Example

<echoproperties />

Report the current properties to the log.

<echoproperties destfile="my.properties"/>

Report the current properties to the file "my.properties", and will fail the build if the file could not be created or written to.

<echoproperties destfile="my.properties" failonerror="false"/>

Report the current properties to the file "my.properties", and will log a message if the file could not be created or written to, but will still allow the build to continue.

<echoproperties prefix="phing."/>

List all properties beginning with "phing."

<echoproperties regex="/.*phing.*/"/>

Lists all properties that contain "phing" in their names.