diff --git a/lib/Cake/Cache/Cache.php b/lib/Cake/Cache/Cache.php index e121e2a7056..0278de176cd 100644 --- a/lib/Cake/Cache/Cache.php +++ b/lib/Cake/Cache/Cache.php @@ -19,10 +19,10 @@ /** * Cache provides a consistent interface to Caching in your application. It allows you * to use several different Cache engines, without coupling your application to a specific - * implementation. It also allows you to change out cache storage or configuration without effecting + * implementation. It also allows you to change out cache storage or configuration without effecting * the rest of your application. * - * You can configure Cache engines in your application's `bootstrap.php` file. A sample configuration would + * You can configure Cache engines in your application's `bootstrap.php` file. A sample configuration would * be * * {{{ @@ -32,9 +32,9 @@ * )); * }}} * - * This would configure an APC cache engine to the 'shared' alias. You could then read and write - * to that cache alias by using it for the `$config` parameter in the various Cache methods. In - * general all Cache operations are supported by all cache engines. However, Cache::increment() and + * This would configure an APC cache engine to the 'shared' alias. You could then read and write + * to that cache alias by using it for the `$config` parameter in the various Cache methods. In + * general all Cache operations are supported by all cache engines. However, Cache::increment() and * Cache::decrement() are not supported by File caching. * * @package Cake.Cache @@ -65,7 +65,7 @@ class Cache { protected static $_engines = array(); /** - * Set the cache configuration to use. config() can + * Set the cache configuration to use. config() can * both create new configurations, return the settings for already configured * configurations. * @@ -95,15 +95,15 @@ class Cache { * handy for deleting a complete group from cache. * - `prefix` Prefix appended to all entries. Good for when you need to share a keyspace * with either another cache config or another application. - * - `probability` Probability of hitting a cache gc cleanup. Setting to 0 will disable + * - `probability` Probability of hitting a cache gc cleanup. Setting to 0 will disable * cache::gc from ever being called automatically. * - `servers' Used by memcache. Give the address of the memcached servers to use. - * - `compress` Used by memcache. Enables memcache's compressed format. - * - `serialize` Used by FileCache. Should cache objects be serialized first. - * - `path` Used by FileCache. Path to where cachefiles should be saved. - * - `lock` Used by FileCache. Should files be locked before writing to them? - * - `user` Used by Xcache. Username for XCache - * - `password` Used by Xcache/Redis. Password for XCache/Redis + * - `compress` Used by memcache. Enables memcache's compressed format. + * - `serialize` Used by FileCache. Should cache objects be serialized first. + * - `path` Used by FileCache. Path to where cachefiles should be saved. + * - `lock` Used by FileCache. Should files be locked before writing to them? + * - `user` Used by Xcache. Username for XCache + * - `password` Used by Xcache/Redis. Password for XCache/Redis * * @see app/Config/core.php for configuration settings * @param string $name Name of the configuration @@ -180,7 +180,7 @@ public static function configured() { } /** - * Drops a cache engine. Deletes the cache configuration information + * Drops a cache engine. Deletes the cache configuration information * If the deleted configuration is the last configuration using an certain engine, * the Engine instance is also unset. * @@ -196,7 +196,7 @@ public static function drop($name) { } /** - * Temporarily change the settings on a cache config. The settings will persist for the next write + * Temporarily change the settings on a cache config. The settings will persist for the next write * operation (write, decrement, increment, clear). Any reads that are done before the write, will * use the modified settings. If `$settings` is empty, the settings will be reset to the * original configuration. @@ -262,7 +262,7 @@ public static function gc($config = 'default', $expires = null) { /** * Write data for key into cache. Will automatically use the currently - * active cache configuration. To set the currently active configuration use + * active cache configuration. To set the currently active configuration use * Cache::config() * * ### Usage: @@ -312,8 +312,8 @@ public static function write($key, $value, $config = 'default') { } /** - * Read a key from the cache. Will automatically use the currently - * active cache configuration. To set the currently active configuration use + * Read a key from the cache. Will automatically use the currently + * active cache configuration. To set the currently active configuration use * Cache::config() * * ### Usage: diff --git a/lib/Cake/Cache/Engine/ApcEngine.php b/lib/Cake/Cache/Engine/ApcEngine.php index 58b035af27e..3fbe11e90c6 100644 --- a/lib/Cake/Cache/Engine/ApcEngine.php +++ b/lib/Cake/Cache/Engine/ApcEngine.php @@ -117,10 +117,10 @@ public function delete($key) { } /** - * Delete all keys from the cache. This will clear every cache config using APC. + * Delete all keys from the cache. This will clear every cache config using APC. * * @param boolean $check If true, nothing will be cleared, as entries are removed - * from APC as they expired. This flag is really only used by FileEngine. + * from APC as they expired. This flag is really only used by FileEngine. * @return boolean True Returns true. */ public function clear($check) { diff --git a/lib/Cake/Cache/Engine/FileEngine.php b/lib/Cake/Cache/Engine/FileEngine.php index da68c398cf8..9c9a2cd5c1e 100644 --- a/lib/Cake/Cache/Engine/FileEngine.php +++ b/lib/Cake/Cache/Engine/FileEngine.php @@ -1,7 +1,7 @@ array('password' => 'secret'))` diff --git a/lib/Cake/Configure/PhpReader.php b/lib/Cake/Configure/PhpReader.php index be2099749f6..4372baadb8e 100644 --- a/lib/Cake/Configure/PhpReader.php +++ b/lib/Cake/Configure/PhpReader.php @@ -37,7 +37,7 @@ class PhpReader implements ConfigReaderInterface { /** * Constructor for PHP Config file reading. * - * @param string $path The path to read config files from. Defaults to APP . 'Config' . DS + * @param string $path The path to read config files from. Defaults to APP . 'Config' . DS */ public function __construct($path = null) { if (!$path) { @@ -49,7 +49,7 @@ public function __construct($path = null) { /** * Read a config file and return its contents. * - * Files with `.` in the name will be treated as values in plugins. Instead of reading from + * Files with `.` in the name will be treated as values in plugins. Instead of reading from * the initialized path, plugin keys will be located using App::pluginPath(). * * @param string $key The identifier to read from. If the key has a . it will be treated diff --git a/lib/Cake/Console/Command/AclShell.php b/lib/Cake/Console/Command/AclShell.php index fa04118f13f..9c28015619c 100644 --- a/lib/Cake/Console/Command/AclShell.php +++ b/lib/Cake/Console/Command/AclShell.php @@ -24,8 +24,8 @@ App::uses('Hash', 'Utility'); /** - * 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. + * 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.Command */ @@ -501,7 +501,7 @@ public function getOptionParser() { ' - . - The node will be bound to a specific record of the given model.', '', ' - - The node will be given a string alias (or path, in the case of )', - " i.e. 'John'. When used with , this takes the form of an alias path,", + " i.e. 'John'. When used with , this takes the form of an alias path,", " i.e. //.", '', "To add a node at the root level, enter 'root' or '/' as the parameter." diff --git a/lib/Cake/Console/Command/ConsoleShell.php b/lib/Cake/Console/Command/ConsoleShell.php index 6ae1c29d189..65d9fb19096 100644 --- a/lib/Cake/Console/Command/ConsoleShell.php +++ b/lib/Cake/Console/Command/ConsoleShell.php @@ -120,7 +120,7 @@ public function getOptionParser() { "\tRoute ", "", "where url is the path to your your action plus any query parameters,", - "minus the application's base path. For example:", + "minus the application's base path. For example:", "", "\tRoute /posts/view/1", "", diff --git a/lib/Cake/Console/Command/SchemaShell.php b/lib/Cake/Console/Command/SchemaShell.php index 9baa1626d04..46cd761e35e 100644 --- a/lib/Cake/Console/Command/SchemaShell.php +++ b/lib/Cake/Console/Command/SchemaShell.php @@ -237,7 +237,7 @@ public function dump() { } /** - * Run database create commands. Alias for run create. + * Run database create commands. Alias for run create. * * @return void */ @@ -247,7 +247,7 @@ public function create() { } /** - * Run database create commands. Alias for run create. + * Run database create commands. Alias for run create. * * @return void */ diff --git a/lib/Cake/Console/Command/Task/BakeTask.php b/lib/Cake/Console/Command/Task/BakeTask.php index e32e2539e38..4b8180a3475 100644 --- a/lib/Cake/Console/Command/Task/BakeTask.php +++ b/lib/Cake/Console/Command/Task/BakeTask.php @@ -59,7 +59,7 @@ public function startup() { } /** - * Gets the path for output. Checks the plugin property + * Gets the path for output. Checks the plugin property * and returns the correct path. * * @return string Path to output. diff --git a/lib/Cake/Console/Command/Task/ControllerTask.php b/lib/Cake/Console/Command/Task/ControllerTask.php index 457d74950b7..58fedfa055d 100644 --- a/lib/Cake/Console/Command/Task/ControllerTask.php +++ b/lib/Cake/Console/Command/Task/ControllerTask.php @@ -96,7 +96,7 @@ public function execute() { } /** - * Bake All the controllers at once. Will only bake controllers for models that exist. + * Bake All the controllers at once. Will only bake controllers for models that exist. * * @return void */ diff --git a/lib/Cake/Console/Command/Task/FixtureTask.php b/lib/Cake/Console/Command/Task/FixtureTask.php index 5804650a69b..87e6e9128ae 100644 --- a/lib/Cake/Console/Command/Task/FixtureTask.php +++ b/lib/Cake/Console/Command/Task/FixtureTask.php @@ -115,7 +115,7 @@ public function execute() { } /** - * Bake All the Fixtures at once. Will only bake fixtures for models that exist. + * Bake All the Fixtures at once. Will only bake fixtures for models that exist. * * @return void */ diff --git a/lib/Cake/Console/Command/Task/TemplateTask.php b/lib/Cake/Console/Command/Task/TemplateTask.php index 2ba14caec05..0338d260f32 100644 --- a/lib/Cake/Console/Command/Task/TemplateTask.php +++ b/lib/Cake/Console/Command/Task/TemplateTask.php @@ -43,7 +43,7 @@ class TemplateTask extends AppShell { public $templatePaths = array(); /** - * Initialize callback. Setup paths for the template task. + * Initialize callback. Setup paths for the template task. * * @return void */ diff --git a/lib/Cake/Console/Command/Task/ViewTask.php b/lib/Cake/Console/Command/Task/ViewTask.php index b50c99a6acb..9518fb5c516 100644 --- a/lib/Cake/Console/Command/Task/ViewTask.php +++ b/lib/Cake/Console/Command/Task/ViewTask.php @@ -63,7 +63,7 @@ class ViewTask extends BakeTask { public $scaffoldActions = array('index', 'view', 'add', 'edit'); /** - * An array of action names that don't require templates. These + * An array of action names that don't require templates. These * actions will not emit errors when doing bakeActions() * * @var array @@ -423,7 +423,7 @@ public function getOptionParser() { return $parser->description( __d('cake_console', 'Bake views for a controller, using built-in or custom templates.') )->addArgument('controller', array( - 'help' => __d('cake_console', 'Name of the controller views to bake. Can be Plugin.name as a shortcut for plugin baking.') + 'help' => __d('cake_console', 'Name of the controller views to bake. Can be Plugin.name as a shortcut for plugin baking.') ))->addArgument('action', array( 'help' => __d('cake_console', "Will bake a single action's file. core templates are (index, add, edit, view)") ))->addArgument('alias', array( diff --git a/lib/Cake/Console/ConsoleInputOption.php b/lib/Cake/Console/ConsoleInputOption.php index a6841fa163c..863ed125b77 100644 --- a/lib/Cake/Console/ConsoleInputOption.php +++ b/lib/Cake/Console/ConsoleInputOption.php @@ -47,7 +47,7 @@ class ConsoleInputOption { protected $_help; /** - * Is the option a boolean option. Boolean options do not consume a parameter. + * Is the option a boolean option. Boolean options do not consume a parameter. * * @var boolean */ @@ -73,7 +73,7 @@ class ConsoleInputOption { * @param string|array $name The long name of the option, or an array with all the properties. * @param string $short The short alias for this option * @param string $help The help text for this option - * @param boolean $boolean Whether this option is a boolean option. Boolean options don't consume extra tokens + * @param boolean $boolean Whether this option is a boolean option. Boolean options don't consume extra tokens * @param string $default The default value for this option. * @param array $choices Valid choices for this option. * @throws ConsoleException diff --git a/lib/Cake/Console/ConsoleOptionParser.php b/lib/Cake/Console/ConsoleOptionParser.php index 97726f0beaf..e37974a912b 100644 --- a/lib/Cake/Console/ConsoleOptionParser.php +++ b/lib/Cake/Console/ConsoleOptionParser.php @@ -27,22 +27,22 @@ /** * Handles parsing the ARGV in the command line and provides support - * for GetOpt compatible option definition. Provides a builder pattern implementation + * for GetOpt compatible option definition. Provides a builder pattern implementation * for creating shell option parsers. * * ### Options * * Named arguments come in two forms, long and short. Long arguments are preceded * by two - and give a more verbose option name. i.e. `--version`. Short arguments are - * preceded by one - and are only one character long. They usually match with a long option, + * preceded by one - and are only one character long. They usually match with a long option, * and provide a more terse alternative. * * ### Using Options * - * Options can be defined with both long and short forms. By using `$parser->addOption()` - * you can define new options. The name of the option is used as its long form, and you + * Options can be defined with both long and short forms. By using `$parser->addOption()` + * you can define new options. The name of the option is used as its long form, and you * can supply an additional short form, with the `short` option. Short options should - * only be one letter long. Using more than one letter for a short option will raise an exception. + * only be one letter long. Using more than one letter for a short option will raise an exception. * * Calling options can be done using syntax similar to most *nix command line tools. Long options * cane either include an `=` or leave it out. @@ -53,8 +53,8 @@ * * `cake myshell command -cn` * - * Short options can be combined into groups as seen above. Each letter in a group - * will be treated as a separate option. The previous example is equivalent to: + * Short options can be combined into groups as seen above. Each letter in a group + * will be treated as a separate option. The previous example is equivalent to: * * `cake myshell command -c -n` * @@ -64,8 +64,8 @@ * * ### Positional arguments * - * If no positional arguments are defined, all of them will be parsed. If you define positional - * arguments any arguments greater than those defined will cause exceptions. Additionally you can + * If no positional arguments are defined, all of them will be parsed. If you define positional + * arguments any arguments greater than those defined will cause exceptions. Additionally you can * declare arguments as optional, by setting the required param to false. * * `$parser->addArgument('model', array('required' => false));` @@ -73,7 +73,7 @@ * ### Providing Help text * * By providing help text for your positional arguments and named arguments, the ConsoleOptionParser - * can generate a help display for you. You can view the help for shells by using the `--help` or `-h` switch. + * can generate a help display for you. You can view the help for shells by using the `--help` or `-h` switch. * * @package Cake.Console */ @@ -136,7 +136,7 @@ class ConsoleOptionParser { /** * Construct an OptionParser so you can define its behavior * - * @param string $command The command name this parser is for. The command name is used for generating help. + * @param string $command The command name this parser is for. The command name is used for generating help. * @param boolean $defaultOptions Whether you want the verbose and quiet options set. Setting * this to false will prevent the addition of `--verbose` & `--quiet` options. */ @@ -165,7 +165,7 @@ public function __construct($command = null, $defaultOptions = true) { /** * Static factory method for creating new OptionParsers so you can chain methods off of them. * - * @param string $command The command name this parser is for. The command name is used for generating help. + * @param string $command The command name this parser is for. The command name is used for generating help. * @param boolean $defaultOptions Whether you want the verbose and quiet options set. * @return ConsoleOptionParser */ @@ -248,7 +248,7 @@ public function description($text = null) { } /** - * Get or set an epilog to the parser. The epilog is added to the end of + * Get or set an epilog to the parser. The epilog is added to the end of * the options and arguments listing when help is generated. * * @param string|array $text Text when setting or null when reading. If an array the text will be imploded with "\n" @@ -272,14 +272,14 @@ public function epilog($text = null) { * ### Options * * - `short` - The single letter variant for this option, leave undefined for none. - * - `help` - Help text for this option. Used when generating help for the option. + * - `help` - Help text for this option. Used when generating help for the option. * - `default` - The default value for this option. Defaults are added into the parsed params when the - * attached option is not provided or has no value. Using default and boolean together will not work. + * attached option is not provided or has no value. Using default and boolean together will not work. * are added into the parsed parameters when the option is undefined. Defaults to null. * - `boolean` - The option uses no value, its just a boolean switch. Defaults to false. - * If an option is defined as boolean, it will always be added to the parsed params. If no present + * If an option is defined as boolean, it will always be added to the parsed params. If no present * it will be false, if present it will be true. - * - `choices` A list of valid choices for this option. If left empty all values are valid.. + * - `choices` A list of valid choices for this option. If left empty all values are valid.. * An exception will be raised when parse() encounters an invalid value. * * @param ConsoleInputOption|string $name The long name you want to the value to be parsed out as when options are parsed. @@ -320,10 +320,10 @@ public function addOption($name, $options = array()) { * - `index` The index for the arg, if left undefined the argument will be put * onto the end of the arguments. If you define the same index twice the first * option will be overwritten. - * - `choices` A list of valid choices for this argument. If left empty all values are valid.. + * - `choices` A list of valid choices for this argument. If left empty all values are valid.. * An exception will be raised when parse() encounters an invalid value. * - * @param ConsoleInputArgument|string $name The name of the argument. Will also accept an instance of ConsoleInputArgument + * @param ConsoleInputArgument|string $name The name of the argument. Will also accept an instance of ConsoleInputArgument * @param array $params Parameters for the argument, see above. * @return ConsoleOptionParser $this. */ @@ -386,8 +386,8 @@ public function addOptions(array $options) { * ### Options * * - `help` - Help text for the subcommand. - * - `parser` - A ConsoleOptionParser for the subcommand. This allows you to create method - * specific option parsers. When help is generated for a subcommand, if a parser is present + * - `parser` - A ConsoleOptionParser for the subcommand. This allows you to create method + * specific option parsers. When help is generated for a subcommand, if a parser is present * it will be used. * * @param ConsoleInputSubcommand|string $name Name of the subcommand. Will also accept an instance of ConsoleInputSubcommand @@ -452,12 +452,12 @@ public function subcommands() { } /** - * Parse the argv array into a set of params and args. If $command is not null + * Parse the argv array into a set of params and args. If $command is not null * and $command is equal to a subcommand that has a parser, that parser will be used * to parse the $argv * * @param array $argv Array of args (argv) to parse. - * @param string $command The subcommand to use. If this parameter is a subcommand, that has a parser, + * @param string $command The subcommand to use. If this parameter is a subcommand, that has a parser, * That parser will be used to parse $argv instead. * @return Array array($params, $args) * @throws ConsoleException When an invalid parameter is encountered. @@ -528,7 +528,7 @@ public function help($subcommand = null, $format = 'text', $width = 72) { } /** - * Parse the value for a long option out of $this->_tokens. Will handle + * Parse the value for a long option out of $this->_tokens. Will handle * options with an `=` in them. * * @param string $option The option to parse. diff --git a/lib/Cake/Console/ConsoleOutput.php b/lib/Cake/Console/ConsoleOutput.php index a781e0b9ab7..09bb64d99a3 100644 --- a/lib/Cake/Console/ConsoleOutput.php +++ b/lib/Cake/Console/ConsoleOutput.php @@ -37,7 +37,7 @@ * `$this->out('Overwrite: foo.php was overwritten.');` * * This would create orange 'Overwrite:' text, while the rest of the text would remain the normal color. - * See ConsoleOutput::styles() to learn more about defining your own styles. Nested styles are not supported + * See ConsoleOutput::styles() to learn more about defining your own styles. Nested styles are not supported * at this time. * * @package Cake.Console @@ -270,9 +270,9 @@ public function styles($style = null, $definition = null) { } /** - * Get/Set the output type to use. The output type how formatting tags are treated. + * Get/Set the output type to use. The output type how formatting tags are treated. * - * @param integer $type The output type to use. Should be one of the class constants. + * @param integer $type The output type to use. Should be one of the class constants. * @return mixed Either null or the value if getting. */ public function outputAs($type = null) { diff --git a/lib/Cake/Console/HelpFormatter.php b/lib/Cake/Console/HelpFormatter.php index 6ac43717b4d..31b03fdee46 100644 --- a/lib/Cake/Console/HelpFormatter.php +++ b/lib/Cake/Console/HelpFormatter.php @@ -17,11 +17,11 @@ App::uses('String', 'Utility'); /** - * HelpFormatter formats help for console shells. Can format to either - * text or XML formats. Uses ConsoleOptionParser methods to generate help. + * HelpFormatter formats help for console shells. Can format to either + * text or XML formats. Uses ConsoleOptionParser methods to generate help. * * Generally not directly used. Using $parser->help($command, 'xml'); is usually - * how you would access help. Or via the `--help=xml` option on the command line. + * how you would access help. Or via the `--help=xml` option on the command line. * * Xml output is useful for integration with other tools like IDE's or other build tools. * @@ -173,7 +173,7 @@ protected function _getMaxLength($collection) { /** * Get the help as an xml string. * - * @param boolean $string Return the SimpleXml object or a string. Defaults to true. + * @param boolean $string Return the SimpleXml object or a string. Defaults to true. * @return string|SimpleXmlElement See $string */ public function xml($string = true) { diff --git a/lib/Cake/Console/Shell.php b/lib/Cake/Console/Shell.php index b3b48d9313e..111c2cbb758 100644 --- a/lib/Cake/Console/Shell.php +++ b/lib/Cake/Console/Shell.php @@ -521,7 +521,7 @@ protected function _getInput($prompt, $options, $default) { * * ### Options * - * - `width` The width to wrap to. Defaults to 72 + * - `width` The width to wrap to. Defaults to 72 * - `wordWrap` Only wrap on words breaks (spaces) Defaults to true. * - `indent` Indent the text with the string provided. Defaults to null. * @@ -541,9 +541,9 @@ public function wrapText($text, $options = array()) { * * ### Output levels * - * There are 3 built-in output level. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE. + * There are 3 built-in output level. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE. * The verbose and quiet output levels, map to the `verbose` and `quiet` output switches - * present in most shells. Using Shell::QUIET for a message means it will always display. + * present in most shells. Using Shell::QUIET for a message means it will always display. * While using Shell::VERBOSE means it will only display when verbose output is toggled. * * @param string|array $message A string or a an array of strings to output diff --git a/lib/Cake/Console/ShellDispatcher.php b/lib/Cake/Console/ShellDispatcher.php index 246f1fc978a..37473a977ec 100644 --- a/lib/Cake/Console/ShellDispatcher.php +++ b/lib/Cake/Console/ShellDispatcher.php @@ -337,7 +337,7 @@ public function shiftArgs() { } /** - * Shows console help. Performs an internal dispatch to the CommandList Shell + * Shows console help. Performs an internal dispatch to the CommandList Shell * * @return void */ diff --git a/lib/Cake/Console/TaskCollection.php b/lib/Cake/Console/TaskCollection.php index 95d5ed91b3b..aac5a725d1c 100644 --- a/lib/Cake/Console/TaskCollection.php +++ b/lib/Cake/Console/TaskCollection.php @@ -18,7 +18,7 @@ App::uses('ObjectCollection', 'Utility'); /** - * Collection object for Tasks. Provides features + * Collection object for Tasks. Provides features * for lazily loading tasks, and firing callbacks on loaded tasks. * * @package Cake.Console @@ -49,7 +49,7 @@ public function __construct(Shell $Shell) { } /** - * Loads/constructs a task. Will return the instance in the collection + * Loads/constructs a task. Will return the instance in the collection * if it already exists. * * @param string $task Task name to load diff --git a/lib/Cake/Console/Templates/default/views/view.ctp b/lib/Cake/Console/Templates/default/views/view.ctp index c3a7087a715..47a80a32b06 100644 --- a/lib/Cake/Console/Templates/default/views/view.ctp +++ b/lib/Cake/Console/Templates/default/views/view.ctp @@ -54,7 +54,7 @@ foreach ($fields as $field) { foreach ($data as $alias => $details) { if ($details['controller'] != $this->name && !in_array($details['controller'], $done)) { echo "\t\t
  • Html->link(__('List " . Inflector::humanize($details['controller']) . "'), array('controller' => '{$details['controller']}', 'action' => 'index')); ?>
    • \n"; - echo "\t\t
  • Html->link(__('New " . Inflector::humanize(Inflector::underscore($alias)) . "'), array('controller' => '{$details['controller']}', 'action' => 'add')); ?>
    • \n"; + echo "\t\t
  • Html->link(__('New " . Inflector::humanize(Inflector::underscore($alias)) . "'), array('controller' => '{$details['controller']}', 'action' => 'add')); ?>
    • \n"; $done[] = $details['controller']; } } diff --git a/lib/Cake/Console/Templates/skel/Config/core.php b/lib/Cake/Console/Templates/skel/Config/core.php index 5690872155e..c1a2a112d8d 100644 --- a/lib/Cake/Console/Templates/skel/Config/core.php +++ b/lib/Cake/Console/Templates/skel/Config/core.php @@ -35,8 +35,8 @@ Configure::write('debug', 2); /** - * Configure the Error handler used to handle errors for your application. By default - * ErrorHandler::handleError() is used. It will display errors using Debugger, when debug > 0 + * Configure the Error handler used to handle errors for your application. By default + * ErrorHandler::handleError() is used. It will display errors using Debugger, when debug > 0 * and log errors with CakeLog when debug = 0. * * Options: @@ -55,16 +55,16 @@ )); /** - * Configure the Exception handler used for uncaught exceptions. By default, + * Configure the Exception handler used for uncaught exceptions. By default, * ErrorHandler::handleException() is used. It will display a HTML page for the exception, and - * while debug > 0, framework errors like Missing Controller will be displayed. When debug = 0, + * while debug > 0, framework errors like Missing Controller will be displayed. When debug = 0, * framework errors will be coerced into generic HTTP errors. * * Options: * * - `handler` - callback - The callback to handle exceptions. You can set this to any callback type, * including anonymous functions. - * - `renderer` - string - The class responsible for rendering uncaught exceptions. If you choose a custom class you + * - `renderer` - string - The class responsible for rendering uncaught exceptions. If you choose a custom class you * should place the file for that class in app/Lib/Error. This class needs to implement a render method. * - `log` - boolean - Should Exceptions be logged? * @@ -161,8 +161,8 @@ * value to false, when dealing with older versions of IE, Chrome Frame or certain web-browsing devices and AJAX * - `Session.defaults` - The default configuration set to use as a basis for your session. * There are four builtins: php, cake, cache, database. - * - `Session.handler` - Can be used to enable a custom session handler. Expects an array of of callables, - * that can be used with `session_save_handler`. Using this option will automatically add `session.save_handler` + * - `Session.handler` - Can be used to enable a custom session handler. Expects an array of of callables, + * that can be used with `session_save_handler`. Using this option will automatically add `session.save_handler` * to the ini array. * - `Session.autoRegenerate` - Enabling this setting, turns on automatic renewal of sessions, and * sessionids that change frequently. See CakeSession::$requestCountdown. @@ -324,7 +324,7 @@ $prefix = 'myapp_'; /** - * Configure the cache used for general framework caching. Path information, + * Configure the cache used for general framework caching. Path information, * object listings, and translation cache files are stored with this configuration. */ Cache::config('_cake_core_', array( @@ -336,7 +336,7 @@ )); /** - * Configure the cache for model and datasource caches. This cache configuration + * Configure the cache for model and datasource caches. This cache configuration * is used to store schema descriptions, and table listings in connections. */ Cache::config('_cake_model_', array( diff --git a/lib/Cake/Console/Templates/skel/Config/database.php.default b/lib/Cake/Console/Templates/skel/Config/database.php.default index 245c28222da..25ea26368a5 100644 --- a/lib/Cake/Console/Templates/skel/Config/database.php.default +++ b/lib/Cake/Console/Templates/skel/Config/database.php.default @@ -34,7 +34,7 @@ * Database/Sqlserver - Microsoft SQL Server 2005 and higher * * You can add custom database datasources (or override existing datasources) by adding the - * appropriate file to app/Model/Datasource/Database. Datasources should be named 'MyDatasource.php', + * appropriate file to app/Model/Datasource/Database. Datasources should be named 'MyDatasource.php', * * * persistent => true / false @@ -44,11 +44,11 @@ * the host you connect to the database. To add a socket or port number, use 'port' => # * * prefix => - * Uses the given prefix for all the tables in this database. This setting can be overridden + * Uses the given prefix for all the tables in this database. This setting can be overridden * on a per-table basis with the Model::$tablePrefix property. * * schema => - * For Postgres/Sqlserver specifies which schema you would like to use the tables in. Postgres defaults to 'public'. For Sqlserver, it defaults to empty and use + * For Postgres/Sqlserver specifies which schema you would like to use the tables in. Postgres defaults to 'public'. For Sqlserver, it defaults to empty and use * the connected user's default schema (typically 'dbo'). * * encoding => diff --git a/lib/Cake/Console/Templates/skel/Config/email.php.default b/lib/Cake/Console/Templates/skel/Config/email.php.default index c423f782f29..76de9832045 100644 --- a/lib/Cake/Console/Templates/skel/Config/email.php.default +++ b/lib/Cake/Console/Templates/skel/Config/email.php.default @@ -33,7 +33,7 @@ * Debug - Do not send the email, just return the result * * You can add custom transports (or override existing transports) by adding the - * appropriate file to app/Network/Email. Transports should be named 'YourTransport.php', + * appropriate file to app/Network/Email. Transports should be named 'YourTransport.php', * where 'Your' is the name of the transport. * * from => diff --git a/lib/Cake/Console/Templates/skel/Config/routes.php b/lib/Cake/Console/Templates/skel/Config/routes.php index c68cc3e4a48..47df614ee45 100644 --- a/lib/Cake/Console/Templates/skel/Config/routes.php +++ b/lib/Cake/Console/Templates/skel/Config/routes.php @@ -32,7 +32,7 @@ Router::connect('/pages/*', array('controller' => 'pages', 'action' => 'display')); /** - * Load all plugin routes. See the CakePlugin documentation on + * Load all plugin routes. See the CakePlugin documentation on * how to customize the loading of plugin routes. */ CakePlugin::routes(); diff --git a/lib/Cake/Console/Templates/skel/webroot/index.php b/lib/Cake/Console/Templates/skel/webroot/index.php index 3b6e141ce89..38be5c4cd7f 100644 --- a/lib/Cake/Console/Templates/skel/webroot/index.php +++ b/lib/Cake/Console/Templates/skel/webroot/index.php @@ -53,7 +53,7 @@ * Un-comment this line to specify a fixed path to CakePHP. * This should point at the directory containing `Cake`. * - * For ease of development CakePHP uses PHP's include_path. If you + * For ease of development CakePHP uses PHP's include_path. If you * cannot modify your include_path set this value. * * Leaving this constant undefined will result in it being defined in Cake/bootstrap.php @@ -90,7 +90,7 @@ } } if (!empty($failed)) { - trigger_error("CakePHP core could not be found. Check the value of CAKE_CORE_INCLUDE_PATH in APP/webroot/index.php. It should point to the directory containing your " . DS . "cake core directory and your " . DS . "vendors root directory.", E_USER_ERROR); + trigger_error("CakePHP core could not be found. Check the value of CAKE_CORE_INCLUDE_PATH in APP/webroot/index.php. It should point to the directory containing your " . DS . "cake core directory and your " . DS . "vendors root directory.", E_USER_ERROR); } App::uses('Dispatcher', 'Routing'); diff --git a/lib/Cake/Console/Templates/skel/webroot/test.php b/lib/Cake/Console/Templates/skel/webroot/test.php index da7088fd8b2..3a3474e2f63 100644 --- a/lib/Cake/Console/Templates/skel/webroot/test.php +++ b/lib/Cake/Console/Templates/skel/webroot/test.php @@ -50,7 +50,7 @@ /** * The absolute path to the "Cake" directory, WITHOUT a trailing DS. * - * For ease of development CakePHP uses PHP's include_path. If you + * For ease of development CakePHP uses PHP's include_path. If you * need to cannot modify your include_path, you can set this path. * * Leaving this constant undefined will result in it being defined in Cake/bootstrap.php @@ -82,7 +82,7 @@ } } if (!empty($failed)) { - trigger_error("CakePHP core could not be found. Check the value of CAKE_CORE_INCLUDE_PATH in APP/webroot/index.php. It should point to the directory containing your " . DS . "cake core directory and your " . DS . "vendors root directory.", E_USER_ERROR); + trigger_error("CakePHP core could not be found. Check the value of CAKE_CORE_INCLUDE_PATH in APP/webroot/index.php. It should point to the directory containing your " . DS . "cake core directory and your " . DS . "vendors root directory.", E_USER_ERROR); } if (Configure::read('debug') < 1) { diff --git a/lib/Cake/Controller/Component.php b/lib/Cake/Controller/Component.php index 658db6df813..6d8b817a2d7 100644 --- a/lib/Cake/Controller/Component.php +++ b/lib/Cake/Controller/Component.php @@ -18,14 +18,14 @@ App::uses('ComponentCollection', 'Controller'); /** - * Base class for an individual Component. Components provide reusable bits of - * controller logic that can be composed into a controller. Components also + * Base class for an individual Component. Components provide reusable bits of + * controller logic that can be composed into a controller. Components also * provide request life-cycle callbacks for injecting logic at specific points. * * ## Life cycle callbacks * * Components can provide several callbacks that are fired at various stages of the request - * cycle. The available callbacks are: + * cycle. The available callbacks are: * * - `initialize()` - Fired before the controller's beforeFilter method. * - `startup()` - Fired after the controller's beforeFilter method. @@ -141,10 +141,10 @@ public function shutdown(Controller $controller) { } /** - * Called before Controller::redirect(). Allows you to replace the url that will + * Called before Controller::redirect(). Allows you to replace the url that will * be redirected to with a new url. The return of this method can either be an array or a string. * - * If the return is an array and contains a 'url' key. You may also supply the following: + * If the return is an array and contains a 'url' key. You may also supply the following: * * - `status` The status code for the redirect * - `exit` Whether or not the redirect should exit. diff --git a/lib/Cake/Controller/Component/Acl/DbAcl.php b/lib/Cake/Controller/Component/Acl/DbAcl.php index 679bbd0df0f..02f917d7078 100644 --- a/lib/Cake/Controller/Component/Acl/DbAcl.php +++ b/lib/Cake/Controller/Component/Acl/DbAcl.php @@ -16,8 +16,8 @@ App::uses('Hash', 'Utility'); /** - * DbAcl implements an ACL control system in the database. ARO's and ACO's are - * structured into trees and a linking table is used to define permissions. You + * DbAcl implements an ACL control system in the database. ARO's and ACO's are + * structured into trees and a linking table is used to define permissions. You * can install the schema for DbAcl with the Schema Shell. * * `$aco` and `$aro` parameters can be slash delimited paths to tree nodes. diff --git a/lib/Cake/Controller/Component/Acl/IniAcl.php b/lib/Cake/Controller/Component/Acl/IniAcl.php index f894740e0ea..837d3309a69 100644 --- a/lib/Cake/Controller/Component/Acl/IniAcl.php +++ b/lib/Cake/Controller/Component/Acl/IniAcl.php @@ -15,7 +15,7 @@ App::uses('AclInterface', 'Controller/Component/Acl'); /** - * IniAcl implements an access control system using an INI file. An example + * IniAcl implements an access control system using an INI file. An example * of the ini file used can be found in /config/acl.ini.php. * * @package Cake.Controller.Component.Acl @@ -31,7 +31,7 @@ class IniAcl extends Object implements AclInterface { /** * The Hash::extract() path to the user/aro identifier in the - * acl.ini file. This path will be used to extract the string + * acl.ini file. This path will be used to extract the string * representation of a user used in the ini file. * * @var string diff --git a/lib/Cake/Controller/Component/AclComponent.php b/lib/Cake/Controller/Component/AclComponent.php index 66ee9a330ff..4b048fb19ba 100644 --- a/lib/Cake/Controller/Component/AclComponent.php +++ b/lib/Cake/Controller/Component/AclComponent.php @@ -96,7 +96,7 @@ public function adapter($adapter = null) { } /** - * Pass-thru function for ACL check instance. Check methods + * Pass-thru function for ACL check instance. Check methods * are used to check whether or not an ARO can access an ACO * * @param array|string|Model $aro ARO The requesting object identifier. See `AclNode::node()` for possible formats diff --git a/lib/Cake/Controller/Component/Auth/ActionsAuthorize.php b/lib/Cake/Controller/Component/Auth/ActionsAuthorize.php index 3f279b0787d..27fc8180f7f 100644 --- a/lib/Cake/Controller/Component/Auth/ActionsAuthorize.php +++ b/lib/Cake/Controller/Component/Auth/ActionsAuthorize.php @@ -16,7 +16,7 @@ App::uses('BaseAuthorize', 'Controller/Component/Auth'); /** - * An authorization adapter for AuthComponent. Provides the ability to authorize using the AclComponent, + * An authorization adapter for AuthComponent. Provides the ability to authorize using the AclComponent, * If AclComponent is not already loaded it will be loaded using the Controller's ComponentCollection. * * @package Cake.Controller.Component.Auth diff --git a/lib/Cake/Controller/Component/Auth/BaseAuthenticate.php b/lib/Cake/Controller/Component/Auth/BaseAuthenticate.php index 297dd5753c8..f456e46ab7d 100644 --- a/lib/Cake/Controller/Component/Auth/BaseAuthenticate.php +++ b/lib/Cake/Controller/Component/Auth/BaseAuthenticate.php @@ -144,7 +144,7 @@ public function logout($user) { } /** - * Get a user based on information in the request. Primarily used by stateless authentication + * Get a user based on information in the request. Primarily used by stateless authentication * systems like basic and digest auth. * * @param CakeRequest $request Request object. diff --git a/lib/Cake/Controller/Component/Auth/BaseAuthorize.php b/lib/Cake/Controller/Component/Auth/BaseAuthorize.php index 9bf2d1b6782..c242f213dc6 100644 --- a/lib/Cake/Controller/Component/Auth/BaseAuthorize.php +++ b/lib/Cake/Controller/Component/Auth/BaseAuthorize.php @@ -40,10 +40,10 @@ abstract class BaseAuthorize { /** * Settings for authorize objects. * - * - `actionPath` - The path to ACO nodes that contains the nodes for controllers. Used as a prefix + * - `actionPath` - The path to ACO nodes that contains the nodes for controllers. Used as a prefix * when calling $this->action(); * - `actionMap` - Action -> crud mappings. Used by authorization objects that want to map actions to CRUD roles. - * - `userModel` - Model name that ARO records can be found under. Defaults to 'User'. + * - `userModel` - Model name that ARO records can be found under. Defaults to 'User'. * * @var array */ @@ -64,7 +64,7 @@ abstract class BaseAuthorize { * Constructor * * @param ComponentCollection $collection The controller for this request. - * @param string $settings An array of settings. This class does not use any settings. + * @param string $settings An array of settings. This class does not use any settings. */ public function __construct(ComponentCollection $collection, $settings = array()) { $this->_Collection = $collection; @@ -101,7 +101,7 @@ public function controller(Controller $controller = null) { } /** - * Get the action path for a given request. Primarily used by authorize objects + * Get the action path for a given request. Primarily used by authorize objects * that need to get information about the plugin, controller, and action being invoked. * * @param CakeRequest $request The request a path is needed for. @@ -120,7 +120,7 @@ public function action($request, $path = '/:plugin/:controller/:action') { } /** - * Maps crud actions to actual action names. Used to modify or get the current mapped actions. + * Maps crud actions to actual action names. Used to modify or get the current mapped actions. * * Create additional mappings for a standard CRUD operation: * @@ -135,8 +135,8 @@ public function action($request, $path = '/:plugin/:controller/:action') { * }}} * * You can use the custom CRUD operations to create additional generic permissions - * that behave like CRUD operations. Doing this will require additional columns on the - * permissions lookup. When using with DbAcl, you'll have to add additional _admin type columns + * that behave like CRUD operations. Doing this will require additional columns on the + * permissions lookup. When using with DbAcl, you'll have to add additional _admin type columns * to the `aros_acos` table. * * @param array $map Either an array of mappings, or undefined to get current values. diff --git a/lib/Cake/Controller/Component/Auth/BasicAuthenticate.php b/lib/Cake/Controller/Component/Auth/BasicAuthenticate.php index df65e9c71b8..6a6ff41b13f 100644 --- a/lib/Cake/Controller/Component/Auth/BasicAuthenticate.php +++ b/lib/Cake/Controller/Component/Auth/BasicAuthenticate.php @@ -18,9 +18,9 @@ /** * Basic Authentication adapter for AuthComponent. * - * Provides Basic HTTP authentication support for AuthComponent. Basic Auth will authenticate users - * against the configured userModel and verify the username and passwords match. Clients using Basic Authentication - * must support cookies. Since AuthComponent identifies users based on Session contents, clients using Basic + * Provides Basic HTTP authentication support for AuthComponent. Basic Auth will authenticate users + * against the configured userModel and verify the username and passwords match. Clients using Basic Authentication + * must support cookies. Since AuthComponent identifies users based on Session contents, clients using Basic * Auth must support cookies. * * ### Using Basic auth @@ -34,7 +34,7 @@ * ); * }}} * - * In your login function just call `$this->Auth->login()` without any checks for POST data. This + * In your login function just call `$this->Auth->login()` without any checks for POST data. This * will send the authentication headers, and trigger the login dialog in the browser/client. * * @package Cake.Controller.Component.Auth @@ -51,7 +51,7 @@ class BasicAuthenticate extends BaseAuthenticate { * i.e. `array('User.is_active' => 1).` * - `recursive` The value of the recursive key passed to find(). Defaults to 0. * - `contain` Extra models to contain and store in session. - * - `realm` The realm authentication is for. Defaults the server name. + * - `realm` The realm authentication is for. Defaults the server name. * * @var array */ @@ -81,7 +81,7 @@ public function __construct(ComponentCollection $collection, $settings) { } /** - * Authenticate a user using basic HTTP auth. Will use the configured User model and attempt a + * Authenticate a user using basic HTTP auth. Will use the configured User model and attempt a * login using basic HTTP auth. * * @param CakeRequest $request The request to authenticate with. @@ -101,7 +101,7 @@ public function authenticate(CakeRequest $request, CakeResponse $response) { } /** - * Get a user based on information in the request. Used by cookie-less auth for stateless clients. + * Get a user based on information in the request. Used by cookie-less auth for stateless clients. * * @param CakeRequest $request Request object. * @return mixed Either false or an array of user information diff --git a/lib/Cake/Controller/Component/Auth/ControllerAuthorize.php b/lib/Cake/Controller/Component/Auth/ControllerAuthorize.php index 7fa486d4d26..8f2f712752d 100644 --- a/lib/Cake/Controller/Component/Auth/ControllerAuthorize.php +++ b/lib/Cake/Controller/Component/Auth/ControllerAuthorize.php @@ -16,7 +16,7 @@ App::uses('BaseAuthorize', 'Controller/Component/Auth'); /** - * An authorization adapter for AuthComponent. Provides the ability to authorize using a controller callback. + * An authorization adapter for AuthComponent. Provides the ability to authorize using a controller callback. * Your controller's isAuthorized() method should return a boolean to indicate whether or not the user is authorized. * * {{{ @@ -38,7 +38,7 @@ class ControllerAuthorize extends BaseAuthorize { /** - * Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented. + * Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented. * * @param Controller $controller null to get, a controller to set. * @return mixed diff --git a/lib/Cake/Controller/Component/Auth/CrudAuthorize.php b/lib/Cake/Controller/Component/Auth/CrudAuthorize.php index 83761b1e22b..0de2673b294 100644 --- a/lib/Cake/Controller/Component/Auth/CrudAuthorize.php +++ b/lib/Cake/Controller/Component/Auth/CrudAuthorize.php @@ -17,12 +17,12 @@ App::uses('Router', 'Routing'); /** - * An authorization adapter for AuthComponent. Provides the ability to authorize using CRUD mappings. + * An authorization adapter for AuthComponent. Provides the ability to authorize using CRUD mappings. * CRUD mappings allow you to translate controller actions into *C*reate *R*ead *U*pdate *D*elete actions. * This is then checked in the AclComponent as specific permissions. * - * For example, taking `/posts/index` as the current request. The default mapping for `index`, is a `read` permission - * check. The Acl check would then be for the `posts` controller with the `read` permission. This allows you + * For example, taking `/posts/index` as the current request. The default mapping for `index`, is a `read` permission + * check. The Acl check would then be for the `posts` controller with the `read` permission. This allows you * to create permission systems that focus more on what is being done to resources, rather than the specific actions * being visited. * @@ -37,7 +37,7 @@ class CrudAuthorize extends BaseAuthorize { * Sets up additional actionMap values that match the configured `Routing.prefixes`. * * @param ComponentCollection $collection The component collection from the controller. - * @param string $settings An array of settings. This class does not use any settings. + * @param string $settings An array of settings. This class does not use any settings. */ public function __construct(ComponentCollection $collection, $settings = array()) { parent::__construct($collection, $settings); diff --git a/lib/Cake/Controller/Component/Auth/DigestAuthenticate.php b/lib/Cake/Controller/Component/Auth/DigestAuthenticate.php index 3ef4b6510ac..3d944468b0a 100644 --- a/lib/Cake/Controller/Component/Auth/DigestAuthenticate.php +++ b/lib/Cake/Controller/Component/Auth/DigestAuthenticate.php @@ -18,12 +18,12 @@ /** * Digest Authentication adapter for AuthComponent. * - * Provides Digest HTTP authentication support for AuthComponent. Unlike most AuthComponent adapters, - * DigestAuthenticate requires a special password hash that conforms to RFC2617. You can create this - * password using `DigestAuthenticate::password()`. If you wish to use digest authentication alongside other + * Provides Digest HTTP authentication support for AuthComponent. Unlike most AuthComponent adapters, + * DigestAuthenticate requires a special password hash that conforms to RFC2617. You can create this + * password using `DigestAuthenticate::password()`. If you wish to use digest authentication alongside other * authentication methods, its recommended that you store the digest authentication separately. * - * Clients using Digest Authentication must support cookies. Since AuthComponent identifies users based + * Clients using Digest Authentication must support cookies. Since AuthComponent identifies users based * on Session contents, clients without support for cookies will not function properly. * * ### Using Digest auth @@ -37,18 +37,18 @@ * ); * }}} * - * In your login function just call `$this->Auth->login()` without any checks for POST data. This + * In your login function just call `$this->Auth->login()` without any checks for POST data. This * will send the authentication headers, and trigger the login dialog in the browser/client. * * ### Generating passwords compatible with Digest authentication. * - * Due to the Digest authentication specification, digest auth requires a special password value. You + * Due to the Digest authentication specification, digest auth requires a special password value. You * can generate this password using `DigestAuthenticate::password()` * * `$digestPass = DigestAuthenticate::password($username, env('SERVER_NAME'), $password);` * * Its recommended that you store this digest auth only password separate from password hashes used for other - * login methods. For example `User.digest_pass` could be used for a digest password, while `User.password` would + * login methods. For example `User.digest_pass` could be used for a digest password, while `User.password` would * store the password hash for use with other methods like Basic or Form. * * @package Cake.Controller.Component.Auth @@ -66,7 +66,7 @@ class DigestAuthenticate extends BaseAuthenticate { * - `recursive` The value of the recursive key passed to find(). Defaults to 0. * - `contain` Extra models to contain and store in session. * - `realm` The realm authentication is for, Defaults to the servername. - * - `nonce` A nonce used for authentication. Defaults to `uniqid()`. + * - `nonce` A nonce used for authentication. Defaults to `uniqid()`. * - `qop` Defaults to auth, no other values are supported at this time. * - `opaque` A string that must be returned unchanged by clients. * Defaults to `md5($settings['realm'])` @@ -108,7 +108,7 @@ public function __construct(ComponentCollection $collection, $settings) { } /** - * Authenticate a user using Digest HTTP auth. Will use the configured User model and attempt a + * Authenticate a user using Digest HTTP auth. Will use the configured User model and attempt a * login using Digest HTTP auth. * * @param CakeRequest $request The request to authenticate with. @@ -128,7 +128,7 @@ public function authenticate(CakeRequest $request, CakeResponse $response) { } /** - * Get a user based on information in the request. Used by cookie-less auth for stateless clients. + * Get a user based on information in the request. Used by cookie-less auth for stateless clients. * * @param CakeRequest $request Request object. * @return mixed Either false or an array of user information diff --git a/lib/Cake/Controller/Component/Auth/FormAuthenticate.php b/lib/Cake/Controller/Component/Auth/FormAuthenticate.php index f2f3c35f1ae..e472f0ae50b 100644 --- a/lib/Cake/Controller/Component/Auth/FormAuthenticate.php +++ b/lib/Cake/Controller/Component/Auth/FormAuthenticate.php @@ -16,8 +16,8 @@ App::uses('BaseAuthenticate', 'Controller/Component/Auth'); /** - * An authentication adapter for AuthComponent. Provides the ability to authenticate using POST - * data. Can be used by configuring AuthComponent to use it via the AuthComponent::$authenticate setting. + * An authentication adapter for AuthComponent. Provides the ability to authenticate using POST + * data. Can be used by configuring AuthComponent to use it via the AuthComponent::$authenticate setting. * * {{{ * $this->Auth->authenticate = array( @@ -58,8 +58,8 @@ protected function _checkFields(CakeRequest $request, $model, $fields) { } /** - * Authenticates the identity contained in a request. Will use the `settings.userModel`, and `settings.fields` - * to find POST data that is used to find a matching record in the `settings.userModel`. Will return false if + * Authenticates the identity contained in a request. Will use the `settings.userModel`, and `settings.fields` + * to find POST data that is used to find a matching record in the `settings.userModel`. Will return false if * there is no post data, either username or password is missing, of if the scope conditions have not been met. * * @param CakeRequest $request The request that contains login information. diff --git a/lib/Cake/Controller/Component/AuthComponent.php b/lib/Cake/Controller/Component/AuthComponent.php index 96ac195c7ee..e2750161257 100644 --- a/lib/Cake/Controller/Component/AuthComponent.php +++ b/lib/Cake/Controller/Component/AuthComponent.php @@ -51,7 +51,7 @@ class AuthComponent extends Component { public $components = array('Session', 'RequestHandler'); /** - * An array of authentication objects to use for authenticating users. You can configure + * An array of authentication objects to use for authenticating users. You can configure * multiple adapters and they will be checked sequentially when users are identified. * * {{{ @@ -63,7 +63,7 @@ class AuthComponent extends Component { * }}} * * Using the class name without 'Authenticate' as the key, you can pass in an array of settings for each - * authentication object. Additionally you can define settings that should be set to all authentications objects + * authentication object. Additionally you can define settings that should be set to all authentications objects * using the 'all' key: * * {{{ @@ -92,7 +92,7 @@ class AuthComponent extends Component { protected $_authenticateObjects = array(); /** - * An array of authorization objects to use for authorizing users. You can configure + * An array of authorization objects to use for authorizing users. You can configure * multiple adapters and they will be checked sequentially when authorization checks are done. * * {{{ @@ -104,7 +104,7 @@ class AuthComponent extends Component { * }}} * * Using the class name without 'Authorize' as the key, you can pass in an array of settings for each - * authorization object. Additionally you can define settings that should be set to all authorization objects + * authorization object. Additionally you can define settings that should be set to all authorization objects * using the 'all' key: * * {{{ @@ -156,7 +156,7 @@ class AuthComponent extends Component { ); /** - * The session key name where the record of the current user is stored. If + * The session key name where the record of the current user is stored. If * unspecified, it will be "Auth.User". * * @var string @@ -173,7 +173,7 @@ class AuthComponent extends Component { /** * A URL (defined as a string or array) to the controller action that handles - * logins. Defaults to `/users/login` + * logins. Defaults to `/users/login` * * @var mixed */ @@ -186,7 +186,7 @@ class AuthComponent extends Component { /** * Normally, if a user is redirected to the $loginAction page, the location they * were redirected from will be stored in the session so that they can be - * redirected back after a successful login. If this session value is not + * redirected back after a successful login. If this session value is not * set, the user will be redirected to the page specified in $loginRedirect. * * @var mixed @@ -195,7 +195,7 @@ class AuthComponent extends Component { public $loginRedirect = null; /** - * The default action to redirect to after the user is logged out. While AuthComponent does + * The default action to redirect to after the user is logged out. While AuthComponent does * not handle post-logout redirection, a redirect URL will be returned from AuthComponent::logout(). * Defaults to AuthComponent::$loginAction. * @@ -269,7 +269,7 @@ public function initialize(Controller $controller) { } /** - * Main execution method. Handles redirecting of invalid users, and processing + * Main execution method. Handles redirecting of invalid users, and processing * of login form data. * * @param Controller $controller A reference to the instantiating controller object @@ -382,7 +382,7 @@ protected function _setDefaults() { * be authorized for the request. * * @param array $user The user to check the authorization of. If empty the user in the session will be used. - * @param CakeRequest $request The request to authenticate for. If empty, the current request will be used. + * @param CakeRequest $request The request to authenticate for. If empty, the current request will be used. * @return boolean True if $user is authorized, otherwise false */ public function isAuthorized($user = null, $request = null) { @@ -498,7 +498,7 @@ public function deny($action = null) { } /** - * Maps action names to CRUD operations. Used for controller-based authentication. Make sure + * Maps action names to CRUD operations. Used for controller-based authentication. Make sure * to configure the authorize property before calling this method. As it delegates $map to all the * attached authorize objects. * @@ -517,7 +517,7 @@ public function mapActions($map = array()) { } /** - * Log a user in. If a $user is provided that data will be stored as the logged in user. If `$user` is empty or not + * Log a user in. If a $user is provided that data will be stored as the logged in user. If `$user` is empty or not * specified, the request will be used to identify a user. If the identification was successful, * the user record is written to the session key specified in AuthComponent::$sessionKey. Logging in * will also change the session id in order to help mitigate session replays. @@ -542,9 +542,9 @@ public function login($user = null) { /** * Logs a user out, and returns the login action to redirect to. * Triggers the logout() method of all the authenticate objects, so they can perform - * custom logout logic. AuthComponent will remove the session data, so - * there is no need to do that in an authentication object. Logging out - * will also renew the session id. This helps mitigate issues with session replays. + * custom logout logic. AuthComponent will remove the session data, so + * there is no need to do that in an authentication object. Logging out + * will also renew the session id. This helps mitigate issues with session replays. * * @return string AuthComponent::$logoutRedirect * @see AuthComponent::$logoutRedirect @@ -568,11 +568,11 @@ public function logout() { /** * Get the current user. * - * Will prefer the static user cache over sessions. The static user - * cache is primarily used for stateless authentication. For stateful authentication, + * Will prefer the static user cache over sessions. The static user + * cache is primarily used for stateless authentication. For stateful authentication, * cookies + sessions will be used. * - * @param string $key field to retrieve. Leave null to get entire User record + * @param string $key field to retrieve. Leave null to get entire User record * @return mixed User record. or null if no user is logged in. * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#accessing-the-logged-in-user */ @@ -593,7 +593,7 @@ public static function user($key = null) { /** * Similar to AuthComponent::user() except if the session user cannot be found, connected authentication - * objects will have their getUser() methods called. This lets stateless authentication methods function correctly. + * objects will have their getUser() methods called. This lets stateless authentication methods function correctly. * * @return boolean true if a user can be found, false if one cannot. */ @@ -616,8 +616,8 @@ protected function _getUser() { } /** - * If no parameter is passed, gets the authentication redirect URL. Pass a url in to - * set the destination a user should be redirected to upon logging in. Will fallback to + * If no parameter is passed, gets the authentication redirect URL. Pass a url in to + * set the destination a user should be redirected to upon logging in. Will fallback to * AuthComponent::$loginRedirect if there is no stored redirect value. * * @param string|array $url Optional URL to write as the login redirect URL. @@ -697,7 +697,7 @@ public function constructAuthenticate() { /** * Hash a password with the application's salt value (as defined with Configure::write('Security.salt'); * - * This method is intended as a convenience wrapper for Security::hash(). If you want to use + * This method is intended as a convenience wrapper for Security::hash(). If you want to use * a hashing/encryption system not supported by that method, do not use this method. * * @param string $password Password to hash @@ -709,7 +709,7 @@ public static function password($password) { } /** - * Component shutdown. If user is logged in, wipe out redirect. + * Component shutdown. If user is logged in, wipe out redirect. * * @param Controller $controller Instantiating controller * @return void @@ -730,7 +730,7 @@ public function loggedIn() { } /** - * Set a flash message. Uses the Session component, and values from AuthComponent::$flash. + * Set a flash message. Uses the Session component, and values from AuthComponent::$flash. * * @param string $message The message to set. * @return void diff --git a/lib/Cake/Controller/Component/CookieComponent.php b/lib/Cake/Controller/Component/CookieComponent.php index 0bc156210e9..665541e0aed 100644 --- a/lib/Cake/Controller/Component/CookieComponent.php +++ b/lib/Cake/Controller/Component/CookieComponent.php @@ -110,7 +110,7 @@ class CookieComponent extends Component { /** * HTTP only cookie * - * Set to true to make HTTP only cookies. Cookies that are HTTP only + * Set to true to make HTTP only cookies. Cookies that are HTTP only * are not accessible in Javascript. * * @var boolean diff --git a/lib/Cake/Controller/Component/EmailComponent.php b/lib/Cake/Controller/Component/EmailComponent.php index 1e356e67a6f..0b4d027db30 100644 --- a/lib/Cake/Controller/Component/EmailComponent.php +++ b/lib/Cake/Controller/Component/EmailComponent.php @@ -239,7 +239,7 @@ class EmailComponent extends Component { * it be handled by sendmail (or similar) or a string * to completely override the Message-ID. * - * If you are sending Email from a shell, be sure to set this value. As you + * If you are sending Email from a shell, be sure to set this value. As you * could encounter delivery issues if you do not. * * @var mixed diff --git a/lib/Cake/Controller/Component/PaginatorComponent.php b/lib/Cake/Controller/Component/PaginatorComponent.php index 934e661a19d..7ebf35d6d4b 100644 --- a/lib/Cake/Controller/Component/PaginatorComponent.php +++ b/lib/Cake/Controller/Component/PaginatorComponent.php @@ -20,12 +20,12 @@ App::uses('Hash', 'Utility'); /** - * This component is used to handle automatic model data pagination. The primary way to use this + * This component is used to handle automatic model data pagination. The primary way to use this * component is to call the paginate() method. There is a convenience wrapper on Controller as well. * * ### Configuring pagination * - * You configure pagination using the PaginatorComponent::$settings. This allows you to configure + * You configure pagination using the PaginatorComponent::$settings. This allows you to configure * the default pagination behavior in general or for a specific model. General settings are used when there * are no specific model configuration, or the model you are paginating does not have specific settings. * @@ -36,7 +36,7 @@ * ); * }}} * - * The above settings will be used to paginate any model. You can configure model specific settings by + * The above settings will be used to paginate any model. You can configure model specific settings by * keying the settings with the model name. * * {{{ @@ -71,11 +71,11 @@ class PaginatorComponent extends Component { /** - * Pagination settings. These settings control pagination at a general level. + * Pagination settings. These settings control pagination at a general level. * You can also define sub arrays for pagination settings for specific models. * * - `maxLimit` The maximum limit users can choose to view. Defaults to 100 - * - `limit` The initial number of items per page. Defaults to 20. + * - `limit` The initial number of items per page. Defaults to 20. * - `page` The starting page, defaults to 1. * - `paramType` What type of parameters you want pagination to use? * - `named` Use named parameters / routed parameters. @@ -91,7 +91,7 @@ class PaginatorComponent extends Component { ); /** - * A list of parameters users are allowed to set using request parameters. Modifying + * A list of parameters users are allowed to set using request parameters. Modifying * this list will allow users to have more influence over pagination, * be careful with what you permit. * @@ -118,7 +118,7 @@ public function __construct(ComponentCollection $collection, $settings = array() * * @param Model|string $object Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel') * @param string|array $scope Additional find conditions to use while paginating - * @param array $whitelist List of allowed fields for ordering. This allows you to prevent ordering + * @param array $whitelist List of allowed fields for ordering. This allows you to prevent ordering * on non-indexed, or undesirable columns. * @return array Model query results * @throws MissingModelException @@ -289,7 +289,7 @@ protected function _getObject($object) { * - Model specific settings. * - Request parameters * - * The result of this method is the aggregate of all the option sets combined together. You can change + * The result of this method is the aggregate of all the option sets combined together. You can change * PaginatorComponent::$whitelist to modify which options/values can be set using request parameters. * * @param string $alias Model alias being paginated, if the general settings has a key with this value @@ -311,7 +311,7 @@ public function mergeOptions($alias) { } /** - * Get the default settings for a $model. If there are no settings for a specific model, the general settings + * Get the default settings for a $model. If there are no settings for a specific model, the general settings * will be used. * * @param string $alias Model name to get default settings for. @@ -334,8 +334,8 @@ public function getDefaults($alias) { } /** - * Validate that the desired sorting can be performed on the $object. Only fields or - * virtualFields can be sorted on. The direction param will also be sanitized. Lastly + * Validate that the desired sorting can be performed on the $object. Only fields or + * virtualFields can be sorted on. The direction param will also be sanitized. Lastly * sort + direction keys will be converted into the model friendly order key. * * You can use the whitelist parameter to control which columns/fields are available for sorting. @@ -343,7 +343,7 @@ public function getDefaults($alias) { * * @param Model $object The model being paginated. * @param array $options The pagination options being used for this request. - * @param array $whitelist The list of columns that can be used for sorting. If empty all keys are allowed. + * @param array $whitelist The list of columns that can be used for sorting. If empty all keys are allowed. * @return array An array of options with sort + direction removed and replaced with order if possible. */ public function validateSort(Model $object, array $options, array $whitelist = array()) { diff --git a/lib/Cake/Controller/Component/RequestHandlerComponent.php b/lib/Cake/Controller/Component/RequestHandlerComponent.php index cfcbf5393b7..981a754da8f 100644 --- a/lib/Cake/Controller/Component/RequestHandlerComponent.php +++ b/lib/Cake/Controller/Component/RequestHandlerComponent.php @@ -3,7 +3,7 @@ * Request object for handling alternative HTTP requests * * Alternative HTTP requests can come from wireless units like mobile phones, palmtop computers, - * and the like. These units have no use for Ajax requests, and this Component can tell how Cake + * and the like. These units have no use for Ajax requests, and this Component can tell how Cake * should respond to the different needs of a handheld computer and a desktop machine. * * CakePHP(tm) : Rapid Development Framework (http://cakephp.org) @@ -171,11 +171,11 @@ protected function _setExtension() { * * - Disabling layout rendering for Ajax requests (based on the HTTP_X_REQUESTED_WITH header) * - If Router::parseExtensions() is enabled, the layout and template type are - * switched based on the parsed extension or Accept-Type header. For example, if `controller/action.xml` + * switched based on the parsed extension or Accept-Type header. For example, if `controller/action.xml` * is requested, the view path becomes `app/View/Controller/xml/action.ctp`. Also if * `controller/action` is requested with `Accept-Type: application/xml` in the headers - * the view path will become `app/View/Controller/xml/action.ctp`. Layout and template - * types will only switch to mime-types recognized by CakeResponse. If you need to declare + * the view path will become `app/View/Controller/xml/action.ctp`. Layout and template + * types will only switch to mime-types recognized by CakeResponse. If you need to declare * additional mime-types, you can do so using CakeResponse::type() in your controllers beforeFilter() * method. * - If a helper with the same name as the extension exists, it is added to the controller. @@ -403,7 +403,7 @@ public function getAjaxVersion() { } /** - * Adds/sets the Content-type(s) for the given name. This method allows + * Adds/sets the Content-type(s) for the given name. This method allows * content-types to be mapped to friendly aliases (or extensions), which allows * RequestHandler to automatically respond to requests of that type in the * startup method. @@ -440,7 +440,7 @@ public function getClientIP($safe = true) { } /** - * Determines which content types the client accepts. Acceptance is based on + * Determines which content types the client accepts. Acceptance is based on * the file extension parsed by the Router (if present), and by the HTTP_ACCEPT * header. Unlike CakeRequest::accepts() this method deals entirely with mapped content types. * @@ -457,8 +457,8 @@ public function getClientIP($safe = true) { * @param string|array $type Can be null (or no parameter), a string type name, or an * array of types * @return mixed If null or no parameter is passed, returns an array of content - * types the client accepts. If a string is passed, returns true - * if the client accepts it. If an array is passed, returns true + * types the client accepts. If a string is passed, returns true + * if the client accepts it. If an array is passed, returns true * if the client accepts one or more elements in the array. * @see RequestHandlerComponent::setContent() */ @@ -487,7 +487,7 @@ public function accepts($type = null) { * Determines the content type of the data the client has sent (i.e. in a POST request) * * @param string|array $type Can be null (or no parameter), a string type name, or an array of types - * @return mixed If a single type is supplied a boolean will be returned. If no type is provided + * @return mixed If a single type is supplied a boolean will be returned. If no type is provided * The mapped value of CONTENT_TYPE will be returned. If an array is supplied the first type * in the request content type will be returned. */ @@ -514,8 +514,8 @@ public function requestedWith($type = null) { } /** - * Determines which content-types the client prefers. If no parameters are given, - * the single content-type that the client most likely prefers is returned. If $type is + * Determines which content-types the client prefers. If no parameters are given, + * the single content-type that the client most likely prefers is returned. If $type is * an array, the first item in the array that the client accepts is returned. * Preference is determined primarily by the file extension parsed by the Router * if provided, and secondarily by the list of content-types provided in @@ -524,7 +524,7 @@ public function requestedWith($type = null) { * @param string|array $type An optional array of 'friendly' content-type names, i.e. * 'html', 'xml', 'js', etc. * @return mixed If $type is null or not provided, the first content-type in the - * list, based on preference, is returned. If a single type is provided + * list, based on preference, is returned. If a single type is provided * a boolean will be returned if that type is preferred. * If an array of types are provided then the first preferred type is returned. * If no type is provided the first preferred type is returned. @@ -636,7 +636,7 @@ public function renderAs(Controller $controller, $type, $options = array()) { } /** - * Sets the response header based on type map index name. This wraps several methods + * Sets the response header based on type map index name. This wraps several methods * available on CakeResponse. It also allows you to use Content-Type aliases. * * @param string|array $type Friendly type name, i.e. 'html' or 'xml', or a full content-type, @@ -708,7 +708,7 @@ public function mapType($cType) { * Maps a content type alias back to its mime-type(s) * * @param string|array $alias String alias to convert back into a content type. Or an array of aliases to map. - * @return string Null on an undefined alias. String value of the mapped alias type. If an + * @return string Null on an undefined alias. String value of the mapped alias type. If an * alias maps to more than one content type, the first one will be returned. */ public function mapAlias($alias) { @@ -726,11 +726,11 @@ public function mapAlias($alias) { } /** - * Add a new mapped input type. Mapped input types are automatically + * Add a new mapped input type. Mapped input types are automatically * converted by RequestHandlerComponent during the startup() callback. * * @param string $type The type alias being converted, ie. json - * @param array $handler The handler array for the type. The first index should + * @param array $handler The handler array for the type. The first index should * be the handling callback, all other arguments should be additional parameters * for the handler. * @return void diff --git a/lib/Cake/Controller/Component/SecurityComponent.php b/lib/Cake/Controller/Component/SecurityComponent.php index b086e1fa51c..d58c538ddd0 100644 --- a/lib/Cake/Controller/Component/SecurityComponent.php +++ b/lib/Cake/Controller/Component/SecurityComponent.php @@ -137,7 +137,7 @@ class SecurityComponent extends Component { public $unlockedActions = array(); /** - * Whether to validate POST data. Set to false to disable for data coming from 3rd party + * Whether to validate POST data. Set to false to disable for data coming from 3rd party * services, etc. * * @var boolean @@ -145,7 +145,7 @@ class SecurityComponent extends Component { public $validatePost = true; /** - * Whether to use CSRF protected forms. Set to false to disable CSRF protection on forms. + * Whether to use CSRF protected forms. Set to false to disable CSRF protection on forms. * * @var boolean * @see http://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF) @@ -156,15 +156,15 @@ class SecurityComponent extends Component { /** * The duration from when a CSRF token is created that it will expire on. * Each form/page request will generate a new token that can only be submitted once unless - * it expires. Can be any value compatible with strtotime() + * it expires. Can be any value compatible with strtotime() * * @var string */ public $csrfExpires = '+30 minutes'; /** - * Controls whether or not CSRF tokens are use and burn. Set to false to not generate - * new tokens on each request. One token will be reused until it expires. This reduces + * Controls whether or not CSRF tokens are use and burn. Set to false to not generate + * new tokens on each request. One token will be reused until it expires. This reduces * the chances of users getting invalid requests because of token consumption. * It has the side effect of making CSRF less secure, as tokens are reusable. * @@ -174,7 +174,7 @@ class SecurityComponent extends Component { /** * Control the number of tokens a user can keep open. - * This is most useful with one-time use tokens. Since new tokens + * This is most useful with one-time use tokens. Since new tokens * are created on each request, having a hard limit on the number of open tokens * can be useful in controlling the size of the session file. * @@ -543,7 +543,7 @@ public function generateToken(CakeRequest $request) { /** * Validate that the controller has a CSRF token in the POST data - * and that the token is legit/not expired. If the token is valid + * and that the token is legit/not expired. If the token is valid * it will be removed from the list of valid tokens. * * @param Controller $controller A controller to check diff --git a/lib/Cake/Controller/Component/SessionComponent.php b/lib/Cake/Controller/Component/SessionComponent.php index 0bcdb7fa6af..76dfdf69250 100644 --- a/lib/Cake/Controller/Component/SessionComponent.php +++ b/lib/Cake/Controller/Component/SessionComponent.php @@ -165,7 +165,7 @@ public function destroy() { * Get/Set the session id. * * When fetching the session id, the session will be started - * if it has not already been started. When setting the session id, + * if it has not already been started. When setting the session id, * the session will not be started. * * @param string $id Id to use (optional) diff --git a/lib/Cake/Controller/ComponentCollection.php b/lib/Cake/Controller/ComponentCollection.php index ade39f03665..feb83ed9490 100644 --- a/lib/Cake/Controller/ComponentCollection.php +++ b/lib/Cake/Controller/ComponentCollection.php @@ -63,9 +63,9 @@ public function getController() { } /** - * Loads/constructs a component. Will return the instance in the registry if it already exists. + * Loads/constructs a component. Will return the instance in the registry if it already exists. * You can use `$settings['enabled'] = false` to disable callbacks on a component when loading it. - * Callbacks default to on. Disabled component methods work as normal, only callbacks are disabled. + * Callbacks default to on. Disabled component methods work as normal, only callbacks are disabled. * * You can alias your component as an existing component by setting the 'className' key, i.e., * {{{ diff --git a/lib/Cake/Controller/Controller.php b/lib/Cake/Controller/Controller.php index 7fc3500debe..b71a1126d3f 100644 --- a/lib/Cake/Controller/Controller.php +++ b/lib/Cake/Controller/Controller.php @@ -26,20 +26,20 @@ * Provides basic functionality, such as rendering views inside layouts, * automatic model availability, redirection, callbacks, and more. * - * Controllers should provide a number of 'action' methods. These are public methods on the controller - * that are not prefixed with a '_' and not part of Controller. Each action serves as an endpoint for - * performing a specific action on a resource or collection of resources. For example adding or editing a new + * Controllers should provide a number of 'action' methods. These are public methods on the controller + * that are not prefixed with a '_' and not part of Controller. Each action serves as an endpoint for + * performing a specific action on a resource or collection of resources. For example adding or editing a new * object, or listing a set of objects. * - * You can access request parameters, using `$this->request`. The request object contains all the POST, GET and FILES + * You can access request parameters, using `$this->request`. The request object contains all the POST, GET and FILES * that were part of the request. * - * After performing the required actions, controllers are responsible for creating a response. This usually - * takes the form of a generated View, or possibly a redirection to another controller action. In either case + * After performing the required actions, controllers are responsible for creating a response. This usually + * takes the form of a generated View, or possibly a redirection to another controller action. In either case * `$this->response` allows you to manipulate all aspects of the response. * * Controllers are created by Dispatcher based on request parameters and routing. By default controllers and actions - * use conventional names. For example `/posts/index` maps to `PostsController::index()`. You can re-map urls + * use conventional names. For example `/posts/index` maps to `PostsController::index()`. You can re-map urls * using Router::connect(). * * @package Cake.Controller @@ -434,7 +434,7 @@ public function __set($name, $value) { /** * Sets the request objects and configures a number of controller properties - * based on the contents of the request. The properties that get set are + * based on the contents of the request. The properties that get set are * * - $this->request - To the $request parameter * - $this->plugin - To the $request->params['plugin'] @@ -463,7 +463,7 @@ public function setRequest(CakeRequest $request) { } /** - * Dispatches the controller action. Checks that the action + * Dispatches the controller action. Checks that the action * exists and isn't private. * * @param CakeRequest $request @@ -1082,7 +1082,7 @@ public function paginate($object = null, $scope = array(), $whitelist = array()) } /** - * Called before the controller action. You can use this method to configure and customize components + * Called before the controller action. You can use this method to configure and customize components * or perform logic that needs to happen before each controller action. * * @return void diff --git a/lib/Cake/Controller/Scaffold.php b/lib/Cake/Controller/Scaffold.php index d008443afa5..d345ba4c8e8 100644 --- a/lib/Cake/Controller/Scaffold.php +++ b/lib/Cake/Controller/Scaffold.php @@ -321,7 +321,7 @@ protected function _scaffoldDelete(CakeRequest $request) { } /** - * Sends a message to the user. Either uses Sessions or flash messages depending + * Sends a message to the user. Either uses Sessions or flash messages depending * on the availability of a session * * @param string $message Message to display diff --git a/lib/Cake/Core/App.php b/lib/Cake/Core/App.php index fd6d1d1b245..787fd1ae059 100644 --- a/lib/Cake/Core/App.php +++ b/lib/Cake/Core/App.php @@ -22,7 +22,7 @@ * * ### Adding paths * - * You can add paths to the search indexes App uses to find classes using `App::build()`. Adding + * You can add paths to the search indexes App uses to find classes using `App::build()`. Adding * additional controller paths for example would alter where CakePHP looks for controllers. * This allows you to split your application up across the filesystem. * @@ -48,8 +48,8 @@ * * ### Locating plugins and themes * - * Plugins and Themes can be located with App as well. Using App::pluginPath('DebugKit') for example, will - * give you the full path to the DebugKit plugin. App::themePath('purple'), would give the full path to the + * Plugins and Themes can be located with App as well. Using App::pluginPath('DebugKit') for example, will + * give you the full path to the DebugKit plugin. App::themePath('purple'), would give the full path to the * `purple` theme. * * ### Inspecting known objects @@ -240,7 +240,7 @@ public static function path($type, $plugin = null) { /** * Get all the currently loaded paths from App. Useful for inspecting - * or storing all paths App knows about. For a paths to a specific package + * or storing all paths App knows about. For a paths to a specific package * use App::path() * * @return array An array of packages and their associated paths. @@ -365,7 +365,7 @@ public static function pluginPath($plugin) { } /** - * Finds the path that a theme is on. Searches through the defined theme paths. + * Finds the path that a theme is on. Searches through the defined theme paths. * * Usage: * @@ -420,7 +420,7 @@ public static function core($type) { * @param string $type Type of object, i.e. 'Model', 'Controller', 'View/Helper', 'file', 'class' or 'plugin' * @param string|array $path Optional Scan only the path given. If null, paths for the chosen type will be used. * @param boolean $cache Set to false to rescan objects of the chosen type. Defaults to true. - * @return mixed Either false on incorrect / miss. Or an array of found objects. + * @return mixed Either false on incorrect / miss. Or an array of found objects. * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::objects */ public static function objects($type, $path = null, $cache = true) { @@ -579,7 +579,7 @@ public static function location($className) { } /** - * Finds classes based on $name or specific file(s) to search. Calling App::import() will + * Finds classes based on $name or specific file(s) to search. Calling App::import() will * not construct any classes contained in the files. It will only find and require() the file. * * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#including-files-with-app-import diff --git a/lib/Cake/Core/Configure.php b/lib/Cake/Core/Configure.php index 0baf339c04c..524601708a1 100644 --- a/lib/Cake/Core/Configure.php +++ b/lib/Cake/Core/Configure.php @@ -150,7 +150,7 @@ public static function write($config, $value = null) { } /** - * Used to read information stored in Configure. Its not + * Used to read information stored in Configure. Its not * possible to store `null` values in Configure. * * Usage: @@ -160,7 +160,7 @@ public static function write($config, $value = null) { * }}} * * @linkhttp://book.cakephp.org/2.0/en/development/configuration.html#Configure::read - * @param string $var Variable to obtain. Use '.' to access array elements. + * @param string $var Variable to obtain. Use '.' to access array elements. * @return mixed value stored in configure, or null. */ public static function read($var = null) { @@ -202,15 +202,15 @@ public static function delete($var = null) { } /** - * Add a new reader to Configure. Readers allow you to read configuration - * files in various formats/storage locations. CakePHP comes with two built-in readers - * PhpReader and IniReader. You can also implement your own reader classes in your application. + * Add a new reader to Configure. Readers allow you to read configuration + * files in various formats/storage locations. CakePHP comes with two built-in readers + * PhpReader and IniReader. You can also implement your own reader classes in your application. * * To add a new reader to Configure: * * `Configure::config('ini', new IniReader());` * - * @param string $name The name of the reader being configured. This alias is used later to + * @param string $name The name of the reader being configured. This alias is used later to * read values from a specific reader. * @param ConfigReaderInterface $reader The reader to append. * @return void @@ -233,7 +233,7 @@ public static function configured($name = null) { } /** - * Remove a configured reader. This will unset the reader + * Remove a configured reader. This will unset the reader * and make any future attempts to use it cause an Exception. * * @param string $name Name of the reader to drop. @@ -248,7 +248,7 @@ public static function drop($name) { } /** - * Loads stored configuration information from a resource. You can add + * Loads stored configuration information from a resource. You can add * config file resource readers with `Configure::config()`. * * Loaded configuration information will be merged with the current @@ -257,7 +257,7 @@ public static function drop($name) { * * `Configure::load('Users.user', 'default')` * - * Would load the 'user' config file using the default config reader. You can load + * Would load the 'user' config file using the default config reader. You can load * app config files by giving the name of the resource you want loaded. * * `Configure::load('setup', 'default');` @@ -293,7 +293,7 @@ public static function load($key, $config = 'default', $merge = true) { /** * Dump data currently in Configure into $key. The serialization format - * is decided by the config reader attached as $config. For example, if the + * is decided by the config reader attached as $config. For example, if the * 'default' adapter is a PhpReader, the generated file will be a PHP * configuration file loadable by the PhpReader. * @@ -365,12 +365,12 @@ public static function version() { } /** - * Used to write runtime configuration into Cache. Stored runtime configuration can be - * restored using `Configure::restore()`. These methods can be used to enable configuration managers + * Used to write runtime configuration into Cache. Stored runtime configuration can be + * restored using `Configure::restore()`. These methods can be used to enable configuration managers * frontends, or other GUI type interfaces for configuration. * * @param string $name The storage name for the saved configuration. - * @param string $cacheConfig The cache configuration to save into. Defaults to 'default' + * @param string $cacheConfig The cache configuration to save into. Defaults to 'default' * @param array $data Either an array of data to store, or leave empty to store all values. * @return boolean Success */ @@ -382,7 +382,7 @@ public static function store($name, $cacheConfig = 'default', $data = null) { } /** - * Restores configuration data stored in the Cache into configure. Restored + * Restores configuration data stored in the Cache into configure. Restored * values will overwrite existing ones. * * @param string $name Name of the stored config file to load. diff --git a/lib/Cake/Core/Object.php b/lib/Cake/Core/Object.php index 15a58309def..097b6b4d127 100644 --- a/lib/Cake/Core/Object.php +++ b/lib/Cake/Core/Object.php @@ -49,16 +49,16 @@ public function toString() { * or fetch the return value from controller actions. * * Under the hood this method uses Router::reverse() to convert the $url parameter into a string - * URL. You should use URL formats that are compatible with Router::reverse() + * URL. You should use URL formats that are compatible with Router::reverse() * * #### Passing POST and GET data * - * POST and GET data can be simulated in requestAction. Use `$extra['url']` for - * GET data. The `$extra['data']` parameter allows POST data simulation. + * POST and GET data can be simulated in requestAction. Use `$extra['url']` for + * GET data. The `$extra['data']` parameter allows POST data simulation. * - * @param string|array $url String or array-based url. Unlike other url arrays in CakePHP, this + * @param string|array $url String or array-based url. Unlike other url arrays in CakePHP, this * url will not automatically handle passed and named arguments in the $url parameter. - * @param array $extra if array includes the key "return" it sets the AutoRender to true. Can + * @param array $extra if array includes the key "return" it sets the AutoRender to true. Can * also be used to submit GET/POST data, and named/passed arguments. * @return mixed Boolean true or false on success/failure, or contents * of rendered action if 'return' is set in $extra. @@ -132,7 +132,7 @@ public function dispatchMethod($method, $params = array()) { } /** - * Stop execution of the current script. Wraps exit() making + * Stop execution of the current script. Wraps exit() making * testing easier. * * @param integer|string $status see http://php.net/exit for values @@ -143,7 +143,7 @@ protected function _stop($status = 0) { } /** - * Convenience method to write a message to CakeLog. See CakeLog::write() + * Convenience method to write a message to CakeLog. See CakeLog::write() * for more information on writing to logs. * * @param string $msg Log message @@ -159,7 +159,7 @@ public function log($msg, $type = LOG_ERR) { } /** - * Allows setting of multiple properties of the object in a single line of code. Will only set + * Allows setting of multiple properties of the object in a single line of code. Will only set * properties that are part of a class declaration. * * @param array $properties An associative array containing properties and corresponding values. @@ -180,7 +180,7 @@ protected function _set($properties = array()) { * Merges this objects $property with the property in $class' definition. * This classes value for the property will be merged on top of $class' * - * This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine + * This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine * this method as an empty function. * * @param array $properties The name of the properties to merge. diff --git a/lib/Cake/Error/ErrorHandler.php b/lib/Cake/Error/ErrorHandler.php index 87a60583548..ab7414e257e 100644 --- a/lib/Cake/Error/ErrorHandler.php +++ b/lib/Cake/Error/ErrorHandler.php @@ -30,12 +30,12 @@ * * ### Uncaught exceptions * - * When debug < 1 a CakeException will render 404 or 500 errors. If an uncaught exception is thrown + * When debug < 1 a CakeException will render 404 or 500 errors. If an uncaught exception is thrown * and it is a type that ErrorHandler does not know about it will be treated as a 500 error. * * ### Implementing application specific exception handling * - * You can implement application specific exception handling in one of a few ways. Each approach + * You can implement application specific exception handling in one of a few ways. Each approach * gives you different amounts of control over the exception handling process. * * - Set Configure::write('Exception.handler', 'YourClass::yourMethod'); @@ -44,22 +44,22 @@ * * #### Create your own Exception handler with `Exception.handler` * - * This gives you full control over the exception handling process. The class you choose should be - * loaded in your app/Config/bootstrap.php, so its available to handle any exceptions. You can + * This gives you full control over the exception handling process. The class you choose should be + * loaded in your app/Config/bootstrap.php, so its available to handle any exceptions. You can * define the handler as any callback type. Using Exception.handler overrides all other exception * handling settings and logic. * * #### Using `AppController::appError();` * - * This controller method is called instead of the default exception rendering. It receives the - * thrown exception as its only argument. You should implement your error handling in that method. + * This controller method is called instead of the default exception rendering. It receives the + * thrown exception as its only argument. You should implement your error handling in that method. * Using AppController::appError(), will supersede any configuration for Exception.renderer. * * #### Using a custom renderer with `Exception.renderer` * * If you don't want to take control of the exception handling, but want to change how exceptions are - * rendered you can use `Exception.renderer` to choose a class to render exception pages. By default - * `ExceptionRenderer` is used. Your custom exception renderer class should be placed in app/Lib/Error. + * rendered you can use `Exception.renderer` to choose a class to render exception pages. By default + * `ExceptionRenderer` is used. Your custom exception renderer class should be placed in app/Lib/Error. * * Your custom renderer should expect an exception in its constructor, and implement a render method. * Failing to do so will cause additional errors. @@ -73,8 +73,8 @@ * ### PHP errors * * Error handler also provides the built in features for handling php errors (trigger_error). - * While in debug mode, errors will be output to the screen using debugger. While in production mode, - * errors will be logged to CakeLog. You can control which errors are logged by setting + * While in debug mode, errors will be output to the screen using debugger. While in production mode, + * errors will be logged to CakeLog. You can control which errors are logged by setting * `Error.level` in your core.php. * * #### Logging errors @@ -84,7 +84,7 @@ * * #### Controlling what errors are logged/displayed * - * You can control which errors are logged / displayed by ErrorHandler by setting `Error.level`. Setting this + * You can control which errors are logged / displayed by ErrorHandler by setting `Error.level`. Setting this * to one or a combination of a few of the E_* constants will only enable the specified errors. * * e.g. `Configure::write('Error.level', E_ALL & ~E_NOTICE);` @@ -138,7 +138,7 @@ public static function handleException(Exception $exception) { /** * Set as the default error handler by CakePHP. Use Configure::write('Error.handler', $callback), to use your own - * error handling methods. This function will use Debugger to display errors when debug > 0. And + * error handling methods. This function will use Debugger to display errors when debug > 0. And * will log errors to CakeLog, when debug == 0. * * You can use Configure::write('Error.level', $value); to set what type of errors will be handled here. diff --git a/lib/Cake/Error/ExceptionRenderer.php b/lib/Cake/Error/ExceptionRenderer.php index 130bee59ce3..93429428a0a 100644 --- a/lib/Cake/Error/ExceptionRenderer.php +++ b/lib/Cake/Error/ExceptionRenderer.php @@ -2,7 +2,7 @@ /** * Exception Renderer * - * Provides Exception rendering features. Which allow exceptions to be rendered + * Provides Exception rendering features. Which allow exceptions to be rendered * as HTML pages. * * PHP 5 @@ -29,7 +29,7 @@ * Exception Renderer. * * Captures and handles all unhandled exceptions. Displays helpful framework errors when debug > 1. - * When debug < 1 a CakeException will render 404 or 500 errors. If an uncaught exception is thrown + * When debug < 1 a CakeException will render 404 or 500 errors. If an uncaught exception is thrown * and it is a type that ExceptionHandler does not know about it will be treated as a 500 error. * * ### Implementing application specific exception rendering @@ -41,8 +41,8 @@ * * #### Using AppController::appError(); * - * This controller method is called instead of the default exception handling. It receives the - * thrown exception as its only argument. You should implement your error handling in that method. + * This controller method is called instead of the default exception handling. It receives the + * thrown exception as its only argument. You should implement your error handling in that method. * * #### Using a subclass of ExceptionRenderer * diff --git a/lib/Cake/Error/exceptions.php b/lib/Cake/Error/exceptions.php index 70f24b6e1cc..a740558be10 100644 --- a/lib/Cake/Error/exceptions.php +++ b/lib/Cake/Error/exceptions.php @@ -1,6 +1,6 @@ _methods[$method])) { diff --git a/lib/Cake/Model/Datasource/CakeSession.php b/lib/Cake/Model/Datasource/CakeSession.php index f7fbb280701..b0955148612 100644 --- a/lib/Cake/Model/Datasource/CakeSession.php +++ b/lib/Cake/Model/Datasource/CakeSession.php @@ -318,7 +318,7 @@ public static function valid() { /** * Tests that the user agent is valid and that the session hasn't 'timed out'. * Since timeouts are implemented in CakeSession it checks the current self::$time - * against the time the session is set to expire. The User agent is only checked + * against the time the session is set to expire. The User agent is only checked * if Session.checkAgent == true. * * @return boolean diff --git a/lib/Cake/Model/Datasource/DataSource.php b/lib/Cake/Model/Datasource/DataSource.php index c04e6771a3b..6eb968a0236 100644 --- a/lib/Cake/Model/Datasource/DataSource.php +++ b/lib/Cake/Model/Datasource/DataSource.php @@ -264,7 +264,7 @@ public function lastAffected($source = null) { /** * Check whether the conditions for the Datasource being available - * are satisfied. Often used from connect() to check for support + * are satisfied. Often used from connect() to check for support * before establishing a connection. * * @return boolean Whether or not the Datasources conditions for use are met. diff --git a/lib/Cake/Model/Datasource/Database/Mysql.php b/lib/Cake/Model/Datasource/Database/Mysql.php index b19df98ac99..0fd1846e941 100644 --- a/lib/Cake/Model/Datasource/Database/Mysql.php +++ b/lib/Cake/Model/Datasource/Database/Mysql.php @@ -544,7 +544,7 @@ public function alterSchema($compare, $table = null) { * Generate a MySQL "drop table" statement for the given Schema object * * @param CakeSchema $schema An instance of a subclass of CakeSchema - * @param string $table Optional. If specified only the table name given will be generated. + * @param string $table Optional. If specified only the table name given will be generated. * Otherwise, all tables defined in the schema are generated. * @return string */ diff --git a/lib/Cake/Model/Datasource/Database/Postgres.php b/lib/Cake/Model/Datasource/Database/Postgres.php index bbab17e3ee2..08149d81315 100644 --- a/lib/Cake/Model/Datasource/Database/Postgres.php +++ b/lib/Cake/Model/Datasource/Database/Postgres.php @@ -34,7 +34,7 @@ class Postgres extends DboSource { public $description = "PostgreSQL DBO Driver"; /** - * Base driver configuration settings. Merged with user settings. + * Base driver configuration settings. Merged with user settings. * * @var array */ @@ -298,7 +298,7 @@ public function getSequence($table, $field = 'id') { } /** - * Reset a sequence based on the MAX() value of $column. Useful + * Reset a sequence based on the MAX() value of $column. Useful * for resetting sequences after using insertMulti(). * * @param string $table The name of the table to update. diff --git a/lib/Cake/Model/Datasource/Database/Sqlite.php b/lib/Cake/Model/Datasource/Database/Sqlite.php index 7a9294193c3..5fb8d6533e8 100644 --- a/lib/Cake/Model/Datasource/Database/Sqlite.php +++ b/lib/Cake/Model/Datasource/Database/Sqlite.php @@ -553,7 +553,7 @@ public function hasResult() { * Generate a "drop table" statement for the given Schema object * * @param CakeSchema $schema An instance of a subclass of CakeSchema - * @param string $table Optional. If specified only the table name given will be generated. + * @param string $table Optional. If specified only the table name given will be generated. * Otherwise, all tables defined in the schema are generated. * @return string */ diff --git a/lib/Cake/Model/Datasource/Database/Sqlserver.php b/lib/Cake/Model/Datasource/Database/Sqlserver.php index 8bd9d7bac2b..e0c8238bd34 100644 --- a/lib/Cake/Model/Datasource/Database/Sqlserver.php +++ b/lib/Cake/Model/Datasource/Database/Sqlserver.php @@ -22,7 +22,7 @@ /** * Dbo driver for SQLServer * - * A Dbo driver for SQLServer 2008 and higher. Requires the `sqlsrv` + * A Dbo driver for SQLServer 2008 and higher. Requires the `sqlsrv` * and `pdo_sqlsrv` extensions to be enabled. * * @package Cake.Model.Datasource.Database @@ -51,7 +51,7 @@ class Sqlserver extends DboSource { public $endQuote = "]"; /** - * Creates a map between field aliases and numeric indexes. Workaround for the + * Creates a map between field aliases and numeric indexes. Workaround for the * SQL Server driver's 30-character column name limitation. * * @var array @@ -762,7 +762,7 @@ protected function _execute($sql, $params = array(), $prepareOptions = array()) * Generate a "drop table" statement for the given Schema object * * @param CakeSchema $schema An instance of a subclass of CakeSchema - * @param string $table Optional. If specified only the table name given will be generated. + * @param string $table Optional. If specified only the table name given will be generated. * Otherwise, all tables defined in the schema are generated. * @return string */ diff --git a/lib/Cake/Model/Datasource/DboSource.php b/lib/Cake/Model/Datasource/DboSource.php index 0d6410ac247..fcc1bf9d486 100644 --- a/lib/Cake/Model/Datasource/DboSource.php +++ b/lib/Cake/Model/Datasource/DboSource.php @@ -52,8 +52,8 @@ class DboSource extends DataSource { public $alias = 'AS '; /** - * Caches result from query parsing operations. Cached results for both DboSource::name() and - * DboSource::conditions() will be stored here. Method caching uses `md5()`. If you have + * Caches result from query parsing operations. Cached results for both DboSource::name() and + * DboSource::conditions() will be stored here. Method caching uses `md5()`. If you have * problems with collisions, set DboSource::$cacheMethods to false. * * @var array @@ -62,7 +62,7 @@ class DboSource extends DataSource { /** * Whether or not to cache the results of DboSource::name() and DboSource::conditions() - * into the memory cache. Set to false to disable the use of the memory cache. + * into the memory cache. Set to false to disable the use of the memory cache. * * @var boolean */ @@ -379,7 +379,7 @@ public function identifier($identifier) { } /** - * Returns an object to represent a database expression in a query. Expression objects + * Returns an object to represent a database expression in a query. Expression objects * are not sanitized or escaped. * * @param string $expression An arbitrary SQL expression to be inserted into a query. @@ -759,7 +759,7 @@ public function flushMethodCache() { } /** - * Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods. + * Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods. * Will retrieve a value from the cache if $value is null. * * If caching is disabled and a write is attempted, the $value will be returned. @@ -788,7 +788,7 @@ public function cacheMethod($method, $key, $value = null) { * Returns a quoted name of $data for use in an SQL statement. * Strips fields out of SQL functions before quoting. * - * Results of this method are stored in a memory cache. This improves performance, but + * Results of this method are stored in a memory cache. This improves performance, but * because the method uses a hashing algorithm it can have collisions. * Setting DboSource::$cacheMethods to false will disable the memory cache. * @@ -888,7 +888,7 @@ public function getLog($sorted = false, $clear = true) { /** * Outputs the contents of the queries log. If in a non-CLI environment the sql_log element - * will be rendered and output. If in a CLI environment, a plain text log is generated. + * will be rendered and output. If in a CLI environment, a plain text log is generated. * * @param boolean $sorted Get the queries sorted by time taken, defaults to false. * @return void @@ -1024,7 +1024,7 @@ public function create(Model $model, $fields = null, $values = null) { * @param Model $model A Model object that the query is for. * @param array $queryData An array of queryData information containing keys similar to Model::find() * @param integer $recursive Number of levels of association - * @return mixed boolean false on error/failure. An array of results on success. + * @return mixed boolean false on error/failure. An array of results on success. */ public function read(Model $model, $queryData = array(), $recursive = null) { $queryData = $this->_scrubQueryData($queryData); @@ -1164,7 +1164,7 @@ protected function _filterResults(&$results, Model $model, $filtered = array()) } /** - * Queries associations. Used to fetch results on recursive models. + * Queries associations. Used to fetch results on recursive models. * * @param Model $model Primary Model object * @param Model $linkModel Linked model that @@ -1740,7 +1740,7 @@ public function renderJoinStatement($data) { /** * Renders a final SQL statement by putting together the component parts in the correct order * - * @param string $type type of query being run. e.g select, create, update, delete, schema, alter. + * @param string $type type of query being run. e.g select, create, update, delete, schema, alter. * @param array $data Array of data to insert into the query. * @return string Rendered SQL expression to be run. */ @@ -2182,12 +2182,12 @@ public function lastInsertId($source = null) { /** * Creates a default set of conditions from the model if $conditions is null/empty. - * If conditions are supplied then they will be returned. If a model doesn't exist and no conditions + * If conditions are supplied then they will be returned. If a model doesn't exist and no conditions * were provided either null or false will be returned based on what was input. * * @param Model $model * @param string|array|boolean $conditions Array of conditions, conditions string, null or false. If an array of conditions, - * or string conditions those conditions will be returned. With other values the model's existence will be checked. + * or string conditions those conditions will be returned. With other values the model's existence will be checked. * If the model doesn't exist a null or false will be returned depending on the input value. * @param boolean $useAlias Use model aliases rather than table names when generating conditions * @return mixed Either null, false, $conditions or an array of default conditions to use. @@ -2376,11 +2376,11 @@ public function fields(Model $model, $alias = null, $fields = array(), $quote = } /** - * Creates a WHERE clause by parsing given conditions data. If an array or string - * conditions are provided those conditions will be parsed and quoted. If a boolean - * is given it will be integer cast as condition. Null will return 1 = 1. + * Creates a WHERE clause by parsing given conditions data. If an array or string + * conditions are provided those conditions will be parsed and quoted. If a boolean + * is given it will be integer cast as condition. Null will return 1 = 1. * - * Results of this method are stored in a memory cache. This improves performance, but + * Results of this method are stored in a memory cache. This improves performance, but * because the method uses a hashing algorithm it can have collisions. * Setting DboSource::$cacheMethods to false will disable the memory cache. * @@ -2422,7 +2422,7 @@ public function conditions($conditions, $quoteValues = true, $where = true, $mod } /** - * Creates a WHERE clause by parsing given conditions array. Used by DboSource::conditions(). + * Creates a WHERE clause by parsing given conditions array. Used by DboSource::conditions(). * * @param array $conditions Array or string of conditions * @param boolean $quoteValues If true, values should be quoted @@ -2889,8 +2889,8 @@ public function boolean($data, $quote = false) { * * @param string $table The table being inserted into. * @param array $fields The array of field/column names being inserted. - * @param array $values The array of values to insert. The values should - * be an array of rows. Each row should have values keyed by the column name. + * @param array $values The array of values to insert. The values should + * be an array of rows. Each row should have values keyed by the column name. * Each row must have the values in the same order as $fields. * @return boolean */ @@ -2934,7 +2934,7 @@ public function insertMulti($table, $fields, $values) { } /** - * Reset a sequence based on the MAX() value of $column. Useful + * Reset a sequence based on the MAX() value of $column. Useful * for resetting sequences after using insertMulti(). * * This method should be implemented by datasources that require sequences to be used. @@ -2960,7 +2960,7 @@ public function index($model) { * Generate a database-native schema for the given Schema object * * @param Model $schema An instance of a subclass of CakeSchema - * @param string $tableName Optional. If specified only the table name given will be generated. + * @param string $tableName Optional. If specified only the table name given will be generated. * Otherwise, all tables defined in the schema are generated. * @return string */ @@ -3035,7 +3035,7 @@ public function alterSchema($compare, $table = null) { * Generate a "drop table" statement for the given Schema object * * @param CakeSchema $schema An instance of a subclass of CakeSchema - * @param string $table Optional. If specified only the table name given will be generated. + * @param string $table Optional. If specified only the table name given will be generated. * Otherwise, all tables defined in the schema are generated. * @return string */ diff --git a/lib/Cake/Model/Datasource/Session/CacheSession.php b/lib/Cake/Model/Datasource/Session/CacheSession.php index c9f14e464ee..da6945bbf07 100644 --- a/lib/Cake/Model/Datasource/Session/CacheSession.php +++ b/lib/Cake/Model/Datasource/Session/CacheSession.php @@ -1,6 +1,6 @@ 'posts', 'name' => 'Post', 'ds' => 'connection2')); * }}} * - * Would create a model attached to the posts table on connection2. Dynamic model creation is useful + * Would create a model attached to the posts table on connection2. Dynamic model creation is useful * when you want a model object that contains no associations or attached behaviors. * * @param integer|string|array $id Set this ID for this model on startup, can also be an array of options, see above. @@ -1408,7 +1408,7 @@ public function hasField($name, $checkVirtual = false) { } /** - * Check that a method is callable on a model. This will check both the model's own methods, its + * Check that a method is callable on a model. This will check both the model's own methods, its * inherited methods and methods that could be callable through behaviors. * * @param string $method The method to be called. @@ -1469,7 +1469,7 @@ public function getVirtualField($field = null) { * for those fields that are not defined in $data, and clearing previous validation errors. * Especially helpful for saving data in loops. * - * @param boolean|array $data Optional data array to assign to the model after it is created. If null or false, + * @param boolean|array $data Optional data array to assign to the model after it is created. If null or false, * schema data defaults are not merged. * @param boolean $filterKey If true, overwrites any primary key input with an empty value * @return array The current Model::data; after merging $data and/or defaults from database @@ -1971,7 +1971,7 @@ public function updateCounterCache($keys = array(), $created = false) { } /** - * Helper method for Model::updateCounterCache(). Checks the fields to be updated for + * Helper method for Model::updateCounterCache(). Checks the fields to be updated for * * @param array $data The fields of the record that will be updated * @return array Returns updated foreign key values, along with an 'old' key containing the old @@ -2626,7 +2626,7 @@ public function hasAny($conditions = null) { * }}} * * In addition to the standard query keys above, you can provide Datasource, and behavior specific - * keys. For example, when using a SQL based datasource you can use the joins key to specify additional + * keys. For example, when using a SQL based datasource you can use the joins key to specify additional * joins that should be part of the query. * * {{{ @@ -2735,7 +2735,7 @@ public function buildQuery($type = 'first', $query = array()) { } /** - * Handles the before/after filter logic for find('first') operations. Only called by Model::find(). + * Handles the before/after filter logic for find('first') operations. Only called by Model::find(). * * @param string $state Either "before" or "after" * @param array $query @@ -2756,7 +2756,7 @@ protected function _findFirst($state, $query, $results = array()) { } /** - * Handles the before/after filter logic for find('count') operations. Only called by Model::find(). + * Handles the before/after filter logic for find('count') operations. Only called by Model::find(). * * @param string $state Either "before" or "after" * @param array $query @@ -2802,7 +2802,7 @@ protected function _findCount($state, $query, $results = array()) { } /** - * Handles the before/after filter logic for find('list') operations. Only called by Model::find(). + * Handles the before/after filter logic for find('list') operations. Only called by Model::find(). * * @param string $state Either "before" or "after" * @param array $query @@ -3039,7 +3039,7 @@ public function query($sql) { * Returns true if all fields pass validation. Will validate hasAndBelongsToMany associations * that use the 'with' key as well. Since _saveMulti is incapable of exiting a save operation. * - * Will validate the currently set data. Use Model::set() or Model::create() to set the active data. + * Will validate the currently set data. Use Model::set() or Model::create() to set the active data. * * @param array $options An optional array of custom options to be made available in the beforeValidate callback * @return boolean True if there are no errors @@ -3273,7 +3273,7 @@ public function getAssociated($type = null) { } /** - * Gets the name and fields to be used by a join model. This allows specifying join fields + * Gets the name and fields to be used by a join model. This allows specifying join fields * in the association definition. * * @param string|array $assoc The model to be joined diff --git a/lib/Cake/Model/ModelBehavior.php b/lib/Cake/Model/ModelBehavior.php index 25920e63dc1..cf884f44a21 100644 --- a/lib/Cake/Model/ModelBehavior.php +++ b/lib/Cake/Model/ModelBehavior.php @@ -22,13 +22,13 @@ /** * Model behavior base class. * - * Defines the Behavior interface, and contains common model interaction functionality. Behaviors + * Defines the Behavior interface, and contains common model interaction functionality. Behaviors * allow you to simulate mixins, and create reusable blocks of application logic, that can be reused across - * several models. Behaviors also provide a way to hook into model callbacks and augment their behavior. + * several models. Behaviors also provide a way to hook into model callbacks and augment their behavior. * * ### Mixin methods * - * Behaviors can provide mixin like features by declaring public methods. These methods should expect + * Behaviors can provide mixin like features by declaring public methods. These methods should expect * the model instance to be shifted onto the parameter list. * * {{{ @@ -41,9 +41,9 @@ * * ### Mapped methods * - * Behaviors can also define mapped methods. Mapped methods use pattern matching for method invocation. This - * allows you to create methods similar to Model::findAllByXXX methods on your behaviors. Mapped methods need to - * be declared in your behaviors `$mapMethods` array. The method signature for a mapped method is slightly different + * Behaviors can also define mapped methods. Mapped methods use pattern matching for method invocation. This + * allows you to create methods similar to Model::findAllByXXX methods on your behaviors. Mapped methods need to + * be declared in your behaviors `$mapMethods` array. The method signature for a mapped method is slightly different * than a normal behavior mixin method. * * {{{ @@ -54,8 +54,8 @@ * } * }}} * - * The above will map every doXXX() method call to the behavior. As you can see, the model is - * still the first parameter, but the called method name will be the 2nd parameter. This allows + * The above will map every doXXX() method call to the behavior. As you can see, the model is + * still the first parameter, but the called method name will be the 2nd parameter. This allows * you to munge the method name for additional information, much like Model::findAllByXX. * * @package Cake.Model @@ -65,9 +65,9 @@ class ModelBehavior extends Object { /** - * Contains configuration settings for use with individual model objects. This + * Contains configuration settings for use with individual model objects. This * is used because if multiple models use this Behavior, each will use the same - * object instance. Individual model settings should be stored as an + * object instance. Individual model settings should be stored as an * associative array, keyed off of the model name. * * @var array @@ -78,7 +78,7 @@ class ModelBehavior extends Object { /** * Allows the mapping of preg-compatible regular expressions to public or * private methods in this class, where the array key is a /-delimited regular - * expression, and the value is a class method. Similar to the functionality of + * expression, and the value is a class method. Similar to the functionality of * the findBy* / findAllBy* magic methods. * * @var array @@ -96,7 +96,7 @@ public function setup(Model $model, $config = array()) { } /** - * Clean up any initialization this behavior has done on a model. Called when a behavior is dynamically + * Clean up any initialization this behavior has done on a model. Called when a behavior is dynamically * detached from a model using Model::detach(). * * @param Model $model Model using this behavior @@ -111,7 +111,7 @@ public function cleanup(Model $model) { /** * beforeFind can be used to cancel find operations, or modify the query that will be executed. - * By returning null/false you can abort a find. By returning an array you can modify/replace the query + * By returning null/false you can abort a find. By returning an array you can modify/replace the query * that is going to be run. * * @param Model $model Model using this behavior @@ -136,7 +136,7 @@ public function afterFind(Model $model, $results, $primary) { /** * beforeValidate is called before a model is validated, you can use this callback to - * add behavior validation rules into a models validate array. Returning false + * add behavior validation rules into a models validate array. Returning false * will allow you to make the validation fail. * * @param Model $model Model using this behavior @@ -158,7 +158,7 @@ public function afterValidate(Model $model) { } /** - * beforeSave is called before a model is saved. Returning false from a beforeSave callback + * beforeSave is called before a model is saved. Returning false from a beforeSave callback * will abort the save operation. * * @param Model $model Model using this behavior @@ -181,7 +181,7 @@ public function afterSave(Model $model, $created) { /** * Before delete is called before any delete occurs on the attached model, but after the model's - * beforeDelete is called. Returning false from a beforeDelete will abort the delete. + * beforeDelete is called. Returning false from a beforeDelete will abort the delete. * * @param Model $model Model using this behavior * @param boolean $cascade If true records that depend on this record will also be deleted @@ -213,7 +213,7 @@ public function onError(Model $model, $error) { /** * If $model's whitelist property is non-empty, $field will be added to it. * Note: this method should *only* be used in beforeValidate or beforeSave to ensure - * that it only modifies the whitelist for the current save operation. Also make sure + * that it only modifies the whitelist for the current save operation. Also make sure * you explicitly set the value of the field which you are allowing. * * @param Model $model Model using this behavior diff --git a/lib/Cake/Model/ModelValidator.php b/lib/Cake/Model/ModelValidator.php index 46291591617..b37e637ef69 100644 --- a/lib/Cake/Model/ModelValidator.php +++ b/lib/Cake/Model/ModelValidator.php @@ -90,7 +90,7 @@ public function __construct(Model $Model) { * Returns true if all fields pass validation. Will validate hasAndBelongsToMany associations * that use the 'with' key as well. Since `Model::_saveMulti` is incapable of exiting a save operation. * - * Will validate the currently set data. Use `Model::set()` or `Model::create()` to set the active data. + * Will validate the currently set data. Use `Model::set()` or `Model::create()` to set the active data. * * @param array $options An optional array of custom options to be made available in the beforeValidate callback * @return boolean True if there are no errors diff --git a/lib/Cake/Model/Permission.php b/lib/Cake/Model/Permission.php index 623db1d2242..4aad6af8efc 100644 --- a/lib/Cake/Model/Permission.php +++ b/lib/Cake/Model/Permission.php @@ -90,12 +90,12 @@ public function check($aro, $aco, $action = "*") { $acoPath = $this->Aco->node($aco); if (!$aroPath || !$acoPath) { - trigger_error(__d('cake_dev', "DbAcl::check() - Failed ARO/ACO node lookup in permissions check. Node references:\nAro: ") . print_r($aro, true) . "\nAco: " . print_r($aco, true), E_USER_WARNING); + trigger_error(__d('cake_dev', "DbAcl::check() - Failed ARO/ACO node lookup in permissions check. Node references:\nAro: ") . print_r($aro, true) . "\nAco: " . print_r($aco, true), E_USER_WARNING); return false; } if (!$acoPath) { - trigger_error(__d('cake_dev', "DbAcl::check() - Failed ACO node lookup in permissions check. Node references:\nAro: ") . print_r($aro, true) . "\nAco: " . print_r($aco, true), E_USER_WARNING); + trigger_error(__d('cake_dev', "DbAcl::check() - Failed ACO node lookup in permissions check. Node references:\nAro: ") . print_r($aro, true) . "\nAco: " . print_r($aco, true), E_USER_WARNING); return false; } diff --git a/lib/Cake/Network/CakeRequest.php b/lib/Cake/Network/CakeRequest.php index 8aa3343fc20..3441b81412a 100644 --- a/lib/Cake/Network/CakeRequest.php +++ b/lib/Cake/Network/CakeRequest.php @@ -43,8 +43,8 @@ class CakeRequest implements ArrayAccess { ); /** - * Array of POST data. Will contain form data as well as uploaded files. - * Inputs prefixed with 'data' will have the data prefix removed. If there is + * Array of POST data. Will contain form data as well as uploaded files. + * Inputs prefixed with 'data' will have the data prefix removed. If there is * overlap between an input prefixed with data and one without, the 'data' prefixed * value will take precedence. * @@ -115,7 +115,7 @@ class CakeRequest implements ArrayAccess { ); /** - * Copy of php://input. Since this stream can only be read once in most SAPI's + * Copy of php://input. Since this stream can only be read once in most SAPI's * keep a copy of it so users don't need to know about that detail. * * @var string @@ -125,7 +125,7 @@ class CakeRequest implements ArrayAccess { /** * Constructor * - * @param string $url Trimmed url string to use. Should not contain the application base path. + * @param string $url Trimmed url string to use. Should not contain the application base path. * @param boolean $parseEnvironment Set to false to not auto parse the environment. ie. GET, POST and FILES. */ public function __construct($url = null, $parseEnvironment = true) { @@ -220,8 +220,8 @@ protected function _processGet() { } /** - * Get the request uri. Looks in PATH_INFO first, as this is the exact value we need prepared - * by PHP. Following that, REQUEST_URI, PHP_SELF, HTTP_X_REWRITE_URL and argv are checked in that order. + * Get the request uri. Looks in PATH_INFO first, as this is the exact value we need prepared + * by PHP. Following that, REQUEST_URI, PHP_SELF, HTTP_X_REWRITE_URL and argv are checked in that order. * Each of these server variables have the base path, and query strings stripped off * * @return string URI The CakePHP request path that is being accessed. @@ -362,7 +362,7 @@ protected function _processFileData($path, $data, $field) { * Get the IP the client is using, or says they are using. * * @param boolean $safe Use safe = false when you think the user might manipulate their HTTP_CLIENT_IP - * header. Setting $safe = false will will also look at HTTP_X_FORWARDED_FOR + * header. Setting $safe = false will will also look at HTTP_X_FORWARDED_FOR * @return string The client IP. */ public function clientIp($safe = true) { @@ -460,8 +460,8 @@ public function __isset($name) { } /** - * Check whether or not a Request is a certain type. Uses the built in detection rules - * as well as additional rules defined with CakeRequest::addDetector(). Any detector can be called + * Check whether or not a Request is a certain type. Uses the built in detection rules + * as well as additional rules defined with CakeRequest::addDetector(). Any detector can be called * as `is($type)` or `is$Type()`. * * @param string $type The type of request you want to check. @@ -515,14 +515,14 @@ public function is($type) { * * ### Option based comparison * - * Option based comparisons use a list of options to create a regular expression. Subsequent calls + * Option based comparisons use a list of options to create a regular expression. Subsequent calls * to add an already defined options detector will merge the options. * * e.g `addDetector('mobile', array('env' => 'HTTP_USER_AGENT', 'options' => array('Fennec')));` * * ### Callback detectors * - * Callback detectors allow you to provide a 'callback' type to handle the check. The callback will + * Callback detectors allow you to provide a 'callback' type to handle the check. The callback will * receive the request object as its only parameter. * * e.g `addDetector('custom', array('callback' => array('SomeClass', 'somemethod')));` @@ -534,7 +534,7 @@ public function is($type) { * e.g `addDetector('post', array('param' => 'requested', 'value' => 1)` * * @param string $name The name of the detector. - * @param array $options The options for the detector definition. See above. + * @param array $options The options for the detector definition. See above. * @return void */ public function addDetector($name, $options) { @@ -558,7 +558,7 @@ public function addParams($params) { } /** - * Add paths to the requests' paths vars. This will overwrite any existing paths. + * Add paths to the requests' paths vars. This will overwrite any existing paths. * Provides an easy way to modify, here, webroot and base. * * @param array $paths Array of paths to merge in @@ -574,7 +574,7 @@ public function addPaths($paths) { } /** - * Get the value of the current requests url. Will include named parameters and querystring arguments. + * Get the value of the current requests url. Will include named parameters and querystring arguments. * * @param boolean $base Include the base path, set to false to trim the base path off. * @return string the current request url including query string args. @@ -670,7 +670,7 @@ public function subdomains($tldLength = 1) { * This method will order the returned content types by the preference values indicated * by the client. * - * @param string $type The content type to check for. Leave null to get all types a client accepts. + * @param string $type The content type to check for. Leave null to get all types a client accepts. * @return mixed Either an array of all the types the client accepts or a boolean if they accept the * provided type. */ @@ -761,7 +761,7 @@ protected static function _parseAcceptWithQualifier($header) { } /** - * Provides a read accessor for `$this->query`. Allows you + * Provides a read accessor for `$this->query`. Allows you * to use a syntax similar to `CakeSession` for reading url query data. * * @param string $name Query string variable name @@ -772,7 +772,7 @@ public function query($name) { } /** - * Provides a read/write accessor for `$this->data`. Allows you + * Provides a read/write accessor for `$this->data`. Allows you * to use a syntax similar to `CakeSession` for reading post data. * * ## Reading values. diff --git a/lib/Cake/Network/CakeResponse.php b/lib/Cake/Network/CakeResponse.php index e7e3eb5c78d..44689b0e281 100644 --- a/lib/Cake/Network/CakeResponse.php +++ b/lib/Cake/Network/CakeResponse.php @@ -1101,7 +1101,7 @@ public function length($bytes = null) { * is marked as so accordingly so the client can be informed of that. * * In order to mark a response as not modified, you need to set at least - * the Last-Modified etag response header before calling this method. Otherwise + * the Last-Modified etag response header before calling this method. Otherwise * a comparison will not be possible. * * @param CakeRequest $request Request object @@ -1128,7 +1128,7 @@ public function checkNotModified(CakeRequest $request) { } /** - * String conversion. Fetches the response body as a string. + * String conversion. Fetches the response body as a string. * Does *not* send headers. * * @return string diff --git a/lib/Cake/Network/Email/CakeEmail.php b/lib/Cake/Network/Email/CakeEmail.php index c096a975569..95af4e29753 100644 --- a/lib/Cake/Network/Email/CakeEmail.php +++ b/lib/Cake/Network/Email/CakeEmail.php @@ -1507,7 +1507,7 @@ protected function _render($content) { /** * Gets the text body types that are in this email message * - * @return array Array of types. Valid types are 'text' and 'html' + * @return array Array of types. Valid types are 'text' and 'html' */ protected function _getTypes() { $types = array($this->_emailFormat); diff --git a/lib/Cake/Network/Http/HttpSocket.php b/lib/Cake/Network/Http/HttpSocket.php index b3c268476a4..5b0e12fc804 100644 --- a/lib/Cake/Network/Http/HttpSocket.php +++ b/lib/Cake/Network/Http/HttpSocket.php @@ -165,7 +165,7 @@ public function __construct($config = array()) { /** * Set authentication settings. * - * Accepts two forms of parameters. If all you need is a username + password, as with + * Accepts two forms of parameters. If all you need is a username + password, as with * Basic authentication you can do the following: * * {{{ @@ -651,7 +651,7 @@ protected function _configUri($uri = null) { } /** - * Configure the socket's context. Adds in configuration + * Configure the socket's context. Adds in configuration * that can not be declared in the class definition. * * @param string $host The host you're connecting to. diff --git a/lib/Cake/Routing/Dispatcher.php b/lib/Cake/Routing/Dispatcher.php index 3f891f32b67..1187ef986e1 100644 --- a/lib/Cake/Routing/Dispatcher.php +++ b/lib/Cake/Routing/Dispatcher.php @@ -32,8 +32,8 @@ App::uses('CakeEventListener', 'Event'); /** - * Dispatcher converts Requests into controller actions. It uses the dispatched Request - * to locate and load the correct controller. If found, the requested action is called on + * Dispatcher converts Requests into controller actions. It uses the dispatched Request + * to locate and load the correct controller. If found, the requested action is called on * the controller. * * @package Cake.Routing @@ -122,9 +122,9 @@ protected function _attachFilters($manager) { * Dispatches and invokes given Request, handing over control to the involved controller. If the controller is set * to autoRender, via Controller::$autoRender, then Dispatcher will render the view. * - * Actions in CakePHP can be any public method on a controller, that is not declared in Controller. If you + * Actions in CakePHP can be any public method on a controller, that is not declared in Controller. If you * want controller methods to be public and in-accessible by URL, then prefix them with a `_`. - * For example `public function _loadPosts() { }` would not be accessible via URL. Private and protected methods + * For example `public function _loadPosts() { }` would not be accessible via URL. Private and protected methods * are also not accessible via URL. * * If no controller of given name can be found, invoke() will throw an exception. diff --git a/lib/Cake/Routing/Route/CakeRoute.php b/lib/Cake/Routing/Route/CakeRoute.php index 83d822f7b83..1d31e9ae1cb 100644 --- a/lib/Cake/Routing/Route/CakeRoute.php +++ b/lib/Cake/Routing/Route/CakeRoute.php @@ -17,7 +17,7 @@ * A single Route used by the Router to connect requests to * parameter maps. * - * Not normally created as a standalone. Use Router::connect() to create + * Not normally created as a standalone. Use Router::connect() to create * Routes for your application. * * @package Cake.Routing.Route @@ -69,7 +69,7 @@ class CakeRoute { protected $_compiledRoute = null; /** - * HTTP header shortcut map. Used for evaluating header-based route expressions. + * HTTP header shortcut map. Used for evaluating header-based route expressions. * * @var array */ @@ -102,7 +102,7 @@ public function compiled() { } /** - * Compiles the route's regular expression. Modifies defaults property so all necessary keys are set + * Compiles the route's regular expression. Modifies defaults property so all necessary keys are set * and populates $this->names with the named routing elements. * * @return array Returns a string regular expression of the compiled route. @@ -116,7 +116,7 @@ public function compile() { } /** - * Builds a route regular expression. Uses the template, defaults and options + * Builds a route regular expression. Uses the template, defaults and options * properties to compile a regular expression that can be used to parse request strings. * * @return void @@ -260,7 +260,7 @@ public function parse($url) { * Parse passed and Named parameters into a list of passed args, and a hash of named parameters. * The local and global configuration for named parameters will be used. * - * @param string $args A string with the passed & named params. eg. /1/page:2 + * @param string $args A string with the passed & named params. eg. /1/page:2 * @param string $context The current route context, which should contain controller/action keys. * @return array Array of ($pass, $named) */ @@ -378,8 +378,8 @@ public function persistParams($url, $params) { } /** - * Attempt to match a url array. If the url matches the route parameters and settings, then - * return a generated string url. If the url doesn't match the route parameters, false will be returned. + * Attempt to match a url array. If the url matches the route parameters and settings, then + * return a generated string url. If the url doesn't match the route parameters, false will be returned. * This method handles the reverse routing or conversion of url arrays into string urls. * * @param array $url An array of parameters to check matching with. diff --git a/lib/Cake/Routing/Router.php b/lib/Cake/Routing/Router.php index 4b6dafe8ab3..87d2166316f 100644 --- a/lib/Cake/Routing/Router.php +++ b/lib/Cake/Routing/Router.php @@ -21,21 +21,21 @@ App::uses('CakeRoute', 'Routing/Route'); /** - * Parses the request URL into controller, action, and parameters. Uses the connected routes - * to match the incoming url string to parameters that will allow the request to be dispatched. Also - * handles converting parameter lists into url strings, using the connected routes. Routing allows you to decouple + * Parses the request URL into controller, action, and parameters. Uses the connected routes + * to match the incoming url string to parameters that will allow the request to be dispatched. Also + * handles converting parameter lists into url strings, using the connected routes. Routing allows you to decouple * the way the world interacts with your application (urls) and the implementation (controllers and actions). * * ### Connecting routes * - * Connecting routes is done using Router::connect(). When parsing incoming requests or reverse matching - * parameters, routes are enumerated in the order they were connected. You can modify the order of connected - * routes using Router::promote(). For more information on routes and how to connect them see Router::connect(). + * Connecting routes is done using Router::connect(). When parsing incoming requests or reverse matching + * parameters, routes are enumerated in the order they were connected. You can modify the order of connected + * routes using Router::promote(). For more information on routes and how to connect them see Router::connect(). * * ### Named parameters * - * Named parameters allow you to embed key:value pairs into path segments. This allows you create hash - * structures using urls. You can define how named parameters work in your application using Router::connectNamed() + * Named parameters allow you to embed key:value pairs into path segments. This allows you create hash + * structures using urls. You can define how named parameters work in your application using Router::connectNamed() * * @package Cake.Routing */ @@ -71,7 +71,7 @@ class Router { protected static $_parseExtensions = false; /** - * List of valid extensions to parse from a URL. If null, any extension is allowed. + * List of valid extensions to parse from a URL. If null, any extension is allowed. * * @var array */ @@ -152,7 +152,7 @@ class Router { /** * Initial state is populated the first time reload() is called which is at the bottom - * of this file. This is a cheat as get_class_vars() returns the value of static vars even if they + * of this file. This is a cheat as get_class_vars() returns the value of static vars even if they * have changed. * * @var array @@ -237,7 +237,7 @@ public static function resourceMap($resourceMap = null) { /** * Connects a new Route in the router. * - * Routes are a way of connecting request urls to objects in your application. At their core routes + * Routes are a way of connecting request urls to objects in your application. At their core routes * are a set or regular expressions that are used to match requests to destinations. * * Examples: @@ -266,11 +266,11 @@ public static function resourceMap($resourceMap = null) { * $options offers four 'special' keys. `pass`, `named`, `persist` and `routeClass` * have special meaning in the $options array. * - * - `pass` is used to define which of the routed parameters should be shifted into the pass array. Adding a + * - `pass` is used to define which of the routed parameters should be shifted into the pass array. Adding a * parameter to pass will remove it from the regular route array. Ex. `'pass' => array('slug')` * - `persist` is used to define which route parameters should be automatically included when generating * new urls. You can override persistent parameters by redefining them in a url or remove them by - * setting the parameter to `false`. Ex. `'persist' => array('lang')` + * setting the parameter to `false`. Ex. `'persist' => array('lang')` * - `routeClass` is used to extend and change how individual routes parse requests and handle reverse routing, * via a custom routing class. Ex. `'routeClass' => 'SlugRoute'` * - `named` is used to configure named parameters at the route level. This key uses the same options @@ -293,7 +293,7 @@ public static function resourceMap($resourceMap = null) { * @param array $defaults An array describing the default route parameters. These parameters will be used by default * and can supply routing parameters that are not dynamic. See above. * @param array $options An array matching the named elements in the route to regular expressions which that - * element should match. Also contains additional parameters such as which routed parameters should be + * element should match. Also contains additional parameters such as which routed parameters should be * shifted into the passed arguments, supplying patterns for routing parameters and supplying the name of a * custom routing class. * @see routes @@ -349,7 +349,7 @@ public static function connect($route, $defaults = array(), $options = array()) * * `Router::redirect('/home/*', array('controller' => 'posts', 'action' => 'view', array('persist' => true)));` * - * Redirects /home/* to /posts/view and passes the parameters to /posts/view. Using an array as the + * Redirects /home/* to /posts/view and passes the parameters to /posts/view. Using an array as the * redirect destination allows you to use other routes to define where a url string should be redirected to. * * `Router::redirect('/posts/*', 'http://google.com', array('status' => 302));` @@ -359,13 +359,13 @@ public static function connect($route, $defaults = array(), $options = array()) * ### Options: * * - `status` Sets the HTTP status (default 301) - * - `persist` Passes the params to the redirected route, if it can. This is useful with greedy routes, - * routes that end in `*` are greedy. As you can remap urls and not loose any passed/named args. + * - `persist` Passes the params to the redirected route, if it can. This is useful with greedy routes, + * routes that end in `*` are greedy. As you can remap urls and not loose any passed/named args. * * @param string $route A string describing the template of the route * @param array $url A url to redirect to. Can be a string or a Cake array-based url * @param array $options An array matching the named elements in the route to regular expressions which that - * element should match. Also contains additional parameters such as which routed parameters should be + * element should match. Also contains additional parameters such as which routed parameters should be * shifted into the passed arguments. As well as supplying patterns for routing parameters. * @see routes * @return array Array of routes @@ -381,7 +381,7 @@ public static function redirect($route, $url, $options = array()) { /** * Specifies what named parameters CakePHP should be parsing out of incoming urls. By default - * CakePHP will parse every named parameter out of incoming URLs. However, if you want to take more + * CakePHP will parse every named parameter out of incoming URLs. However, if you want to take more * control over how named parameters are parsed you can use one of the following setups: * * Do not parse any named parameters: @@ -420,11 +420,11 @@ public static function redirect($route, $url, $options = array()) { * * ### Options * - * - `greedy` Setting this to true will make Router parse all named params. Setting it to false will + * - `greedy` Setting this to true will make Router parse all named params. Setting it to false will * parse only the connected named params. * - `default` Set this to true to merge in the default set of named parameters. * - `reset` Set to true to clear existing rules and start fresh. - * - `separator` Change the string used to separate the key & value in a named parameter. Defaults to `:` + * - `separator` Change the string used to separate the key & value in a named parameter. Defaults to `:` * * @param array $named A list of named parameters. Key value pairs are accepted where values are * either regex strings to match, or arrays as seen above. @@ -474,15 +474,15 @@ public static function namedConfig() { } /** - * Creates REST resource routes for the given controller(s). When creating resource routes + * Creates REST resource routes for the given controller(s). When creating resource routes * for a plugin, by default the prefix will be changed to the lower_underscore version of the plugin - * name. By providing a prefix you can override this behavior. + * name. By providing a prefix you can override this behavior. * * ### Options: * - * - 'id' - The regular expression fragment to use when matching IDs. By default, matches + * - 'id' - The regular expression fragment to use when matching IDs. By default, matches * integer values and UUIDs. - * - 'prefix' - URL prefix to use for the generated routes. Defaults to '/'. + * - 'prefix' - URL prefix to use for the generated routes. Defaults to '/'. * * @param string|array $controller A controller name or array of controller names (i.e. "Posts" or "ListItems") * @param array $options Options to use when generating REST routes @@ -533,7 +533,7 @@ public static function prefixes() { } /** - * Parses given URL string. Returns 'routing' parameters for that url. + * Parses given URL string. Returns 'routing' parameters for that url. * * @param string $url URL to be parsed * @return array Parsed elements from URL @@ -608,8 +608,8 @@ protected static function _parseExtension($url) { * parameters as the current request parameters that are merged with url arrays * created later in the request. * - * Nested requests will create a stack of requests. You can remove requests using - * Router::popRequest(). This is done automatically when using Object::requestAction(). + * Nested requests will create a stack of requests. You can remove requests using + * Router::popRequest(). This is done automatically when using Object::requestAction(). * * Will accept either a CakeRequest object or an array of arrays. Support for * accepting arrays may be removed in the future. @@ -630,7 +630,7 @@ public static function setRequestInfo($request) { } /** - * Pops a request off of the request stack. Used when doing requestAction + * Pops a request off of the request stack. Used when doing requestAction * * @return CakeRequest The request removed from the stack. * @see Router::setRequestInfo() @@ -702,7 +702,7 @@ public static function getPaths($current = false) { } /** - * Reloads default Router settings. Resets all class variables and + * Reloads default Router settings. Resets all class variables and * removes all connected routes. * * @return void @@ -1042,8 +1042,8 @@ public static function reverse($params, $full = false) { } /** - * Normalizes a URL for purposes of comparison. Will strip the base path off - * and replace any double /'s. It will not unify the casing and underscoring + * Normalizes a URL for purposes of comparison. Will strip the base path off + * and replace any double /'s. It will not unify the casing and underscoring * of the input value. * * @param array|string $url URL to normalize Either an array or a string url. diff --git a/lib/Cake/Test/Case/Console/Command/Task/ModelTaskTest.php b/lib/Cake/Test/Case/Console/Command/Task/ModelTaskTest.php index 9f7479d29c4..6f6610b8137 100644 --- a/lib/Cake/Test/Case/Console/Command/Task/ModelTaskTest.php +++ b/lib/Cake/Test/Case/Console/Command/Task/ModelTaskTest.php @@ -62,7 +62,7 @@ public function setUp() { } /** - * Setup a mock that has out mocked. Normally this is not used as it makes $this->at() really tricky. + * Setup a mock that has out mocked. Normally this is not used as it makes $this->at() really tricky. * * @return void */ diff --git a/lib/Cake/Test/Case/Console/Command/Task/ProjectTaskTest.php b/lib/Cake/Test/Case/Console/Command/Task/ProjectTaskTest.php index b9fbe469bed..df77ee3af08 100644 --- a/lib/Cake/Test/Case/Console/Command/Task/ProjectTaskTest.php +++ b/lib/Cake/Test/Case/Console/Command/Task/ProjectTaskTest.php @@ -150,7 +150,7 @@ public function testExecuteWithAbsolutePath() { } /** - * test bake with CakePHP on the include path. The constants should remain commented out. + * test bake with CakePHP on the include path. The constants should remain commented out. * * @return void */ diff --git a/lib/Cake/Test/Case/Console/Command/Task/TemplateTaskTest.php b/lib/Cake/Test/Case/Console/Command/Task/TemplateTaskTest.php index d2df394bb11..896192e44d7 100644 --- a/lib/Cake/Test/Case/Console/Command/Task/TemplateTaskTest.php +++ b/lib/Cake/Test/Case/Console/Command/Task/TemplateTaskTest.php @@ -93,8 +93,8 @@ public function testFindingInstalledThemesForBake() { } /** - * test getting the correct theme name. Ensure that with only one theme, or a theme param - * that the user is not bugged. If there are more, find and return the correct theme name + * test getting the correct theme name. Ensure that with only one theme, or a theme param + * that the user is not bugged. If there are more, find and return the correct theme name * * @return void */ diff --git a/lib/Cake/Test/Case/Console/Command/Task/TestTaskTest.php b/lib/Cake/Test/Case/Console/Command/Task/TestTaskTest.php index 6fad8069eaf..e852fdcaf39 100644 --- a/lib/Cake/Test/Case/Console/Command/Task/TestTaskTest.php +++ b/lib/Cake/Test/Case/Console/Command/Task/TestTaskTest.php @@ -425,7 +425,7 @@ public function testGetRealClassname() { } /** - * test baking files. The conditionally run tests are known to fail in PHP4 + * test baking files. The conditionally run tests are known to fail in PHP4 * as PHP4 classnames are all lower case, breaking the plugin path inflection. * * @return void diff --git a/lib/Cake/Test/Case/Controller/Component/AuthComponentTest.php b/lib/Cake/Test/Case/Controller/Component/AuthComponentTest.php index d55c62c3543..8153bfe6c46 100644 --- a/lib/Cake/Test/Case/Controller/Component/AuthComponentTest.php +++ b/lib/Cake/Test/Case/Controller/Component/AuthComponentTest.php @@ -418,7 +418,7 @@ public function testLogin() { /** * test that being redirected to the login page, with no post data does - * not set the session value. Saving the session value in this circumstance + * not set the session value. Saving the session value in this circumstance * can cause the user to be redirected to an already public page. * * @return void diff --git a/lib/Cake/Test/Case/Model/ModelIntegrationTest.php b/lib/Cake/Test/Case/Model/ModelIntegrationTest.php index 7fc2f5041f0..14d859ca865 100644 --- a/lib/Cake/Test/Case/Model/ModelIntegrationTest.php +++ b/lib/Cake/Test/Case/Model/ModelIntegrationTest.php @@ -274,7 +274,7 @@ public function testFindWithJoinsOption() { } /** - * Tests cross database joins. Requires $test and $test2 to both be set in DATABASE_CONFIG + * Tests cross database joins. Requires $test and $test2 to both be set in DATABASE_CONFIG * NOTE: When testing on MySQL, you must set 'persistent' => false on *both* database connections, * or one connection will step on the other. */ @@ -284,7 +284,7 @@ public function testCrossDatabaseJoins() { $skip = (!isset($config['test']) || !isset($config['test2'])); if ($skip) { $this->markTestSkipped('Primary and secondary test databases not configured, skipping cross-database - join tests. To run theses tests defined $test and $test2 in your database configuration.' + join tests. To run theses tests defined $test and $test2 in your database configuration.' ); } @@ -815,7 +815,7 @@ public function testHABTMKeepExistingWithThreeDbs() { $this->skipIf($this->db instanceof Sqlite, 'This test is not compatible with Sqlite.'); $this->skipIf( !isset($config['test']) || !isset($config['test2']) || !isset($config['test_database_three']), - 'Primary, secondary, and tertiary test databases not configured, skipping test. To run this test define $test, $test2, and $test_database_three in your database configuration.' + 'Primary, secondary, and tertiary test databases not configured, skipping test. To run this test define $test, $test2, and $test_database_three in your database configuration.' ); $this->loadFixtures('Player', 'Guild', 'GuildsPlayer', 'Armor', 'ArmorsPlayer'); @@ -2367,7 +2367,7 @@ public function testMultischemaFixture() { $config = ConnectionManager::enumConnectionObjects(); $this->skipIf($this->db instanceof Sqlite, 'This test is not compatible with Sqlite.'); $this->skipIf(!isset($config['test']) || !isset($config['test2']), - 'Primary and secondary test databases not configured, skipping cross-database join tests. To run these tests define $test and $test2 in your database configuration.' + 'Primary and secondary test databases not configured, skipping cross-database join tests. To run these tests define $test and $test2 in your database configuration.' ); $this->loadFixtures('Player', 'Guild', 'GuildsPlayer'); @@ -2397,7 +2397,7 @@ public function testMultischemaFixtureWithThreeDatabases() { $this->skipIf($this->db instanceof Sqlite, 'This test is not compatible with Sqlite.'); $this->skipIf( !isset($config['test']) || !isset($config['test2']) || !isset($config['test_database_three']), - 'Primary, secondary, and tertiary test databases not configured, skipping test. To run this test define $test, $test2, and $test_database_three in your database configuration.' + 'Primary, secondary, and tertiary test databases not configured, skipping test. To run this test define $test, $test2, and $test_database_three in your database configuration.' ); $this->loadFixtures('Player', 'Guild', 'GuildsPlayer', 'Armor', 'ArmorsPlayer'); diff --git a/lib/Cake/Test/Case/Model/ModelValidationTest.php b/lib/Cake/Test/Case/Model/ModelValidationTest.php index 743b965d308..fec821495dd 100644 --- a/lib/Cake/Test/Case/Model/ModelValidationTest.php +++ b/lib/Cake/Test/Case/Model/ModelValidationTest.php @@ -167,7 +167,7 @@ public function testInvalidFieldsWithFieldListParams() { } /** - * Test that invalidFields() integrates well with save(). And that fieldList can be an empty type. + * Test that invalidFields() integrates well with save(). And that fieldList can be an empty type. * * @return void */ diff --git a/lib/Cake/Test/Case/TestSuite/CakeTestFixtureTest.php b/lib/Cake/Test/Case/TestSuite/CakeTestFixtureTest.php index ab26dac6e66..71bf3e915c4 100644 --- a/lib/Cake/Test/Case/TestSuite/CakeTestFixtureTest.php +++ b/lib/Cake/Test/Case/TestSuite/CakeTestFixtureTest.php @@ -352,7 +352,7 @@ public function testImport() { } /** - * test that importing with records works. Make sure to try with postgres as its + * test that importing with records works. Make sure to try with postgres as its * handling of aliases is a workaround at best. * * @return void diff --git a/lib/Cake/Test/Case/View/Helper/FormHelperTest.php b/lib/Cake/Test/Case/View/Helper/FormHelperTest.php index 798e7d3ec2f..e719b09ad3a 100644 --- a/lib/Cake/Test/Case/View/Helper/FormHelperTest.php +++ b/lib/Cake/Test/Case/View/Helper/FormHelperTest.php @@ -1070,7 +1070,7 @@ public function testSecuritySubmitImageName() { /** * testFormSecurityMultipleInputFields method * - * Test secure form creation with multiple row creation. Checks hidden, text, checkbox field types + * Test secure form creation with multiple row creation. Checks hidden, text, checkbox field types * * @return void */ @@ -7881,7 +7881,7 @@ public function testBrokenness() { /* * #2 This is structurally identical to the test above (#1) - only the parent name has * changed, so we should expect the same select list data, just with a different name - * for the parent. As of #7117, this test fails because option 3 => 'Three' disappears. + * for the parent. As of #7117, this test fails because option 3 => 'Three' disappears. * This is where data corruption can occur, because when a select value is missing from * a list a form will substitute the first value in the list - without the user knowing. * If the optgroup name 'Parent' (above) is updated to 'Three' (below), this should not diff --git a/lib/Cake/Test/Case/View/Helper/PrototypeEngineHelperTest.php b/lib/Cake/Test/Case/View/Helper/PrototypeEngineHelperTest.php index 2df8cefa3ec..90674b77281 100644 --- a/lib/Cake/Test/Case/View/Helper/PrototypeEngineHelperTest.php +++ b/lib/Cake/Test/Case/View/Helper/PrototypeEngineHelperTest.php @@ -283,8 +283,8 @@ public function testSortable() { } /** - * test drag() method. Scriptaculous lacks the ability to take an Array of Elements - * in new Drag() when selection is a multiple type. Iterate over the array. + * test drag() method. Scriptaculous lacks the ability to take an Array of Elements + * in new Drag() when selection is a multiple type. Iterate over the array. * * @return void */ diff --git a/lib/Cake/Test/Case/View/HelperTest.php b/lib/Cake/Test/Case/View/HelperTest.php index 30a43d07879..f6d870b051f 100644 --- a/lib/Cake/Test/Case/View/HelperTest.php +++ b/lib/Cake/Test/Case/View/HelperTest.php @@ -556,7 +556,7 @@ public function testValueHabtmKeys() { } /** - * Ensure HTML escaping of url params. So link addresses are valid and not exploited + * Ensure HTML escaping of url params. So link addresses are valid and not exploited * * @return void */ diff --git a/lib/Cake/Test/test_app/Plugin/TestPlugin/Lib/Error/TestPluginExceptionRenderer.php b/lib/Cake/Test/test_app/Plugin/TestPlugin/Lib/Error/TestPluginExceptionRenderer.php index 785dc2b594e..f72ca82170c 100644 --- a/lib/Cake/Test/test_app/Plugin/TestPlugin/Lib/Error/TestPluginExceptionRenderer.php +++ b/lib/Cake/Test/test_app/Plugin/TestPlugin/Lib/Error/TestPluginExceptionRenderer.php @@ -2,7 +2,7 @@ /** * Exception Renderer * - * Provides Exception rendering features. Which allow exceptions to be rendered + * Provides Exception rendering features. Which allow exceptions to be rendered * as HTML pages. * * PHP 5 diff --git a/lib/Cake/TestSuite/CakeTestRunner.php b/lib/Cake/TestSuite/CakeTestRunner.php index e007fbf2086..2fa81006f1e 100644 --- a/lib/Cake/TestSuite/CakeTestRunner.php +++ b/lib/Cake/TestSuite/CakeTestRunner.php @@ -39,7 +39,7 @@ public function __construct($loader, $params) { } /** - * Actually run a suite of tests. Cake initializes fixtures here using the chosen fixture manager + * Actually run a suite of tests. Cake initializes fixtures here using the chosen fixture manager * * @param PHPUnit_Framework_Test $suite * @param array $arguments diff --git a/lib/Cake/TestSuite/CakeTestSuiteDispatcher.php b/lib/Cake/TestSuite/CakeTestSuiteDispatcher.php index 20adfbf909a..8c34ebba601 100644 --- a/lib/Cake/TestSuite/CakeTestSuiteDispatcher.php +++ b/lib/Cake/TestSuite/CakeTestSuiteDispatcher.php @@ -55,7 +55,7 @@ class CakeTestSuiteDispatcher { protected $_baseUrl; /** - * Base dir of the request. Used for accessing assets. + * Base dir of the request. Used for accessing assets. * * @var string */ @@ -117,7 +117,7 @@ public static function run() { } /** - * Checks that PHPUnit is installed. Will exit if it doesn't + * Checks that PHPUnit is installed. Will exit if it doesn't * * @return void */ diff --git a/lib/Cake/TestSuite/ControllerTestCase.php b/lib/Cake/TestSuite/ControllerTestCase.php index 3813716450f..3b323b90df9 100644 --- a/lib/Cake/TestSuite/ControllerTestCase.php +++ b/lib/Cake/TestSuite/ControllerTestCase.php @@ -196,16 +196,16 @@ public function __call($name, $arguments) { * * ### Options: * - * - `data` Will be used as the request data. If the `method` is GET, - * data will be used a GET params. If the `method` is POST, it will be used + * - `data` Will be used as the request data. If the `method` is GET, + * data will be used a GET params. If the `method` is POST, it will be used * as POST data. By setting `$options['data']` to a string, you can simulate XML or JSON * payloads to your controllers allowing you to test REST webservices. * - `method` POST or GET. Defaults to POST. - * - `return` Specify the return type you want. Choose from: + * - `return` Specify the return type you want. Choose from: * - `vars` Get the set view variables. * - `view` Get the rendered view, without a layout. * - `contents` Get the rendered view including the layout. - * - `result` Get the return value of the controller action. Useful + * - `result` Get the return value of the controller action. Useful * for testing requestAction methods. * * @param string $url The url to test diff --git a/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php b/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php index f203fd18e75..cce86162edd 100644 --- a/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php +++ b/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php @@ -48,7 +48,7 @@ abstract class BaseCoverageReport { public $pluginTest = false; /** - * Array of test case file names. Used to do basename() matching with + * Array of test case file names. Used to do basename() matching with * files that have coverage to decide which results to show on page load. * * @var array @@ -110,7 +110,7 @@ public function getPathFilter() { } /** - * Filters the coverage data by path. Files not in the provided path will be removed. + * Filters the coverage data by path. Files not in the provided path will be removed. * * @param string $path Path to filter files by. * @return array Array of coverage data for files that match the given path. diff --git a/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php b/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php index c9ec6eeda28..3dd3f06028e 100644 --- a/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php +++ b/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php @@ -32,7 +32,7 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter { protected $_headerSent = false; /** - * Array of request parameters. Usually parsed GET params. + * Array of request parameters. Usually parsed GET params. * * @var array */ diff --git a/lib/Cake/Utility/CakeNumber.php b/lib/Cake/Utility/CakeNumber.php index b02fc562a2d..7c70bc7869d 100644 --- a/lib/Cake/Utility/CakeNumber.php +++ b/lib/Cake/Utility/CakeNumber.php @@ -30,7 +30,7 @@ class CakeNumber { /** - * Currencies supported by the helper. You can add additional currency formats + * Currencies supported by the helper. You can add additional currency formats * with CakeNumber::addFormat * * @var array @@ -270,7 +270,7 @@ protected static function _numberFormat($value, $places = 0, $decimals = '.', $t * ie. '$'. `before` is an alias for `wholeSymbol`. * - `after` - The currency symbol to place after decimal numbers * ie. 'c'. Set to boolean false to use no decimal symbol. - * eg. 0.35 => $0.35. `after` is an alias for `fractionSymbol` + * eg. 0.35 => $0.35. `after` is an alias for `fractionSymbol` * - `zero` - The text to use for zero values, can be a * string or a number. ie. 0, 'Free!' * - `places` - Number of decimal places to use. ie. 2 @@ -344,7 +344,7 @@ public static function currency($value, $currency = null, $options = array()) { } /** - * Add a currency format to the Number helper. Makes reusing + * Add a currency format to the Number helper. Makes reusing * currency formats easier. * * {{{ $number->addFormat('NOK', array('before' => 'Kr. ')); }}} diff --git a/lib/Cake/Utility/ClassRegistry.php b/lib/Cake/Utility/ClassRegistry.php index b47dca8dc94..63803bcd150 100644 --- a/lib/Cake/Utility/ClassRegistry.php +++ b/lib/Cake/Utility/ClassRegistry.php @@ -273,10 +273,10 @@ public static function &getObject($key) { /** * Sets the default constructor parameter for an object type * - * @param string $type Type of object. If this parameter is omitted, defaults to "Model" + * @param string $type Type of object. If this parameter is omitted, defaults to "Model" * @param array $param The parameter that will be passed to object constructors when objects * of $type are created - * @return mixed Void if $param is being set. Otherwise, if only $type is passed, returns + * @return mixed Void if $param is being set. Otherwise, if only $type is passed, returns * the previously-set value of $param, or null if not set. */ public static function config($type, $param = array()) { diff --git a/lib/Cake/Utility/Debugger.php b/lib/Cake/Utility/Debugger.php index d507073cbb3..e809ab0771d 100644 --- a/lib/Cake/Utility/Debugger.php +++ b/lib/Cake/Utility/Debugger.php @@ -47,7 +47,7 @@ class Debugger { protected $_outputFormat = 'js'; /** - * Templates used when generating trace or error strings. Can be global or indexed by the format + * Templates used when generating trace or error strings. Can be global or indexed by the format * value used in $_outputFormat. * * @var string @@ -180,7 +180,7 @@ public static function dump($var) { } /** - * Creates an entry in the log file. The log entry will contain a stack trace from where it was called. + * Creates an entry in the log file. The log entry will contain a stack trace from where it was called. * as well as export the variable using exportVar. By default the log is written to the debug log. * * @param mixed $var Variable or content to log @@ -268,11 +268,11 @@ public static function showError($code, $description, $file = null, $line = null * ### Options * * - `depth` - The number of stack frames to return. Defaults to 999 - * - `format` - The format you want the return. Defaults to the currently selected format. If + * - `format` - The format you want the return. Defaults to the currently selected format. If * format is 'array' or 'points' the return will be an array. * - `args` - Should arguments for functions be shown? If true, the arguments for each method call * will be displayed. - * - `start` - The stack frame to start generating a trace from. Defaults to 0 + * - `start` - The stack frame to start generating a trace from. Defaults to 0 * * @param array $options Format for outputting stack trace * @return mixed Formatted stack trace @@ -379,7 +379,7 @@ public static function trimPath($path) { * `Debugger::excerpt('/path/to/file', 100, 4);` * * The above would return an array of 8 items. The 4th item would be the provided line, - * and would be wrapped in ``. All of the lines + * and would be wrapped in ``. All of the lines * are processed with highlight_string() as well, so they have basic PHP syntax highlighting * applied. * @@ -505,7 +505,7 @@ protected static function _export($var, $depth, $indent) { } /** - * Export an array type object. Filters out keys used in datasource configuration. + * Export an array type object. Filters out keys used in datasource configuration. * * The following keys are replaced with ***'s * @@ -622,7 +622,7 @@ protected static function _object($var, $depth, $indent) { * * @param string $format The format you want errors to be output as. * Leave null to get the current format. - * @return mixed Returns null when setting. Returns the current format when getting. + * @return mixed Returns null when setting. Returns the current format when getting. * @throws CakeException when choosing a format that doesn't exist. */ public static function outputAs($format = null) { @@ -642,7 +642,7 @@ public static function outputAs($format = null) { * `Debugger::addFormat('custom', $data);` * * Where $data is an array of strings that use String::insert() variable - * replacement. The template vars should be in a `{:id}` style. + * replacement. The template vars should be in a `{:id}` style. * An error formatter can have the following keys: * * - 'error' - Used for the container for the error message. Gets the following template @@ -655,7 +655,7 @@ public static function outputAs($format = null) { * Gets the following templates: `id`, `context` * - 'links' - An array of HTML links that are used for creating links to other resources. * Typically this is used to create javascript links to open other sections. - * Link keys, are: `code`, `context`, `help`. See the js output format for an + * Link keys, are: `code`, `context`, `help`. See the js output format for an * example. * - 'traceLine' - Used for creating lines in the stacktrace. Gets the following * template variables: `reference`, `path`, `line` @@ -665,9 +665,9 @@ public static function outputAs($format = null) { * * `Debugger::addFormat('custom', array('callback' => array($foo, 'outputError'));` * - * The callback can expect two parameters. The first is an array of all + * The callback can expect two parameters. The first is an array of all * the error data. The second contains the formatted strings generated using - * the other template strings. Keys like `info`, `links`, `code`, `context` and `trace` + * the other template strings. Keys like `info`, `links`, `code`, `context` and `trace` * will be present depending on the other templates in the format type. * * @param string $format Format to use, including 'js' for JavaScript-enhanced HTML, 'html' for diff --git a/lib/Cake/Utility/File.php b/lib/Cake/Utility/File.php index a3cd6b03dbc..cb8369ded44 100644 --- a/lib/Cake/Utility/File.php +++ b/lib/Cake/Utility/File.php @@ -200,8 +200,8 @@ public function offset($offset = false, $seek = SEEK_SET) { } /** - * Prepares a ascii string for writing. Converts line endings to the - * correct terminator for the current platform. If windows "\r\n" will be used + * Prepares a ascii string for writing. Converts line endings to the + * correct terminator for the current platform. If windows "\r\n" will be used * all other platforms will use "\n" * * @param string $data Data to prepare for writing. @@ -546,7 +546,7 @@ public function copy($dest, $overwrite = true) { } /** - * Get the mime type of the file. Uses the finfo extension if + * Get the mime type of the file. Uses the finfo extension if * its available, otherwise falls back to mime_content_type * * @return false|string The mimetype of the file, or false if reading fails. diff --git a/lib/Cake/Utility/Hash.php b/lib/Cake/Utility/Hash.php index 3961b1b3345..0fe57964a3a 100644 --- a/lib/Cake/Utility/Hash.php +++ b/lib/Cake/Utility/Hash.php @@ -20,7 +20,7 @@ * from arrays or 'sets' of data. * * `Hash` provides an improved interface, more consistent and - * predictable set of features over `Set`. While it lacks the spotty + * predictable set of features over `Set`. While it lacks the spotty * support for pseudo Xpath, its more fully featured dot notation provides * similar features in a more consistent implementation. * @@ -83,7 +83,7 @@ public static function get(array $data, $path) { * * @param array $data The data to extract from. * @param string $path The path to extract. - * @return array An array of the extracted values. Returns an empty array + * @return array An array of the extracted values. Returns an empty array * if there are no matches. */ public static function extract(array $data, $path) { @@ -479,7 +479,7 @@ public static function check(array $data, $path) { * Recursively filters a data set. * * @param array $data Either an array to filter, or value when in callback - * @param callable $callback A function to filter the data with. Defaults to + * @param callable $callback A function to filter the data with. Defaults to * `self::_filter()` Which strips out all non-zero empty values. * @return array Filtered array * @link http://book.cakephp.org/2.0/en/core-utility-libraries/hash.html#Hash::filter @@ -578,7 +578,7 @@ public static function expand($data, $separator = '.') { * This function can be thought of as a hybrid between PHP's `array_merge` and `array_merge_recursive`. * * The difference between this method and the built-in ones, is that if an array key contains another array, then - * Hash::merge() will behave in a recursive fashion (unlike `array_merge`). But it will not act recursively for + * Hash::merge() will behave in a recursive fashion (unlike `array_merge`). But it will not act recursively for * keys that contain scalar values (unlike `array_merge_recursive`). * * Note: This function will work with an unlimited amount of arguments and typecasts non-array parameters into arrays. diff --git a/lib/Cake/Utility/ObjectCollection.php b/lib/Cake/Utility/ObjectCollection.php index d5946308347..7ad39e40be8 100644 --- a/lib/Cake/Utility/ObjectCollection.php +++ b/lib/Cake/Utility/ObjectCollection.php @@ -12,12 +12,12 @@ */ /** - * Deals with Collections of objects. Keeping registries of those objects, + * Deals with Collections of objects. Keeping registries of those objects, * loading and constructing new objects and triggering callbacks. Each subclass needs * to implement its own load() functionality. * * All core subclasses of ObjectCollection by convention loaded objects are stored - * in `$this->_loaded`. Enabled objects are stored in `$this->_enabled`. In addition + * in `$this->_loaded`. Enabled objects are stored in `$this->_enabled`. In addition * the all support an `enabled` option that controls the enabled/disabled state of the object * when loaded. * @@ -61,7 +61,7 @@ abstract public function load($name, $options = array()); /** * Trigger a callback method on every object in the collection. - * Used to trigger methods on objects in the collection. Will fire the methods in the + * Used to trigger methods on objects in the collection. Will fire the methods in the * order they were attached. * * ### Options @@ -70,7 +70,7 @@ abstract public function load($name, $options = array()); * Can either be a scalar value, or an array of values to break on. Defaults to `false`. * * - `break` Set to true to enabled breaking. When a trigger is broken, the last returned value - * will be returned. If used in combination with `collectReturn` the collected results will be returned. + * will be returned. If used in combination with `collectReturn` the collected results will be returned. * Defaults to `false`. * * - `collectReturn` Set to true to collect the return of each object into an array. @@ -237,7 +237,7 @@ public function setPriority($name, $priority = null) { } /** - * Disables callbacks on a object or array of objects. Public object methods are still + * Disables callbacks on a object or array of objects. Public object methods are still * callable as normal. * * @param string|array $name CamelCased name of the objects(s) to disable (string or array) @@ -252,7 +252,7 @@ public function disable($name) { /** * Gets the list of currently-enabled objects, or, the current status of a single objects * - * @param string $name Optional. The name of the object to check the status of. If omitted, + * @param string $name Optional. The name of the object to check the status of. If omitted, * returns an array of currently-enabled object * @return mixed If $name is specified, returns the boolean status of the corresponding object. * Otherwise, returns an array of all enabled objects. @@ -267,7 +267,7 @@ public function enabled($name = null) { /** * Gets the list of attached objects, or, whether the given object is attached * - * @param string $name Optional. The name of the object to check the status of. If omitted, + * @param string $name Optional. The name of the object to check the status of. If omitted, * returns an array of currently-attached objects * @return mixed If $name is specified, returns the boolean status of the corresponding object. * Otherwise, returns an array of all attached objects. @@ -280,7 +280,7 @@ public function attached($name = null) { /** * Gets the list of loaded objects, or, whether the given object is loaded * - * @param string $name Optional. The name of the object to check the status of. If omitted, + * @param string $name Optional. The name of the object to check the status of. If omitted, * returns an array of currently-loaded objects * @return mixed If $name is specified, returns the boolean status of the corresponding object. * Otherwise, returns an array of all loaded objects. diff --git a/lib/Cake/Utility/Security.php b/lib/Cake/Utility/Security.php index 651996957c3..c3df97f2150 100644 --- a/lib/Cake/Utility/Security.php +++ b/lib/Cake/Utility/Security.php @@ -136,7 +136,7 @@ public static function hash($string, $type = null, $salt = false) { } /** - * Sets the default hash method for the Security object. This affects all objects using + * Sets the default hash method for the Security object. This affects all objects using * Security::hash(). * * @param string $hash Method to use (sha1/sha256/md5/blowfish) diff --git a/lib/Cake/Utility/Set.php b/lib/Cake/Utility/Set.php index a80a8fa0394..75534306580 100644 --- a/lib/Cake/Utility/Set.php +++ b/lib/Cake/Utility/Set.php @@ -32,7 +32,7 @@ class Set { * to the two is that if an array key contains another array then the function behaves recursive (unlike array_merge) * but does not do if for keys containing strings (unlike array_merge_recursive). * - * Since this method emulates `array_merge`, it will re-order numeric keys. When combined with out of + * Since this method emulates `array_merge`, it will re-order numeric keys. When combined with out of * order numeric keys containing arrays, results can be lossy. * * Note: This function will work with an unlimited amount of arguments and typecasts non-array @@ -185,7 +185,7 @@ protected static function _map(&$array, $class, $primary = false) { /** * Checks to see if all the values in the array are numeric * - * @param array $array The array to check. If null, the value of the current Set object + * @param array $array The array to check. If null, the value of the current Set object * @return boolean true if values are numeric, false otherwise * @link http://book.cakephp.org/2.0/en/core-utility-libraries/set.html#Set::numeric */ diff --git a/lib/Cake/Utility/String.php b/lib/Cake/Utility/String.php index 1b18f323e68..56568f3321e 100644 --- a/lib/Cake/Utility/String.php +++ b/lib/Cake/Utility/String.php @@ -320,7 +320,7 @@ public static function cleanInsert($str, $options) { * * ### Options * - * - `width` The width to wrap to. Defaults to 72 + * - `width` The width to wrap to. Defaults to 72 * - `wordWrap` Only wrap on words breaks (spaces) Defaults to true. * - `indent` String to indent with. Defaults to null. * - `indentAt` 0 based index to start indenting at. Defaults to 0. diff --git a/lib/Cake/Utility/Validation.php b/lib/Cake/Utility/Validation.php index e1387389acb..cf5eccfcb1c 100644 --- a/lib/Cake/Utility/Validation.php +++ b/lib/Cake/Utility/Validation.php @@ -1,6 +1,6 @@ 0, or Asset.timestamp == 'force' + * Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp == 'force' * a timestamp will be added. * * @param string $path The file path to timestamp, the path must be inside WWW_ROOT @@ -394,8 +394,8 @@ public function assetTimestamp($path) { } /** - * Used to remove harmful tags from content. Removes a number of well known XSS attacks - * from content. However, is not guaranteed to remove all possibilities. Escaping + * Used to remove harmful tags from content. Removes a number of well known XSS attacks + * from content. However, is not guaranteed to remove all possibilities. Escaping * content is the best way to prevent all possible attacks. * * @param string|array $output Either an array of strings to clean or a single string to clean. @@ -432,7 +432,7 @@ public function clean($output) { * If the value is not one of these 3, the parameter is not output. * * 'escape' is a special option in that it controls the conversion of - * attributes to their html-entity encoded equivalents. Set to false to disable html-encoding. + * attributes to their html-entity encoded equivalents. Set to false to disable html-encoding. * * If value for any option key is set to `null` or `false`, that option will be excluded from output. * @@ -529,7 +529,7 @@ public function setEntity($entity, $setScope = false) { $entity = $this->_modelScope . '.' . $entity; } - // 0.name, 0.created.month style inputs. Excludes inputs with the modelScope in them. + // 0.name, 0.created.month style inputs. Excludes inputs with the modelScope in them. if ( $count >= 2 && is_numeric($parts[0]) && @@ -609,7 +609,7 @@ public function field() { * @param array|string $options Either an array of html attributes to add $id into, or a string * with a view entity path to get a domId for. * @param string $id The name of the 'id' attribute. - * @return mixed If $options was an array, an array will be returned with $id set. If a string + * @return mixed If $options was an array, an array will be returned with $id set. If a string * was supplied, a string will be returned. */ public function domId($options = null, $id = 'id') { @@ -736,7 +736,7 @@ public function value($options = array(), $field = null, $key = 'value') { } /** - * Sets the defaults for an input tag. Will set the + * Sets the defaults for an input tag. Will set the * name, value, and id attributes for an array of html attributes. * * @param string $field The field name to initialize. @@ -796,7 +796,7 @@ public function beforeRender($viewFile) { } /** - * After render callback. afterRender is called after the view file is rendered + * After render callback. afterRender is called after the view file is rendered * but before the layout has been rendered. * * Overridden in subclasses. @@ -808,7 +808,7 @@ public function afterRender($viewFile) { } /** - * Before layout callback. beforeLayout is called before the layout is rendered. + * Before layout callback. beforeLayout is called before the layout is rendered. * * Overridden in subclasses. * @@ -819,7 +819,7 @@ public function beforeLayout($layoutFile) { } /** - * After layout callback. afterLayout is called after the layout has rendered. + * After layout callback. afterLayout is called after the layout has rendered. * * Overridden in subclasses. * diff --git a/lib/Cake/View/Helper/CacheHelper.php b/lib/Cake/View/Helper/CacheHelper.php index 9c5d153b734..c116fed2e56 100644 --- a/lib/Cake/View/Helper/CacheHelper.php +++ b/lib/Cake/View/Helper/CacheHelper.php @@ -88,7 +88,7 @@ public function afterLayout($layoutFile) { } /** - * Parse a file + output. Matches nocache tags between the current output and the current file + * Parse a file + output. Matches nocache tags between the current output and the current file * stores a reference of the file, so the generated can be swapped back with the file contents when * writing the cache file. * diff --git a/lib/Cake/View/Helper/FormHelper.php b/lib/Cake/View/Helper/FormHelper.php index 27be0f4ef10..b5106c1f025 100644 --- a/lib/Cake/View/Helper/FormHelper.php +++ b/lib/Cake/View/Helper/FormHelper.php @@ -60,7 +60,7 @@ class FormHelper extends AppHelper { const SECURE_SKIP = 'skip'; /** - * Defines the type of form being created. Set by FormHelper::create(). + * Defines the type of form being created. Set by FormHelper::create(). * * @var string */ @@ -292,16 +292,16 @@ public function tagIsInvalid() { * * - `type` Form method defaults to POST * - `action` The controller action the form submits to, (optional). - * - `url` The url the form submits to. Can be a string or a url array. If you use 'url' + * - `url` The url the form submits to. Can be a string or a url array. If you use 'url' * you should leave 'action' undefined. * - `default` Allows for the creation of Ajax forms. Set this to false to prevent the default event handler. * Will create an onsubmit attribute if it doesn't not exist. If it does, default action suppression * will be appended. * - `onsubmit` Used in conjunction with 'default' to create ajax forms. * - `inputDefaults` set the default $options for FormHelper::input(). Any options that would - * be set when using FormHelper::input() can be set here. Options set with `inputDefaults` + * be set when using FormHelper::input() can be set here. Options set with `inputDefaults` * can be overridden when calling input() - * - `encoding` Set the accept-charset encoding for the form. Defaults to `Configure::read('App.encoding')` + * - `encoding` Set the accept-charset encoding for the form. Defaults to `Configure::read('App.encoding')` * * @param mixed $model The model name for which the form is being defined. Should * include the plugin name for plugin models. e.g. `ContactManager.Contact`. @@ -586,7 +586,7 @@ public function unlockField($name = null) { * * @param boolean $lock Whether this field should be part of the validation * or excluded as part of the unlockedFields. - * @param string|array $field Reference to field to be secured. Should be dot separated to indicate nesting. + * @param string|array $field Reference to field to be secured. Should be dot separated to indicate nesting. * @param mixed $value Field value, if value should not be tampered with. * @return void */ @@ -766,7 +766,7 @@ public function error($field, $text = null, $options = array()) { * }}} * * @param string $fieldName This should be "Modelname.fieldname" - * @param string $text Text that will appear in the label field. If + * @param string $text Text that will appear in the label field. If * $text is left undefined the text will be inflected from the * fieldName. * @param array|string $options An array of HTML attributes, or a string, to be used as a class name. @@ -806,7 +806,7 @@ public function label($fieldName = null, $text = null, $options = array()) { } /** - * Generate a set of inputs for `$fields`. If $fields is null the fields of current model + * Generate a set of inputs for `$fields`. If $fields is null the fields of current model * will be used. * * You can customize individual inputs through `$fields`. @@ -1288,7 +1288,7 @@ protected function _extractOption($name, $options, $default = null) { /** * Generate a label for an input() call. * - * $options can contain a hash of id overrides. These overrides will be + * $options can contain a hash of id overrides. These overrides will be * used instead of the generated values if present. * * @param string $fieldName @@ -1363,8 +1363,8 @@ protected function _inputLabel($fieldName, $label, $options) { * - `hiddenField` - boolean to indicate if you want the results of checkbox() to include * a hidden input with a value of ''. * - `disabled` - create a disabled input. - * - `default` - Set the default value for the checkbox. This allows you to start checkboxes - * as checked, without having to check the POST data. A matching POST data value, will overwrite + * - `default` - Set the default value for the checkbox. This allows you to start checkboxes + * as checked, without having to check the POST data. A matching POST data value, will overwrite * the default value. * * @param string $fieldName Name of a field, like this "Modelname.fieldname" @@ -1411,7 +1411,7 @@ public function checkbox($fieldName, $options = array()) { /** * Creates a set of radio widgets. Will create a legend and fieldset - * by default. Use $options to control this + * by default. Use $options to control this * * ### Attributes: * @@ -1423,8 +1423,8 @@ public function checkbox($fieldName, $options = array()) { * - `hiddenField` - boolean to indicate if you want the results of radio() to include * a hidden input with a value of ''. This is useful for creating radio sets that non-continuous * - `disabled` - Set to `true` or `disabled` to disable all the radio buttons. - * - `empty` - Set to `true` to create a input with the value '' as the first option. When `true` - * the radio label will be 'empty'. Set this option to a string to control the label value. + * - `empty` - Set to `true` to create a input with the value '' as the first option. When `true` + * the radio label will be 'empty'. Set this option to a string to control the label value. * * @param string $fieldName Name of a field, like this "Modelname.fieldname" * @param array $options Radio button options array. @@ -1526,7 +1526,7 @@ public function radio($fieldName, $options = array(), $attributes = array()) { /** * Missing method handler - implements various simple input types. Is used to create inputs - * of various types. e.g. `$this->Form->text();` will create `` while + * of various types. e.g. `$this->Form->text();` will create `` while * `$this->Form->range();` will create `` * * ### Usage @@ -1637,7 +1637,7 @@ public function file($fieldName, $options = array()) { } /** - * Creates a `