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

Source for file Mkdir.php

Documentation is available at Mkdir.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 Mkdir command manager class
  53.  *
  54.  * Create a new directory under version control.
  55.  * 
  56.  * From svn mkdir --help:
  57.  *
  58.  * usage: 1. mkdir PATH...
  59.  *        2. mkdir URL...
  60.  * 
  61.  *   Create version controlled directories.
  62.  * 
  63.  *   1. Each directory specified by a working copy PATH is created locally
  64.  *     and scheduled for addition upon the next commit.
  65.  * 
  66.  *   2. Each directory specified by a URL is created in the repository via
  67.  *     an immediate commit.
  68.  * 
  69.  *   In both cases, all the intermediate directories must already exist.
  70.  *
  71.  * New directories must include a message option
  72.  * (either with 'm', 'message', 'file' or 'F' keys), when the directory is
  73.  * created directly in the repository, as that results in an immediate commit.
  74.  *
  75.  * $switches is an array containing one or more command line options
  76.  * defined by the following associative keys:
  77.  *
  78.  * <code>
  79.  *
  80.  * $switches = array(
  81.  *  'm [message]'   =>  'Specified commit message',
  82.  *                      // either 'm' or 'message' may be used
  83.  *  'F [file]'      =>  'Read commit message data from specified file',
  84.  *                      // either 'F' or 'file' may be used
  85.  *  'q [quiet]'     =>  true|false,
  86.  *                      // prints as little as possible
  87.  *  'force-log'     =>  true|false,
  88.  *                      // force validity of log message source
  89.  *  'username'      =>  'Subversion repository login',
  90.  *  'password'      =>  'Subversion repository password',
  91.  *  'no-auth-cache' =>  true|false,
  92.  *                      // Do not cache authentication tokens
  93.  *  'encoding'      =>  'ARG',
  94.  *                      // treat value as being in charset encoding ARG
  95.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  96.  * );
  97.  *
  98.  * </code>
  99.  *
  100.  * Note: Subversion does not offer an XML output option for this subcommand
  101.  *
  102.  * The non-interactive option available on the command-line
  103.  * svn client may also be set (true|false), but it is set to true by default.
  104.  *
  105.  * The editor-cmd option available on the command-line svn client is not available
  106.  * since this class does not operate as an interactive shell session.
  107.  *
  108.  * Usage example:
  109.  * <code>
  110.  * <?php
  111.  * require_once 'VersionControl/SVN.php';
  112.  *
  113.  * // Set up runtime options. Will be passed to all
  114.  * // subclasses.
  115.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  116.  *
  117.  * // Pass array of subcommands we need to factory
  118.  * $svn = VersionControl_SVN::factory(array('mkdir'), $options);
  119.  *
  120.  * // Define any switches and aguments we may need
  121.  * $switches = array('m' => 'Let\'s make a hole here ...', 'username' => 'user', 'password' => 'pass');
  122.  * $args = array('svn://svn.example.com/repos/TestProj/trunk/newdir');
  123.  *
  124.  * // Run command
  125.  * try {
  126.  *     print_r($svn->mkdir->run($args, $switches));
  127.  * } catch (VersionControl_SVN_Exception $e) {
  128.  *     print_r($e->getMessage());
  129.  * }
  130.  * ?>
  131.  * </code>
  132.  *
  133.  * @category VersionControl
  134.  * @package  VersionControl_SVN
  135.  * @author   Clay Loveless <clay@killersoft.com>
  136.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  137.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  138.  * @version  0.5.1
  139.  * @link     http://pear.php.net/package/VersionControl_SVN
  140.  */
  141. {
  142.     /**
  143.      * Minimum number of args required by this subcommand.
  144.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  145.      * Subversion Complete Reference for details on arguments for this subcommand.
  146.      *
  147.      * @var int $minArgs 
  148.      */
  149.     public $minArgs = 1;
  150.  
  151.     /**
  152.      * Switches required by this subcommand.
  153.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  154.      * Subversion Complete Reference for details on arguments for this subcommand.
  155.      *
  156.      * @var array $requiredSwitches 
  157.      */
  158.     public $requiredSwitches = array('m|message|F|file');
  159.  
  160.     /**
  161.      * Constuctor of command. Adds available switches.
  162.      */
  163.     public function __construct()
  164.     {
  165.         parent::__construct();
  166.  
  167.         $this->validSwitchesValue = array_merge(
  168.             $this->validSwitchesValue,
  169.             array(
  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.                 'parents',
  183.                 'forde-log',
  184.             )
  185.         );
  186.     }
  187. }
  188.  
  189. ?>

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