Methods
Add a new fileset.
createFileSet() : \FileSet
Returns the textual description of the task
getDescription() : string
Inherited
inherited_from |
\Task::getDescription() |
Returns
string
The text description of the task
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
inherited_from |
\Task::getLocation() |
Returns
\Location
The location object describing the position of this
task within the buildfile.
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
inherited_from |
\Task::getOwningTarget() |
Returns
\Target
The target object that owns this task
Returns a reference to current project
getProject() : \Project
Inherited
inherited_from |
\ProjectComponent::getProject() |
inherited_from |
\Task::getProject() |
Returns
\Project
Reference to current porject object
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
inherited_from |
\Task::getTaskName() |
Returns
string
Name of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
Inherited
inherited_from |
\Task::getTaskType() |
Returns
string
The type of this task (XML Tag)
Called by the parser to let the task initialize properly.
init()
Inherited
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
inherited_from |
\Task::init() |
Exceptions
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
string
The message to log
$level
integer
The priority of the message
The main function for the task
main() : void
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
phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Exceptions
Set the checkall property
setCheckAll(bool $checkall) : void
Parameters
$checkall
bool
Set the deltaset property
setDeltaSet(string $deltaSet) : void
Parameters
$deltaSet
string
Sets a textual description of the task
setDescription(string $desc)
Inherited
inherited_from |
\Task::setDescription() |
Parameters
$desc
string
The text describing the task
Set the directory where to find the patchfiles
setDir(string $dir) : void
Set the lastchangetoapply property
setLastChangeToApply(int $lastChangeToApply) : void
Parameters
$lastChangeToApply
int
Sets the location within the buildfile this task occurs.
setLocation(\Location $location)
Inherited
Called by
the parser to set location information.
inherited_from |
\Task::setLocation() |
Parameters
$location
\Location
The location object describing the position of this task within the buildfile.
Set the outputfile which contains all patch sql statements for this deployment
setOutputFile(string $outputFile) : void
Parameters
$outputFile
string
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\Target
Reference to owning target
Set the password for the database connection
setPassword(string $password) : void
Parameters
$password
string
References the project to the current component.
setProject(\Project $project)
Inherited
inherited_from |
\ProjectComponent::setProject() |
inherited_from |
\Task::setProject() |
Parameters
$project
\Project
The reference to the current project
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
inherited_from |
\Task::setTaskName() |
Parameters
$name
string
Returns
string
A string representing the name of this task for log
Sets the type of the task.
setTaskType(string $name)
Inherited
Usually this is the name of the XML tag
inherited_from |
\Task::setTaskType() |
Parameters
$name
string
The type of this task (XML Tag)
Set the undo outputfile which contains all undo statements for this deployment
setUndoOutputFile(string $undoOutputFile) : void
Parameters
$undoOutputFile
string
Set the url for the database connection
setUrl(string $url) : void
Set the userid for the database connection
setUserId(string $userid) : void
Parameters
$userid
string
Generate the sql for doing/undoing the deployment and write it to a file
createOutputFile(string $file, bool $undo) : void
Parameters
$file
string
$undo
bool
Create the deploy and undo deploy outputfiles
deploy() : void
Determine if this patch file need to be deployed
(using fileChangeNumber, lastChangeAppliedInDb and $this->checkall)
fileNeedsToBeRead(int $fileChangeNumber, string $lastChangeAppliedInDb) : bool
Parameters
$fileChangeNumber
int
$lastChangeAppliedInDb
string
Returns
bool
True or false if patch file needs to be deployed
Generate the sql for doing/undoing this deployment
generateSql(bool $undo) : string
Parameters
$undo
bool
Returns
string
The sql
Get the numbers of all the patches that are already applied according to
the changelog table in the database
getAppliedChangeNumbers() : array
Get a list of all the patch files in the patch file directory
getDeltasFilesArray() : array
Get the number of the last patch applied to the database
getLastChangeAppliedInDb() : int | mixed
Returns
int
mixed
The highest patch number that is applied in the db
Returns a name
getRegisterSlot(string $slotName)
Inherited
inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
Sort files in the patch files directory (ascending or descending depending on $undo boolean)
sortFiles(array $files, bool $undo) : void
Parameters
$files
array
$undo
bool
Properties
$appliedChangeNumbers : array
$description : string
Inherited
inherited_from |
\Task::$$description |
$location : \Location
Inherited
inherited_from |
\Task::$$location |
$project : \Project
Inherited
inherited_from |
\ProjectComponent::$$project |
inherited_from |
\Task::$$project |
$target : \Target
Inherited
inherited_from |
\Task::$$target |
$taskName : string
Inherited
inherited_from |
\Task::$$taskName |
$taskType : string
Inherited
inherited_from |
\Task::$$taskType |