phing-tasks-system
[ class tree: phing-tasks-system ] [ index: phing-tasks-system ] [ all elements ]

Class: IncludePathTask

Source Location: /tasks/system/IncludePathTask.php

Class Overview

ProjectComponent
   |
   --Task
      |
      --IncludePathTask

Adds a normalized path to the PHP include_path.


Author(s):

Version:

  • $Revision: 526 $

Copyright:

  • � 2001,2002 THYRELL. All rights reserved

Methods


Inherited Variables

Inherited Methods

Class: Task

Task::getDescription()
Returns the textual description of the task
Task::getLocation()
Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages.
Task::getOwningTarget()
Returns the owning target of this task.
Task::getRegisterSlot()
Returns a name
Task::getRuntimeConfigurableWrapper()
Returns the wrapper object for runtime configuration
Task::getTaskName()
Returns the name of task, used only for log messages
Task::getTaskType()
Returns the name of the task under which it was invoked, usually the XML tagname
Task::init()
Called by the parser to let the task initialize properly.
Task::log()
Provides a project level log event to the task.
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.
Task::maybeConfigure()
Configure this task if it hasn't been done already.
Task::perform()
Perfrom this task
Task::setDescription()
Sets a textual description of the task
Task::setLocation()
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Task::setOwningTarget()
Sets the owning target this task belongs to.
Task::setRuntimeConfigurableWrapper()
Sets the wrapper object this task should use for runtime configurable elements.
Task::setTaskName()
Sets the name of this task for log messages
Task::setTaskType()
Sets the type of the task. Usually this is the name of the XML tag

Class: ProjectComponent

ProjectComponent::getProject()
Returns a reference to current project
ProjectComponent::log()
Logs a message with the given priority.
ProjectComponent::setProject()
References the project to the current component.

Class Details

[line 40]
Adds a normalized path to the PHP include_path.

This provides a way to alter the include_path without editing any global php.ini settings or PHP_CLASSPATH environment variable.

  1.    <includepath classpath="new/path/here"/>




Tags:

author:  Hans Lellelid <hans@xmpl.org>
version:  $Revision: 526 $
copyright:  � 2001,2002 THYRELL. All rights reserved


[ Top ]


Class Methods


method createClasspath [line 77]

void createClasspath( )

Create the classpath to be used when searching for component being defined



Tags:

access:  public


[ Top ]

method main [line 94]

void main( )

Main entry point



Tags:

access:  public


Overrides 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.)

[ Top ]

method setClasspath [line 66]

void setClasspath( $classpath)

Set the classpath to be used when searching for component being defined



Tags:

access:  public


Parameters:

Path   $classpath   An Path object containing the classpath.

[ Top ]

method setClasspathRef [line 87]

void setClasspathRef( $r)

Reference to a classpath to use when loading the files.



Tags:

access:  public


Parameters:

Reference   $r  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:05 +0200 by phpDocumentor 1.4.3