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

Source for file Import.php

Documentation is available at Import.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 Import command manager class
  53.  *
  54.  * Recursively commit an unversioned file or tree into the repository
  55.  *
  56.  * Commits must include a commit message option (either with 'm', 'message', 'file' or 'F'
  57.  * keys), but the message itself may be blank.
  58.  *
  59.  * If the 'path' argument is omitted, '.' is assumed. Parent directories are
  60.  * created as necessary in the repository.
  61.  *
  62.  * $switches is an array containing one or more command line options
  63.  * defined by the following associative keys:
  64.  *
  65.  * <code>
  66.  *
  67.  * $switches = array(
  68.  *  'm [message]'   =>  'Specified commit message',
  69.  *                      // either 'm' or 'message' may be used
  70.  *  'F [file]'      =>  'Read commit message data from specified file',
  71.  *                      // either 'F' or 'file' may be used
  72.  *  'q [quiet]'     =>  true|false,
  73.  *                      // prints as little as possible
  74.  *  'N'             =>  true|false,
  75.  *                      // operate on single directory only
  76.  *  'non-recursive' =>  true|false,
  77.  *                      // operate on single directory only
  78.  *  'force-log'     =>  true|false,
  79.  *                      // force validity of log message source
  80.  *  'username'      =>  'Subversion repository login',
  81.  *  'password'      =>  'Subversion repository password',
  82.  *  'no-auth-cache' =>  true|false,
  83.  *                      // Do not cache authentication tokens
  84.  *  'encoding'      =>  'ARG',
  85.  *                      // treat value as being in charset encoding ARG
  86.  *  'auto-props'    =>  true|false,
  87.  *                      // enable automatic properties. Setting to false IS NOT the same
  88.  *                      // as setting no-auto-props to true.
  89.  *  'no-auto-props' =>  true|false,
  90.  *                      // disable automatic properties. Setting to false IS NOT the same
  91.  *                      // as setting auto-props to true.
  92.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  93.  * );
  94.  *
  95.  * </code>
  96.  *
  97.  * Note: Subversion does not offer an XML output option for this subcommand
  98.  *
  99.  * The non-interactive option available on the command-line
  100.  * svn client may also be set (true|false), but it is set to true by default.
  101.  *
  102.  * The editor-cmd option available on the command-line svn client is not available
  103.  * since this class does not operate as an interactive shell session.
  104.  *
  105.  * Usage example:
  106.  * <code>
  107.  * <?php
  108.  * require_once 'VersionControl/SVN.php';
  109.  *
  110.  * // Set up runtime options. Will be passed to all
  111.  * // subclasses.
  112.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  113.  *
  114.  * // Pass array of subcommands we need to factory
  115.  * $svn = VersionControl_SVN::factory(array('import'), $options);
  116.  *
  117.  * // Define any switches and aguments we may need
  118.  * $switches = array('m' => 'Initial Import - and awwwaaay we go!',
  119.  *                   'username' => 'user', 'password' => 'pass');
  120.  * $args = array('/path/to/working_copy',
  121.  *               'svn://svn.example.com/repos/NewProject/');
  122.  *
  123.  * // Run command
  124.  * try {
  125.  *     print_r($svn->import->run($args, $switches));
  126.  * } catch (VersionControl_SVN_Exception $e) {
  127.  *     print_r($e->getMessage());
  128.  * }
  129.  * ?>
  130.  * </code>
  131.  *
  132.  * @category VersionControl
  133.  * @package  VersionControl_SVN
  134.  * @author   Clay Loveless <clay@killersoft.com>
  135.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  136.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  137.  * @version  0.5.1
  138.  * @link     http://pear.php.net/package/VersionControl_SVN
  139.  */
  140. {
  141.     /**
  142.      * Minimum number of args required by this subcommand.
  143.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  144.      * Subversion Complete Reference for details on arguments for this subcommand.
  145.      *
  146.      * @var int $minArgs 
  147.      */
  148.     public $minArgs = 1;
  149.  
  150.     /**
  151.      * Switches required by this subcommand.
  152.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  153.      * Subversion Complete Reference for details on arguments for this subcommand.
  154.      *
  155.      * @var array $requiredSwitches 
  156.      */
  157.     public $requiredSwitches = array('m|message|F|file');
  158.  
  159.     /**
  160.      * Constuctor of command. Adds available switches.
  161.      */
  162.     public function __construct()
  163.     {
  164.         parent::__construct();
  165.  
  166.         $this->validSwitchesValue = array_merge(
  167.             $this->validSwitchesValue,
  168.             array(
  169.                 'depth',
  170.                 'm''message',
  171.                 'F''file',
  172.                 'editor-cmd',
  173.                 'encoding',
  174.                 'with-revprop',
  175.             )
  176.         );
  177.  
  178.         $this->validSwitches = array_merge(
  179.             $this->validSwitches,
  180.             array(
  181.                 'q''quiet',
  182.                 'N''non-recursive',
  183.                 'force',
  184.                 'no-auto-props',
  185.                 'force-log',
  186.                 'no-ignore',
  187.             )
  188.         );
  189.     }
  190. }
  191.  
  192. ?>

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