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

Source for file Propset.php

Documentation is available at Propset.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 Propset command manager class
  53.  *
  54.  * Set PROPNAME to PROPVAL on files, dirs, or revisions.
  55.  *
  56.  * Note: svn recognizes the following special versioned properties
  57.  * but will store any arbitrary properties set:
  58.  *   svn:ignore     - A newline separated list of file patterns to ignore.
  59.  *   svn:keywords   - Keywords to be expanded.  Valid keywords are:
  60.  *     URL, HeadURL             - The URL for the head version of the object.
  61.  *     Author, LastChangedBy    - The last person to modify the file.
  62.  *     Date, LastChangedDate    - The date/time the object was last modified.
  63.  *     Rev, LastChangedRevision - The last revision the object changed.
  64.  *     Id                       - A compressed summary of the previous
  65.  *                                  4 keywords.
  66.  *   svn:executable - If present, make the file executable. This
  67.  *     property cannot be set on a directory.  A non-recursive attempt
  68.  *     will fail, and a recursive attempt will set the property only
  69.  *     on the file children of the directory.
  70.  *   svn:eol-style  - One of 'native', 'LF', 'CR', 'CRLF'.
  71.  *   svn:mime-type  - The mimetype of the file.  Used to determine
  72.  *     whether to merge the file, and how to serve it from Apache.
  73.  *     A mimetype beginning with 'text/' (or an absent mimetype) is
  74.  *     treated as text.  Anything else is treated as binary.
  75.  *   svn:externals  - A newline separated list of module specifiers,
  76.  *     each of which consists of a relative directory path, optional
  77.  *     revision flags, and an URL.  For example
  78.  *       foo             http://example.com/repos/zig
  79.  *       foo/bar -r 1234 http://example.com/repos/zag
  80.  *
  81.  *
  82.  * $switches is an array containing one or more command line options
  83.  * defined by the following associative keys:
  84.  *
  85.  * <code>
  86.  *
  87.  * $switches = array(
  88.  *  'F [file]'      =>  'Read data from specified file',
  89.  *                      // either 'F' or 'file' may be used
  90.  *  'q [quiet]'     =>  true|false,
  91.  *                      // print as little as possible
  92.  *  'R'             =>  true|false,
  93.  *                      // descend recursively
  94.  *  'recursive'     =>  true|false,
  95.  *                      // descend recursively
  96.  *  'revprop'       =>  true|false,
  97.  *                      // operate on a revision property (use with r)
  98.  *  'targets'       =>  'ARG',
  99.  *                      // pass contents of file ARG as additional args
  100.  *  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  101.  *                        A revision argument can be one of:
  102.  *                           NUMBER       revision number
  103.  *                           "{" DATE "}" revision at start of the date
  104.  *                           "HEAD"       latest in repository
  105.  *                           "BASE"       base rev of item's working copy
  106.  *                           "COMMITTED"  last commit at or before BASE
  107.  *                           "PREV"       revision just before COMMITTED',
  108.  *                      // either 'r' or 'revision' may be used
  109.  *  'username'      =>  'Subversion repository login',
  110.  *  'password'      =>  'Subversion repository password',
  111.  *  'no-auth-cache' =>  true|false,
  112.  *                      // Do not cache authentication tokens
  113.  *  'encoding'      =>  'ARG',
  114.  *                      // treat value as being in charset encoding ARG
  115.  *  'force'         =>  true|false,
  116.  *                      // force operation to run
  117.  *  'config-dir'    =>  'Path to a Subversion configuration directory'
  118.  * );
  119.  *
  120.  * </code>
  121.  *
  122.  * Note: Subversion does not offer an XML output option for this subcommand
  123.  *
  124.  * The non-interactive option available on the command-line
  125.  * svn client may also be set (true|false), but it is set to true by default.
  126.  *
  127.  * Usage example:
  128.  * <code>
  129.  * <?php
  130.  * require_once 'VersionControl/SVN.php';
  131.  *
  132.  * // Set up runtime options. Will be passed to all
  133.  * // subclasses.
  134.  * $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  135.  *
  136.  * // Pass array of subcommands we need to factory
  137.  * $svn = VersionControl_SVN::factory(array('propset'), $options);
  138.  *
  139.  * // Define any switches and aguments we may need
  140.  * $switches = array('username' => 'user', 'password' => 'pass');
  141.  * $args = array('svn:mime-type', 'image/jpeg', 'foo.jpg');
  142.  *
  143.  * // Run command
  144.  * try {
  145.  *     print_r($svn->propset->run($args, $switches));
  146.  * } catch (VersionControl_SVN_Exception $e) {
  147.  *     print_r($e->getMessage());
  148.  * }
  149.  * ?>
  150.  * </code>
  151.  *
  152.  * @category VersionControl
  153.  * @package  VersionControl_SVN
  154.  * @author   Clay Loveless <clay@killersoft.com>
  155.  * @author   Alexander Opitz <opitz.alexander@gmail.com>
  156.  * @license  http://www.opensource.org/licenses/bsd-license.php BSD License
  157.  * @version  0.5.1
  158.  * @link     http://pear.php.net/package/VersionControl_SVN
  159.  */
  160. {
  161.     /**
  162.      * Minimum number of args required by this subcommand.
  163.      * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},
  164.      * Subversion Complete Reference for details on arguments for this subcommand.
  165.      *
  166.      * @var int $minArgs 
  167.      */
  168.     public $minArgs = 3;
  169.  
  170.     /**
  171.      * Constuctor of command. Adds available switches.
  172.      */
  173.     public function __construct()
  174.     {
  175.         parent::__construct();
  176.  
  177.         $this->validSwitchesValue = array_merge(
  178.             $this->validSwitchesValue,
  179.             array(
  180.                 'F''file',
  181.                 'encoding',
  182.                 'r''revision',
  183.                 'targets',
  184.                 'depth',
  185.                 'changelist',
  186.             )
  187.         );
  188.  
  189.         $this->validSwitches = array_merge(
  190.             $this->validSwitches,
  191.             array(
  192.                 'q''quiet',
  193.                 'R''recursive',
  194.                 'revprop',
  195.                 'force',
  196.             )
  197.         );
  198.     }
  199. }
  200.  
  201. ?>

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