Classes, interfaces and traits
BuildListener¶
Interface for build listeners.
Classes that implement a listener must extend this class and (faux)implement
all methods that are decleard as dummies below.
« More »
BuildLogger¶
Interface for build loggers.
Build loggers are build listeners but with some additional functionality:
- They can be configured with a log level (below which they will ignore messages)
- They have error and output streams
Classes that implement a listener must implement this interface.
« More »
StreamRequiredBuildLogger¶
Interface for build loggers that require that out/err streams be set in order to function.
This is just an empty sub-interface to BuildLogger, but is used by Phing to throw
graceful errors when classes like phing.listener.DefaultLogger are being used as
-listener.
« More »
SubBuildListener¶
Instances of classes that implement this interface can register
to be also notified when things happened during a subbuild.
<p>A subbuild is a separate project instance created by the
<code><phing></code> task family. These project instances will
never fire the buildStarted and buildFinished events, but they will
fire subBuildStarted/ and subBuildFinished. The main project
instance - the one created by running Phing in the first place - will
never invoke one of the methods of this interface.</p>
« More »
TaskContainer¶
Abstract interface for objects which can contain tasks (targets)
Used to check if a class can contain tasks (via instanceof)
« More »
AbstractPropertySetterTask¶
The base class for all Tasks.
Use \Project#createTask to register a new Task.
« More »
BuildEvent¶
Encapsulates a build specific event.
<p>We have three sources of events all handled by this class:
<ul>
<li>Project level events</li>
<li>Target level events</li>
<li>Task level events</li>
</ul>
<p> Events are all fired from the project class by creating an event object
using this class and passing it to the listeners.
« More »
BuildException¶
BuildException is for when things go wrong in a build execution.
« More »
ChainedMapper¶
A <code>ContainerMapper</code> that chains the results of the first
nested <code>FileNameMapper</code>s into sourcefiles for the second,
the second to the third, and so on, returning the resulting mapped
filenames from the last nested <code>FileNameMapper</code>.
« More »
ConfigurationException¶
ConfigurationException is thrown by Phing during the configuration and setup phase of the project.
« More »
ContainerMapper¶
A <code>FileNameMapper</code> that contains
other <code>FileNameMapper</code>s.
« More »
Diagnostics¶
A little diagnostic helper that output some information that may help
in support. It should quickly give correct information about the
phing system.
« More »
ExitStatusException¶
BuildException + exit status.
« More »
IntrospectionHelper¶
Helper class that collects the methods that a task or nested element
holds to set attributes, create nested elements or hold PCDATA
elements.
<ul>
<li><strong>SMART-UP INLINE DOCS</strong></li>
<li><strong>POLISH-UP THIS CLASS</strong></li>
</ul>
« More »
Phing¶
Entry point into Phing. This class handles the full lifecycle of a build -- from
parsing & handling commandline arguments to assembling the project to shutting down
and cleaning up in the end.
If you are invoking Phing from an external application, this is still
the class to use. Your application can invoke the start() method, passing
any commandline arguments or additional properties.
« More »
Project¶
The Phing project class. Represents a completely configured Phing project.
The class defines the project and all tasks/targets. It also contains
methods to start a build as well as some properties and FileSystem
abstraction.
« More »
ProjectComponent¶
Abstract class providing properties and methods common to all
the project components
« More »
RuntimeConfigurable¶
Wrapper class that holds the attributes of a Task (or elements
nested below that level) and takes care of configuring that element
at runtime.
<strong>SMART-UP INLINE DOCS</strong>
« More »
Target¶
The Target component. Carries all required target data. Implements the
abstract class {@link TaskContainer}
« More »
Task¶
The base class for all Tasks.
Use \Project#createTask to register a new Task.
« More »
TaskAdapter¶
Use introspection to "adapt" an arbitrary ( not extending Task, but with
similar patterns).
Use \Project#createTask to register a new Task.
« More »
UnknownElement¶
Wrapper class that holds all information necessary to create a task
that did not exist when Phing started.
<em> This has something to do with phing encountering an task XML element
it is not aware of at start time. This is a situation where special steps
need to be taken so that the element is then known.</em>
« More »