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

Source for file Commit.php

Documentation is available at Commit.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 Commit command manager class
  53.  *
  54.  * Send changes from a working copy to 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.  * $switches is an array containing one or more command line options
  60.  * defined by the following associative keys:
  61.  *
  62.  * <code>
  63.  *
  64.  * $switches = array(
  65.  *  'm [message]'   =>  'Specified commit message',
  66.  *                      // either 'm' or 'message' may be used
  67.  *  'F [file]'      =>  'Read commit message data from specified file',
  68.  *                      // either 'F' or 'file' may be used
  69.  *  'q [quiet]'     =>  true|false,
  70.  *                      // prints as little as possible
  71.  *  'N'             =>  true|false,
  72.  *                      // operate on single directory only
  73.  *  'non-recursive' =>  true|false,
  74.  *                      // operate on single directory only
  75.  *  'targets'       =>  'ARG',
  76.  *                      // pass contents of file ARG as additional args
  77.  *  'force-log'     =>  true|false,
  78.  *                      // force validity of log message source
  79.  *  'username'      =>  'Subversion repository login',
  80.  *  'password'      =>  'Subversion repository password',
  81.  *  'no-auth-cache' =>  true|false,
  82.  *                      // Do not cache authentication tokens
  83.  *  'encoding'      =>  'ARG',
  84.  *                      // treat value as being in charset encoding ARG
  85.  *  'config-dir'    =>  'Path to a Subversion configuration directory',
  86.  *  'changelist     =>  'Changelist to operate on'
  87.  * );
  88.  *
  89.  * </code>
  90.  *
  91.  * If a path is not used in the $args array, the default path of '.' will
  92.  * be assumed.
  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('checkout'), $options);
  113.  *
  114.  * // Define any switches and aguments we may need
  115.  * $switches = array('m' => 'Bug #1234 fixed!', 'username' => 'user', 'password' => 'pass');
  116.  * $args = array('/path/to/working_copy');
  117.  *
  118.  * // Run command
  119.  * try {
  120.  *     print_r($svn->commit->run($args, $switches));
  121.  * } catch (VersionControl_SVN_Exception $e) {
  122.  *     print_r($e->getMessage());
  123.  * }
  124.  * ?>
  125.  * </code>
  126.  *
  127.  * @category VersionControl
  128.  * @package  VersionControl_SVN
  129.  * @author   Clay Loveless <clay@killersoft.com>
  130.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  131.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  132.  * @version  0.5.1
  133.  * @link     http://pear.php.net/package/VersionControl_SVN
  134.  */
  135. {
  136.     /**
  137.      * Switches required by this subcommand.
  138.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  139.      * Subversion Complete Reference for details on arguments for this subcommand.
  140.      *
  141.      * @var array $requiredSwitches 
  142.      */
  143.     public $requiredSwitches = array('m|message|F|file');
  144.  
  145.     /**
  146.      * Constuctor of command. Adds available switches.
  147.      */
  148.     public function __construct()
  149.     {
  150.         parent::__construct();
  151.  
  152.         $this->validSwitchesValue = array_merge(
  153.             $this->validSwitchesValue,
  154.             array(
  155.                 'depth',
  156.                 'targets',
  157.                 'm''message',
  158.                 'F''file',
  159.                 'editor-cmd',
  160.                 'encoding',
  161.                 'with-revprop',
  162.                 'changelist',
  163.             )
  164.         );
  165.  
  166.         $this->validSwitches = array_merge(
  167.             $this->validSwitches,
  168.             array(
  169.                 'q''quiet',
  170.                 'N''non-recursive',
  171.                 'no-unlock',
  172.                 'force-log',
  173.                 'keep-changelist',
  174.             )
  175.         );
  176.     }
  177. }
  178.  
  179. ?>

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