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

Source for file Status.php

Documentation is available at Status.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 Status command manager class
  53.  *
  54.  * Print the status of working copy files and directories.
  55.  *
  56.  * There are many possible output values from this command. The following
  57.  * is from 'svn help status':
  58.  *
  59.  *  With no args, print only locally modified items (no network access).
  60.  *  With -u, add working revision and server out-of-date information.
  61.  *  With -v, print full revision information on every item.
  62.  *
  63.  *  The first five columns in the output are each one character wide:
  64.  *    First column: Says if item was added, deleted, or otherwise changed
  65.  *      ' ' no modifications
  66.  *      'A' Added
  67.  *      'C' Conflicted
  68.  *      'D' Deleted
  69.  *      'G' Merged
  70.  *      'I' Ignored
  71.  *      'M' Modified
  72.  *      'R' Replaced
  73.  *      'X' item is unversioned, but is used by an externals definition
  74.  *      '?' item is not under version control
  75.  *      '!' item is missing (removed by non-svn command) or incomplete
  76.  *      '~' versioned item obstructed by some item of a different kind
  77.  *    Second column: Modifications of a file's or directory's properties
  78.  *      ' ' no modifications
  79.  *      'C' Conflicted
  80.  *      'M' Modified
  81.  *    Third column: Whether the working copy directory is locked
  82.  *      ' ' not locked
  83.  *      'L' locked
  84.  *    Fourth column: Scheduled commit will contain addition-with-history
  85.  *      ' ' no history scheduled with commit
  86.  *      '+' history scheduled with commit
  87.  *    Fifth column: Whether the item is switched relative to its parent
  88.  *      ' ' normal
  89.  *      'S' switched
  90.  *
  91.  *  The out-of-date information appears in the eighth column (with -u):
  92.  *      '*' a newer revision exists on the server
  93.  *      ' ' the working copy is up to date
  94.  *
  95.  *  Remaining fields are variable width and delimited by spaces:
  96.  *    The working revision (with -u or -v)
  97.  *    The last committed revision and last committed author (with -v)
  98.  *    The working copy path is always the final field, so it can
  99.  *      include spaces.
  100.  *
  101.  *  Example output:
  102.  *    svn status wc
  103.  *     M     wc/bar.c
  104.  *    A  +   wc/qax.c
  105.  *
  106.  *    svn status -u wc
  107.  *     M           965    wc/bar.c
  108.  *           *     965    wc/foo.c
  109.  *    A  +         965    wc/qax.c
  110.  *    Head revision:   981
  111.  *
  112.  *    svn status --show-updates --verbose wc
  113.  *     M           965       938 kfogel       wc/bar.c
  114.  *           *     965       922 sussman      wc/foo.c
  115.  *    A  +         965       687 joe          wc/qax.c
  116.  *                 965       687 joe          wc/zig.c
  117.  *    Head revision:   981
  118.  *
  119.  *
  120.  * $switches is an array containing one or more command line options
  121.  * defined by the following associative keys:
  122.  *
  123.  * <code>
  124.  *
  125.  * $switches = array(
  126.  *  'u'             =>  true|false,
  127.  *                      // display update information
  128.  *  'show-updates'  =>  true|false,
  129.  *                      // display update information
  130.  *  'v [verbose]'   =>  true|false,
  131.  *                      // prints extra information
  132.  *  'N'             =>  true|false,
  133.  *                      // operate on a single directory only
  134.  *  'non-recursive' =>  true|false,
  135.  *                      // operate on a single directory only
  136.  *  'q [quiet]'     =>  true|false,
  137.  *                      // prints as little as possible
  138.  *  'no-ignore'     =>  true|false,
  139.  *                      // disregard default and svn:ignore property ignores
  140.  *  'username'      =>  'Subversion repository login',
  141.  *  'password'      =>  'Subversion repository password',
  142.  *  'no-auth-cache' =>  true|false,
  143.  *                      // Do not cache authentication tokens
  144.  *  'config-dir'    =>  'Path to a Subversion configuration directory',
  145.  *  'changelist     =>  'Changelist to operate on'
  146.  * );
  147.  *
  148.  * </code>
  149.  *
  150.  * Note: Subversion does not offer an XML output option for this subcommand
  151.  *
  152.  * The non-interactive option available on the command-line
  153.  * svn client may also be set (true|false), but it is set to true by default.
  154.  *
  155.  * Usage example:
  156.  * <code>
  157.  * <?php
  158.  * require_once 'VersionControl/SVN.php';
  159.  *
  160.  * // Set up runtime options. Will be passed to all
  161.  * // subclasses.
  162.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  163.  *
  164.  * // Pass array of subcommands we need to factory
  165.  * $svn = VersionControl_SVN::factory(array('status'), $options);
  166.  *
  167.  * // Define any switches and aguments we may need
  168.  * $switches = array('u' => true, 'v' => true);
  169.  * $args = array('/path/to/working/copy/TestProj/trunk');
  170.  *
  171.  * // Run command
  172.  * try {
  173.  *     print_r($svn->status->run($args, $switches));
  174.  * } catch (VersionControl_SVN_Exception $e) {
  175.  *     print_r($e->getMessage());
  176.  * }
  177.  * ?>
  178.  * </code>
  179.  *
  180.  * @category VersionControl
  181.  * @package  VersionControl_SVN
  182.  * @author   Clay Loveless <clay@killersoft.com>
  183.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  184.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  185.  * @version  0.5.1
  186.  * @link     http://pear.php.net/package/VersionControl_SVN
  187.  */
  188. {
  189.     /**
  190.      * Keep track of whether XML output is available for a command
  191.      *
  192.      * @var boolean $xmlAvail 
  193.      */
  194.     protected $xmlAvail = true;
  195.  
  196.     /**
  197.      * Constuctor of command. Adds available switches.
  198.      */
  199.     public function __construct()
  200.     {
  201.         parent::__construct();
  202.  
  203.         $this->validSwitchesValue = array_merge(
  204.             $this->validSwitchesValue,
  205.             array(
  206.                 'depth',
  207.                 'changelist',
  208.             )
  209.         );
  210.  
  211.         $this->validSwitches = array_merge(
  212.             $this->validSwitches,
  213.             array(
  214.                 'u''show-updates',
  215.                 'v''verbose',
  216.                 'N''non-recursive',
  217.                 'q''quiet',
  218.                 'no-ignore',
  219.                 'incremental',
  220.                 'xml',
  221.                 'ignore-externals',
  222.             )
  223.         );
  224.     }
  225. }
  226.  
  227. ?>

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