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

Source for file Diff.php

Documentation is available at Diff.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 Diff command manager class
  53.  *
  54.  * Display the differences between two paths.
  55.  * 
  56.  * From 'svn diff --help':
  57.  *
  58.  * usage: 1. diff [-r N[:M]] [--old OLD-TARGET] [--new NEW-TARGET] [PATH...]
  59.  *        2. diff -r N:M URL
  60.  *        3. diff [-r N[:M]] URL1[@N] URL2[@M]
  61.  * 
  62.  *   1. Display the differences between OLD-TARGET and NEW-TARGET.  PATHs, if
  63.  *      given, are relative to OLD-TARGET and NEW-TARGET and restrict the output
  64.  *      to differences for those paths.  OLD-TARGET and NEW-TARGET may be working
  65.  *      copy paths or URL[@REV].
  66.  * 
  67.  *      OLD-TARGET defaults to the path '.' and NEW-TARGET defaults to OLD-TARGET.
  68.  *      N defaults to BASE or, if OLD-TARGET is an URL, to HEAD.
  69.  *      M defaults to the current working version or, if NEW-TARGET is an URL,
  70.  *      to HEAD.
  71.  * 
  72.  *      '-r N' sets the revision of OLD-TGT to N, '-r N:M' also sets the
  73.  *      revision of NEW-TGT to M.
  74.  * 
  75.  *   2. Shorthand for 'svn diff -r N:M --old=URL --new=URL'.
  76.  * 
  77.  *   3. Shorthand for 'svn diff [-r N[:M]] --old=URL1 --new=URL2'
  78.  * 
  79.  *   Use just 'svn diff' to display local modifications in a working copy
  80.  *
  81.  * Conversion of the above usage examples to VersionControl_SVN_Diff:
  82.  *
  83.  * Example 1:
  84.  * <code>
  85.  * <?php
  86.  * require_once 'VersionControl/SVN.php';
  87.  *
  88.  * // Set up runtime options. Will be passed to all
  89.  * // subclasses.
  90.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  91.  *
  92.  * $switches = array('r' => '5:8');
  93.  * $args = array('svn://svn.example.com/repos/TestProj/trunk/example.php',
  94.  *               'svn://svn.example.com/repos/TestProj/trunk/example2.php');
  95.  * );
  96.  *
  97.  * $svn = VersionControl_SVN::factory(array('diff'), $options);
  98.   * try {
  99.  *     print_r($svn->diff->run($args, $switches));
  100.  * } catch (VersionControl_SVN_Exception $e) {
  101.  *     print_r($e->getMessage());
  102.  * }
  103.  * ?>
  104.  * </code>
  105.  *
  106.  * Example 2:
  107.  * <code>
  108.  * <?php
  109.  * require_once 'VersionControl/SVN.php';
  110.  *
  111.  * // Set up runtime options. Will be passed to all
  112.  * // subclasses.
  113.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  114.  *
  115.  * $switches = array('r' => '5:8');
  116.  * $args = array('svn://svn.example.com/repos/TestProj/trunk/example.php');
  117.  *
  118.  * $svn = VersionControl_SVN::factory(array('diff'), $options);
  119.   * try {
  120.  *     print_r($svn->diff->run($args, $switches));
  121.  * } catch (VersionControl_SVN_Exception $e) {
  122.  *     print_r($e->getMessage());
  123.  * }
  124.  * ?>
  125.  * </code>
  126.  *
  127.  * Example 3:
  128.  * <code>
  129.  * <?php
  130.  * require_once 'VersionControl/SVN.php';
  131.  *
  132.  * // Set up runtime options. Will be passed to all
  133.  * // subclasses.
  134.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  135.  *
  136.  * $switches = array('r' => '5:8');
  137.  * $args = array('svn://svn.example.com/repos/TestProj/trunk/example.php',
  138.  *               'svn://svn.example.com/repos/TestProj/trunk/example2.php');
  139.  *
  140.  * $svn = VersionControl_SVN::factory(array('diff'), $options);
  141.   * try {
  142.  *     print_r($svn->diff->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.  *  'old'           =>  'OLD-TARGET',
  165.  *                      // use OLD-TARGET as the older target
  166.  *  'new'           =>  'NEW-TARGET',
  167.  *                      // use NEW-TARGET as the newer target
  168.  *  'x [extensions]'=>  'ARG',
  169.  *                      // pass ARG as bundled options to GNU diff
  170.  *                      // either 'x' or 'extensions' may be used
  171.  *  'N'             =>  true|false,
  172.  *                      // operate on single directory only
  173.  *  'non-recursive' =>  true|false,
  174.  *                      // operate on single directory only
  175.  *  'diff-cmd'      =>  'ARG',
  176.  *                      // use ARG as diff command
  177.  *  'no-diff-deleted' => true|false,
  178.  *                      // do not print differences for deleted files
  179.  *  'notice-ancestry' => true|false,
  180.  *                      // notice ancestry when calculating differences
  181.  *  'username'      =>  'Subversion repository login',
  182.  *  'password'      =>  'Subversion repository password',
  183.  *  'no-auth-cache' =>  true|false,
  184.  *                      // Do not cache authentication tokens
  185.  *  'config-dir'    =>  'Path to a Subversion configuration directory',
  186.  *  'changelist     =>  'Changelist to operate on'
  187.  * );
  188.  *
  189.  * </code>
  190.  *
  191.  * Note: Subversion does not offer an XML output option for this subcommand
  192.  *
  193.  * The non-interactive option available on the command-line
  194.  * svn client may also be set (true|false), but it is set to true by default.
  195.  *
  196.  * The editor-cmd option available on the command-line svn client is not available
  197.  * since this class does not operate as an interactive shell session.
  198.  *
  199.  * @category VersionControl
  200.  * @package  VersionControl_SVN
  201.  * @author   Clay Loveless <clay@killersoft.com>
  202.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  203.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  204.  * @version  0.5.1
  205.  * @link     http://pear.php.net/package/VersionControl_SVN
  206.  */
  207. {
  208.     /**
  209.      * Minimum number of args required by this subcommand.
  210.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  211.      * Subversion Complete Reference for details on arguments for this subcommand.
  212.      *
  213.      * @var int $minArgs 
  214.      */
  215.     public $minArgs = 1;
  216.  
  217.     /**
  218.      * Keep track of whether XML output is available for a command
  219.      *
  220.      * @var boolean $xmlAvail 
  221.      */
  222.     protected $xmlAvail = true;
  223.  
  224.     /**
  225.      * Constuctor of command. Adds available switches.
  226.      */
  227.     public function __construct()
  228.     {
  229.         parent::__construct();
  230.  
  231.         $this->validSwitchesValue = array_merge(
  232.             $this->validSwitchesValue,
  233.             array(
  234.                 'r''revision',
  235.                 'c''change',
  236.                 'old',
  237.                 'new',
  238.                 'depth',
  239.                 'diff-cmd',
  240.                 'x''extensions',
  241.                 'changelist',
  242.             )
  243.         );
  244.  
  245.         $this->validSwitches = array_merge(
  246.             $this->validSwitches,
  247.             array(
  248.                 'N''non-recursive',
  249.                 'no-diff-deleted',
  250.                 'notice-ancestry',
  251.                 'summarize',
  252.                 'force',
  253.                 'xml',
  254.             )
  255.         );
  256.     }
  257. }
  258.  
  259. ?>

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