Element index for package phing
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ w ]
[ _ ]
_
- _makeCircularException
- in file Project.php, method Project::_makeCircularException()
- _topoSort
- in file Project.php, method Project::_topoSort()
Topologically sort a set of Targets.
- _tsort
- in file Project.php, method Project::_tsort()
- __construct
- in file RuntimeConfigurable.php, method RuntimeConfigurable::__construct()
- __construct
- in file UnknownElement.php, method UnknownElement::__construct()
Constructs a UnknownElement object
- __construct
- in file Project.php, method Project::__construct()
Constructor, sets any default vars.
- __construct
- in file BuildException.php, method BuildException::__construct()
Construct a BuildException.
- __construct
- in file ConfigurationException.php, method ConfigurationException::__construct()
Construct a BuildException.
- __construct
- in file IntrospectionHelper.php, method IntrospectionHelper::__construct()
This function constructs a new introspection helper for a specific class.
- __construct
- in file BuildEvent.php, method BuildEvent::__construct()
Construct a BuildEvent for a project, task or target source event
- __import
- in file Phing.php, method Phing::__import()
Import a PHP file
top
a
- addBuildListener
- in file Project.php, method Project::addBuildListener()
- addChild
- in file RuntimeConfigurable.php, method RuntimeConfigurable::addChild()
Adds child elements to the wrapped element.
- addChild
- in file UnknownElement.php, method UnknownElement::addChild()
Add a child element to the unknown element
- addDataType
- in file Target.php, method Target::addDataType()
Adds a runtime configurable element to the list of this targets child elements.
- addDataTypeDefinition
- in file Project.php, method Project::addDataTypeDefinition()
Adds a data type definition.
- addDependency
- in file Target.php, method Target::addDependency()
Adds a singular dependent target name to the list
- addOrReplaceTarget
- in file Project.php, method Project::addOrReplaceTarget()
- addReference
- in file Project.php, method Project::addReference()
Adds a reference to an object. This method is called when the parser
- addTarget
- in file Project.php, method Project::addTarget()
add a new target to the project
- addTask
- in file Target.php, method Target::addTask()
Adds a task element to the list of this targets child elements
- addTask
- in file TaskContainer.php, method TaskContainer::addTask()
Adds a task to this task container. Must be implemented by derived class
- addTaskDefinition
- in file Project.php, method Project::addTaskDefinition()
Adds a task definition.
- addText
- in file IntrospectionHelper.php, method IntrospectionHelper::addText()
Adds PCDATA areas.
- addText
- in file RuntimeConfigurable.php, method RuntimeConfigurable::addText()
Add characters from #PCDATA areas to the wrapped element.
top
top
c
- $cause
- in file BuildException.php, variable BuildException::$cause
The nested "cause" exception.
- $cause
- in file ConfigurationException.php, variable ConfigurationException::$cause
The nested "cause" exception.
- clearCapturedPhpErrors
- in file Phing.php, method Phing::clearCapturedPhpErrors()
Clears the captured errors without affecting the starting/stopping of the capture.
- ConfigurationException
- in file ConfigurationException.php, class ConfigurationException
ConfigurationException is thrown by Phing during the configuration and setup phase of the project.
- ConfigurationException.php
- procedural page ConfigurationException.php
- copyInheritedProperties
- in file Project.php, method Project::copyInheritedProperties()
Copies all user properties that have not been set on the command line or a GUI tool from this instance to the Project instance given as the argument.
- copyUserProperties
- in file Project.php, method Project::copyUserProperties()
Copies all user properties that have been set on the command line or a GUI tool from this instance to the Project instance given as the argument.
- createDataType
- in file Project.php, method Project::createDataType()
Create a task instance and return reference to it See createTask() for explanation how this works
- createElement
- in file IntrospectionHelper.php, method IntrospectionHelper::createElement()
Creates a named nested element.
- createTask
- in file Project.php, method Project::createTask()
Create a new task instance and return reference to it. This method is sorta factory like. A _local_ instance is created and a reference returned to that instance. Usually PHP destroys local variables when the function call ends. But not if you return a reference to that variable.
- currentTimeMillis
- in file Phing.php, method Phing::currentTimeMillis()
top
top
top
top
g
- getAttributes
- in file IntrospectionHelper.php, method IntrospectionHelper::getAttributes()
Return all attribues supported by the introspected class.
- getAttributes
- in file RuntimeConfigurable.php, method RuntimeConfigurable::getAttributes()
Returns the AttributeList of the wrapped element.
- getBasedir
- in file Project.php, method Project::getBasedir()
Returns the basedir of this project
- getBuildListeners
- in file Project.php, method Project::getBuildListeners()
- getCapturedPhpErrors
- in file Phing.php, method Phing::getCapturedPhpErrors()
Gets any PHP errors that were captured to buffer.
- getCause
- in file BuildException.php, method BuildException::getCause()
Gets the cause exception.
- getCause
- in file ConfigurationException.php, method ConfigurationException::getCause()
Gets the cause exception.
- getChild
- in file RuntimeConfigurable.php, method RuntimeConfigurable::getChild()
Returns the child with index
- getCurrentProject
- in file Phing.php, method Phing::getCurrentProject()
Gets the current Project.
- getDataTypeDefinitions
- in file Project.php, method Project::getDataTypeDefinitions()
- getDefaultTarget
- in file Project.php, method Project::getDefaultTarget()
- getDefinedProperty
- in file Phing.php, method Phing::getDefinedProperty()
This gets a property that was set via command line or otherwise passed into Phing.
- getDependencies
- in file Target.php, method Target::getDependencies()
Returns reference to indexed array of the dependencies this target has.
- getDescription
- in file Task.php, method Task::getDescription()
Returns the textual description of the task
- getDescription
- in file Target.php, method Target::getDescription()
Returns the description of this target.
- getDescription
- in file Project.php, method Project::getDescription()
return the description, null otherwise
- getElementName
- in file IntrospectionHelper.php, method IntrospectionHelper::getElementName()
Get the the name for an element.
- getElementTag
- in file RuntimeConfigurable.php, method RuntimeConfigurable::getElementTag()
- getErrorStream
- in file Phing.php, method Phing::getErrorStream()
Gets the stream to use for error output.
- getException
- in file BuildEvent.php, method BuildEvent::getException()
Returns the exception that was thrown, if any.
- getGlobalFilterSet
- in file Project.php, method Project::getGlobalFilterSet()
returns the global filterset (future use)
- getHelper
- in file IntrospectionHelper.php, method IntrospectionHelper::getHelper()
Factory method for helper objects.
- getInputHandler
- in file Project.php, method Project::getInputHandler()
Retrieves the current input handler.
- getLocation
- in file BuildException.php, method BuildException::getLocation()
Gets the location of error in XML file.
- getLocation
- in file Task.php, method Task::getLocation()
Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages.
- getMessage
- in file BuildEvent.php, method BuildEvent::getMessage()
Returns the logging message. This field will only be set for "messageLogged" events.
- getMsgOutputLevel
- in file Phing.php, method Phing::getMsgOutputLevel()
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.
- getName
- in file Target.php, method Target::getName()
Returns name of this target.
- getName
- in file Project.php, method Project::getName()
Returns the name of this project
- getNestedElements
- in file IntrospectionHelper.php, method IntrospectionHelper::getNestedElements()
Return all nested elements supported by the introspected class.
- getOutputStream
- in file Phing.php, method Phing::getOutputStream()
Gets the stream to use for standard (non-error) output.
- getOwningTarget
- in file Task.php, method Task::getOwningTarget()
Returns the owning target of this task.
- getPhingVersion
- in file Phing.php, method Phing::getPhingVersion()
Gets the current Phing version based on VERSION.TXT file.
- getPriority
- in file BuildEvent.php, method BuildEvent::getPriority()
Returns the priority of the logging message. This field will only be set for "messageLogged" events.
- getProject
- in file Target.php, method Target::getProject()
Returns reference to current project
- getProject
- in file ProjectComponent.php, method ProjectComponent::getProject()
Returns a reference to current project
- getProject
- in file BuildEvent.php, method BuildEvent::getProject()
Returns the project instance that fired this event.
- getProperties
- in file Project.php, method Project::getProperties()
Returns a copy of the properties table.
- getProperties
- in file Phing.php, method Phing::getProperties()
Retuns reference to all properties
- getProperty
- in file Project.php, method Project::getProperty()
Returns the value of a property, if it is set.
- getProperty
- in file Phing.php, method Phing::getProperty()
Returns property value for a System property.
- getPropertyName
- in file IntrospectionHelper.php, method IntrospectionHelper::getPropertyName()
extract the name of a property from a method name - subtracting a given prefix.
- getProxy
- in file TaskAdapter.php, method TaskAdapter::getProxy()
Gets the target object.
- getReference
- in file Project.php, method Project::getReference()
Returns a specific reference.
- getReferences
- in file Project.php, method Project::getReferences()
Returns the references array.
- getRegisterSlot
- in file Task.php, method Task::getRegisterSlot()
Returns a name
- getResourcePath
- in file Phing.php, method Phing::getResourcePath()
Looks on include path for specified file.
- getRuntimeConfigurableWrapper
- in file Task.php, method Task::getRuntimeConfigurableWrapper()
Returns the wrapper object for runtime configuration
- getTag
- in file UnknownElement.php, method UnknownElement::getTag()
Return the XML element name that this UnnownElement
handles.
- getTarget
- in file BuildEvent.php, method BuildEvent::getTarget()
Returns the target instance that fired this event.
- getTargets
- in file Project.php, method Project::getTargets()
- getTask
- in file BuildEvent.php, method BuildEvent::getTask()
Returns the target instance that fired this event.
- getTaskDefinitions
- in file Project.php, method Project::getTaskDefinitions()
- getTaskName
- in file UnknownElement.php, method UnknownElement::getTaskName()
Get the name of the task to use in logging messages.
- getTaskName
- in file Task.php, method Task::getTaskName()
Returns the name of task, used only for log messages
- getTasks
- in file Target.php, method Target::getTasks()
Returns an array of all tasks this target has as childrens.
- getTaskType
- in file Task.php, method Task::getTaskType()
Returns the name of the task under which it was invoked, usually the XML tagname
- getTimer
- in file Phing.php, method Phing::getTimer()
Returns reference to Timer object.
- getUserProperties
- in file Project.php, method Project::getUserProperties()
Returns a copy of the user property hashtable
- getUserProperty
- in file Project.php, method Project::getUserProperty()
Returns the value of a user property, if it is set.
top
top
i
- import
- in file Phing.php, method Phing::import()
Import a dot-path notation class path.
- init
- in file Task.php, method Task::init()
Called by the parser to let the task initialize properly.
- init
- in file Project.php, method Project::init()
inits the project, called from main app
- IntrospectionHelper
- in file IntrospectionHelper.php, class IntrospectionHelper
Helper class that collects the methods that a task or nested element holds to set attributes, create nested elements or hold PCDATA elements.
- IntrospectionHelper.php
- procedural page IntrospectionHelper.php
top
top
m
- $message
- in file BuildEvent.php, variable BuildEvent::$message
The message of this event, if the event is a message
- main
- in file TaskAdapter.php, method TaskAdapter::main()
Main entry point.
- main
- in file Target.php, method Target::main()
The entry point for this class. Does some checking, then processes and performs the tasks for this target.
- main
- in file Task.php, method Task::main()
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.
- main
- in file UnknownElement.php, method UnknownElement::main()
Called when the real task has been configured for the first time.
- makeObject
- in file UnknownElement.php, method UnknownElement::makeObject()
Creates a named task or data type. If the real object is a task, it is configured up to the init() stage.
- makeTask
- in file UnknownElement.php, method UnknownElement::makeTask()
Create a named task and configure it up to the init() stage.
- maybeConfigure
- in file UnknownElement.php, method UnknownElement::maybeConfigure()
Tries to configure the unknown element
- maybeConfigure
- in file Task.php, method Task::maybeConfigure()
Configure this task if it hasn't been done already.
- maybeConfigure
- in file RuntimeConfigurable.php, method RuntimeConfigurable::maybeConfigure()
Configure the wrapped element and all children.
- messageLogged
- in file BuildListener.php, method BuildListener::messageLogged()
Fired whenever a message is logged.
- MSG_DEBUG
- in file Project.php, class constant Project::MSG_DEBUG
- MSG_ERR
- in file Project.php, class constant Project::MSG_ERR
- MSG_INFO
- in file Project.php, class constant Project::MSG_INFO
- MSG_VERBOSE
- in file Project.php, class constant Project::MSG_VERBOSE
- MSG_WARN
- in file Project.php, class constant Project::MSG_WARN
top
p
- $priority
- in file BuildEvent.php, variable BuildEvent::$priority
The priority of the message
- $project
- in file ProjectComponent.php, variable ProjectComponent::$project
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
- $project
- in file BuildEvent.php, variable BuildEvent::$project
A reference to the project
- perform
- in file Task.php, method Task::perform()
Perfrom this task
- performTasks
- in file Target.php, method Target::performTasks()
Performs the tasks by calling the main method of this target that actually executes the tasks.
- Phing
- in file Phing.php, class 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.
- Phing.php
- procedural page Phing.php
- printDescription
- in file Phing.php, method Phing::printDescription()
Print the project description, if any
- printMessage
- in file Phing.php, method Phing::printMessage()
Prints the message of the Exception if it's not null.
- printTargets
- in file Phing.php, method Phing::printTargets()
Print out a list of all targets in the current buildfile
- printUsage
- in file Phing.php, method Phing::printUsage()
Prints the usage of how to use this class
- printVersion
- in file Phing.php, method Phing::printVersion()
Prints the current Phing version.
- Project
- in file Project.php, class Project
The Phing project class. Represents a completely configured Phing project.
- Project.php
- procedural page Project.php
- ProjectComponent
- in file ProjectComponent.php, class ProjectComponent
Abstract class providing properties and methods common to all the project components
- ProjectComponent.php
- procedural page ProjectComponent.php
top
top
s
- StreamRequiredBuildLogger.php
- procedural page StreamRequiredBuildLogger.php
- setAttribute
- in file IntrospectionHelper.php, method IntrospectionHelper::setAttribute()
Sets the named attribute.
- setAttributes
- in file RuntimeConfigurable.php, method RuntimeConfigurable::setAttributes()
Set's the attributes for the wrapped element.
- setBasedir
- in file Project.php, method Project::setBasedir()
Set basedir object from xml
- setCurrentProject
- in file Phing.php, method Phing::setCurrentProject()
Sets the current Project
- setDefaultTarget
- in file Project.php, method Project::setDefaultTarget()
- setDefinedProperty
- in file Phing.php, method Phing::setDefinedProperty()
This sets a property that was set via command line or otherwise passed into Phing.
- setDepends
- in file Target.php, method Target::setDepends()
Sets the target dependencies from xml
- setDescription
- in file Project.php, method Project::setDescription()
Set the projects description
- setDescription
- in file Task.php, method Task::setDescription()
Sets a textual description of the task
- setDescription
- in file Target.php, method Target::setDescription()
Sets a textual description of this target.
- setErrorStream
- in file Phing.php, method Phing::setErrorStream()
Sets the stream to use for error output.
- setErrorStream
- in file BuildLogger.php, method BuildLogger::setErrorStream()
Sets the output stream to use for errors.
- setException
- in file BuildEvent.php, method BuildEvent::setException()
Set the exception that was the cause of this event.
- setIf
- in file Target.php, method Target::setIf()
Set the if-condition from the XML tag, if any. The property name given as parameter must be present so the if condition evaluates to true
- setInheritedProperty
- in file Project.php, method Project::setInheritedProperty()
Sets a user property, which cannot be overwritten by set/unset property calls. Any previous value is overwritten. Also marks these properties as properties that have not come from the command line.
- setInputHandler
- in file Project.php, method Project::setInputHandler()
Sets the input handler
- setLocation
- in file Task.php, method Task::setLocation()
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
- setLocation
- in file BuildException.php, method BuildException::setLocation()
Sets the location of error in XML file.
- setMessage
- in file BuildEvent.php, method BuildEvent::setMessage()
Sets the message with details and the message priority for this event.
- setMessageOutputLevel
- in file BuildLogger.php, method BuildLogger::setMessageOutputLevel()
Sets the min log level that this logger should respect.
- setName
- in file Target.php, method Target::setName()
Sets the name of the target
- setName
- in file Project.php, method Project::setName()
Sets the name of the current project
- setNewProperty
- in file Project.php, method Project::setNewProperty()
Sets a property if no value currently exists. If the property exists already, a message is logged and the method returns with no other effect.
- setOutputStream
- in file Phing.php, method Phing::setOutputStream()
Sets the stream to use for standard (non-error) output.
- setOutputStream
- in file BuildLogger.php, method BuildLogger::setOutputStream()
Sets the standard output stream to use.
- setOwningTarget
- in file Task.php, method Task::setOwningTarget()
Sets the owning target this task belongs to.
- setProject
- in file ProjectComponent.php, method ProjectComponent::setProject()
References the project to the current component.
- setProject
- in file Target.php, method Target::setProject()
References the project to the current component.
- setProperty
- in file Phing.php, method Phing::setProperty()
- setProperty
- in file Project.php, method Project::setProperty()
Sets a property. Any existing property of the same name is overwritten, unless it is a user property.
- setProxy
- in file TaskAdapter.php, method TaskAdapter::setProxy()
Set the target object.
- setProxy
- in file RuntimeConfigurable.php, method RuntimeConfigurable::setProxy()
- setRuntimeConfigurableWrapper
- in file Task.php, method Task::setRuntimeConfigurableWrapper()
Sets the wrapper object this task should use for runtime configurable elements.
- setSystemProperties
- in file Project.php, method Project::setSystemProperties()
Sets system properties and the environment variables for this project.
- setTaskName
- in file Task.php, method Task::setTaskName()
Sets the name of this task for log messages
- setTaskType
- in file Task.php, method Task::setTaskType()
Sets the type of the task. Usually this is the name of the XML tag
- setUnless
- in file Target.php, method Target::setUnless()
Set the unless-condition from the XML tag, if any. The property name given as parameter must be present so the unless condition evaluates to true
- setUserProperty
- in file Project.php, method Project::setUserProperty()
Sets a user property, which cannot be overwritten by set/unset property calls. Any previous value is overwritten.
- shutdown
- in file Phing.php, method Phing::shutdown()
Performs any shutdown routines, such as stopping timers.
- start
- in file Phing.php, method Phing::start()
Entry point allowing for more options from other front ends.
- startPhpErrorCapture
- in file Phing.php, method Phing::startPhpErrorCapture()
Begins capturing PHP errors to a buffer.
- startup
- in file Phing.php, method Phing::startup()
Start up Phing.
- stopPhpErrorCapture
- in file Phing.php, method Phing::stopPhpErrorCapture()
Stops capturing PHP errors to a buffer.
- storeElement
- in file IntrospectionHelper.php, method IntrospectionHelper::storeElement()
Creates a named nested element.
- StreamRequiredBuildLogger
- in file StreamRequiredBuildLogger.php, class StreamRequiredBuildLogger
Interface for build loggers that require that out/err streams be set in order to function.
- supportsCharacters
- in file IntrospectionHelper.php, method IntrospectionHelper::supportsCharacters()
Does the introspected class support PCDATA?
top
t
- $target
- in file Task.php, variable Task::$target
- $target
- in file BuildEvent.php, variable BuildEvent::$target
A reference to the target
- $task
- in file BuildEvent.php, variable BuildEvent::$task
A reference to the task
- $taskName
- in file Task.php, variable Task::$taskName
- $taskType
- in file Task.php, variable Task::$taskType
- Target
- in file Target.php, class Target
The Target component. Carries all required target data. Implements the abstract class TaskContainer
- Target.php
- procedural page Target.php
- targetFinished
- in file BuildListener.php, method BuildListener::targetFinished()
Fired when a target has finished.
- targetStarted
- in file BuildListener.php, method BuildListener::targetStarted()
Fired when a target is started.
- Task
- in file Task.php, class Task
The base class for all Tasks.
- Task.php
- procedural page Task.php
- TaskAdapter
- in file TaskAdapter.php, class TaskAdapter
Use introspection to "adapt" an arbitrary ( not extending Task, but with similar patterns).
- TaskAdapter.php
- procedural page TaskAdapter.php
- TaskContainer
- in file TaskContainer.php, class TaskContainer
Abstract interface for objects which can contain tasks (targets) Used to check if a class can contain tasks (via instanceof)
- TaskContainer.php
- procedural page TaskContainer.php
- taskFinished
- in file BuildListener.php, method BuildListener::taskFinished()
Fired when a task has finished.
- taskStarted
- in file BuildListener.php, method BuildListener::taskStarted()
Fired when a task is started.
- toString
- in file Target.php, method Target::toString()
Returns a string representation of this target. In our case it simply returns the target name field
top
u
- UnknownElement
- in file UnknownElement.php, class UnknownElement
Wrapper class that holds all information necessary to create a task that did not exist when Phing started.
- UnknownElement.php
- procedural page UnknownElement.php
- unsetCurrentProject
- in file Phing.php, method Phing::unsetCurrentProject()
Unsets the current Project
top
top
|
|