php merge

php-слияние

Введение

При работе с редакциями текста иногда приходится сталкиваться с проблемой, что на основе одного и того же исходного текста существует несколько редакций. Вместо того, чтобы выбирать одну и отбрасывать другую, мы хотим объединить две версии.

Git делает это уже чудесно. В PHP-приложении нам нужен простой инструмент, который делает то же самое. Существует расширение xdiff PECL, в котором есть функция xdiff_string_merge3. Но xdiff_string_merge3 ведет себя не так, как git, и xdiff может быть недоступен в вашей системе.

PhpMerge — небольшая библиотека, решающая эту проблему. Существует два класса: PhpMergePhpMerge и PhpMergeGitMerge , которые реализуют PhpMergePhpMergeInterface , который имеет только метод merge .

PhpMerge использует SebastianBergmannDiffDiffer для получения различий между разными версиями и вычисляет на их основе объединенный текст. GitMerge использует SymplifyGitWrapperGitWrapper , записывает текст во временный файл и использует git командной строки для объединения текста.

Использование

Простой пример:

 use PhpMerge  PhpMerge ;

// Create a merger instance.
$ merger = new PhpMerge ();

// Get the texts to merge.
$ original = <<<'EOD'
unchanged
replaced
unchanged
normal
unchanged
unchanged
removed

EOD;

$ version1 = <<<'EOD'
added
unchanged
replacement
unchanged
normal
unchanged
unchanged

EOD;

$ version2 = <<<'EOD'
unchanged
replaced
unchanged
normal??
unchanged
unchanged

EOD;

$ expected = <<<'EOD'
added
unchanged
replacement
unchanged
normal??
unchanged
unchanged

EOD;

$ result = $ merger -> merge ( $ original , $ version1 , $ version2 );
// $result === $expected;

При конфликтах слияния:

 // Continuing from before with:
use Phpmerge  MergeException ;
use PhpMerge  MergeConflict ;


$ conflicting = <<<'EOD'
unchanged
replaced
unchanged
normal!!
unchanged
unchanged

EOD;

try {
    $ merger -> merge ( $ original , $ version2 , $ conflicting );
} catch ( MergeException $ exception ) {
    /** @var MergeConflict[] $conflicts */
    $ conflicts = $ exception -> getConflicts ();

    $ original_lines = $ conflicts [ 0 ]-> getBase ();
    // $original_lines === ["normaln"];
    
    $ version2_lines = $ conflicts [ 0 ]-> getRemote ();
    // $version2_lines === ["normal??n"];
    
    $ conflicting_lines = $ conflicts [ 0 ]-> getLocal ();
    // $conflicting_lines === ["normal!!n"];
    
    $ line_numer_of_conflict = $ conflicts [ 0 ]-> getBaseLine ();
    // $line_numer_of_conflict === 3; // Count starts with 0.
    
    // It is also possible to get the merged version using the first version
    // to resolve conflicts.
    $ merged = $ exception -> getMerged ();
    // $merged === $version2;
    // In this case, but in general there could be non-conflicting changes.
    
    $ line_in_merged = $ conflicts [ 0 ]-> getMergedLine ();
    // $line_in_merged === 3; // Count starts with 0.
}

Использование командной строки git для выполнения слияния:

 use PhpMerge  GitMerge ;

$ merger = new GitMerge ();

// Use as the previous example. 

Установка

PhpMerge можно установить вместе с Composer, добавив библиотеку в качестве зависимости к файлу композитора.json.

{
    "require" : {
        "bircher/php-merge" : " ~4.0 "
    }
}

Чтобы использовать git командной строки с GitMerge :

{
    "require" : {
        "bircher/php-merge" : " ~4.0 " ,
        "symplify/git-wrapper" : " ^9.1|^10.0 "
    }
}

Инструкции по установке и использованию см. в документации Composer.

Разница с ~3.0

В версии ~4.0 мы переключаемся с cpliakas/git-wrapper symplify/git-wrapper поскольку первый устарел. Это обновление означает, что при использовании только PhpMergePhpMerge изменений не будет.