Permalink
Browse files

Updating doc blocks and @package strings for Console

classes.
  • Loading branch information...
1 parent f534ea0 commit 74e2cb150774a1ff8d2d858ed3a8b0974ac2a61f @markstory markstory committed Jul 26, 2011
Showing with 142 additions and 198 deletions.
  1. +2 −3 lib/Cake/Console/AppShell.php
  2. +1 −8 lib/Cake/Console/Command/AclShell.php
  3. +2 −5 lib/Cake/Console/Command/ApiShell.php
  4. +1 −3 lib/Cake/Console/Command/BakeShell.php
  5. +1 −1 lib/Cake/Console/Command/CommandListShell.php
  6. +3 −5 lib/Cake/Console/Command/ConsoleShell.php
  7. +1 −4 lib/Cake/Console/Command/I18nShell.php
  8. +1 −6 lib/Cake/Console/Command/SchemaShell.php
  9. +5 −1 lib/Cake/Console/Command/Task/BakeTask.php
  10. +1 −5 lib/Cake/Console/Command/Task/ControllerTask.php
  11. +1 −2 lib/Cake/Console/Command/Task/DbConfigTask.php
  12. +1 −22 lib/Cake/Console/Command/Task/ExtractTask.php
  13. +1 −5 lib/Cake/Console/Command/Task/FixtureTask.php
  14. +1 −8 lib/Cake/Console/Command/Task/ModelTask.php
  15. +1 −5 lib/Cake/Console/Command/Task/PluginTask.php
  16. +1 −3 lib/Cake/Console/Command/Task/ProjectTask.php
  17. +6 −5 lib/Cake/Console/Command/Task/TemplateTask.php
  18. +1 −7 lib/Cake/Console/Command/Task/TestTask.php
  19. +1 −10 lib/Cake/Console/Command/Task/ViewTask.php
  20. +7 −2 lib/Cake/Console/Command/TestsuiteShell.php
  21. +3 −8 lib/Cake/Console/Command/UpgradeShell.php
  22. +3 −3 lib/Cake/Console/ConsoleErrorHandler.php
  23. +1 −2 lib/Cake/Console/ConsoleInputArgument.php
  24. +1 −2 lib/Cake/Console/ConsoleInputOption.php
  25. +2 −3 lib/Cake/Console/ConsoleInputSubcommand.php
  26. +41 −39 lib/Cake/Console/ConsoleOptionParser.php
  27. +2 −3 lib/Cake/Console/ConsoleOutput.php
  28. +3 −3 lib/Cake/Console/HelpFormatter.php
  29. +31 −13 lib/Cake/Console/Shell.php
  30. +10 −11 lib/Cake/Console/ShellDispatcher.php
  31. +6 −1 lib/Cake/Console/TaskCollection.php
@@ -12,19 +12,18 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells
* @since CakePHP(tm) v 2.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
/**
* This is a placeholder class.
- * Create the same file in app/console/shells/AppShell.php
+ * Create the same file in app/Console/Command/AppShell.php
*
* Add your application-wide methods in the class below, your shells
* will inherit them.
*
- * @package cake.console.libs
+ * @package Cake.Console
*/
class AppShell extends Shell {
@@ -12,7 +12,6 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells
* @since CakePHP(tm) v 1.2.0.5012
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
@@ -24,39 +23,35 @@
* Shell for ACL management. This console is known to have issues with zend.ze1_compatibility_mode
* being enabled. Be sure to turn it off when using this shell.
*
- * @package cake.console.libs
+ * @package Cake.Console.Command
*/
class AclShell extends Shell {
/**
* Contains instance of AclComponent
*
* @var AclComponent
- * @access public
*/
public $Acl;
/**
* Contains arguments parsed from the command line.
*
* @var array
- * @access public
*/
public $args;
/**
* Contains database source to use
*
* @var string
- * @access public
*/
public $connection = 'default';
/**
* Contains tasks to load and instantiate
*
* @var array
- * @access public
*/
public $tasks = array('DbConfig');
@@ -556,7 +551,6 @@ function _getNodeId($class, $identifier) {
* get params for standard Acl methods
*
* @return array aro, aco, action
- * @access private
*/
function __getParams() {
$aro = is_numeric($this->args[0]) ? intval($this->args[0]) : $this->args[0];
@@ -585,7 +579,6 @@ function __getParams() {
*
* @param string $type Node type (ARO/ACO)
* @return array Variables
- * @access private
*/
function __dataVars($type = null) {
if ($type == null) {
@@ -14,7 +14,6 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells
* @since CakePHP(tm) v 1.2.0.5012
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
@@ -23,15 +22,14 @@
/**
* API shell to show method signatures of CakePHP core classes.
*
- * @package cake.console.libs
+ * @package Cake.Console.Command
*/
class ApiShell extends Shell {
/**
* Map between short name for paths and real paths.
*
* @var array
- * @access public
*/
public $paths = array();
@@ -192,9 +190,8 @@ public function help() {
* @param object $File File object
* @param string $class Class name
* @return array Methods and signatures indexed by method name
- * @access private
*/
- function __parseClass($path, $class) {
+ private function __parseClass($path, $class) {
$parsed = array();
if (!class_exists($class)) {
@@ -16,7 +16,6 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells
* @since CakePHP(tm) v 1.2.0.5012
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
@@ -26,7 +25,7 @@
/**
* Bake is a command-line code generation utility for automating programmer chores.
*
- * @package cake.console.libs
+ * @package Cake.Console.Command
* @link http://book.cakephp.org/view/1522/Code-Generation-with-Bake
*/
class BakeShell extends Shell {
@@ -35,7 +34,6 @@ class BakeShell extends Shell {
* Contains tasks to load and instantiate
*
* @var array
- * @access public
*/
public $tasks = array('Project', 'DbConfig', 'Model', 'Controller', 'View', 'Plugin', 'Fixture', 'Test');
@@ -21,7 +21,7 @@
/**
* Shows a list of commands available from the console.
*
- * @package cake.console.shells
+ * @package Cake.Console.Command
*/
class CommandListShell extends Shell {
@@ -12,37 +12,35 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells
* @since CakePHP(tm) v 1.2.0.5012
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
/**
- * @package cake.console.shells
+ * Provides a very basic 'interactive' console for CakePHP apps.
+ *
+ * @package Cake.Console.Command
*/
class ConsoleShell extends Shell {
/**
* Available binding types
*
* @var array
- * @access public
*/
public $associations = array('hasOne', 'hasMany', 'belongsTo', 'hasAndBelongsToMany');
/**
* Chars that describe invalid commands
*
* @var array
- * @access public
*/
public $badCommandChars = array('$', ';');
/**
* Available models
*
* @var array
- * @access public
*/
public $models = array();
@@ -12,31 +12,28 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells
* @since CakePHP(tm) v 1.2.0.5669
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
/**
* Shell for I18N management.
*
- * @package cake.console.shells
+ * @package Cake.Console.Command
*/
class I18nShell extends Shell {
/**
* Contains database source to use
*
* @var string
- * @access public
*/
public $dataSource = 'default';
/**
* Contains tasks to load and instantiate
*
* @var array
- * @access public
*/
public $tasks = array('DbConfig', 'Extract');
@@ -15,7 +15,6 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells
* @since CakePHP(tm) v 1.2.0.5550
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
@@ -26,7 +25,7 @@
/**
* Schema is a command-line database management utility for automating programmer chores.
*
- * @package cake.console.shells
+ * @package Cake.Console.Command
* @link http://book.cakephp.org/view/1523/Schema-management-and-migrations
*/
class SchemaShell extends Shell {
@@ -35,7 +34,6 @@ class SchemaShell extends Shell {
* is this a dry run?
*
* @var boolean
- * @access private
*/
private $__dry = null;
@@ -302,7 +300,6 @@ function _loadSchema() {
* Create database from Schema object
* Should be called via the run method
*
- * @access private
*/
function __create($Schema, $table = null) {
$db = ConnectionManager::getDataSource($this->Schema->connection);
@@ -345,7 +342,6 @@ function __create($Schema, $table = null) {
* Update database with Schema object
* Should be called via the run method
*
- * @access private
*/
function __update(&$Schema, $table = null) {
$db = ConnectionManager::getDataSource($this->Schema->connection);
@@ -387,7 +383,6 @@ function __update(&$Schema, $table = null) {
/**
* Runs sql from __create() or __update()
*
- * @access private
*/
function __run($contents, $event, &$Schema) {
if (empty($contents)) {
@@ -12,10 +12,14 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells.tasks
* @since CakePHP(tm) v 1.3
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
+/**
+ * Base class for Bake Tasks.
+ *
+ * @package Cake.Console.Command.Task
+ */
class BakeTask extends Shell {
/**
@@ -12,7 +12,6 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells.tasks
* @since CakePHP(tm) v 1.2
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
@@ -23,23 +22,21 @@
/**
* Task class for creating and updating controller files.
*
- * @package cake.console.shells.tasks
+ * @package Cake.Console.Command.Task
*/
class ControllerTask extends BakeTask {
/**
* Tasks to be loaded by this Task
*
* @var array
- * @access public
*/
public $tasks = array('Model', 'Test', 'Template', 'DbConfig', 'Project');
/**
* path to Controller directory
*
* @var array
- * @access public
*/
public $path = null;
@@ -265,7 +262,6 @@ protected function _askAboutMethods() {
* @param string $admin Admin route to use
* @param boolean $wannaUseSession Set to true to use sessions, false otherwise
* @return string Baked actions
- * @access private
*/
public function bakeActions($controllerName, $admin = null, $wannaUseSession = true) {
$currentModelName = $modelImport = $this->_modelName($controllerName);
@@ -12,15 +12,14 @@
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
- * @package cake.console.shells.tasks
* @since CakePHP(tm) v 1.2
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
/**
* Task class for creating and updating the database configuration file.
*
- * @package cake.console.shells.tasks
+ * @package Cake.Console.Command.Task
*/
class DbConfigTask extends Shell {
Oops, something went wrong.

0 comments on commit 74e2cb1

Please sign in to comment.