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

Source for file Add.php

Documentation is available at Add.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 Add command manager class
  54.  *
  55.  * Put files and directories under version control, scheduling
  56.  * them for addition to repository.  They will be added in next commit.
  57.  *
  58.  * While it may or may not seem obvious, it's worth mentioning that
  59.  * the path to the file being added should already be an Subversion
  60.  * project working copy.
  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.  * array(
  68.  *  'config-dir'    =>  'Path to a Subversion configuration directory',
  69.  *  'targets'       =>  'ARG',
  70.  *                      // pass contents of file ARG as additional args
  71.  *  'q [quiet]'     =>  true|false,
  72.  *                     // prints as little as possible
  73.  *  'v [verbose]'   =>  true|false,
  74.  *                      // prints extra information
  75.  *  'N'             =>  true|false,
  76.  *                      // operate on single directory only
  77.  *  'non-recursive' =>  true|false,
  78.  *                      // operate on single directory only
  79.  *  'auto-props'    =>  true|false,
  80.  *                      // enable automatic properties. Setting to false IS NOT
  81.  *                      // the same as setting no-auto-props to true.
  82.  *  'no-auto-props' =>  true|false
  83.  *                      // disable automatic properties. Setting to false IS NOT
  84.  *                      // the same as setting auto-props to true.
  85.  * );
  86.  *
  87.  * </code>
  88.  *
  89.  * Usage example:
  90.  * <code>
  91.  * <?php
  92.  * require_once 'VersionControl/SVN.php';
  93.  *
  94.  * // Set up runtime options. Will be passed to all
  95.  * // subclasses.
  96.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  97.  *
  98.  * // Pass array of subcommands we need to factory
  99.  * $svn = VersionControl_SVN::factory(array('add'), $options);
  100.  *
  101.  * // Define any switches and aguments we may need
  102.  * $switches = array();
  103.  * $args = array('/local_working_files/myproject/newfile.php');
  104.  *
  105.  * // Run command
  106.  * try {
  107.  *     print_r($svn->add->run($args, $switches));
  108.  * } catch (VersionControl_SVN_Exception $e) {
  109.  *     print_r($e->getMessage());
  110.  * }
  111.  * ?>
  112.  * </code>
  113.  *
  114.  *
  115.  * Note: Subversion does not offer an XML output option for this subcommand
  116.  *
  117.  * @category VersionControl
  118.  * @package  VersionControl_SVN
  119.  * @author   Clay Loveless <clay@killersoft.com>
  120.  * @author   Michiel Rook <mrook@php.net>
  121.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  122.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  123.  * @version  0.5.1
  124.  * @link     http://pear.php.net/package/VersionControl_SVN
  125.  */
  126. {
  127.     /**
  128.      * Minimum number of args required by this subcommand.
  129.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  130.      * Subversion Complete Reference for details on arguments for this subcommand.
  131.      *
  132.      * @var int $minArgs 
  133.      */
  134.     public $minArgs = 1;
  135.  
  136.     /**
  137.      * Constuctor of command. Adds available switches.
  138.      */
  139.     public function __construct()
  140.     {
  141.         parent::__construct();
  142.  
  143.         $this->validSwitchesValue = array_merge(
  144.             $this->validSwitchesValue,
  145.             array(
  146.                 'targets',
  147.                 'depth',
  148.             )
  149.         );
  150.  
  151.         $this->validSwitches = array_merge(
  152.             $this->validSwitches,
  153.             array(
  154.                 'N''non-recursive',
  155.                 'q''quiet',
  156.                 'force',
  157.                 'no-ignore',
  158.                 'auto-props',
  159.                 'no-auto-props',
  160.                 'parents',
  161.             )
  162.         );
  163.     }
  164. }
  165.  
  166. ?>

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