VersionControl_SVN
[ class tree: VersionControl_SVN ] [ index: VersionControl_SVN ] [ all elements ]

Source for file Merge.php

Documentation is available at Merge.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4: */
  3. /**
  4.  * +----------------------------------------------------------------------+
  5.  * | This LICENSE is in the BSD license style.                            |
  6.  * | http://www.opensource.org/licenses/bsd-license.php                   |
  7.  * |                                                                      |
  8.  * | Redistribution and use in source and binary forms, with or without   |
  9.  * | modification, are permitted provided that the following conditions   |
  10.  * | are met:                                                             |
  11.  * |                                                                      |
  12.  * |  * Redistributions of source code must retain the above copyright    |
  13.  * |    notice, this list of conditions and the following disclaimer.     |
  14.  * |                                                                      |
  15.  * |  * Redistributions in binary form must reproduce the above           |
  16.  * |    copyright notice, this list of conditions and the following       |
  17.  * |    disclaimer in the documentation and/or other materials provided   |
  18.  * |    with the distribution.                                            |
  19.  * |                                                                      |
  20.  * |  * Neither the name of Clay Loveless nor the names of contributors   |
  21.  * |    may be used to endorse or promote products derived from this      |
  22.  * |    software without specific prior written permission.               |
  23.  * |                                                                      |
  24.  * | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS  |
  25.  * | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT    |
  26.  * | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS    |
  27.  * | FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE      |
  28.  * | COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,  |
  29.  * | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
  30.  * | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;     |
  31.  * | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER     |
  32.  * | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT   |
  33.  * | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN    |
  34.  * | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE      |
  35.  * | POSSIBILITY OF SUCH DAMAGE.                                          |
  36.  * +----------------------------------------------------------------------+
  37.  *
  38.  * PHP version 5
  39.  *
  40.  * @category  VersionControl
  41.  * @package   VersionControl_SVN
  42.  * @author    Clay Loveless <clay@killersoft.com>
  43.  * @author    Alexander Opitz <opitz.alexander@gmail.com>
  44.  * @copyright 2004-2007 Clay Loveless
  45.  * @license   http://www.opensource.org/licenses/bsd-license.php BSD License
  46.  * @link      http://pear.php.net/package/VersionControl_SVN
  47.  */
  48.  
  49. require_once 'VersionControl/SVN/Command.php';
  50.  
  51. /**
  52.  * Subversion Merge command manager class
  53.  *
  54.  * Apply the differences between two sources to a working copy path.
  55.  * 
  56.  * From 'svn merge --help':
  57.  *
  58.  * usage: 1. merge sourceURL1[@N] sourceURL2[@M] [WCPATH]
  59.  *        2. merge sourceWCPATH1@N sourceWCPATH2@M [WCPATH]
  60.  *        3. merge -r N:M SOURCE [WCPATH]
  61.  * 
  62.  *   1. In the first form, the source URLs are specified at revisions
  63.  *      N and M.  These are the two sources to be compared.  The revisions
  64.  *      default to HEAD if omitted.
  65.  * 
  66.  *   2. In the second form, the URLs corresponding to the source working
  67.  *      copy paths define the sources to be compared.  The revisions must
  68.  *      be specified.
  69.  * 
  70.  *   3. In the third form, SOURCE can be a URL, or working copy item
  71.  *      in which case the corresponding URL is used.  This URL, at
  72.  *      revisions N and M, defines the two sources to be compared.
  73.  * 
  74.  *   WCPATH is the working copy path that will receive the changes.
  75.  *   If WCPATH is omitted, a default value of '.' is assumed, unless
  76.  *   the sources have identical basenames that match a file within '.':
  77.  *   in which case, the differences will be applied to that file.
  78.  *
  79.  * Conversion of the above usage examples to VersionControl_SVN_Merge:
  80.  *
  81.  * Example 1:
  82.  * <code>
  83.  * <?php
  84.  * require_once 'VersionControl/SVN.php';
  85.  *
  86.  * // Set up runtime options. Will be passed to all
  87.  * // subclasses.
  88.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  89.  *
  90.  * $args = array(
  91.  *  'svn://svn.example.com/repos/TestProj/trunk/example.php@4',   // sourceurl1
  92.  *  'svn://svn.example.com/repos/TestProj/branch/example.php@15', // sourceurl2
  93.  *  '/path/to/working/copy'                                       // wcpath
  94.  * );
  95.  *
  96.  * $svn = VersionControl_SVN::factory(array('merge'), $options);
  97.  * try {
  98.  *     print_r($svn->merge->run($args, $switches));
  99.  * } catch (VersionControl_SVN_Exception $e) {
  100.  *     print_r($e->getMessage());
  101.  * }
  102.  * ?>
  103.  * </code>
  104.  *
  105.  * Example 2:
  106.  * <code>
  107.  * <?php
  108.  * require_once 'VersionControl/SVN.php';
  109.  *
  110.  * // Set up runtime options. Will be passed to all
  111.  * // subclasses.
  112.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  113.  *
  114.  * $args = array(
  115.  *  '/path/to/working/copy/trunk/example.php@4',    // wcpath1
  116.  *  '/path/to/working/copy/branch/example.php@15'   // wcpath2
  117.  * );
  118.  *
  119.  * $svn = VersionControl_SVN::factory(array('merge'), $options);
  120.  * try {
  121.  *     print_r($svn->merge->run($args, $switches));
  122.  * } catch (VersionControl_SVN_Exception $e) {
  123.  *     print_r($e->getMessage());
  124.  * }
  125.  * ?>
  126.  * </code>
  127.  *
  128.  * Example 3:
  129.  * <code>
  130.  * <?php
  131.  * require_once 'VersionControl/SVN.php';
  132.  *
  133.  * // Set up runtime options. Will be passed to all
  134.  * // subclasses.
  135.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  136.  *
  137.  * $switches = array('r' => '5:8');
  138.  * $args = array('svn://svn.example.com/repos/TestProj/trunk/example.php');
  139.  *
  140.  * $svn = VersionControl_SVN::factory(array('merge'), $options);
  141.  * try {
  142.  *     print_r($svn->merge->run($args, $switches));
  143.  * } catch (VersionControl_SVN_Exception $e) {
  144.  *     print_r($e->getMessage());
  145.  * }
  146.  * ?>
  147.  * </code>
  148.  *
  149.  * $switches is an array containing one or more command line options
  150.  * defined by the following associative keys:
  151.  *
  152.  * <code>
  153.  *
  154.  * $switches = array(
  155.  *  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  156.  *                        A revision argument can be one of:
  157.  *                           NUMBER       revision number
  158.  *                           "{" DATE "}" revision at start of the date
  159.  *                           "HEAD"       latest in repository
  160.  *                           "BASE"       base rev of item's working copy
  161.  *                           "COMMITTED"  last commit at or before BASE
  162.  *                           "PREV"       revision just before COMMITTED',
  163.  *                      // either 'r' or 'revision' may be used
  164.  *  'q [quiet]'     =>  true|false,
  165.  *                      // print as little as possible
  166.  *  'dry-run'       =>  true|false,
  167.  *                      // try operation but make no changes
  168.  *  'force'         =>  true|false,
  169.  *                      // force operation to run
  170.  *  'N'             =>  true|false,
  171.  *                      // operate on single directory only
  172.  *  'non-recursive' =>  true|false,
  173.  *                      // operate on single directory only
  174.  *  'diff3-cmd'     =>  'ARG',
  175.  *                      // use ARG as merge command
  176.  *  'ignore-ancestry' => true|false,
  177.  *                      // ignore ancestry when calculating merges
  178.  *  'username'      =>  'Subversion repository login',
  179.  *  'password'      =>  'Subversion repository password',
  180.  *  'no-auth-cache' =>  true|false,
  181.  *                      // Do not cache authentication tokens
  182.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  183.  * );
  184.  *
  185.  * </code>
  186.  *
  187.  * Note: Subversion does not offer an XML output option for this subcommand
  188.  *
  189.  * The non-interactive option available on the command-line
  190.  * svn client may also be set (true|false), but it is set to true by default.
  191.  *
  192.  * @category VersionControl
  193.  * @package  VersionControl_SVN
  194.  * @author   Clay Loveless <clay@killersoft.com>
  195.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  196.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  197.  * @version  0.5.1
  198.  * @link     http://pear.php.net/package/VersionControl_SVN
  199.  */
  200. {
  201.     /**
  202.      * Minimum number of args required by this subcommand.
  203.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  204.      * Subversion Complete Reference for details on arguments for this subcommand.
  205.      *
  206.      * @var int $minArgs 
  207.      */
  208.     public $minArgs = 1;
  209.  
  210.     /**
  211.      * Constuctor of command. Adds available switches.
  212.      */
  213.     public function __construct()
  214.     {
  215.         parent::__construct();
  216.  
  217.         $this->validSwitchesValue = array_merge(
  218.             $this->validSwitchesValue,
  219.             array(
  220.                 'r''revision',
  221.                 'c''change',
  222.                 'depth',
  223.                 'diff-cmd',
  224.                 'x''extensions',
  225.                 'accept'
  226.             )
  227.         );
  228.  
  229.         $this->validSwitches = array_merge(
  230.             $this->validSwitches,
  231.             array(
  232.                 'N''non-recursive',
  233.                 'q''quiet',
  234.                 'force',
  235.                 'dry-run',
  236.                 'record-only',
  237.                 'ignore-ancestry',
  238.                 'reintegrated',
  239.             )
  240.         );
  241.     }
  242. }
  243.  
  244. ?>

Documentation generated on Sat, 09 Feb 2013 12:30:11 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.