Class JFilesystemPatcher

A Unified Diff Format Patcher class

Package: Joomla\Platform\FileSystem
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.1
Link: This has been derived from the PhpPatcher version 0.1.1 written by Giuseppe Mazzotta
Located at joomla/filesystem/patcher.php

Methods summary

`protected`	# `__construct( )` Constructor Constructor The constructor is protected to force the use of JFilesystemPatcher::getInstance() Since 12.1
`public static JFilesystemPatcher`	# `getInstance( )` Method to get a patcher Method to get a patcher Returns `JFilesystemPatcher` - an instance of the patcher Since 12.1
`public JFilesystemPatcher`	# `reset( )` Reset the pacher Reset the pacher Returns `JFilesystemPatcher` - This object for chaining Since 12.1
`public integer`	# `apply( )` Apply the patches Apply the patches Returns `integer` - The number of files patched Throws `RuntimeException` Since 12.1
`public JFilesystemPatch`	# `addFile( string $filename, string $root = JPATH_BASE, string $strip = 0 )` Add a unified diff file to the patcher Add a unified diff file to the patcher Parameters `$filename` `string` - $filename Path to the unified diff file `$root` `string` - $root The files root path `$strip` `string` - $strip The number of '/' to strip Returns `JFilesystemPatch` - $this for chaining Since 12.1
`public JFilesystemPatch`	# `add( string $udiff, string $root = JPATH_BASE, string $strip = 0 )` Add a unified diff string to the patcher Add a unified diff string to the patcher Parameters `$udiff` `string` - $udiff Unified diff input string `$root` `string` - $root The files root path `$strip` `string` - $strip The number of '/' to strip Returns `JFilesystemPatch` - $this for chaining Since 12.1
`protected static array`	# `splitLines( string $data )` Separate CR or CRLF lines Separate CR or CRLF lines Parameters `$data` `string` - $data Input string Returns `array` - The lines of the inputdestination file Since 12.1
`protected static boolean`	# `findHeader( array & $lines, string & $src, string & $dst )` Find the diff header Find the diff header The internal array pointer of $lines is on the next line after the finding Parameters `$lines` `array` - &$lines The udiff array of lines `$src` `string` - &$src The source file `$dst` `string` - &$dst The destination file Returns `boolean` - TRUE in case of success, FALSE in case of failure Throws `RuntimeException` Since 12.1
`protected static boolean`	# `findHunk( array & $lines, string & $src_line, string & $src_size, string & $dst_line, string & $dst_size )` Find the next hunk of difference Find the next hunk of difference The internal array pointer of $lines is on the next line after the finding Parameters `$lines` `array` - &$lines The udiff array of lines `$src_line` `string` - &$src_line The beginning of the patch for the source file `$src_size` `string` - &$src_size The size of the patch for the source file `$dst_line` `string` - &$dst_line The beginning of the patch for the destination file `$dst_size` `string` - &$dst_size The size of the patch for the destination file Returns `boolean` - TRUE in case of success, false in case of failure Throws `RuntimeException` Since 12.1
`protected`	# `applyHunk( array & $lines, string $src, string $dst, string $src_line, string $src_size, string $dst_line, string $dst_size )` Apply the patch Apply the patch Parameters `$lines` `array` - &$lines The udiff array of lines `$src` `string` - $src The source file `$dst` `string` - $dst The destination file `$src_line` `string` - $src_line The beginning of the patch for the source file `$src_size` `string` - $src_size The size of the patch for the source file `$dst_line` `string` - $dst_line The beginning of the patch for the destination file `$dst_size` `string` - $dst_size The size of the patch for the destination file Throws `RuntimeException` Since 12.1
`protected array &`	# `getSource( string $src )` Get the lines of a source file Get the lines of a source file Parameters `$src` `string` - $src The path of a file Returns `array` - The lines of the source file Since 12.1
`protected array &`	# `getDestination( string $dst, string $src )` Get the lines of a destination file Get the lines of a destination file Parameters `$dst` `string` - $dst The path of a destination file `$src` `string` - $src The path of a source file Returns `array` - The lines of the destination file Since 12.1

Magic methods summary

Constants summary

`string`	`SRC_FILE`	`'/^---\\s+(\\S+)\s+\\d{1,4}-\\d{1,2}-\\d{1,2}\\s+\\d{1,2}:\\d{1,2}:\\d{1,2}(\\.\\d+)?\\s+(\+\|-)\\d{4}/A'`	# Regular expression for searching source files Regular expression for searching source files
`string`	`DST_FILE`	`'/^\\+\\+\\+\\s+(\\S+)\s+\\d{1,4}-\\d{1,2}-\\d{1,2}\\s+\\d{1,2}:\\d{1,2}:\\d{1,2}(\\.\\d+)?\\s+(\+\|-)\\d{4}/A'`	# Regular expression for searching destination files Regular expression for searching destination files
`string`	`HUNK`	`'/@@ -(\\d+)(,(\\d+))?\\s+\\+(\\d+)(,(\\d+))?\\s+@@($)/A'`	# Regular expression for searching hunks of differences Regular expression for searching hunks of differences
`string`	`SPLIT`	`'/(\r\n)\|(\r)\|(\n)/'`	# Regular expression for splitting lines Regular expression for splitting lines

Properties summary

`protected array`	`$sources`	# sources files sources files Since 12.1
`protected array`	`$destinations`	# destination files destination files Since 12.1
`protected array`	`$removals`	# removal files removal files Since 12.1
`protected array`	`$patches`	# patches patches Since 12.1
`protected static array`	`$instance`	# instance of this class instance of this class Since 12.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFilesystemPatcher

Methods summary

Since

Returns

Since

Returns

Since

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Constants summary

Properties summary

Since

Since

Since

Since

Since