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

Source for file Delete.php

Documentation is available at Delete.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 Delete command manager class
  53.  *
  54.  * Remove files and directories from version control.
  55.  * 
  56.  *  1. Each item specified by a PATH is scheduled for deletion upon
  57.  *     the next commit.  Files, and directories that have not been
  58.  *     committed, are immediately removed from the working copy.
  59.  *     PATHs that are, or contain, unversioned or modified items will
  60.  *     not be removed unless the 'force' option is given.
  61.  * 
  62.  *  2. Each item specified by a URL is deleted from the repository
  63.  *     via an immediate commit.
  64.  *
  65.  * $switches is an array containing one or more command line options
  66.  * defined by the following associative keys:
  67.  *
  68.  * <code>
  69.  *
  70.  * $switches = array(
  71.  *  'm [message]'   =>  'Specified commit message',
  72.  *                      // either 'm' or 'message' may be used (optional)
  73.  *  'F [file]'      =>  'Read commit message data from specified file',
  74.  *                      // either 'F' or 'file' may be used (optional)
  75.  *  'q [quiet]'     =>  true|false,
  76.  *                      // prints as little as possible
  77.  *  'targets'       =>  'ARG',
  78.  *                      // pass contents of file ARG as additional args
  79.  *  'force'         =>  true|false,
  80.  *                      // force operation to run
  81.  *  'force-log'     =>  true|false,
  82.  *                      // force validity of log message source
  83.  *  'username'      =>  'Subversion repository login',
  84.  *  'password'      =>  'Subversion repository password',
  85.  *  'no-auth-cache' =>  true|false,
  86.  *                      // Do not cache authentication tokens
  87.  *  'encoding'      =>  'ARG',
  88.  *                      // treat value as being in charset encoding ARG
  89.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  90.  * );
  91.  *
  92.  * </code>
  93.  *
  94.  * Note: Subversion does not offer an XML output option for this subcommand
  95.  *
  96.  * The non-interactive option available on the command-line
  97.  * svn client may also be set (true|false), but it is set to true by default.
  98.  *
  99.  * The editor-cmd option available on the command-line svn client is not available
  100.  * since this class does not operate as an interactive shell session.
  101.  *
  102.  * Usage example:
  103.  * <code>
  104.  * <?php
  105.  * require_once 'VersionControl/SVN.php';
  106.  *
  107.  * // Set up runtime options. Will be passed to all
  108.  * // subclasses.
  109.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  110.  *
  111.  * // Pass array of subcommands we need to factory
  112.  * $svn = VersionControl_SVN::factory(array('delete'), $options);
  113.  *
  114.  * // Define any switches and aguments we may need
  115.  * $switches = array('m' => 'Whoops! Better get rid of this file',
  116.  *                   'username' => 'user', 'password' => 'pass');
  117.  * $args = array('svn://svn.example.com/repos/TestProj/trunk/template1/bad_index.tpl');
  118.  *
  119.  * // Run command
  120.  * try {
  121.  *     print_r($svn->delete->run($args, $switches));
  122.  * } catch (VersionControl_SVN_Exception $e) {
  123.  *     print_r($e->getMessage());
  124.  * }
  125.  * ?>
  126.  * </code>
  127.  *
  128.  * @category VersionControl
  129.  * @package  VersionControl_SVN
  130.  * @author   Clay Loveless <clay@killersoft.com>
  131.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  132.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  133.  * @version  0.5.1
  134.  * @link     http://pear.php.net/package/VersionControl_SVN
  135.  */
  136. {
  137.     /**
  138.      * Minimum number of args required by this subcommand.
  139.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  140.      * Subversion Complete Reference for details on arguments for this subcommand.
  141.      *
  142.      * @var int $minArgs 
  143.      */
  144.     public $minArgs = 1;
  145.  
  146.     /**
  147.      * Constuctor of command. Adds available switches.
  148.      */
  149.     public function __construct()
  150.     {
  151.         parent::__construct();
  152.  
  153.         $this->validSwitchesValue = array_merge(
  154.             $this->validSwitchesValue,
  155.             array(
  156.                 'targets',
  157.                 'm''message',
  158.                 'F''file',
  159.                 'editor-cmd',
  160.                 'encoding',
  161.                 'with-revprop',
  162.             )
  163.         );
  164.  
  165.         $this->validSwitches = array_merge(
  166.             $this->validSwitches,
  167.             array(
  168.                 'force',
  169.                 'q''quiet',
  170.                 'force-log',
  171.                 'keep-local',
  172.             )
  173.         );
  174.     }
  175. }
  176.  
  177. ?>

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