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

Source for file Checkout.php

Documentation is available at Checkout.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 Checkout command manager class
  53.  *
  54.  * Checkout a working copy from a repository.
  55.  *
  56.  * $switches is an array containing one or more command line options
  57.  * defined by the following associative keys:
  58.  *
  59.  * <code>
  60.  *
  61.  * $switches = array(
  62.  *  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  63.  *                        A revision argument can be one of:
  64.  *                           NUMBER       revision number
  65.  *                           "{" DATE "}" revision at start of the date
  66.  *                           "HEAD"       latest in repository
  67.  *                           "BASE"       base rev of item's working copy
  68.  *                           "COMMITTED"  last commit at or before BASE
  69.  *                           "PREV"       revision just before COMMITTED',
  70.  *                      // either 'r' or 'revision' may be used
  71.  *  'q [quiet]'     =>  true|false,
  72.  *                      // prints as little as possible
  73.  *  'N'             =>  true|false,
  74.  *                      // operate on single directory only
  75.  *  'non-recursive' =>  true|false,
  76.  *                      // operate on single directory only
  77.  *  'username'      =>  'Subversion repository login',
  78.  *  'password'      =>  'Subversion repository password',
  79.  *  'no-auth-cache' =>  true|false,
  80.  *                      // Do not cache authentication tokens
  81.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  82.  * );
  83.  *
  84.  * </code>
  85.  *
  86.  * Note: If PATH is omitted from $args, the basename of the URL will be used as
  87.  * the destination. If multiple URLs are given each will be checked
  88.  * out into a sub-directory of PATH, with the name of the sub-directory
  89.  * being the basename of the URL.
  90.  *
  91.  * Note: Subversion does not offer an XML output option for this subcommand
  92.  *
  93.  * The non-interactive option available on the command-line
  94.  * svn client may also be set (true|false), but it is set to true by default.
  95.  *
  96.  * Usage example:
  97.  * <code>
  98.  * <?php
  99.  * require_once 'VersionControl/SVN.php';
  100.  *
  101.  * // Set up runtime options. Will be passed to all
  102.  * // subclasses.
  103.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  104.  *
  105.  * // Pass array of subcommands we need to factory
  106.  * $svn = VersionControl_SVN::factory(array('checkout'), $options);
  107.  *
  108.  * // Create your working copy directory
  109.  * // Note: your permissions requirements may vary from this example!
  110.  * @mkdir('/path/to/working_copy', 0755);
  111.  *
  112.  *  // Define any switches and aguments we may need
  113.  *  $switches = array('username' => 'user', 'password' => 'pass');
  114.  *  $args = array('svn://svn.example.com/repos/TestProject/trunk', '/path/to/working_copy');
  115.  *
  116.  *  // Run command
  117.  *  try {
  118.  *      print_r($svn->checkout->run($args, $switches));
  119.  *  } catch (VersionControl_SVN_Exception $e) {
  120.  *      print_r($e->getMessage());
  121.  *  }
  122.  *  ?>
  123.  *  </code>
  124.  *
  125.  * @category VersionControl
  126.  * @package  VersionControl_SVN
  127.  * @author   Clay Loveless <clay@killersoft.com>
  128.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  129.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  130.  * @version  0.5.1
  131.  * @link     http://pear.php.net/package/VersionControl_SVN
  132.  */
  133. {
  134.     /**
  135.      * Minimum number of args required by this subcommand.
  136.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  137.      * Subversion Complete Reference for details on arguments for this subcommand.
  138.      *
  139.      * @var int $minArgs 
  140.      */
  141.     public $minArgs = 1;
  142.  
  143.     /**
  144.      * Constuctor of command. Adds available switches.
  145.      */
  146.     public function __construct()
  147.     {
  148.         parent::__construct();
  149.  
  150.         $this->validSwitchesValue = array_merge(
  151.             $this->validSwitchesValue,
  152.             array(
  153.                 'r''revision',
  154.                 'depth',
  155.             )
  156.         );
  157.  
  158.         $this->validSwitches = array_merge(
  159.             $this->validSwitches,
  160.             array(
  161.                 'q''quiet',
  162.                 'N''non-recursive',
  163.                 'force',
  164.                 'ignore-externals',
  165.             )
  166.         );
  167.     }
  168. }
  169.  
  170. ?>

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