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

Source for file List.php

Documentation is available at List.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 List command manager class
  53.  *
  54.  * List directory entries in the repository
  55.  *
  56.  * If the 'target' option is omitted, '.' is assumed, meaning the
  57.  * repository URL of the current working directory.
  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.  * array(
  65.  *  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  66.  *                        A revision argument can be one of:
  67.  *                           NUMBER       revision number
  68.  *                           "{" DATE "}" revision at start of the date
  69.  *                           "HEAD"       latest in repository
  70.  *                           "BASE"       base rev of item's working copy
  71.  *                           "COMMITTED"  last commit at or before BASE
  72.  *                           "PREV"       revision just before COMMITTED',
  73.  *                      // either 'r' or 'revision' may be used
  74.  *  'v [verbose]'   =>  true|false,
  75.  *                      // prints extra information
  76.  *  'R'             =>  true|false,
  77.  *                      // descend recursively
  78.  *  'recursive'     =>  true|false,
  79.  *                      // descend recursively
  80.  *  'username'      =>  'Subversion repository login',
  81.  *  'password'      =>  'Subversion repository password',
  82.  *  'no-auth-cache' =>  true|false,
  83.  *                      // Do not cache authentication tokens
  84.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  85.  * );
  86.  *
  87.  * </code>
  88.  *
  89.  * With the 'verbose' option set to true, the following fields show the
  90.  * status of the item:
  91.  * 
  92.  *     Revision number of the last commit
  93.  *     Author of the last commit
  94.  *     Size (in bytes)
  95.  *     Date and time of the last commit
  96.  * 
  97.  *
  98.  * Usage example:
  99.  * <code>
  100.  * <?php
  101.  * require_once 'VersionControl/SVN.php';
  102.  *
  103.  * // Set up runtime options. Will be passed to all
  104.  * // subclasses.
  105.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  106.  *
  107.  * // Pass array of subcommands we need to factory
  108.  * $svn = VersionControl_SVN::factory(array('list'), $options);
  109.  *
  110.  * // Define any switches and aguments we may need
  111.  * $switches = array('R' => true, 'username' => 'user', 'password' => 'pass');
  112.  * $args = array('svn://svn.example.com/repos/TestProject');
  113.  *
  114.  * // Run command
  115.  * try {
  116.  *     print_r($svn->list->run($args, $switches));
  117.  * } catch (VersionControl_SVN_Exception $e) {
  118.  *     print_r($e->getMessage());
  119.  * }
  120.  * ?>
  121.  * </code>
  122.  *
  123.  * Note: Subversion does not offer an XML output option for this subcommand
  124.  *
  125.  * @category VersionControl
  126.  * @package  VersionControl_SVN
  127.  * @author   Clay Loveless <clay@killersoft.com>
  128.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  129.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  130.  * @version  0.5.1
  131.  * @link     http://pear.php.net/package/VersionControl_SVN
  132.  */
  133. {
  134.     /**
  135.      * Keep track of whether XML output is available for a command
  136.      *
  137.      * @var boolean $xmlAvail 
  138.      */
  139.     protected $xmlAvail = true;
  140.  
  141.     /**
  142.      * Constuctor of command. Adds available switches.
  143.      */
  144.     public function __construct()
  145.     {
  146.         parent::__construct();
  147.  
  148.         $this->validSwitchesValue = array_merge(
  149.             $this->validSwitchesValue,
  150.             array(
  151.                 'r''revision',
  152.                 'depth',
  153.             )
  154.         );
  155.  
  156.         $this->validSwitches = array_merge(
  157.             $this->validSwitches,
  158.             array(
  159.                 'v''verbose',
  160.                 'R''recursive',
  161.                 'incremental',
  162.                 'xml',
  163.             )
  164.         );
  165.     }
  166. }
  167.  
  168. ?>

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