| // +----------------------------------------------------------------------+ // // $Id$ // /** * @package VersionControl_SVN * @category VersionControl * @author Clay Loveless */ /** * Subversion Info command manager class * * Display information about a file or directory in PATH. * * If the 'path' option is omitted, '.' is assumed. * * Note: This command only operates on working copies. It does * NOT access the repository. * * $switches is an array containing one or more command line options * defined by the following associative keys: * *


 *
 * $switches = array(
 *  'targets'       =>  'ARG',
 *                      // passes contents of file ARG as additional arguments
 *  'R'             =>  true|false,
 *                      // descend recursively
 *  'recursive'     =>  true|false,
 *                      // descend recursively
 *  'config-dir'    =>  'Path to a Subversion configuration directory'
 * );
 *
 *

* * Usage example: *


 *  VERSIONCONTROL_SVN_FETCHMODE_RAW);
 *
 * // Pass array of subcommands we need to factory
 * $svn = VersionControl_SVN::factory(array('info'), $options);
 *
 * // Define any switches and aguments we may need
 * $switches = array('R' => true);
 * $args = array('/path/to/working_copy');
 *
 * // Run command
 * if ($output = $svn->info->run($args, $switches)) {
 *     print_r($output);
 * } else {
 *     if (count($errs = $svnstack->getErrors())) { 
 *         foreach ($errs as $err) {
 *             echo '
'.$err['message']."
\n";
 *             echo "Command used: " . $err['params']['cmd'];
 *         }
 *     }
 * }
 * ?>
 *

* * Note: Subversion does not offer an XML output option for this subcommand * * @package VersionControl_SVN * @version @version@ * @category SCM * @author Clay Loveless */ class VersionControl_SVN_Info extends VersionControl_SVN { /** * Valid switches for svn info * * @var array * @access public */ var $valid_switches = array('R', 'recursive', 'targets', 'config-dir', 'config_dir' ); /** * Command-line arguments that should be passed * outside of those specified in {@link switches}. * * @var array * @access public */ var $args = array(); /** * Minimum number of args required by this subcommand. * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion}, * Subversion Complete Reference for details on arguments for this subcommand. * @var int * @access public */ var $min_args = 0; /** * Switches required by this subcommand. * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion}, * Subversion Complete Reference for details on arguments for this subcommand. * @var array * @access public */ var $required_switches = array(); /** * Use exec or passthru to get results from command. * @var bool * @access public */ var $passthru = false; /** * Prepare the svn subcommand switches. * * Defaults to non-interactive mode, and will auto-set the * --xml switch (if available) if $fetchmode is set to VERSIONCONTROL_SVN_FETCHMODE_XML, * VERSIONCONTROL_SVN_FETCHMODE_ASSOC or VERSIONCONTROL_SVN_FETCHMODE_OBJECT * * @param void * @return int true on success, false on failure. Check PEAR_ErrorStack * for error details, if any. */ function prepare() { $meets_requirements = $this->checkCommandRequirements(); if (!$meets_requirements) { return false; } $valid_switches = $this->valid_switches; $switches = $this->switches; $args = $this->args; $fetchmode = $this->fetchmode; $invalid_switches = array(); $_switches = ''; foreach ($switches as $switch => $val) { if (in_array($switch, $valid_switches)) { $switch = str_replace('_', '-', $switch); switch ($switch) { case 'targets': case 'config-dir': $_switches .= "--$switch $val "; break; case 'recursive': if ($val === true) { $_switches .= "--$switch "; } break; case 'R': if ($val === true) { $_switches .= "-$switch "; } break; default: // that's all, folks! break; } } else { $invalid_switches[] = $switch; } } $_switches = trim($_switches); $this->_switches = $_switches; $cmd = "$this->svn_path $this->_svn_cmd $_switches"; if (!empty($args)) { $cmd .= ' '. join(' ', $args); } $this->_prepped_cmd = $cmd; $this->prepared = true; $invalid = count($invalid_switches); if ($invalid > 0) { $params['was'] = 'was'; $params['is_invalid_switch'] = 'is an invalid switch'; if ($invalid > 1) { $params['was'] = 'were'; $params['is_invalid_switch'] = 'are invalid switches'; } $params['list'] = $invalid_switches; $params['switches'] = $switches; $params['_svn_cmd'] = ucfirst($this->_svn_cmd); $this->_stack->push(VERSIONCONTROL_SVN_NOTICE_INVALID_SWITCH, 'notice', $params); } return true; } // }}} // {{{ parseOutput() /** * Handles output parsing of standard and verbose output of command. * * @param array $out Array of output captured by exec command in {@link run}. * @return mixed Returns output requested by fetchmode (if available), or raw output * if desired fetchmode is not available. * @access public */ function parseOutput($out) { $fetchmode = $this->fetchmode; switch($fetchmode) { case VERSIONCONTROL_SVN_FETCHMODE_RAW: return join("\n", $out); break; case VERSIONCONTROL_SVN_FETCHMODE_ASSOC: // Temporary, see parseOutputArray below return join("\n", $out); break; case VERSIONCONTROL_SVN_FETCHMODE_OBJECT: // Temporary, will return object-ified array from // parseOutputArray return join("\n", $out); break; case VERSIONCONTROL_SVN_FETCHMODE_XML: // Temporary, will eventually build an XML string // with XML_Util or XML_Tree return join("\n", $out); break; default: // What you get with VERSIONCONTROL_SVN_FETCHMODE_DEFAULT return join("\n", $out); break; } } /** * Helper method for parseOutput that parses output into an associative array * * @todo Finish this method! : ) */ function parseOutputArray($out) { $parsed = array(); } } /// }}} ?>