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

Source for file Export.php

Documentation is available at Export.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 Export command manager class
  53.  *
  54.  * Create an unversioned copy of a tree.
  55.  * 
  56.  * From 'svn export --help':
  57.  *
  58.  * usage: 1. export [-r REV] URL [PATH]
  59.  *        2. export [-r REV] PATH1 [PATH2]
  60.  * 
  61.  *   1. Exports a clean directory tree from the repository specified by
  62.  *      URL, at revision REV if it is given, otherwise at HEAD, into
  63.  *      PATH. If PATH is omitted, the last component of the URL is used
  64.  *      for the local directory name.
  65.  * 
  66.  *   2. Exports a clean directory tree from the working copy specified by
  67.  *      PATH1, at revision REV if it is given, otherwise at WORKING, into
  68.  *      PATH2.  If PATH2 is omitted, the last component of the PATH1 is used
  69.  *      for the local directory name. If REV is not specified, all local
  70.  *      changes will be preserved, but files not under version control will
  71.  *      not be copied.
  72.  *
  73.  * Conversion of the above usage examples to VersionControl_SVN_Export:
  74.  *
  75.  * Example 1:
  76.  * <code>
  77.  * <?php
  78.  * require_once 'VersionControl/SVN.php';
  79.  *
  80.  * // Set up runtime options. Will be passed to all
  81.  * // subclasses.
  82.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  83.  *
  84.  * $switches = array('r' => 'HEAD');
  85.  * $args = array('svn://svn.example.com/repos/TestProj/trunk',
  86.  *               '/my/export/path/Test-Project-1.0');
  87.  *
  88.  * $svn = VersionControl_SVN::factory(array('export'), $options);
  89.  * try {
  90.  *     print_r($svn->export->run($args, $switches));
  91.  * } catch (VersionControl_SVN_Exception $e) {
  92.  *     print_r($e->getMessage());
  93.  * }
  94.  *
  95.  * ?>
  96.  * </code>
  97.  *
  98.  * Example 2:
  99.  * <code>
  100.  * <?php
  101.  * require_once 'VersionControl/SVN.php';
  102.  *
  103.  * // Set up runtime options. Will be passed to all
  104.  * // subclasses.
  105.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  106.  *
  107.  * $args = array('/repos/TestProj/trunk',
  108.  *               '/my/export/path/Test-Project-1.0');
  109.  *
  110.  * $svn = VersionControl_SVN::factory(array('export'), $options);
  111.  * try {
  112.  *     print_r($svn->export->run($args, $switches));
  113.  * } catch (VersionControl_SVN_Exception $e) {
  114.  *     print_r($e->getMessage());
  115.  * }
  116.  *
  117.  * ?>
  118.  * </code>
  119.  *
  120.  *
  121.  * $switches is an array containing one or more command line options
  122.  * defined by the following associative keys:
  123.  *
  124.  * <code>
  125.  *
  126.  * $switches = array(
  127.  *  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  128.  *                        A revision argument can be one of:
  129.  *                           NUMBER       revision number
  130.  *                           "{" DATE "}" revision at start of the date
  131.  *                           "HEAD"       latest in repository
  132.  *                           "BASE"       base rev of item's working copy
  133.  *                           "COMMITTED"  last commit at or before BASE
  134.  *                           "PREV"       revision just before COMMITTED',
  135.  *                      // either 'r' or 'revision' may be used
  136.  *  'q [quiet]'     =>  true|false,
  137.  *                      // prints as little as possible
  138.  *  'force'         =>  true|false,
  139.  *                      // force operation to run
  140.  *  'username'      =>  'Subversion repository login',
  141.  *  'password'      =>  'Subversion repository password',
  142.  *  'no-auth-cache' =>  true|false,
  143.  *                      // Do not cache authentication tokens
  144.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  145.  * );
  146.  *
  147.  * </code>
  148.  *
  149.  * Note: Subversion does not offer an XML output option for this subcommand
  150.  *
  151.  * The non-interactive option available on the command-line
  152.  * svn client may also be set (true|false), but it is set to true by default.
  153.  *
  154.  * @category VersionControl
  155.  * @package  VersionControl_SVN
  156.  * @author   Clay Loveless <clay@killersoft.com>
  157.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  158.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  159.  * @version  0.5.1
  160.  * @link     http://pear.php.net/package/VersionControl_SVN
  161.  */
  162. {
  163.     /**
  164.      * Minimum number of args required by this subcommand.
  165.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  166.      * Subversion Complete Reference for details on arguments for this subcommand.
  167.      *
  168.      * @var int $minArgs 
  169.      */
  170.     public $minArgs = 1;
  171.  
  172.     /**
  173.      * Constuctor of command. Adds available switches.
  174.      */
  175.     public function __construct()
  176.     {
  177.         parent::__construct();
  178.  
  179.         $this->validSwitchesValue = array_merge(
  180.             $this->validSwitchesValue,
  181.             array(
  182.                 'r''revision',
  183.                 'depth',
  184.                 'native-eol',
  185.             )
  186.         );
  187.  
  188.         $this->validSwitches = array_merge(
  189.             $this->validSwitches,
  190.             array(
  191.                 'q''quiet',
  192.                 'N''non-recursive',
  193.                 'force',
  194.                 'ignore-externals',
  195.             )
  196.         );
  197.     }
  198. }
  199.  
  200. ?>

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