adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-15 03:18:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1044 from dereuromark/2.3-doc-blocks

Browse source 
double spaces to single ones
This commit is contained in:
José Lorenzo Rodríguez 2012-12-22 14:58:32 -08:00
commit 693be600f8
133 changed files with 654 additions and 654 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
lib/Cake/Cache/Cache.php
View file

@ -19,10 +19,10 @@ App::uses('CacheEngine', 'Cache');
/**
* 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 @@ App::uses('CacheEngine', 'Cache');
* ));
* }}}
*
* 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 @@ class Cache {
}
/**
* 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 @@ class Cache {
}
/**
* 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 @@ class Cache {
/**
* 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 @@ class Cache {
}
/**
* 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:

4
lib/Cake/Cache/Engine/ApcEngine.php
View file

@ -117,10 +117,10 @@ class ApcEngine extends CacheEngine {
}
/**
* 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) {

8
lib/Cake/Cache/Engine/FileEngine.php
View file

@ -1,7 +1,7 @@
<?php
/**
* File Storage engine for cache. Filestorage is the slowest cache storage
* to read and write. However, it is good for servers that don't have other storage
* File Storage engine for cache. Filestorage is the slowest cache storage
* to read and write. However, it is good for servers that don't have other storage
* engine available, or have content which is not performance sensitive.
*
* You can configure a FileEngine cache, using Cache::config()
@ -21,8 +21,8 @@
*/
/**
* File Storage engine for cache. Filestorage is the slowest cache storage
* to read and write. However, it is good for servers that don't have other storage
* File Storage engine for cache. Filestorage is the slowest cache storage
* to read and write. However, it is good for servers that don't have other storage
* engine available, or have content which is not performance sensitive.
*
* You can configure a FileEngine cache, using Cache::config()

8
lib/Cake/Cache/Engine/MemcacheEngine.php
View file

@ -19,8 +19,8 @@
*/
/**
* Memcache storage engine for cache. Memcache has some limitations in the amount of
* control you have over expire times far in the future. See MemcacheEngine::write() for
* Memcache storage engine for cache. Memcache has some limitations in the amount of
* control you have over expire times far in the future. See MemcacheEngine::write() for
* more information.
*
* @package Cake.Cache.Engine
@ -98,7 +98,7 @@ class MemcacheEngine extends CacheEngine {
}
/**
* Parses the server address into the host/port. Handles both IPv6 and IPv4
* Parses the server address into the host/port. Handles both IPv6 and IPv4
* addresses and Unix sockets
*
* @param string $server The server address string.
@ -126,7 +126,7 @@ class MemcacheEngine extends CacheEngine {
}
/**
* Write data for key into cache. When using memcache as your cache engine
* Write data for key into cache. When using memcache as your cache engine
* remember that the Memcache pecl extension does not support cache expiry times greater
* than 30 days in the future. Any duration greater than 30 days will be treated as never expiring.
*

2
lib/Cake/Cache/Engine/WincacheEngine.php
View file

@ -121,7 +121,7 @@ class WincacheEngine extends CacheEngine {
}
/**
* Delete all keys from the cache. This will clear every
* Delete all keys from the cache. This will clear every
* item in the cache matching the cache config prefix.
*
* @param boolean $check If true, nothing will be cleared, as entries will

2
lib/Cake/Config/cacert.pem
View file

@ -5,7 +5,7 @@
##
## This is a bundle of X.509 certificates of public Certificate Authorities
## (CA). These were automatically extracted from Mozilla's root certificates
## file (certdata.txt). This file can be found in the mozilla source tree:
## file (certdata.txt). This file can be found in the mozilla source tree:
## http://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt?raw=1
##
## It contains the certificates in PEM format and therefore

2
lib/Cake/Configure/IniReader.php
View file

@ -25,7 +25,7 @@ App::uses('Hash', 'Utility');
* class shares the same behavior, especially with regards to boolean and null values.
*
* In addition to the native `parse_ini_file` features, IniReader also allows you
* to create nested array structures through usage of `.` delimited names. This allows
* to create nested array structures through usage of `.` delimited names. This allows
* you to create nested arrays structures in an ini config file. For example:
*
* `db.password = secret` would turn into `array('db' => array('password' => 'secret'))`

4
lib/Cake/Configure/PhpReader.php
View file

@ -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 @@ class PhpReader implements ConfigReaderInterface {
/**
* 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

6
lib/Cake/Console/Command/AclShell.php
View file

@ -24,8 +24,8 @@ App::uses('DbAcl', 'Model');
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 @@ class AclShell extends AppShell {
' - <model>.<id> - The node will be bound to a specific record of the given model.',
'',
' - <alias> - The node will be given a string alias (or path, in the case of <parent>)',
" i.e. 'John'. When used with <parent>, this takes the form of an alias path,",
" i.e. 'John'. When used with <parent>, this takes the form of an alias path,",
" i.e. <group>/<subgroup>/<parent>.",
'',
"To add a node at the root level, enter 'root' or '/' as the <parent> parameter."

2
lib/Cake/Console/Command/ConsoleShell.php
View file

@ -120,7 +120,7 @@ class ConsoleShell extends AppShell {
"\tRoute <url>",
"",
"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",
"",

4
lib/Cake/Console/Command/SchemaShell.php
View file

@ -237,7 +237,7 @@ class SchemaShell extends AppShell {
}
/**
* Run database create commands. Alias for run create.
* Run database create commands. Alias for run create.
*
* @return void
*/
@ -247,7 +247,7 @@ class SchemaShell extends AppShell {
}
/**
* Run database create commands. Alias for run create.
* Run database create commands. Alias for run create.
*
* @return void
*/

2
lib/Cake/Console/Command/Task/BakeTask.php
View file

@ -59,7 +59,7 @@ class BakeTask extends AppShell {
}
/**
* 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.

2
lib/Cake/Console/Command/Task/ControllerTask.php
View file

@ -96,7 +96,7 @@ class ControllerTask extends BakeTask {
}
/**
* 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
*/

2
lib/Cake/Console/Command/Task/FixtureTask.php
View file

@ -115,7 +115,7 @@ class FixtureTask extends BakeTask {
}
/**
* 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
*/

2
lib/Cake/Console/Command/Task/TemplateTask.php
View file

@ -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
*/

4
lib/Cake/Console/Command/Task/ViewTask.php
View file

@ -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 @@ class ViewTask extends BakeTask {
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(

4
lib/Cake/Console/ConsoleInputOption.php
View file

@ -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

48
lib/Cake/Console/ConsoleOptionParser.php
View file

@ -27,22 +27,22 @@ App::uses('HelpFormatter', 'Console');
/**
* 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 @@ App::uses('HelpFormatter', 'Console');
*
* `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 @@ App::uses('HelpFormatter', 'Console');
*
* ### 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 @@ App::uses('HelpFormatter', 'Console');
* ### 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 @@ class ConsoleOptionParser {
/**
* 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 @@ class ConsoleOptionParser {
}
/**
* 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 @@ class ConsoleOptionParser {
* ### 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 @@ class ConsoleOptionParser {
* - `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 @@ class ConsoleOptionParser {
* ### 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 @@ class ConsoleOptionParser {
}
/**
* 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 @@ class ConsoleOptionParser {
}
/**
* 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.

6
lib/Cake/Console/ConsoleOutput.php
View file

@ -37,7 +37,7 @@
* `$this->out('<warning>Overwrite:</warning> 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 @@ class ConsoleOutput {
}
/**
* 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) {

8
lib/Cake/Console/HelpFormatter.php
View file

@ -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 @@ class HelpFormatter {
/**
* 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) {

6
lib/Cake/Console/Shell.php
View file

@ -521,7 +521,7 @@ class Shell extends Object {
*
* ### 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 @@ class Shell extends Object {
*
* ### 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

2
lib/Cake/Console/ShellDispatcher.php
View file

@ -337,7 +337,7 @@ class ShellDispatcher {
}
/**
* Shows console help. Performs an internal dispatch to the CommandList Shell
* Shows console help. Performs an internal dispatch to the CommandList Shell
*
* @return void
*/

4
lib/Cake/Console/TaskCollection.php
View file

@ -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 @@ class TaskCollection extends ObjectCollection {
}
/**
* 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

2
lib/Cake/Console/Templates/default/views/view.ctp
View file

@ -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<li><?php echo \$this->Html->link(__('List " . Inflector::humanize($details['controller']) . "'), array('controller' => '{$details['controller']}', 'action' => 'index')); ?> </li>\n";
echo "\t\t<li><?php echo \$this->Html->link(__('New " . Inflector::humanize(Inflector::underscore($alias)) . "'), array('controller' => '{$details['controller']}', 'action' => 'add')); ?> </li>\n";
echo "\t\t<li><?php echo \$this->Html->link(__('New " . Inflector::humanize(Inflector::underscore($alias)) . "'), array('controller' => '{$details['controller']}', 'action' => 'add')); ?> </li>\n";
$done[] = $details['controller'];
}
}

18
lib/Cake/Console/Templates/skel/Config/core.php
View file

@ -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 @@ if (Configure::read('debug') > 0) {
$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 @@ Cache::config('_cake_core_', array(
));
/**
* 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(

6
lib/Cake/Console/Templates/skel/Config/database.php.default
View file

@ -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 =>

2
lib/Cake/Console/Templates/skel/Config/email.php.default
View file

@ -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 =>

2
lib/Cake/Console/Templates/skel/Config/routes.php
View file

@ -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();

4
lib/Cake/Console/Templates/skel/webroot/index.php
View file

@ -53,7 +53,7 @@ if (!defined('APP_DIR')) {
* 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 (!defined('CAKE_CORE_INCLUDE_PATH')) {
}
}
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');

4
lib/Cake/Console/Templates/skel/webroot/test.php
View file

@ -50,7 +50,7 @@ if (!defined('APP_DIR')) {
/**
* 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 (!defined('CAKE_CORE_INCLUDE_PATH')) {
}
}
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) {

10
lib/Cake/Controller/Component.php
View file

@ -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 @@ class Component extends Object {
}
/**
* 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.

4
lib/Cake/Controller/Component/Acl/DbAcl.php
View file

@ -16,8 +16,8 @@ App::uses('AclInterface', 'Controller/Component/Acl');
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.

4
lib/Cake/Controller/Component/Acl/IniAcl.php
View file

@ -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

2
lib/Cake/Controller/Component/AclComponent.php
View file

@ -96,7 +96,7 @@ class AclComponent extends Component {
}
/**
* 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

2
lib/Cake/Controller/Component/Auth/ActionsAuthorize.php
View file

@ -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

2
lib/Cake/Controller/Component/Auth/BaseAuthenticate.php
View file

@ -144,7 +144,7 @@ abstract class BaseAuthenticate {
}
/**
* 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.

14
lib/Cake/Controller/Component/Auth/BaseAuthorize.php
View file

@ -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 @@ abstract class BaseAuthorize {
}
/**
* 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 @@ abstract class BaseAuthorize {
}
/**
* 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 @@ abstract class BaseAuthorize {
* }}}
*
* 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.

14
lib/Cake/Controller/Component/Auth/BasicAuthenticate.php
View file

@ -18,9 +18,9 @@ App::uses('BaseAuthenticate', 'Controller/Component/Auth');
/**
* 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 @@ App::uses('BaseAuthenticate', 'Controller/Component/Auth');
* );
* }}}
*
* 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 @@ class BasicAuthenticate extends BaseAuthenticate {
}
/**
* 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 @@ class BasicAuthenticate extends BaseAuthenticate {
}
/**
* 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

4
lib/Cake/Controller/Component/Auth/ControllerAuthorize.php
View file

@ -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 @@ App::uses('BaseAuthorize', 'Controller/Component/Auth');
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

8
lib/Cake/Controller/Component/Auth/CrudAuthorize.php
View file

@ -17,12 +17,12 @@ App::uses('BaseAuthorize', 'Controller/Component/Auth');
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);

20
lib/Cake/Controller/Component/Auth/DigestAuthenticate.php
View file

@ -18,12 +18,12 @@ App::uses('BaseAuthenticate', 'Controller/Component/Auth');
/**
* 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 @@ App::uses('BaseAuthenticate', 'Controller/Component/Auth');
* );
* }}}
*
* 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 @@ class DigestAuthenticate extends BaseAuthenticate {
}
/**
* 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 @@ class DigestAuthenticate extends BaseAuthenticate {
}
/**
* 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

8
lib/Cake/Controller/Component/Auth/FormAuthenticate.php
View file

@ -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 @@ class FormAuthenticate extends BaseAuthenticate {
}
/**
* 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.

48
lib/Cake/Controller/Component/AuthComponent.php
View file

@ -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 @@ class AuthComponent extends Component {
}
/**
* 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 @@ class AuthComponent extends Component {
* 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 @@ class AuthComponent extends Component {
}
/**
* 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 @@ class AuthComponent extends Component {
}
/**
* 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 @@ class AuthComponent extends Component {
/**
* 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 @@ class AuthComponent extends Component {
/**
* 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 @@ class AuthComponent extends Component {
/**
* 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 @@ class AuthComponent extends Component {
}
/**
* 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 @@ class AuthComponent extends Component {
/**
* 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 @@ class AuthComponent extends Component {
}
/**
* 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 @@ class AuthComponent extends Component {
}
/**
* 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

2
lib/Cake/Controller/Component/CookieComponent.php
View file

@ -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

2
lib/Cake/Controller/Component/EmailComponent.php
View file

@ -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

24
lib/Cake/Controller/Component/PaginatorComponent.php
View file

@ -20,12 +20,12 @@ App::uses('Component', 'Controller');
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 @@ App::uses('Hash', 'Utility');
* );
* }}}
*
* 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 @@ App::uses('Hash', 'Utility');
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 @@ class PaginatorComponent extends Component {
*
* @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 @@ class PaginatorComponent extends Component {
* - 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 @@ class PaginatorComponent extends Component {
}
/**
* 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 @@ class PaginatorComponent extends Component {
}
/**
* 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 @@ class PaginatorComponent extends Component {
*
* @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()) {

32
lib/Cake/Controller/Component/RequestHandlerComponent.php
View file

@ -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 @@ class RequestHandlerComponent extends Component {
*
* - 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 @@ class RequestHandlerComponent extends Component {
}
/**
* 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 @@ class RequestHandlerComponent extends Component {
}
/**
* 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 @@ class RequestHandlerComponent extends Component {
* @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 @@ class RequestHandlerComponent extends Component {
* 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 @@ class RequestHandlerComponent extends Component {
}
/**
* 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 @@ class RequestHandlerComponent extends Component {
* @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 @@ class RequestHandlerComponent extends Component {
}
/**
* 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 @@ class RequestHandlerComponent extends Component {
* 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 @@ class RequestHandlerComponent extends Component {
}
/**
* 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

14
lib/Cake/Controller/Component/SecurityComponent.php
View file

@ -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 @@ class SecurityComponent extends Component {
/**
* 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

2
lib/Cake/Controller/Component/SessionComponent.php
View file

@ -165,7 +165,7 @@ class SessionComponent extends Component {
* 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)

4
lib/Cake/Controller/ComponentCollection.php
View file

@ -63,9 +63,9 @@ class ComponentCollection extends ObjectCollection implements CakeEventListener
}
/**
* 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.,
* {{{

20
lib/Cake/Controller/Controller.php
View file

@ -26,20 +26,20 @@ App::uses('CakeEventManager', 'Event');
* 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 @@ class Controller extends Object implements CakeEventListener {
/**
* 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 @@ class Controller extends Object implements CakeEventListener {
}
/**
* 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 @@ class Controller extends Object implements CakeEventListener {
}
/**
* 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

2
lib/Cake/Controller/Scaffold.php
View file

@ -321,7 +321,7 @@ class Scaffold {
}
/**
* 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

14
lib/Cake/Core/App.php
View file

@ -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 @@ class App {
/**
* 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 @@ class App {
}
/**
* 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 @@ class App {
* @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 @@ class App {
}
/**
* 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

28
lib/Cake/Core/Configure.php
View file

@ -150,7 +150,7 @@ class Configure {
}
/**
* 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 @@ class Configure {
* }}}
*
* @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 @@ class Configure {
}
/**
* 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 @@ class Configure {
}
/**
* 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 @@ class Configure {
}
/**
* 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 @@ class Configure {
*
* `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 @@ class Configure {
/**
* 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 @@ class Configure {
}
/**
* 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 @@ class Configure {
}
/**
* 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.

18
lib/Cake/Core/Object.php
View file

@ -49,16 +49,16 @@ class Object {
* 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 @@ class Object {
}
/**
* 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 @@ class Object {
}
/**
* 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 @@ class Object {
}
/**
* 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 @@ class Object {
* 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.

24
lib/Cake/Error/ErrorHandler.php
View file

@ -30,12 +30,12 @@ App::uses('ExceptionRenderer', 'Error');
*
* ### 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 @@ App::uses('ExceptionRenderer', 'Error');
*
* #### 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 @@ App::uses('ExceptionRenderer', 'Error');
* ### 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 @@ App::uses('ExceptionRenderer', 'Error');
*
* #### 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 @@ class ErrorHandler {
/**
* 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.

8
lib/Cake/Error/ExceptionRenderer.php
View file

@ -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 @@ App::uses('Controller', 'Controller');
* 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 @@ App::uses('Controller', 'Controller');
*
* #### 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
*

16
lib/Cake/Error/exceptions.php
View file

@ -1,6 +1,6 @@
<?php
/**
* Exceptions file. Contains the various exceptions CakePHP will throw until they are
* Exceptions file. Contains the various exceptions CakePHP will throw until they are
* moved into their permanent location.
*
* PHP 5
@ -508,7 +508,7 @@ class AclException extends CakeException {
}
/**
* Exception class for Cache. This exception will be thrown from Cache when it
* Exception class for Cache. This exception will be thrown from Cache when it
* encounters an error.
*
* @package Cake.Error
@ -517,7 +517,7 @@ class CacheException extends CakeException {
}
/**
* Exception class for Router. This exception will be thrown from Router when it
* Exception class for Router. This exception will be thrown from Router when it
* encounters an error.
*
* @package Cake.Error
@ -526,7 +526,7 @@ class RouterException extends CakeException {
}
/**
* Exception class for CakeLog. This exception will be thrown from CakeLog when it
* Exception class for CakeLog. This exception will be thrown from CakeLog when it
* encounters an error.
*
* @package Cake.Error
@ -535,7 +535,7 @@ class CakeLogException extends CakeException {
}
/**
* Exception class for CakeSession. This exception will be thrown from CakeSession when it
* Exception class for CakeSession. This exception will be thrown from CakeSession when it
* encounters an error.
*
* @package Cake.Error
@ -544,7 +544,7 @@ class CakeSessionException extends CakeException {
}
/**
* Exception class for Configure. This exception will be thrown from Configure when it
* Exception class for Configure. This exception will be thrown from Configure when it
* encounters an error.
*
* @package Cake.Error
@ -562,7 +562,7 @@ class SocketException extends CakeException {
}
/**
* Exception class for Xml. This exception will be thrown from Xml when it
* Exception class for Xml. This exception will be thrown from Xml when it
* encounters an error.
*
* @package Cake.Error
@ -571,7 +571,7 @@ class XmlException extends CakeException {
}
/**
* Exception class for Console libraries. This exception will be thrown from Console library
* Exception class for Console libraries. This exception will be thrown from Console library
* classes when they encounter an error.
*
* @package Cake.Error

4
lib/Cake/I18n/I18n.php
View file

@ -123,7 +123,7 @@ class I18n {
*
* @param string $singular String to translate
* @param string $plural Plural string (if any)
* @param string $domain Domain The domain of the translation. Domains are often used by plugin translations
* @param string $domain Domain The domain of the translation. Domains are often used by plugin translations
* @param string $category Category The integer value of the category to use.
* @param integer $count Count Count is used with $plural to choose the correct plural form.
* @param string $language Language to translate string to.
@ -222,7 +222,7 @@ class I18n {
}
/**
* Clears the domains internal data array. Useful for testing i18n.
* Clears the domains internal data array. Useful for testing i18n.
*
* @return void
*/

24
lib/Cake/Log/CakeLog.php
View file

@ -22,8 +22,8 @@
App::uses('LogEngineCollection', 'Log');
/**
* Logs messages to configured Log adapters. One or more adapters
* can be configured using CakeLogs's methods. If you don't
* Logs messages to configured Log adapters. One or more adapters
* can be configured using CakeLogs's methods. If you don't
* configure any adapters, and write to the logs a default
* FileLog will be autoconfigured for you.
*
@ -40,7 +40,7 @@ App::uses('LogEngineCollection', 'Log');
*
* ### Writing to the log
*
* You write to the logs using CakeLog::write(). See its documentation for more
* You write to the logs using CakeLog::write(). See its documentation for more
* information.
*
* ### Logging Levels
@ -60,11 +60,11 @@ App::uses('LogEngineCollection', 'Log');
* ### Logging scopes
*
* When logging messages and configuring log adapters, you can specify
* 'scopes' that the logger will handle. You can think of scopes as subsystems
* in your application that may require different logging setups. For
* 'scopes' that the logger will handle. You can think of scopes as subsystems
* in your application that may require different logging setups. For
* example in an e-commerce application you may want to handle logged errors
* in the cart and ordering subsystems differently than the rest of the
* application. By using scopes you can control logging for each part
* application. By using scopes you can control logging for each part
* of your application and still keep standard log levels.
*
*
@ -139,7 +139,7 @@ class CakeLog {
*
* Will configure a FileLog instance to use the specified path.
* All options that are not `engine` are passed onto the logging adapter,
* and handled there. Any class can be configured as a logging
* and handled there. Any class can be configured as a logging
* adapter as long as it implements the methods in CakeLogInterface.
*
* ### Logging levels
@ -161,8 +161,8 @@ class CakeLog {
* ### Logging scopes
*
* When configuring loggers you can define the active scopes the logger
* is for. If defined only the listed scopes will be handled by the
* logger. If you don't define any scopes an adapter will catch
* is for. If defined only the listed scopes will be handled by the
* logger. If you don't define any scopes an adapter will catch
* all scopes that match the handled levels.
*
* {{{
@ -286,7 +286,7 @@ class CakeLog {
}
/**
* Removes a stream from the active streams. Once a stream has been removed
* Removes a stream from the active streams. Once a stream has been removed
* it will no longer have messages sent to it.
*
* @param string $streamName Key name of a configured stream to remove.
@ -317,7 +317,7 @@ class CakeLog {
}
/**
* Enable stream. Streams that were previously disabled
* Enable stream. Streams that were previously disabled
* can be re-enabled with this method.
*
* @param string $streamName to enable
@ -335,7 +335,7 @@ class CakeLog {
}
/**
* Disable stream. Disabling a stream will
* Disable stream. Disabling a stream will
* prevent that log stream from receiving any messages until
* its re-enabled.
*

2
lib/Cake/Log/Engine/BaseLog.php
View file

@ -44,7 +44,7 @@ abstract class BaseLog implements CakeLogInterface {
}
/**
* Sets instance config. When $config is null, returns config array
* Sets instance config. When $config is null, returns config array
*
* Config
*

2
lib/Cake/Log/Engine/ConsoleLog.php
View file

@ -21,7 +21,7 @@ App::uses('BaseLog', 'Log/Engine');
App::uses('ConsoleOutput', 'Console');
/**
* Console logging. Writes logs to console output.
* Console logging. Writes logs to console output.
*
* @package Cake.Log.Engine
*/

2
lib/Cake/Log/Engine/FileLog.php
View file

@ -21,7 +21,7 @@ App::uses('BaseLog', 'Log/Engine');
App::uses('Hash', 'Utility');
/**
* File Storage stream for Logging. Writes logs to different files
* File Storage stream for Logging. Writes logs to different files
* based on the type of log it is.
*
* @package Cake.Log.Engine

6
lib/Cake/Model/Behavior/TranslateBehavior.php
View file

@ -331,7 +331,7 @@ class TranslateBehavior extends ModelBehavior {
* beforeSave callback.
*
* Copies data into the runtime property when `$options['validate']` is
* disabled. Or the runtime data hasn't been set yet.
* disabled. Or the runtime data hasn't been set yet.
*
* @param Model $Model Model save was called on.
* @return boolean true.
@ -525,7 +525,7 @@ class TranslateBehavior extends ModelBehavior {
* Get instance of model for translations.
*
* If the model has a translateModel property set, this will be used as the class
* name to find/use. If no translateModel property is found 'I18nModel' will be used.
* name to find/use. If no translateModel property is found 'I18nModel' will be used.
*
* @param Model $Model Model to get a translatemodel for.
* @return Model
@ -560,7 +560,7 @@ class TranslateBehavior extends ModelBehavior {
* @param boolean $reset Leave true to have the fields only modified for the next operation.
* if false the field will be added for all future queries.
* @return boolean
* @throws CakeException when attempting to bind a translating called name. This is not allowed
* @throws CakeException when attempting to bind a translating called name. This is not allowed
* as it shadows Model::$name.
*/
public function bindTranslation(Model $Model, $fields, $reset = true) {

6
lib/Cake/Model/BehaviorCollection.php
View file

@ -207,7 +207,7 @@ class BehaviorCollection extends ObjectCollection implements CakeEventListener {
}
/**
* Dispatches a behavior method. Will call either normal methods or mapped methods.
* Dispatches a behavior method. Will call either normal methods or mapped methods.
*
* If a method is not handled by the BehaviorCollection, and $strict is false, a
* special return of `array('unhandled')` will be returned to signal the method was not found.
@ -249,13 +249,13 @@ class BehaviorCollection extends ObjectCollection implements CakeEventListener {
}
/**
* Check to see if a behavior in this collection implements the provided method. Will
* Check to see if a behavior in this collection implements the provided method. Will
* also check mappedMethods.
*
* @param string $method The method to find.
* @param boolean $callback Return the callback for the method.
* @return mixed If $callback is false, a boolean will be returned, if its true, an array
* containing callback information will be returned. For mapped methods the array will have 3 elements.
* containing callback information will be returned. For mapped methods the array will have 3 elements.
*/
public function hasMethod($method, $callback = false) {
if (isset($this->_methods[$method])) {

2
lib/Cake/Model/Datasource/CakeSession.php
View file

@ -318,7 +318,7 @@ class CakeSession {
/**
* 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

2
lib/Cake/Model/Datasource/DataSource.php
View file

@ -264,7 +264,7 @@ class DataSource extends Object {
/**
* 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.

2
lib/Cake/Model/Datasource/Database/Mysql.php
View file

@ -544,7 +544,7 @@ class Mysql extends DboSource {
* 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
*/

4
lib/Cake/Model/Datasource/Database/Postgres.php
View file

@ -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 @@ class Postgres extends DboSource {
}
/**
* 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.

2
lib/Cake/Model/Datasource/Database/Sqlite.php
View file

@ -553,7 +553,7 @@ class Sqlite extends DboSource {
* 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
*/

6
lib/Cake/Model/Datasource/Database/Sqlserver.php
View file

@ -22,7 +22,7 @@ App::uses('DboSource', 'Model/Datasource');
/**
* 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 @@ class Sqlserver extends DboSource {
* 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
*/

44
lib/Cake/Model/Datasource/DboSource.php
View file

@ -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 @@ class DboSource extends DataSource {
}
/**
* 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 @@ class DboSource extends DataSource {
}
/**
* 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 @@ class DboSource extends DataSource {
* 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 @@ class DboSource extends DataSource {
/**
* 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 @@ class DboSource extends DataSource {
* @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 @@ class DboSource extends DataSource {
}
/**
* 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 @@ class DboSource extends DataSource {
/**
* 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 @@ class DboSource extends DataSource {
/**
* 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 @@ class DboSource extends DataSource {
}
/**
* 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 @@ class DboSource extends DataSource {
}
/**
* 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 @@ class DboSource extends DataSource {
*
* @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 @@ class DboSource extends DataSource {
}
/**
* 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 @@ class DboSource extends DataSource {
* 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 @@ class DboSource extends DataSource {
* 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
*/

2
lib/Cake/Model/Datasource/Session/CacheSession.php
View file

@ -1,6 +1,6 @@
<?php
/**
* Cache Session save handler. Allows saving session information into Cache.
* Cache Session save handler. Allows saving session information into Cache.
*
* PHP 5
*

4
lib/Cake/Model/Datasource/Session/CakeSessionHandlerInterface.php
View file

@ -14,7 +14,7 @@
*/
/**
* Interface for Session handlers. Custom session handler classes should implement
* Interface for Session handlers. Custom session handler classes should implement
* this interface as it allows CakeSession know how to map methods to session_set_save_handler()
*
* @package Cake.Model.Datasource.Session
@ -61,7 +61,7 @@ interface CakeSessionHandlerInterface {
public function destroy($id);
/**
* Run the Garbage collection on the session storage. This method should vacuum all
* Run the Garbage collection on the session storage. This method should vacuum all
* expired or dead sessions.
*
* @param integer $expires Timestamp (defaults to current time)

4
lib/Cake/Model/Datasource/Session/DatabaseSession.php
View file

@ -1,6 +1,6 @@
<?php
/**
* Database Session save handler. Allows saving session information into a model.
* Database Session save handler. Allows saving session information into a model.
*
* PHP 5
*
@ -42,7 +42,7 @@ class DatabaseSession implements CakeSessionHandlerInterface {
protected $_timeout;
/**
* Constructor. Looks at Session configuration information and
* Constructor. Looks at Session configuration information and
* sets up the session model.
*
*/

26
lib/Cake/Model/Model.php
View file

@ -91,7 +91,7 @@ class Model extends Object implements CakeEventListener {
public $data = array();
/**
* Holds physical schema/database name for this model. Automatically set during Model creation.
* Holds physical schema/database name for this model. Automatically set during Model creation.
*
* @var string
* @access public
@ -265,7 +265,7 @@ class Model extends Object implements CakeEventListener {
public $tableToModel = array();
/**
* Whether or not to cache queries for this model. This enables in-memory
* Whether or not to cache queries for this model. This enables in-memory
* caching only, the results are not stored beyond the current request.
*
* @var boolean
@ -533,7 +533,7 @@ class Model extends Object implements CakeEventListener {
public $order = null;
/**
* Array of virtual fields this model has. Virtual fields are aliased
* Array of virtual fields this model has. Virtual fields are aliased
* SQL expressions. Fields added to this property will be read as other fields in a model
* but will not be saveable.
*
@ -662,7 +662,7 @@ class Model extends Object implements CakeEventListener {
* $Post = new Model(array('table' => '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 @@ class Model extends Object implements CakeEventListener {
}
/**
* 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 @@ class Model extends Object implements CakeEventListener {
* 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 @@ class Model extends Object implements CakeEventListener {
}
/**
* 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 @@ class Model extends Object implements CakeEventListener {
* }}}
*
* 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 @@ class Model extends Object implements CakeEventListener {
}
/**
* 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 @@ class Model extends Object implements CakeEventListener {
}
/**
* 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 @@ class Model extends Object implements CakeEventListener {
}
/**
* 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 @@ class Model extends Object implements CakeEventListener {
* 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 @@ class Model extends Object implements CakeEventListener {
}
/**
* 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

34
lib/Cake/Model/ModelBehavior.php
View file

@ -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 @@ class ModelBehavior extends Object {
}
/**
* 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 @@ class ModelBehavior extends Object {
/**
* 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 @@ class ModelBehavior extends Object {
/**
* 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 @@ class ModelBehavior extends Object {
}
/**
* 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 @@ class ModelBehavior extends Object {
/**
* 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 @@ class ModelBehavior extends Object {
/**
* 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

2
lib/Cake/Model/ModelValidator.php
View file

@ -90,7 +90,7 @@ class ModelValidator implements ArrayAccess, IteratorAggregate, Countable {
* 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

4
lib/Cake/Model/Permission.php
View file

@ -90,12 +90,12 @@ class Permission extends AppModel {
$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;
}

34
lib/Cake/Network/CakeRequest.php
View file

@ -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 @@ class CakeRequest implements ArrayAccess {
}
/**
* 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 @@ class CakeRequest implements ArrayAccess {
* 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 @@ class CakeRequest implements ArrayAccess {
}
/**
* 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 @@ class CakeRequest implements ArrayAccess {
*
* ### 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 @@ class CakeRequest implements ArrayAccess {
* 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 @@ class CakeRequest implements ArrayAccess {
}
/**
* 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 @@ class CakeRequest implements ArrayAccess {
}
/**
* 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 @@ class CakeRequest implements ArrayAccess {
* 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 @@ class CakeRequest implements ArrayAccess {
}
/**
* 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 @@ class CakeRequest implements ArrayAccess {
}
/**
* 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.

4
lib/Cake/Network/CakeResponse.php
View file

@ -1101,7 +1101,7 @@ class CakeResponse {
* 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 @@ class CakeResponse {
}
/**
* String conversion. Fetches the response body as a string.
* String conversion. Fetches the response body as a string.
* Does *not* send headers.
*
* @return string

2
lib/Cake/Network/Email/CakeEmail.php
View file

@ -1507,7 +1507,7 @@ class CakeEmail {
/**
* 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);

4
lib/Cake/Network/Http/HttpSocket.php
View file

@ -165,7 +165,7 @@ class HttpSocket extends CakeSocket {
/**
* 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 @@ class HttpSocket extends CakeSocket {
}
/**
* 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.

8
lib/Cake/Routing/Dispatcher.php
View file

@ -32,8 +32,8 @@ App::uses('CakeEventManager', 'Event');
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 @@ class Dispatcher implements CakeEventListener {
* 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.

14
lib/Cake/Routing/Route/CakeRoute.php
View file

@ -17,7 +17,7 @@ App::uses('Hash', 'Utility');
* 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 @@ class CakeRoute {
}
/**
* 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 @@ class CakeRoute {
}
/**
* 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 @@ class CakeRoute {
* 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 @@ class CakeRoute {
}
/**
* 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.

64
lib/Cake/Routing/Router.php
View file

@ -21,21 +21,21 @@ App::uses('CakeRequest', 'Network');
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 @@ class Router {
/**
* 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 @@ class Router {
* $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 @@ class Router {
* @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 @@ class Router {
*
* `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 @@ class Router {
* ### 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 @@ class Router {
/**
* 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 @@ class Router {
*
* ### 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 @@ class Router {
}
/**
* 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 @@ class Router {
}
/**
* 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 @@ class Router {
* 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 @@ class Router {
}
/**
* 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 @@ class Router {
}
/**
* 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 @@ class Router {
}
/**
* 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.

2
lib/Cake/Test/Case/Console/Command/Task/ModelTaskTest.php
View file

@ -62,7 +62,7 @@ class ModelTaskTest extends CakeTestCase {
}
/**
* 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
*/

2
lib/Cake/Test/Case/Console/Command/Task/ProjectTaskTest.php
View file

@ -150,7 +150,7 @@ class ProjectTaskTest extends CakeTestCase {
}
/**
* 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
*/

4
lib/Cake/Test/Case/Console/Command/Task/TemplateTaskTest.php
View file

@ -93,8 +93,8 @@ class TemplateTaskTest extends CakeTestCase {
}
/**
* 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
*/

2
lib/Cake/Test/Case/Console/Command/Task/TestTaskTest.php
View file

@ -425,7 +425,7 @@ class TestTaskTest extends CakeTestCase {
}
/**
* 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

2
lib/Cake/Test/Case/Controller/Component/AuthComponentTest.php
View file

@ -418,7 +418,7 @@ class AuthComponentTest extends CakeTestCase {
/**
* 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

10
lib/Cake/Test/Case/Model/ModelIntegrationTest.php
View file

@ -274,7 +274,7 @@ class ModelIntegrationTest extends BaseModelTest {
}
/**
* 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 @@ class ModelIntegrationTest extends BaseModelTest {
$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 @@ class ModelIntegrationTest extends BaseModelTest {
$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 @@ class ModelIntegrationTest extends BaseModelTest {
$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 @@ class ModelIntegrationTest extends BaseModelTest {
$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');

2
lib/Cake/Test/Case/Model/ModelValidationTest.php
View file

@ -167,7 +167,7 @@ class ModelValidationTest extends BaseModelTest {
}
/**
* 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
*/

2
lib/Cake/Test/Case/TestSuite/CakeTestFixtureTest.php
View file

@ -352,7 +352,7 @@ class CakeTestFixtureTest extends CakeTestCase {
}
/**
* 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

4
lib/Cake/Test/Case/View/Helper/FormHelperTest.php
View file

@ -1070,7 +1070,7 @@ class FormHelperTest extends CakeTestCase {
/**
* 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 @@ class FormHelperTest extends CakeTestCase {
/*
* #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

4
lib/Cake/Test/Case/View/Helper/PrototypeEngineHelperTest.php
View file

@ -283,8 +283,8 @@ class PrototypeEngineHelperTest extends CakeTestCase {
}
/**
* 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
*/

2
lib/Cake/Test/Case/View/HelperTest.php
View file

@ -556,7 +556,7 @@ class HelperTest extends CakeTestCase {
}
/**
* 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
*/

2
lib/Cake/Test/test_app/Plugin/TestPlugin/Lib/Error/TestPluginExceptionRenderer.php
View file

@ -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

2
lib/Cake/TestSuite/CakeTestRunner.php
View file

@ -39,7 +39,7 @@ class CakeTestRunner extends PHPUnit_TextUI_TestRunner {
}
/**
* 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

4
lib/Cake/TestSuite/CakeTestSuiteDispatcher.php
View file

@ -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 @@ class CakeTestSuiteDispatcher {
}
/**
* Checks that PHPUnit is installed. Will exit if it doesn't
* Checks that PHPUnit is installed. Will exit if it doesn't
*
* @return void
*/

Some files were not shown because too many files have changed in this diff Show more