Symfony 1.0.0 : Vue détaillée de Phing.php

Classe: Phing - X-Ref

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 applicaiton can invoke the start() method, passing
any commandline arguments or additional properties.

printMessage(Exception $t) X-Ref

Prints the message of the Exception if it's not null.

start(&$args, $additionalUserProperties = null) X-Ref

Entry point allowing for more options from other front ends.

This method encapsulates the complete build lifecycle.

param: array &$args The commandline args passed to phing shell script.
param: array $additionalUserProperties Any additional properties to be passed to Phing (alternative front-end might implement this).
return: void

getMsgOutputLevel() X-Ref

Making output level a static property so that this property
can be accessed by other parts of the system, enabling
us to display more information -- e.g. backtraces -- for "debug" level.

return: int

fire($args) X-Ref

Command line entry point. This method kicks off the building
of a project object and executes a build using either a given
target or the default target.

param: array $args Command line args.
return: void

execute($args) X-Ref

Setup/initialize Phing environment from commandline args.

param: array $args commandline args passed to phing shell.
return: void

_getParentFile(PhingFile $file) X-Ref

Helper to get the parent file for a given file.

param: PhingFile $file
return: PhingFile Parent file or null if none

_findBuildFile($start, $suffix) X-Ref

Search parent directories for the build file.

Takes the given target as a suffix to append to each
parent directory in search of a build file. Once the
root of the file-system has been reached an exception
is thrown.

param: string $start Start file path.
param: string $suffix Suffix filename to look for in parents.
return: PhingFile A handle to the build file

runBuild() X-Ref

Executes the build.

return: void

addBuildListeners(Project $project) X-Ref

Bind any default build listeners to this project.
Currently this means adding the logger.

param: Project $project
return: void

addInputHandler(Project $project) X-Ref

Creates the InputHandler and adds it to the project.

param: Project $project the project instance.

createLogger() X-Ref

Creates the default build logger for sending build events to the log.

return: BuildListener The created Logger

setCurrentProject($p) X-Ref

Sets the current Project

param: Project $p

unsetCurrentProject() X-Ref

Unsets the current Project

getCurrentProject() X-Ref

Gets the current Project.

return: Project Current Project or NULL if none is set yet/still.

log($message, $priority = PROJECT_MSG_INFO) X-Ref

A static convenience method to send a log to the current (last-setup) Project.
If there is no currently-configured Project, then this will do nothing.

param: string $message
param: int $priority PROJECT_MSG_INFO, etc.

handlePhpError($level, $message, $file, $line) X-Ref

Error handler for PHP errors encountered during the build.
This uses the logging for the currently configured project.

startPhpErrorCapture() X-Ref

Begins capturing PHP errors to a buffer.
While errors are being captured, they are not logged.

stopPhpErrorCapture() X-Ref

Stops capturing PHP errors to a buffer.
The errors will once again be logged after calling this method.

clearCapturedPhpErrors() X-Ref

Clears the captured errors without affecting the starting/stopping of the capture.

getCapturedPhpErrors() X-Ref

Gets any PHP errors that were captured to buffer.

return: array array('message' => message, 'line' => line number, 'file' => file name, 'level' => error level)

printUsage() X-Ref

Pas de description

printVersion() X-Ref

Pas de description

getPhingVersion() X-Ref

Pas de description

printDescription(Project $project) X-Ref

Pas de description

printTargets($project) X-Ref

Pas de description

_printTargets($names, $descriptions, $heading, $maxlen) X-Ref

Writes a formatted list of target names with an optional description.

param: array $names The names to be printed.
param: array $descriptions The associated target descriptions.
param: string $heading The heading to display.
param: int $maxlen The maximum length of the names of the targets.

import($dotPath, $classpath = null) X-Ref

Import a dot-path notation class path.

param: string $dotPath
param: mixed $classpath String or object supporting __toString()
return: string The unqualified classname (which can be instantiated).

__import($path, $classpath = null) X-Ref

Import a PHP file

param: string $path Path to the PHP file
param: mixed $classpath String or object supporting __toString()

getResourcePath($path) X-Ref

Looks on include path for specified file.

return: string File found (null if no file found).

setSystemConstants() X-Ref

Set System constants which can be retrieved by calling Phing::getProperty($propName).

return: void

getDefinedProperty($name) X-Ref

This gets a property that was set via command line or otherwise passed into Phing.
"Defined" in this case means "externally defined". The reason this method exists is to
provide a public means of accessing commandline properties for (e.g.) logger or listener
scripts. E.g. to specify which logfile to use, PearLogger needs to be able to access
the pear.log.name property.

param: string $name
return: string value of found property (or null, if none found).

setDefinedProperty($name, $value) X-Ref

This sets a property that was set via command line or otherwise passed into Phing.

param: string $name
return: string value of found property (or null, if none found).

getProperty($propName) X-Ref

Returns property value for a System property.
System properties are "global" properties like line.separator,
and user.dir. Many of these correspond to similar properties in Java
or Ant.

param: string $paramName
return: string Value of found property (or null, if none found).

getProperties() X-Ref

Pas de description

setProperty($propName, $propValue) X-Ref

Pas de description

currentTimeMillis() X-Ref

Pas de description

setIncludePaths() X-Ref

Sets the include path based on PHP_CLASSPATH constant (set in phing.php).

return: void

setIni() X-Ref

Sets PHP INI values that Phing needs.

return: void

getTimer() X-Ref

Returns reference to Timer object.

return: Timer