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

Source for file Update.php

Documentation is available at Update.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    Michiel Rook <mrook@php.net>
  44.  * @author    Alexander Opitz <opitz.alexander@gmail.com>
  45.  * @copyright 2004-2007 Clay Loveless
  46.  * @license   http://www.opensource.org/licenses/bsd-license.php BSD License
  47.  * @link      http://pear.php.net/package/VersionControl_SVN
  48.  */
  49.  
  50. require_once 'VersionControl/SVN/Command.php';
  51.  
  52. /**
  53.  * Subversion Update command manager class
  54.  *
  55.  * Bring changes from the repository into the working copy.
  56.  * 
  57.  * From 'svn update --help':
  58.  *
  59.  * usage: update [PATH...]
  60.  * 
  61.  *   If no revision given, bring working copy up-to-date with HEAD rev.
  62.  *   Else synchronize working copy to revision given by -r.
  63.  * 
  64.  *   For each updated item a line will start with a character reporting the
  65.  *   action taken.  These characters have the following meaning:
  66.  * 
  67.  *     A  Added
  68.  *     D  Deleted
  69.  *     U  Updated
  70.  *     C  Conflict
  71.  *     G  Merged
  72.  * 
  73.  *   A character in the first column signifies an update to the actual file,
  74.  *   while updates to the file's properties are shown in the second column.
  75.  *
  76.  * Conversion of the above usage example to VersionControl_SVN_Switch:
  77.  *
  78.  * <code>
  79.  * <?php
  80.  * require_once 'VersionControl/SVN.php';
  81.  *
  82.  * // Set up runtime options. Will be passed to all
  83.  * // subclasses.
  84.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  85.  *
  86.  * $switches = array('r' => '30');
  87.  * $args = array('/path/to/working/copy');
  88.  *
  89.  * $svn = VersionControl_SVN::factory(array('update'), $options);
  90.  * try {
  91.  *     print_r($svn->update->run($args, $switches));
  92.  * } catch (VersionControl_SVN_Exception $e) {
  93.  *     print_r($e->getMessage());
  94.  * }
  95.  * ?>
  96.  * </code>
  97.  *
  98.  *
  99.  * $switches is an array containing one or more command line options
  100.  * defined by the following associative keys:
  101.  *
  102.  * <code>
  103.  *
  104.  * $switches = array(
  105.  *  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  106.  *                        A revision argument can be one of:
  107.  *                           NUMBER       revision number
  108.  *                           "{" DATE "}" revision at start of the date
  109.  *                           "HEAD"       latest in repository
  110.  *                           "BASE"       base rev of item's working copy
  111.  *                           "COMMITTED"  last commit at or before BASE
  112.  *                           "PREV"       revision just before COMMITTED',
  113.  *                      // either 'r' or 'revision' may be used
  114.  *  'N'             =>  true|false,
  115.  *                      // operate on single directory only
  116.  *  'non-recursive' =>  true|false,
  117.  *                      // operate on single directory only
  118.  *  'q [quiet]'     =>  true|false,
  119.  *                      // print as little as possible
  120.  *  'diff3-cmd'     =>  'ARG',
  121.  *                      // use ARG as merge command
  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   Michiel Rook <mrook@php.net>
  140.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  141.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  142.  * @version  0.5.1
  143.  * @link     http://pear.php.net/package/VersionControl_SVN
  144.  */
  145. {
  146.     /**
  147.      * Constuctor of command. Adds available switches.
  148.      */
  149.     public function __construct()
  150.     {
  151.         parent::__construct();
  152.  
  153.         $this->validSwitchesValue = array_merge(
  154.             $this->validSwitchesValue,
  155.             array(
  156.                 'r''revision',
  157.                 'depth',
  158.                 'set-depth',
  159.                 'diff3-cmd',
  160.                 'changelist',
  161.                 'editor-cmd',
  162.                 'accept',
  163.             )
  164.         );
  165.  
  166.         $this->validSwitches = array_merge(
  167.             $this->validSwitches,
  168.             array(
  169.                 'N''non-recursive',
  170.                 'q''quiet',
  171.                 'force',
  172.                 'ignore-externals',
  173.             )
  174.         );
  175.     }
  176. }
  177.  
  178. ?>

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