tasks/ext/PatchTask.php

Show:

inherited

Classes
- \PatchTask

Table of Contents

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

Requires "patch" to be on the execution path.

Based on Apache Ant PatchTask:

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

\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

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

bool
                 $haltOnFailure= 'false'

Halt on error return value from patch invocation.

Default valuefalseDetails

Type: bool

string
                 $originalFile= ''

File to be patched

Details

Type: string

string
                 $patchFile= ''

Patch file

Details

Type: string

int
                 $strip= ''

Value for a "-p" option

Details

Type: int

Methods

getDescription(
          
          )
        
        :
          void

getLocation(
          
          )
        
        :
          void

getOwningTarget(
          
          )
        
        :
          void

getProject(
          
          )
        
        :
          void

getRegisterSlot(
          
          )
        
        :
          void

getRuntimeConfigurableWrapper(
          
          )
        
        :
          void

getTaskName(
          
          )
        
        :
          void

getTaskType(
          
          )
        
        :
          void

Main task method

Throws

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

maybeConfigure(
          
          )
        
        :
          void

perform(
          
          )
        
        :
          void

setBackups(
          bool $backups
          )
        
        :
          void

Flag to create backups

Optional, default - false

Parameters

Name	Type	Description
$backups	bool	If true create backups

setDescription(
          
          )
        
        :
          void

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(
          
          )
        
        :
          void

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(
          
          )
        
        :
          void

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(
          
          )
        
        :
          void

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(
          
          )
        
        :
          void

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(
          
          )
        
        :
          void

setTaskType(
          
          )
        
        :
          void

tasks/ext/PatchTask.php

\PatchTaskjump to top

Constants

Properties

Methods

\PatchTask
jump to top