Class: VersionControl_SVN_Propset

VersionControl_SVN
   |
   --VersionControl_SVN_Propset

[line 167]
Subversion Propset command manager class

Set PROPNAME to PROPVAL on files, dirs, or revisions.

Note: svn recognizes the following special versioned properties but will store any arbitrary properties set: svn:ignore - A newline separated list of file patterns to ignore. svn:keywords - Keywords to be expanded. Valid keywords are: URL, HeadURL - The URL for the head version of the object. Author, LastChangedBy - The last person to modify the file. Date, LastChangedDate - The date/time the object was last modified. Rev, LastChangedRevision - The last revision the object changed. Id - A compressed summary of the previous 4 keywords. svn:executable - If present, make the file executable. This property cannot be set on a directory. A non-recursive attempt will fail, and a recursive attempt will set the property only on the file children of the directory. svn:eol-style - One of 'native', 'LF', 'CR', 'CRLF'. svn:mime-type - The mimetype of the file. Used to determine whether to merge the file, and how to serve it from Apache. A mimetype beginning with 'text/' (or an absent mimetype) is treated as text. Anything else is treated as binary. svn:externals - A newline separated list of module specifiers, each of which consists of a relative directory path, optional revision flags, and an URL. For example foo http://example.com/repos/zig foo/bar -r 1234 http://example.com/repos/zag

$switches is an array containing one or more command line options defined by the following associative keys:

 $switches = array(

  'F [file]'      =>  'Read data from specified file',
                      // either 'F' or 'file' may be used
  'q [quiet]'     =>  true|false,
                      // print as little as possible
  'R'             =>  true|false,
                      // descend recursively
  'recursive'     =>  true|false,
                      // descend recursively
  'revprop'       =>  true|false,
                      // operate on a revision property (use with r)
  'targets'       =>  'ARG',
                      // pass contents of file ARG as additional args
  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
                        A revision argument can be one of:
                           NUMBER       revision number
                           "{" DATE "}" revision at start of the date
                           "HEAD"       latest in repository
                           "BASE"       base rev of item's working copy
                           "COMMITTED"  last commit at or before BASE
                           "PREV"       revision just before COMMITTED',
                      // either 'r' or 'revision' may be used
  'username'      =>  'Subversion repository login',
  'password'      =>  'Subversion repository password',
  'no-auth-cache' =>  true|false,
                      // Do not cache authentication tokens
  'encoding'      =>  'ARG',
                      // treat value as being in charset encoding ARG
  'force'         =>  true|false,
                      // force operation to run
  'config-dir'    =>  'Path to a Subversion configuration directory
 );

Note: Subversion does not offer an XML output option for this subcommand

The non-interactive option available on the command-line svn client may also be set (true|false), but it is set to true by default.

Usage example:

 <?php

 require_once 'VersionControl/SVN.php';
 
 // Setup error handling -- always a good idea!
 $svnstack = &PEAR_ErrorStack::singleton('VersionControl_SVN');
 
 // Set up runtime options. Will be passed to all
 // subclasses.
 $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
 
 // Pass array of subcommands we need to factory
 $svn = VersionControl_SVN::factory(array('propset'), $options);
 
 // Define any switches and aguments we may need
 $switches = array('username' => 'user', 'password' => 'pass');
 $args = array('svn:mime-type', 'image/jpeg', 'foo.jpg');
 
 // Run command
 if ($output = $svn->propset->run($args, $switches)) {
     print_r($output);
 } else {
     if (count($errs = $svnstack->getErrors())) {
         foreach ($errs as $err) {
             echo '<br />'.$err['message']."<br />\n";
             echo "Command used: " . $err['params']['cmd'];
         }
     }
 }
 ?>

$args = array()

[line 203]

Command-line arguments that should be passed outside of those specified in switches.

$min_args =  3

[line 212]

Minimum number of args required by this subcommand.

See Version Control with Subversion, Subversion Complete Reference for details on arguments for this subcommand.

$passthru =  false

[line 228]

Use exec or passthru to get results from command.

$required_switches = array()

[line 221]

Switches required by this subcommand.

See Version Control with Subversion, Subversion Complete Reference for details on arguments for this subcommand.

$valid_switches = array('r',
                                'revision',
                                'revprop',
                                'R',
                                'recursive',
                                'q',
                                'quiet',
                                'F',
                                'file',
                                'targets',
                                'username',
                                'password',
                                'no-auth-cache',
                                'no_auth_cache',
                                'non-interactive',
                                'non_interactive',
                                'force',
                                'encoding',
                                'config-dir'
                                )

[line 175]

Valid switches for svn propset

parseOutput   [line 333]

---

parseOutputArray   [line 366]

---

prepare   [line 241]

---