zsdtPackTask

Extends \zsdtBaseTask

Class ZendServerDeploymentToolTask

Use \Project#createTask to register a new Task.

author

Siad Ardroumli siad.ardroumli@gmail.com

package

phing.tasks.ext.zendserverdevelopmenttools

Methods

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this task within the buildfile.

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

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.

throws

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) : void
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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() 
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Configure this task if it hasn't been done already.

maybeConfigure() 
inherited

Perfrom this task

perform() 
inherited
throws

Sets a textual description of the task

setDescription(string $desc) 
inherited

Arguments

$desc

string

The text describing the task

The package descriptor file.

setDescriptor(string $descriptor) : void
inherited

Arguments

$descriptor

string

Performs a PHP lint test on the deployment scripts before creating the package.

setLint(boolean $lint) : void

Arguments

$lint

boolean

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

The directory in which the package is created.

setOutput(string $output) : void

The package name will be created as "-.zpk".

Arguments

$output

string

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

A directory containing the data and the script directories, in addition to the package descriptor file.

setPackage(string $package) : void

Arguments

$package

string

setPath

setPath(string $path) : void
inherited

Arguments

$path

string

The PHP executable to use for lint.

setPhpbin(string $phpbin) : void

Arguments

$phpbin

string

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

The path to the package descriptor schema used for validation.

setSchema(string $schema) : void
inherited

Arguments

$schema

string

The directory which contains the package deployment scripts.

setScripts(string $scripts) : void

The Deployment Tool will search this directory for the expected files and then packs them.

Arguments

$scripts

string

The directory that contains the application resources (PHP sources, JavaScript, etc.).

setSource(string $source) : void

The directory's internal structure must match the necessary structure for the application to be functional.

Arguments

$source

string

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Sets the type of the task. Usually this is the name of the XML tag

setTaskType( $name) 
inherited

Arguments

$name

Validates argument list.

validate() : void
inherited

Properties

package

package : string
var

Type(s)

string

source

source : string
var

Type(s)

string

scripts

scripts : string
var

Type(s)

string

output

output : string
var

Type(s)

string

phpbin

phpbin : string
var

Type(s)

string

lint

lint : boolean
var

Type(s)

boolean

action

action : 
inherited

Type(s)

arguments

arguments : 
inherited

Type(s)

descriptor

descriptor : string
inherited
var

Type(s)

string

schema

schema : string
inherited
var

Type(s)

string

path

path : array
inherited
var

Type(s)

array

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project