tasks/ext/PatchTask.php

Show:

inherited

Classes
- \PatchTask

Table of Contents

\PatchTask
jump to top

Package: phing\tasks\ext

Patches a file by applying a 'diff' file to it

Requires "patch" to be on the execution path.

Parent(s): \Task < \ProjectComponent
Author: Andreas Aderhold
Copyright: 2001,2002 THYRELL. All rights reserved
Version: $Id$

Constants

string 
                CMD
                = 'patch --batch --silent '

Base command to be executed (must end with a space character!)

: string

Properties

array
                 $cmdArgs= 'array()'

Command line arguments for patch binary

Default valuearray()Details

Type: array

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description

bool
                 $haltOnFailure= 'false'

Halt on error return value from patch invocation.

Default valuefalseDetails

Type: bool

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location

string
                 $originalFile= ''

File to be patched

Details

Type: string

string
                 $patchFile= ''

Patch file

Details

Type: string

\Project
                 $project= 'null'

inherited

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

A reference to the current project instanceInherited from: \ProjectComponent::$$project \Task::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \Task::$$project

int
                 $strip= ''

Value for a "-p" option

Details

Type: int

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

Methods

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \Location

inherited

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

Inherited from: \Task::getLocation()

Returns

Type	Description
\Location	The location object describing the position of this task within the buildfile.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          string

inherited

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

Inherited from: \Task::getTaskType()

Returns

Type	Description
string	The type of this task (XML Tag)

inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws

Exception	Description
\BuildException

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

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

Main task method

Should throw a BuildException if someting goes wrong with the build

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

Throws

Exception	Description
\BuildException	when it all goes a bit pear shaped

maybeConfigure(
          
          )
        
        :
          void

inherited

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

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

setBackups(
          bool $backups
          )
        
        :
          void

Flag to create backups

Optional, default - false

Parameters

Name	Type	Description
$backups	bool	If true create backups

setDescription(
          string $desc
          )
        
        :
          void

inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()

Parameters

Name	Type	Description
$desc	string	The text describing the task

setDestFile(
          string $file
          )
        
        :
          void

The name of a file to send the output to, instead of patching the file(s) in place

Optional.

Parameters

Name	Type	Description
$file	string	File to send the output to

setDir(
          string $directory
          )
        
        :
          void

The directory to run the patch command in

Defaults to the project's base directory.

Parameters

Name	Type	Description
$directory	string	Directory to run the patch command in

setForward(
          bool $flag
          )
        
        :
          void

Ignore patches that seem to be reversed or already applied

Parameters

Name	Type	Description
$flag	bool	If true set the -N (--forward) option

setFuzz(
          string $value
          )
        
        :
          void

Set the maximum fuzz factor

Defaults to 0

Parameters

Name	Type	Description
$value	string	Value of a fuzz factor

setHaltOnFailure(
          bool $value
          )
        
        :
          void

If true, stop the build process if the patch command exits with an error status.

The default is "false"

Parameters

Name	Type	Description
$value	bool	"true" if it should halt, otherwise "false"

setIgnoreWhiteSpace(
          bool $ignore
          )
        
        :
          void

Flag to ignore whitespace differences;

Default - false

Parameters

Name	Type	Description
$ignore	bool	If true ignore whitespace differences

setLocation(
          \Location $location
          )
        
        :
          void

inherited

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

Inherited from: \Task::setLocation()

Parameters

Name	Type	Description
$location	\Location	The location object describing the position of this task within the buildfile.

setOriginalFile(
          string $file
          )
        
        :
          void

The file to patch

Optional if it can be inferred from the diff file.

Parameters

Name	Type	Description
$file	string	File to patch

setOwningTarget(
          \Target $target
          )
        
        :
          void

inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()

Parameters

Name	Type	Description
$target	\Target	Reference to owning target

setPatchFile(
          string $file
          )
        
        :
          void

The file containing the diff output

Required.

Parameters

Name	Type	Description
$file	string	File containing the diff output

Throws

Exception	Description
\BuildException	if $file not exists

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setQuiet(
          bool $flag
          )
        
        :
          void

Work silently unless an error occurs

Optional, default - false

Parameters

Name	Type	Description
$flag	bool	If true suppress set the -s option on the patch command

setReverse(
          bool $flag
          )
        
        :
          void

Assume patch was created with old and new files swapped

Optional, default - false

Parameters

Name	Type	Description
$flag	bool	If true set the -R option on the patch command

setRuntimeConfigurableWrapper(
          \RuntimeConfigurable $wrapper
          )
        
        :
          void

inherited

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

Inherited from: \Task::setRuntimeConfigurableWrapper()

Parameters

Name	Type	Description
$wrapper	\RuntimeConfigurable	The wrapper object this task should use

setStrip(
          int $num
          )
        
        :
          void

Strip the smallest prefix containing num leading slashes from filenames.

patch's --strip option.

Parameters

Name	Type	Description
$num	int	number of lines to strip

Throws

Exception	Description
\BuildException	if num is < 0, or other errors

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          string $name
          )
        
        :
          void

inherited

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

Inherited from: \Task::setTaskType()

Parameters

Name	Type	Description
$name	string	The type of this task (XML Tag)

tasks/ext/PatchTask.php

\PatchTaskjump to top

Constants

Properties

Methods

\PatchTask
jump to top