Home > PHP > Function > xdiff > xdiff_string_patch()

xdiff_string_patch()

xdiff_string_patch - Patch a string with an unified diff

Syntax

string xdiff_string_patch (string $str, string $patch, int $flags, string &$error)

Arguments

  • str - The original string.
  • patch - The unified patch string. It has to be created using xdiff_string_diff(), xdiff_file_diff() functions or compatible tools.
  • flags - flags can be either XDIFF_PATCH_NORMAL (default mode, normal patch) or XDIFF_PATCH_REVERSE (reversed patch). Starting from version 1.5.0, you can also use binary OR to enable XDIFF_PATCH_IGNORESPACE flag.
  • error - If provided then rejected parts are stored inside this variable.

Description

Patches a str string with an unified patch in patch parameter and returns the result. patch has to be an unified diff created by xdiff_file_diff() / xdiff_string_diff() function. An optional flags parameter specifies mode of operation. Any rejected parts of the patch will be stored inside error variable if it is provided.

Version

PHP PECL xdiff >= 0.2.0

Return value

Returns the patched string, or FALSE on error.