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

Source for file Cleanup.php

Documentation is available at Cleanup.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 Cleanup command manager class
  53.  *
  54.  * Recursively clean up the working copy indicated by PATH, removing
  55.  * locks, resuming unfinished operations, etc.
  56.  *
  57.  * $options is an array containing one or more options
  58.  * defined by the following associative keys:
  59.  *
  60.  * <code>
  61.  *
  62.  * $switches = array(
  63.  *  'config-dir'    =>  'Path to a Subversion configuration directory',
  64.  *  'diff3-cmd'     =>  'ARG'
  65.  *                      // Use ARG as merge command.
  66.  * );
  67.  *
  68.  * </code>
  69.  *
  70.  * If a path is not used in the $args array, the default path of '.' will
  71.  * be assumed.
  72.  *
  73.  * Note: Subversion does not offer an XML output option for this subcommand
  74.  *
  75.  * Note: There is no output from the svn cleanup command!
  76.  *
  77.  * Usage example:
  78.  * <code>
  79.  * <?php
  80.  * require_once 'VersionControl/SVN.php';
  81.  *
  82.  * // Pass array of subcommands we need to factory
  83.  * $svn = VersionControl_SVN::factory(array('cleanup'), $options);
  84.  *
  85.  * // Define any switches and aguments we may need
  86.  * $args = array('/path/to/working_copy');
  87.  *
  88.  * // Run command
  89.  * try {
  90.  *     print_r($svn->cleanup->run($args, $switches));
  91.  * } catch (VersionControl_SVN_Exception $e) {
  92.  *     print_r($e->getMessage());
  93.  * }
  94.  * ?>
  95.  * </code>
  96.  *
  97.  * @category VersionControl
  98.  * @package  VersionControl_SVN
  99.  * @author   Clay Loveless <clay@killersoft.com>
  100.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  101.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  102.  * @version  0.5.1
  103.  * @link     http://pear.php.net/package/VersionControl_SVN
  104.  */
  105. {
  106.     /**
  107.      * Constuctor of command. Adds available switches.
  108.      */
  109.     public function __construct()
  110.     {
  111.         parent::__construct();
  112.  
  113.         $this->validSwitchesValue = array_merge(
  114.             $this->validSwitchesValue,
  115.             array(
  116.                 'diff3-cmd',
  117.             )
  118.         );
  119.     }
  120. }
  121.  
  122. ?>

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