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

Source for file Switch.php

Documentation is available at Switch.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 Switch command manager class
  53.  *
  54.  * Update the working copy to a different URL.
  55.  * 
  56.  * From 'svn switch --help':
  57.  *
  58.  * usage: 1. switch URL [PATH]
  59.  *        2. switch --relocate FROM TO [PATH...]
  60.  * 
  61.  *   1. Update the working copy to mirror a new URL within the repository.
  62.  *      This behaviour is similar to 'svn update', and is the way to
  63.  *      move a working copy to a branch or tag within the same repository.
  64.  * 
  65.  *   2. Rewrite working copy URL metadata to reflect a syntactic change only.
  66.  *      This is used when repository's root URL changes (such as a schema
  67.  *      or hostname change) but your working copy still reflects the same
  68.  *      directory within the same repository.
  69.  *
  70.  * Conversion of the above usage example to VersionControl_SVN_Switch:
  71.  *
  72.  * <code>
  73.  * <?php
  74.  * require_once 'VersionControl/SVN.php';
  75.  *
  76.  * // Set up runtime options. Will be passed to all
  77.  * // subclasses.
  78.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  79.  *
  80.  * $switches = array('relocate' => 'true');
  81.  * $args = array(
  82.  *  'svn://svn.example.com/repos/TestProj/trunk',
  83.  *  'svn://svn.example.com/repos/TestProj_Fork/trunk',
  84.  *  '/path/to/working/copy'
  85.  * );
  86.  *
  87.  * $svn = VersionControl_SVN::factory(array('switch'), $options);
  88.  * try {
  89.  *     print_r($svn->switch->run($args, $switches));
  90.  * } catch (VersionControl_SVN_Exception $e) {
  91.  *     print_r($e->getMessage());
  92.  * }
  93.  * ?>
  94.  * </code>
  95.  *
  96.  *
  97.  * $switches is an array containing one or more command line options
  98.  * defined by the following associative keys:
  99.  *
  100.  * <code>
  101.  *
  102.  * $switches = array(
  103.  *  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  104.  *                        A revision argument can be one of:
  105.  *                           NUMBER       revision number
  106.  *                           "{" DATE "}" revision at start of the date
  107.  *                           "HEAD"       latest in repository
  108.  *                           "BASE"       base rev of item's working copy
  109.  *                           "COMMITTED"  last commit at or before BASE
  110.  *                           "PREV"       revision just before COMMITTED',
  111.  *                      // either 'r' or 'revision' may be used
  112.  *  'N'             =>  true|false,
  113.  *                      // operate on single directory only
  114.  *  'non-recursive' =>  true|false,
  115.  *                      // operate on single directory only
  116.  *  'q [quiet]'     =>  true|false,
  117.  *                      // print as little as possible
  118.  *  'diff3-cmd'     =>  'ARG',
  119.  *                      // use ARG as merge command
  120.  *  'relocate'      =>  true|false,
  121.  *                      // relocate via URL-rewriting
  122.  *  'username'      =>  'Subversion repository login',
  123.  *  'password'      =>  'Subversion repository password',
  124.  *  'no-auth-cache' =>  true|false,
  125.  *                      // Do not cache authentication tokens
  126.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  127.  * );
  128.  *
  129.  * </code>
  130.  *
  131.  * Note: Subversion does not offer an XML output option for this subcommand
  132.  *
  133.  * The non-interactive option available on the command-line
  134.  * svn client may also be set (true|false), but it is set to true by default.
  135.  *
  136.  * @category VersionControl
  137.  * @package  VersionControl_SVN
  138.  * @author   Clay Loveless <clay@killersoft.com>
  139.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  140.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  141.  * @version  0.5.1
  142.  * @link     http://pear.php.net/package/VersionControl_SVN
  143.  */
  144. {
  145.     /**
  146.      * Minimum number of args required by this subcommand.
  147.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  148.      * Subversion Complete Reference for details on arguments for this subcommand.
  149.      *
  150.      * @var int $minArgs 
  151.      */
  152.     public $minArgs = 1;
  153.  
  154.     /**
  155.      * Constuctor of command. Adds available switches.
  156.      */
  157.     public function __construct()
  158.     {
  159.         parent::__construct();
  160.  
  161.         $this->validSwitchesValue = array_merge(
  162.             $this->validSwitchesValue,
  163.             array(
  164.                 'r''revision',
  165.                 'depth',
  166.                 'set-depth',
  167.                 'diff3-cmd',
  168.                 'accept',
  169.             )
  170.         );
  171.  
  172.         $this->validSwitches = array_merge(
  173.             $this->validSwitches,
  174.             array(
  175.                 'N''non-recursive',
  176.                 'q''quiet',
  177.                 'relocate',
  178.                 'ignore-externals',
  179.                 'force',
  180.             )
  181.         );
  182.     }
  183. }
  184.  
  185. ?>

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