5 * handles the cli features of Flexy Framework.
10 * $x = new HTML_FlexyFramework_Cli($ff);
11 * $x->cliHelp(); // summary of all classes which can be run with cli.
12 * (contain static $cli_desc)
13 * $x->cliParse($classname);
17 class HTML_FlexyFramework_Cli
21 * Default options that allow modification of the framewoek behaviour
27 static $cli_opts = array(
29 // this is a flag argument
30 'Pman-nodatabase' => array(
31 'desc' => 'Turn off database',
43 var $ff; // the Framework instance.
46 function HTML_FlexyFramework_Cli($ff)
51 * looks for Cli.php files and runs available() on them
52 * this should return a list of classes that can be used.
53 * - we should the load each one, and find the summary..
60 $fn = basename($_SERVER["SCRIPT_FILENAME"]);
62 echo "\n-------------------------------------------------
63 FlexyFramework Cli Application Usage:
65 #php -d include_path=.:/var/www/pear $fn [COMMAND] --help
67 #php $fn [COMMAND] --help
69 -------------------------------------------------
74 //$this->cliShortHelp('Database');
77 $p = dirname(realpath($_SERVER["SCRIPT_FILENAME"]));
78 $pr = $this->ff->project;
80 $this->cliHelpSearch($p,$pr);
86 function cliHelpSearch($p,$pr, $path=false) {
90 $full_path = array($p,$pr);
91 $class_path = array();
92 if ($path !== false) {
93 $full_path= array_merge($full_path, $path);
94 $class_path = array_merge($class_path, $path);
96 //print_r("CHKDIR: ". implode('/', $full_path)."\n");
98 foreach(scandir(implode('/', $full_path)) as $d) {
100 if (!strlen($d) || $d[0] == '.') {
110 //print_r("CHK: " . implode('/', $chk)."\n");
111 // is it a file.. and .PHP...
112 if (!is_dir(implode('/', $chk))) {
113 if (!preg_match('/\.php$/',$d)) {
116 $clp[] = preg_replace('/\.php$/','', $d);
118 //print_r("CLP: " . implode('/', $clp)."\n");
119 $this->cliShortHelp(implode('/', $clp ));
122 // skip special directories..
123 if ($d == 'templates') {
126 if ($d == 'DataObjects') {
132 // otherwise recurse...
133 //print_r("RECURSE: " . implode('/', $clp)."\n");
135 $this->cliHelpSearch($p,$pr, $clp);
140 //print_r("COMPLETE: ". implode('/', $full_path)."\n");
151 * creates an instance of all the CLI classes and prints out class + title..
154 function cliShortHelp($p) {
155 ////print_r("CHKFILE: $p\n ");
156 list($classname,$subRequest) = $this->ff->requestToClassName($p,FALSE);
157 //var_dump($classname);
158 // does it have a description.
160 $cls = new ReflectionClass($classname);
161 $val = $cls->getStaticPropertyValue('cli_desc');
162 } catch (Exception $e) {
168 echo str_pad($p,40," ") . $val ."\n";
175 * cliParse - parse command line arguments, and return the values.
176 * Will die with help message if --help or error is found..
178 * @param {String} $classname name of class - should be loaded..
179 * @return {Array|false} array of key=>value arguments.. or false if not parsed
182 function cliParse($classname)
185 // cli static $classname::$cli_opts
188 $cls = new ReflectionClass($classname);
189 $val = $cls->getStaticPropertyValue('cli_opts');
190 } catch (Exception $e) {
196 $val = array_merge(self::$cli_opts, $val);
199 require_once 'Console/Getargs.php';
200 $ar = $_SERVER['argv'];
201 $call = array(array_shift($ar)); // remove index.php
202 $call[] = array_shift($ar); // remove our class...
205 $newargs = Console_Getargs::factory($val, $ar);
207 if (!is_a($newargs, 'PEAR_Error')) {
208 return $newargs->getValues();
211 list($optional, $required, $params) = Console_Getargs::getOptionalRequired($val);
213 $helpHeader = 'Usage: php ' . implode (' ', $call) . ' '.
214 $optional . ' ' . $required . ' ' . $params . "\n\n";
217 if ($newargs->getCode() === CONSOLE_GETARGS_ERROR_USER) {
218 // User put illegal values on the command line.
219 echo Console_Getargs::getHelp($val,
220 $helpHeader, "\n\n".$newargs->getMessage(), 78, 4)."\n\n";
223 if ($newargs->getCode() === CONSOLE_GETARGS_HELP) {
225 echo Console_Getargs::getHelp($val,
226 $helpHeader, NULL, 78, 4)."\n\n";
230 die($newargs->getMessage());
238 * the framework can be run without a database even if it's configured.
239 * to support this, we need to handle things like
240 * --pman-nodatabase=1 on the command line.
243 * @returns array() - args, false - nothing matched / invalid, true = help!
247 function parseDefaultOpts()
249 require_once 'Console/Getargs.php';
250 $ar = $_SERVER['argv'];
251 $call = array(array_shift($ar)); // remove index.php
252 $call[] = array_shift($ar);
254 $val = self::$cli_opts;
256 $newargs = Console_Getargs::factory($val, $ar);
258 if (!is_a($newargs, 'PEAR_Error')) {
259 return $newargs->getValues();
261 if ($newargs->getCode() === CONSOLE_GETARGS_ERROR_USER) {
262 // User put illegal values on the command line.
263 echo Console_Getargs::getHelp($val,
264 $helpHeader, "\n\n".$newargs->getMessage(), 78, 4)."\n\n";
267 if ($newargs->getCode() === CONSOLE_GETARGS_HELP) {