1: <?php
  2: /**
  3:  * Base class for Shells
  4:  *
  5:  * PHP 5
  6:  *
  7:  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8:  * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  9:  *
 10:  * Licensed under The MIT License
 11:  * For full copyright and license information, please see the LICENSE.txt
 12:  * Redistributions of files must retain the above copyright notice.
 13:  *
 14:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 15:  * @link          http://cakephp.org CakePHP(tm) Project
 16:  * @since         CakePHP(tm) v 1.2.0.5012
 17:  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 18:  */
 19: 
 20: App::uses('TaskCollection', 'Console');
 21: App::uses('ConsoleOutput', 'Console');
 22: App::uses('ConsoleInput', 'Console');
 23: App::uses('ConsoleInputSubcommand', 'Console');
 24: App::uses('ConsoleOptionParser', 'Console');
 25: App::uses('ClassRegistry', 'Utility');
 26: App::uses('File', 'Utility');
 27: 
 28: /**
 29:  * Base class for command-line utilities for automating programmer chores.
 30:  *
 31:  * @package       Cake.Console
 32:  */
 33: class Shell extends Object {
 34: 
 35: /**
 36:  * Output constant making verbose shells.
 37:  */
 38:     const VERBOSE = 2;
 39: 
 40: /**
 41:  * Output constant for making normal shells.
 42:  */
 43:     const NORMAL = 1;
 44: 
 45: /**
 46:  * Output constants for making quiet shells.
 47:  */
 48:     const QUIET = 0;
 49: 
 50: /**
 51:  * An instance of ConsoleOptionParser that has been configured for this class.
 52:  *
 53:  * @var ConsoleOptionParser
 54:  */
 55:     public $OptionParser;
 56: 
 57: /**
 58:  * If true, the script will ask for permission to perform actions.
 59:  *
 60:  * @var boolean
 61:  */
 62:     public $interactive = true;
 63: 
 64: /**
 65:  * Contains command switches parsed from the command line.
 66:  *
 67:  * @var array
 68:  */
 69:     public $params = array();
 70: 
 71: /**
 72:  * The command (method/task) that is being run.
 73:  *
 74:  * @var string
 75:  */
 76:     public $command;
 77: 
 78: /**
 79:  * Contains arguments parsed from the command line.
 80:  *
 81:  * @var array
 82:  */
 83:     public $args = array();
 84: 
 85: /**
 86:  * The name of the shell in camelized.
 87:  *
 88:  * @var string
 89:  */
 90:     public $name = null;
 91: 
 92: /**
 93:  * The name of the plugin the shell belongs to.
 94:  * Is automatically set by ShellDispatcher when a shell is constructed.
 95:  *
 96:  * @var string
 97:  */
 98:     public $plugin = null;
 99: 
100: /**
101:  * Contains tasks to load and instantiate
102:  *
103:  * @var array
104:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::$tasks
105:  */
106:     public $tasks = array();
107: 
108: /**
109:  * Contains the loaded tasks
110:  *
111:  * @var array
112:  */
113:     public $taskNames = array();
114: 
115: /**
116:  * Contains models to load and instantiate
117:  *
118:  * @var array
119:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::$uses
120:  */
121:     public $uses = array();
122: 
123: /**
124:  * Task Collection for the command, used to create Tasks.
125:  *
126:  * @var TaskCollection
127:  */
128:     public $Tasks;
129: 
130: /**
131:  * Normalized map of tasks.
132:  *
133:  * @var string
134:  */
135:     protected $_taskMap = array();
136: 
137: /**
138:  * stdout object.
139:  *
140:  * @var ConsoleOutput
141:  */
142:     public $stdout;
143: 
144: /**
145:  * stderr object.
146:  *
147:  * @var ConsoleOutput
148:  */
149:     public $stderr;
150: 
151: /**
152:  * stdin object
153:  *
154:  * @var ConsoleInput
155:  */
156:     public $stdin;
157: 
158: /**
159:  *  Constructs this Shell instance.
160:  *
161:  * @param ConsoleOutput $stdout A ConsoleOutput object for stdout.
162:  * @param ConsoleOutput $stderr A ConsoleOutput object for stderr.
163:  * @param ConsoleInput $stdin A ConsoleInput object for stdin.
164:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell
165:  */
166:     public function __construct($stdout = null, $stderr = null, $stdin = null) {
167:         if (!$this->name) {
168:             $this->name = Inflector::camelize(str_replace(array('Shell', 'Task'), '', get_class($this)));
169:         }
170:         $this->Tasks = new TaskCollection($this);
171: 
172:         $this->stdout = $stdout ? $stdout : new ConsoleOutput('php://stdout');
173:         $this->stderr = $stderr ? $stderr : new ConsoleOutput('php://stderr');
174:         $this->stdin = $stdin ? $stdin : new ConsoleInput('php://stdin');
175: 
176:         $this->_useLogger();
177:         $parent = get_parent_class($this);
178:         if ($this->tasks !== null && $this->tasks !== false) {
179:             $this->_mergeVars(array('tasks'), $parent, true);
180:         }
181:         if ($this->uses !== null && $this->uses !== false) {
182:             $this->_mergeVars(array('uses'), $parent, false);
183:         }
184:     }
185: 
186: /**
187:  * Initializes the Shell
188:  * acts as constructor for subclasses
189:  * allows configuration of tasks prior to shell execution
190:  *
191:  * @return void
192:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::initialize
193:  */
194:     public function initialize() {
195:         $this->_loadModels();
196:     }
197: 
198: /**
199:  * Starts up the Shell and displays the welcome message.
200:  * Allows for checking and configuring prior to command or main execution
201:  *
202:  * Override this method if you want to remove the welcome information,
203:  * or otherwise modify the pre-command flow.
204:  *
205:  * @return void
206:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::startup
207:  */
208:     public function startup() {
209:         $this->_welcome();
210:     }
211: 
212: /**
213:  * Displays a header for the shell
214:  *
215:  * @return void
216:  */
217:     protected function _welcome() {
218:         $this->out();
219:         $this->out(__d('cake_console', '<info>Welcome to CakePHP %s Console</info>', 'v' . Configure::version()));
220:         $this->hr();
221:         $this->out(__d('cake_console', 'App : %s', APP_DIR));
222:         $this->out(__d('cake_console', 'Path: %s', APP));
223:         $this->hr();
224:     }
225: 
226: /**
227:  * If $uses = true
228:  * Loads AppModel file and constructs AppModel class
229:  * makes $this->AppModel available to subclasses
230:  * If public $uses is an array of models will load those models
231:  *
232:  * @return boolean
233:  */
234:     protected function _loadModels() {
235:         if (empty($this->uses)) {
236:             return false;
237:         }
238: 
239:         $uses = is_array($this->uses) ? $this->uses : array($this->uses);
240: 
241:         $modelClassName = $uses[0];
242:         if (strpos($uses[0], '.') !== false) {
243:             list($plugin, $modelClassName) = explode('.', $uses[0]);
244:         }
245:         $this->modelClass = $modelClassName;
246: 
247:         foreach ($uses as $modelClass) {
248:             list($plugin, $modelClass) = pluginSplit($modelClass, true);
249:             $this->{$modelClass} = ClassRegistry::init($plugin . $modelClass);
250:         }
251: 
252:         return true;
253:     }
254: 
255: /**
256:  * Loads tasks defined in public $tasks
257:  *
258:  * @return boolean
259:  */
260:     public function loadTasks() {
261:         if ($this->tasks === true || empty($this->tasks) || empty($this->Tasks)) {
262:             return true;
263:         }
264:         $this->_taskMap = TaskCollection::normalizeObjectArray((array)$this->tasks);
265:         $this->taskNames = array_merge($this->taskNames, array_keys($this->_taskMap));
266:         return true;
267:     }
268: 
269: /**
270:  * Check to see if this shell has a task with the provided name.
271:  *
272:  * @param string $task The task name to check.
273:  * @return boolean Success
274:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::hasTask
275:  */
276:     public function hasTask($task) {
277:         return isset($this->_taskMap[Inflector::camelize($task)]);
278:     }
279: 
280: /**
281:  * Check to see if this shell has a callable method by the given name.
282:  *
283:  * @param string $name The method name to check.
284:  * @return boolean
285:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::hasMethod
286:  */
287:     public function hasMethod($name) {
288:         try {
289:             $method = new ReflectionMethod($this, $name);
290:             if (!$method->isPublic() || substr($name, 0, 1) === '_') {
291:                 return false;
292:             }
293:             if ($method->getDeclaringClass()->name === 'Shell') {
294:                 return false;
295:             }
296:             return true;
297:         } catch (ReflectionException $e) {
298:             return false;
299:         }
300:     }
301: 
302: /**
303:  * Dispatch a command to another Shell. Similar to Object::requestAction()
304:  * but intended for running shells from other shells.
305:  *
306:  * ### Usage:
307:  *
308:  * With a string command:
309:  *
310:  *  `return $this->dispatchShell('schema create DbAcl');`
311:  *
312:  * Avoid using this form if you have string arguments, with spaces in them.
313:  * The dispatched will be invoked incorrectly. Only use this form for simple
314:  * command dispatching.
315:  *
316:  * With an array command:
317:  *
318:  * `return $this->dispatchShell('schema', 'create', 'i18n', '--dry');`
319:  *
320:  * @return mixed The return of the other shell.
321:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::dispatchShell
322:  */
323:     public function dispatchShell() {
324:         $args = func_get_args();
325:         if (is_string($args[0]) && count($args) === 1) {
326:             $args = explode(' ', $args[0]);
327:         }
328: 
329:         $Dispatcher = new ShellDispatcher($args, false);
330:         return $Dispatcher->dispatch();
331:     }
332: 
333: /**
334:  * Runs the Shell with the provided argv.
335:  *
336:  * Delegates calls to Tasks and resolves methods inside the class. Commands are looked
337:  * up with the following order:
338:  *
339:  * - Method on the shell.
340:  * - Matching task name.
341:  * - `main()` method.
342:  *
343:  * If a shell implements a `main()` method, all missing method calls will be sent to
344:  * `main()` with the original method name in the argv.
345:  *
346:  * @param string $command The command name to run on this shell. If this argument is empty,
347:  *   and the shell has a `main()` method, that will be called instead.
348:  * @param array $argv Array of arguments to run the shell with. This array should be missing the shell name.
349:  * @return void
350:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::runCommand
351:  */
352:     public function runCommand($command, $argv) {
353:         $isTask = $this->hasTask($command);
354:         $isMethod = $this->hasMethod($command);
355:         $isMain = $this->hasMethod('main');
356: 
357:         if ($isTask || $isMethod && $command !== 'execute') {
358:             array_shift($argv);
359:         }
360: 
361:         $this->OptionParser = $this->getOptionParser();
362:         try {
363:             list($this->params, $this->args) = $this->OptionParser->parse($argv, $command);
364:         } catch (ConsoleException $e) {
365:             $this->out($this->OptionParser->help($command));
366:             return false;
367:         }
368: 
369:         if (!empty($this->params['quiet'])) {
370:             $this->_useLogger(false);
371:         }
372:         if (!empty($this->params['plugin'])) {
373:             CakePlugin::load($this->params['plugin']);
374:         }
375:         $this->command = $command;
376:         if (!empty($this->params['help'])) {
377:             return $this->_displayHelp($command);
378:         }
379: 
380:         if (($isTask || $isMethod || $isMain) && $command !== 'execute') {
381:             $this->startup();
382:         }
383: 
384:         if ($isTask) {
385:             $command = Inflector::camelize($command);
386:             return $this->{$command}->runCommand('execute', $argv);
387:         }
388:         if ($isMethod) {
389:             return $this->{$command}();
390:         }
391:         if ($isMain) {
392:             return $this->main();
393:         }
394:         $this->out($this->OptionParser->help($command));
395:         return false;
396:     }
397: 
398: /**
399:  * Display the help in the correct format
400:  *
401:  * @param string $command
402:  * @return void
403:  */
404:     protected function _displayHelp($command) {
405:         $format = 'text';
406:         if (!empty($this->args[0]) && $this->args[0] === 'xml') {
407:             $format = 'xml';
408:             $this->stdout->outputAs(ConsoleOutput::RAW);
409:         } else {
410:             $this->_welcome();
411:         }
412:         return $this->out($this->OptionParser->help($command, $format));
413:     }
414: 
415: /**
416:  * Gets the option parser instance and configures it.
417:  * By overriding this method you can configure the ConsoleOptionParser before returning it.
418:  *
419:  * @return ConsoleOptionParser
420:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::getOptionParser
421:  */
422:     public function getOptionParser() {
423:         $name = ($this->plugin ? $this->plugin . '.' : '') . $this->name;
424:         $parser = new ConsoleOptionParser($name);
425:         return $parser;
426:     }
427: 
428: /**
429:  * Overload get for lazy building of tasks
430:  *
431:  * @param string $name
432:  * @return Shell Object of Task
433:  */
434:     public function __get($name) {
435:         if (empty($this->{$name}) && in_array($name, $this->taskNames)) {
436:             $properties = $this->_taskMap[$name];
437:             $this->{$name} = $this->Tasks->load($properties['class'], $properties['settings']);
438:             $this->{$name}->args =& $this->args;
439:             $this->{$name}->params =& $this->params;
440:             $this->{$name}->initialize();
441:             $this->{$name}->loadTasks();
442:         }
443:         return $this->{$name};
444:     }
445: 
446: /**
447:  * Prompts the user for input, and returns it.
448:  *
449:  * @param string $prompt Prompt text.
450:  * @param string|array $options Array or string of options.
451:  * @param string $default Default input value.
452:  * @return mixed Either the default value, or the user-provided input.
453:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::in
454:  */
455:     public function in($prompt, $options = null, $default = null) {
456:         if (!$this->interactive) {
457:             return $default;
458:         }
459:         $originalOptions = $options;
460:         $in = $this->_getInput($prompt, $originalOptions, $default);
461: 
462:         if ($options && is_string($options)) {
463:             if (strpos($options, ',')) {
464:                 $options = explode(',', $options);
465:             } elseif (strpos($options, '/')) {
466:                 $options = explode('/', $options);
467:             } else {
468:                 $options = array($options);
469:             }
470:         }
471:         if (is_array($options)) {
472:             $options = array_merge(
473:                 array_map('strtolower', $options),
474:                 array_map('strtoupper', $options),
475:                 $options
476:             );
477:             while ($in === '' || !in_array($in, $options)) {
478:                 $in = $this->_getInput($prompt, $originalOptions, $default);
479:             }
480:         }
481:         return $in;
482:     }
483: 
484: /**
485:  * Prompts the user for input, and returns it.
486:  *
487:  * @param string $prompt Prompt text.
488:  * @param string|array $options Array or string of options.
489:  * @param string $default Default input value.
490:  * @return Either the default value, or the user-provided input.
491:  */
492:     protected function _getInput($prompt, $options, $default) {
493:         if (!is_array($options)) {
494:             $printOptions = '';
495:         } else {
496:             $printOptions = '(' . implode('/', $options) . ')';
497:         }
498: 
499:         if ($default === null) {
500:             $this->stdout->write('<question>' . $prompt . '</question>' . " $printOptions \n" . '> ', 0);
501:         } else {
502:             $this->stdout->write('<question>' . $prompt . '</question>' . " $printOptions \n" . "[$default] > ", 0);
503:         }
504:         $result = $this->stdin->read();
505: 
506:         if ($result === false) {
507:             return $this->_stop(1);
508:         }
509:         $result = trim($result);
510: 
511:         if ($default !== null && ($result === '' || $result === null)) {
512:             return $default;
513:         }
514:         return $result;
515:     }
516: 
517: /**
518:  * Wrap a block of text.
519:  * Allows you to set the width, and indenting on a block of text.
520:  *
521:  * ### Options
522:  *
523:  * - `width` The width to wrap to. Defaults to 72
524:  * - `wordWrap` Only wrap on words breaks (spaces) Defaults to true.
525:  * - `indent` Indent the text with the string provided. Defaults to null.
526:  *
527:  * @param string $text Text the text to format.
528:  * @param string|integer|array $options Array of options to use, or an integer to wrap the text to.
529:  * @return string Wrapped / indented text
530:  * @see String::wrap()
531:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::wrapText
532:  */
533:     public function wrapText($text, $options = array()) {
534:         return String::wrap($text, $options);
535:     }
536: 
537: /**
538:  * Outputs a single or multiple messages to stdout. If no parameters
539:  * are passed outputs just a newline.
540:  *
541:  * ### Output levels
542:  *
543:  * There are 3 built-in output level. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE.
544:  * The verbose and quiet output levels, map to the `verbose` and `quiet` output switches
545:  * present in most shells. Using Shell::QUIET for a message means it will always display.
546:  * While using Shell::VERBOSE means it will only display when verbose output is toggled.
547:  *
548:  * @param string|array $message A string or a an array of strings to output
549:  * @param integer $newlines Number of newlines to append
550:  * @param integer $level The message's output level, see above.
551:  * @return integer|boolean Returns the number of bytes returned from writing to stdout.
552:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::out
553:  */
554:     public function out($message = null, $newlines = 1, $level = Shell::NORMAL) {
555:         $currentLevel = Shell::NORMAL;
556:         if (!empty($this->params['verbose'])) {
557:             $currentLevel = Shell::VERBOSE;
558:         }
559:         if (!empty($this->params['quiet'])) {
560:             $currentLevel = Shell::QUIET;
561:         }
562:         if ($level <= $currentLevel) {
563:             return $this->stdout->write($message, $newlines);
564:         }
565:         return true;
566:     }
567: 
568: /**
569:  * Outputs a single or multiple error messages to stderr. If no parameters
570:  * are passed outputs just a newline.
571:  *
572:  * @param string|array $message A string or a an array of strings to output
573:  * @param integer $newlines Number of newlines to append
574:  * @return void
575:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::err
576:  */
577:     public function err($message = null, $newlines = 1) {
578:         $this->stderr->write($message, $newlines);
579:     }
580: 
581: /**
582:  * Returns a single or multiple linefeeds sequences.
583:  *
584:  * @param integer $multiplier Number of times the linefeed sequence should be repeated
585:  * @return string
586:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::nl
587:  */
588:     public function nl($multiplier = 1) {
589:         return str_repeat(ConsoleOutput::LF, $multiplier);
590:     }
591: 
592: /**
593:  * Outputs a series of minus characters to the standard output, acts as a visual separator.
594:  *
595:  * @param integer $newlines Number of newlines to pre- and append
596:  * @param integer $width Width of the line, defaults to 63
597:  * @return void
598:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::hr
599:  */
600:     public function hr($newlines = 0, $width = 63) {
601:         $this->out(null, $newlines);
602:         $this->out(str_repeat('-', $width));
603:         $this->out(null, $newlines);
604:     }
605: 
606: /**
607:  * Displays a formatted error message
608:  * and exits the application with status code 1
609:  *
610:  * @param string $title Title of the error
611:  * @param string $message An optional error message
612:  * @return void
613:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::error
614:  */
615:     public function error($title, $message = null) {
616:         $this->err(__d('cake_console', '<error>Error:</error> %s', $title));
617: 
618:         if (!empty($message)) {
619:             $this->err($message);
620:         }
621:         return $this->_stop(1);
622:     }
623: 
624: /**
625:  * Clear the console
626:  *
627:  * @return void
628:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::clear
629:  */
630:     public function clear() {
631:         if (empty($this->params['noclear'])) {
632:             if (DS === '/') {
633:                 passthru('clear');
634:             } else {
635:                 passthru('cls');
636:             }
637:         }
638:     }
639: 
640: /**
641:  * Creates a file at given path
642:  *
643:  * @param string $path Where to put the file.
644:  * @param string $contents Content to put in the file.
645:  * @return boolean Success
646:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::createFile
647:  */
648:     public function createFile($path, $contents) {
649:         $path = str_replace(DS . DS, DS, $path);
650: 
651:         $this->out();
652: 
653:         if (is_file($path) && $this->interactive === true) {
654:             $this->out(__d('cake_console', '<warning>File `%s` exists</warning>', $path));
655:             $key = $this->in(__d('cake_console', 'Do you want to overwrite?'), array('y', 'n', 'q'), 'n');
656: 
657:             if (strtolower($key) === 'q') {
658:                 $this->out(__d('cake_console', '<error>Quitting</error>.'), 2);
659:                 return $this->_stop();
660:             } elseif (strtolower($key) !== 'y') {
661:                 $this->out(__d('cake_console', 'Skip `%s`', $path), 2);
662:                 return false;
663:             }
664:         } else {
665:             $this->out(__d('cake_console', 'Creating file %s', $path));
666:         }
667: 
668:         $File = new File($path, true);
669:         if ($File->exists() && $File->writable()) {
670:             $data = $File->prepare($contents);
671:             $File->write($data);
672:             $this->out(__d('cake_console', '<success>Wrote</success> `%s`', $path));
673:             return true;
674:         }
675: 
676:         $this->err(__d('cake_console', '<error>Could not write to `%s`</error>.', $path), 2);
677:         return false;
678:     }
679: 
680: /**
681:  * Action to create a Unit Test
682:  *
683:  * @return boolean Success
684:  */
685:     protected function _checkUnitTest() {
686:         if (class_exists('PHPUnit_Framework_TestCase')) {
687:             return true;
688:             //@codingStandardsIgnoreStart
689:         } elseif (@include 'PHPUnit' . DS . 'Autoload.php') {
690:             //@codingStandardsIgnoreEnd
691:             return true;
692:         } elseif (App::import('Vendor', 'phpunit', array('file' => 'PHPUnit' . DS . 'Autoload.php'))) {
693:             return true;
694:         }
695: 
696:         $prompt = __d('cake_console', 'PHPUnit is not installed. Do you want to bake unit test files anyway?');
697:         $unitTest = $this->in($prompt, array('y', 'n'), 'y');
698:         $result = strtolower($unitTest) === 'y' || strtolower($unitTest) === 'yes';
699: 
700:         if ($result) {
701:             $this->out();
702:             $this->out(__d('cake_console', 'You can download PHPUnit from %s', 'http://phpunit.de'));
703:         }
704:         return $result;
705:     }
706: 
707: /**
708:  * Makes absolute file path easier to read
709:  *
710:  * @param string $file Absolute file path
711:  * @return string short path
712:  * @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::shortPath
713:  */
714:     public function shortPath($file) {
715:         $shortPath = str_replace(ROOT, null, $file);
716:         $shortPath = str_replace('..' . DS, '', $shortPath);
717:         return str_replace(DS . DS, DS, $shortPath);
718:     }
719: 
720: /**
721:  * Creates the proper controller path for the specified controller class name
722:  *
723:  * @param string $name Controller class name
724:  * @return string Path to controller
725:  */
726:     protected function _controllerPath($name) {
727:         return Inflector::underscore($name);
728:     }
729: 
730: /**
731:  * Creates the proper controller plural name for the specified controller class name
732:  *
733:  * @param string $name Controller class name
734:  * @return string Controller plural name
735:  */
736:     protected function _controllerName($name) {
737:         return Inflector::pluralize(Inflector::camelize($name));
738:     }
739: 
740: /**
741:  * Creates the proper model camelized name (singularized) for the specified name
742:  *
743:  * @param string $name Name
744:  * @return string Camelized and singularized model name
745:  */
746:     protected function _modelName($name) {
747:         return Inflector::camelize(Inflector::singularize($name));
748:     }
749: 
750: /**
751:  * Creates the proper underscored model key for associations
752:  *
753:  * @param string $name Model class name
754:  * @return string Singular model key
755:  */
756:     protected function _modelKey($name) {
757:         return Inflector::underscore($name) . '_id';
758:     }
759: 
760: /**
761:  * Creates the proper model name from a foreign key
762:  *
763:  * @param string $key Foreign key
764:  * @return string Model name
765:  */
766:     protected function _modelNameFromKey($key) {
767:         return Inflector::camelize(str_replace('_id', '', $key));
768:     }
769: 
770: /**
771:  * creates the singular name for use in views.
772:  *
773:  * @param string $name
774:  * @return string $name
775:  */
776:     protected function _singularName($name) {
777:         return Inflector::variable(Inflector::singularize($name));
778:     }
779: 
780: /**
781:  * Creates the plural name for views
782:  *
783:  * @param string $name Name to use
784:  * @return string Plural name for views
785:  */
786:     protected function _pluralName($name) {
787:         return Inflector::variable(Inflector::pluralize($name));
788:     }
789: 
790: /**
791:  * Creates the singular human name used in views
792:  *
793:  * @param string $name Controller name
794:  * @return string Singular human name
795:  */
796:     protected function _singularHumanName($name) {
797:         return Inflector::humanize(Inflector::underscore(Inflector::singularize($name)));
798:     }
799: 
800: /**
801:  * Creates the plural human name used in views
802:  *
803:  * @param string $name Controller name
804:  * @return string Plural human name
805:  */
806:     protected function _pluralHumanName($name) {
807:         return Inflector::humanize(Inflector::underscore($name));
808:     }
809: 
810: /**
811:  * Find the correct path for a plugin. Scans $pluginPaths for the plugin you want.
812:  *
813:  * @param string $pluginName Name of the plugin you want ie. DebugKit
814:  * @return string $path path to the correct plugin.
815:  */
816:     protected function _pluginPath($pluginName) {
817:         if (CakePlugin::loaded($pluginName)) {
818:             return CakePlugin::path($pluginName);
819:         }
820:         return current(App::path('plugins')) . $pluginName . DS;
821:     }
822: 
823: /**
824:  * Used to enable or disable logging stream output to stdout and stderr
825:  * If you don't wish to see in your stdout or stderr everything that is logged
826:  * through CakeLog, call this function with first param as false
827:  *
828:  * @param boolean $enable whether to enable CakeLog output or not
829:  * @return void
830:  */
831:     protected function _useLogger($enable = true) {
832:         if (!$enable) {
833:             CakeLog::drop('stdout');
834:             CakeLog::drop('stderr');
835:             return;
836:         }
837:         CakeLog::config('stdout', array(
838:             'engine' => 'ConsoleLog',
839:             'types' => array('notice', 'info'),
840:             'stream' => $this->stdout,
841:         ));
842:         CakeLog::config('stderr', array(
843:             'engine' => 'ConsoleLog',
844:             'types' => array('emergency', 'alert', 'critical', 'error', 'warning', 'debug'),
845:             'stream' => $this->stderr,
846:         ));
847:     }
848: }
849: