Phing API Documentation
Back to top  

XsltTask

Extends \CopyTask

Implements an XSLT processing filter while copying files.

This is a shortcut for calling the task with the XSLTFilter used in the section.

author

Andreas Aderhold, andi@binarycloud.com
version

$Id: 8f87e1c7908c06223382baf628d018c3a0f10824 $
package

phing.tasks.system

Methods

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

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.

Set the stylesheet to use.

setStyle(\PhingFile $style)

Arguments

$style

\PhingFile

Whether to resolve entities in the XML document.

setResolveDocumentExternals(bool $resolveExternals)
since 2.4

Arguments

$resolveExternals

bool

Whether to resolve entities in the stylesheet.

setResolveStylesheetExternals(bool $resolveExternals)
since 2.4

Arguments

$resolveExternals

bool

Support nested <param> tags useing XSLTParam class.

createParam() : \XSLTParam

Response

\XSLTParam

Sets up this object internal stuff. i.e. the Fileutils instance and default mode

__construct() : object
inherited
access

public

Response

object

The CopyTask instance

Set the overwrite flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here.

setOverwrite($bool) : void
inherited
access

public

Arguments

$bool

Used to force listing of all names of copied files.

setVerbose(boolean $verbosity)
inherited

Arguments

$verbosity

boolean

setTstamp

setTstamp($bool)
inherited
see \CopyTask::setPreserveLastModified

Arguments

$bool

Set the preserve timestamp flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here.

setPreserveLastModified($bool) : void
inherited
access

public

Arguments

$bool

Set the preserve permissions flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here.

setPreservepermissions($bool) : void
inherited
access

public

Arguments

$bool

setPreservemode

setPreservemode($bool)
inherited

Arguments

$bool

Set the include empty dirs flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here.

setIncludeEmptyDirs($bool) : void
inherited
access

public

Arguments

$bool

Set the file. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary.

setFile(\PhingFile $file) : void
inherited
access

public

Arguments

$file

\PhingFile

Set the toFile. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary.

setTofile(\PhingFile $file) : void
inherited
access

public

Arguments

$file

\PhingFile

Sets the mode to create destination directories with (ignored on Windows).

setMode($mode) : void
inherited

Default mode is taken from umask()

access

public

Arguments

$mode

Set the toDir. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary.

setTodir(\PhingFile $dir) : void
inherited
access

public

Arguments

$dir

\PhingFile

Set the haltonerror attribute - when true, will make the build fail when errors are detected.

setHaltonerror($haltonerror) : void
inherited
access

public

Arguments

$haltonerror

Nested creator, creates a FileSet for this task

addFileSet(\FileSet $fs) : void
inherited

Arguments

$fs

\FileSet

Nested creator, adds a set of files (nested fileset attribute).

createFileList() : object
inherited
access

public

Response

object

The created filelist object

Creates a filterchain

createFilterChain() : object
inherited
access

public

Response

object

The created filterchain object

Nested creator, creates one Mapper for this task

createMapper() : object
inherited
access

public
throws

Response

object

The created Mapper type object

Validates attributes coming in from XML

validateAttributes() : void
inherited
access

private
throws

Compares source files to destination files to see if they should be copied.

_scan($fromDir, $toDir, $files, $dirs) : void
inherited
access

private

Arguments

$fromDir

$toDir

$files

$dirs

Builds a map of filenames (from->to) that should be copied

buildMap($fromDir, $toDir, $names, $mapper, $map) : void
inherited
access

private

Arguments

$fromDir

$toDir

$names

$mapper

$map

Actually copies the files

doWork() : void
inherited
access

private
throws

logError

logError($message, $location = NULL)
inherited

Arguments

$message

$location

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

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

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)

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

setTaskType($name)
inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)
inherited

Arguments

$slotName

string

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)
inherited

Arguments

$desc

string

The text describing the task

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.

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.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

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

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

maybeConfigure()
inherited

Perfrom this task

perform()
inherited

References the project to the current component.

setProject(\Project $project)
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Properties

XSLTFilter object that we use to handle transformation.

xsltFilter :

Parameters to pass to XSLT procesor.

parameters :

file

file :
inherited

destFile

destFile :
inherited

destDir

destDir :
inherited

overwrite

overwrite :
inherited

preserveLMT

preserveLMT :
inherited

preservePermissions

preservePermissions :
inherited

includeEmpty

includeEmpty :
inherited

flatten

flatten :
inherited

mapperElement

mapperElement :
inherited

fileCopyMap

fileCopyMap :
inherited

dirCopyMap

dirCopyMap :
inherited

completeDirMap

completeDirMap :
inherited

fileUtils

fileUtils :
inherited

filesets

filesets :
inherited

filelists

filelists :
inherited

filterChains

filterChains :
inherited

verbosity

verbosity :
inherited

mode

mode :
inherited

haltonerror

haltonerror :
inherited

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