Merge pull request #349 from shama/patch-spelling

Spelling and grammar fixes

lib/Cake/Cache/Engine/FileEngine.php

@@ -84,7 +84,7 @@ public function init($settings = array()) {
 /**
  * Garbage collection. Permanently remove all expired and deleted data
  *
- * @return boolean True if garbage collection was succesful, false on failure
+ * @return boolean True if garbage collection was successful, false on failure
  */
 	public function gc() {
 		return $this->clear(true);
@@ -273,7 +273,7 @@ public function increment($key, $offset = 1) {
 
 /**
  * Sets the current cache key this class is managing, and creates a writable SplFileObject
- * for the cache file the key is refering to.
+ * for the cache file the key is referring to.
  *
  * @param string $key The key
  * @param boolean $createKey Whether the key should be created if it doesn't exists, or not

lib/Cake/Console/Command/ConsoleShell.php

@@ -88,7 +88,7 @@ public function help() {
 		$out .= "\n";
 		$out .= 'To dynamically set associations, you can do the following:';
 		$out .= "\tModelA bind <association> ModelB";
-		$out .= "where the supported assocations are hasOne, hasMany, belongsTo, hasAndBelongsToMany";
+		$out .= "where the supported associations are hasOne, hasMany, belongsTo, hasAndBelongsToMany";
 		$out .= "\n";
 		$out .= 'To dynamically remove associations, you can do the following:';
 		$out .= "\t ModelA unbind <association> ModelB";

lib/Cake/Console/Command/Task/FixtureTask.php

@@ -91,7 +91,7 @@ public function getOptionParser() {
 
 /**
  * Execution method always used for tasks
- * Handles dispatching to interactive, named, or all processeses.
+ * Handles dispatching to interactive, named, or all processes.
  *
  * @return void
  */

lib/Cake/Console/Command/Task/ModelTask.php

@@ -516,7 +516,7 @@ public function doAssociations($model) {
  * Find belongsTo relations and add them to the associations list.
  *
  * @param Model $model Model instance of model being generated.
- * @param array $associations Array of inprogress associations
+ * @param array $associations Array of in progress associations
  * @return array $associations with belongsTo added in.
  */
 	public function findBelongsTo($model, $associations) {
@@ -545,7 +545,7 @@ public function findBelongsTo($model, $associations) {
  * Find the hasOne and HasMany relations and add them to associations list
  *
  * @param Model $model Model instance being generated
- * @param array $associations Array of inprogress associations
+ * @param array $associations Array of in progress associations
  * @return array $associations with hasOne and hasMany added in.
  */
 	public function findHasOneAndMany($model, $associations) {

lib/Cake/Console/Command/Task/PluginTask.php

@@ -75,7 +75,7 @@ protected function _interactive($plugin = null) {
 		}
 
 		if (!$this->bake($plugin)) {
-			$this->error(__d('cake_console', "An error occured trying to bake: %s in %s", $plugin, $this->path . $plugin));
+			$this->error(__d('cake_console', "An error occurred trying to bake: %s in %s", $plugin, $this->path . $plugin));
 		}
 	}
 

lib/Cake/Controller/Component/Auth/BaseAuthenticate.php

@@ -90,7 +90,7 @@ protected function _findUser($username, $password) {
 	}
 
 /**
- * Hash the plain text password so that it matches the hashed/encrytped password
+ * Hash the plain text password so that it matches the hashed/encrypted password
  * in the datasource.
  *
  * @param string $password The plain text password.
@@ -111,7 +111,7 @@ abstract public function authenticate(CakeRequest $request, CakeResponse $respon
 
 /**
  * Allows you to hook into AuthComponent::logout(),
- * and implement specialized logout behaviour.
+ * and implement specialized logout behavior.
  *
  * All attached authentication objects will have this method
  * called when a user logs out.

lib/Cake/Controller/Component/AuthComponent.php

@@ -204,7 +204,7 @@ class AuthComponent extends Component {
 
 /**
  * Error to display when user attempts to access an object or action to which they do not have
- * acccess.
+ * access.
  *
  * @var string
  * @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#AuthComponent::$authError

lib/Cake/Controller/Component/EmailComponent.php

@@ -93,8 +93,8 @@ class EmailComponent extends Component {
 	public $bcc = array();
 
 /**
- * The date to put in the Date: header.  This should be a date
- * conformant with the RFC2822 standard.  Leave null, to have
+ * The date to put in the Date: header. This should be a date
+ * conforming with the RFC2822 standard. Leave null, to have
  * today's date generated.
  *
  * @var string
@@ -198,7 +198,7 @@ class EmailComponent extends Component {
 	public $xMailer = 'CakePHP Email Component';
 
 /**
- * The list of paths to search if an attachment isnt absolute
+ * The list of paths to search if an attachment isn't absolute
  *
  * @var array
  */
@@ -465,7 +465,7 @@ protected function _formatAddresses($addresses) {
 
 /**
  * Remove certain elements (such as bcc:, to:, %0a) from given value.
- * Helps prevent header injection / mainipulation on user content.
+ * Helps prevent header injection / manipulation on user content.
  *
  * @param string $value Value to strip
  * @param boolean $message Set to true to indicate main message content

lib/Cake/Controller/Component/PaginatorComponent.php

@@ -19,7 +19,7 @@
 
 /**
  * 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 convience wrapper on Controller as well.
+ * component is to call the paginate() method. There is a convenience wrapper on Controller as well.
  *
  * ### Configuring pagination
  *

lib/Cake/Controller/Component/RequestHandlerComponent.php

@@ -485,7 +485,7 @@ public function requestedWith($type = null) {
  *   '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
- *    a boolean will be returnend if that type is preferred.
+ *    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.
  * @see RequestHandlerComponent::setContent()

lib/Cake/Core/Object.php

@@ -55,7 +55,7 @@ public function toString() {
  * or tie plugins into a main application. requestAction can be used to return rendered views
  * or fetch the return value from controller actions.
  *
- * Under the hood this method uses Router::reverse() to convert the $url parmeter into a string
+ * 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()
  *
  * #### Passing POST and GET data
@@ -64,7 +64,7 @@ public function toString() {
  * GET data.  The `$extra['data']` parameter allows POST data simulation.
  *
  * @param mixed $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 paramenter.
+ *    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
  *    also be used to submit GET/POST data, and named/passed arguments.
  * @return mixed Boolean true or false on success/failure, or contents
@@ -144,7 +144,7 @@ protected function _stop($status = 0) {
 	}
 
 /**
- * Convience 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

lib/Cake/Model/Behavior/ContainableBehavior.php

@@ -259,7 +259,7 @@ public function resetBindings($Model) {
  * @param Model $Model Model on which binding restriction is being applied
  * @param array $contain Parameters to use for restricting this model
  * @param array $containments Current set of containments
- * @param boolean $throwErrors Wether unexisting bindings show throw errors
+ * @param boolean $throwErrors Whether non-existent bindings show throw errors
  * @return array Containments
  */
 	public function containments($Model, $contain, $containments = array(), $throwErrors = null) {

lib/Cake/Model/Behavior/TreeBehavior.php

@@ -73,7 +73,7 @@ public function setup($Model, $config = array()) {
 /**
  * After save method. Called after all saves
  *
- * Overriden to transparently manage setting the lft and rght fields if and only if the parent field is included in the
+ * Overridden to transparently manage setting the lft and rght fields if and only if the parent field is included in the
  * parameters to be saved.
  *
  * @param Model $Model Model instance.
@@ -125,7 +125,7 @@ public function beforeDelete($Model, $cascade = true) {
 /**
  * Before save method. Called before all saves
  *
- * Overriden to transparently manage setting the lft and rght fields if and only if the parent field is included in the
+ * Overridden to transparently manage setting the lft and rght fields if and only if the parent field is included in the
  * parameters to be saved. For newly created nodes with NO parent the left and right field values are set directly by
  * this method bypassing the setParent logic.
  *
@@ -624,7 +624,7 @@ public function recover($Model, $mode = 'parent', $missingParentAction = null) {
  * Options:
  *
  * - 'id' id of record to use as top node for reordering
- * - 'field' Which field to use in reordeing defaults to displayField
+ * - 'field' Which field to use in reordering defaults to displayField
  * - 'order' Direction to order either DESC or ASC (defaults to ASC)
  * - 'verify' Whether or not to verify the tree before reorder. defaults to true.
  *

lib/Cake/Model/BehaviorCollection.php

@@ -208,7 +208,7 @@ public function detach($name) {
 /**
  * Dispatches a behavior method.  Will call either normal methods or mapped methods.
  *
- * If a method is not handeled by the BehaviorCollection, and $strict is false, a
+ * 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.
  *
  * @param Model $model The model the method was originally called on.
@@ -253,8 +253,8 @@ public function methods() {
  *
  * @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 returnned, if its true, an array
- *   containing callback information will be returnned.  For mapped methods the array will have 3 elements.
+ * @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.
  */
 	public function hasMethod($method, $callback = false) {
 		if (isset($this->_methods[$method])) {

lib/Cake/Model/Datasource/Database/Mysql.php

@@ -181,7 +181,7 @@ public function enabled() {
  * Returns an array of sources (tables) in the database.
  *
  * @param mixed $data
- * @return array Array of tablenames in the database
+ * @return array Array of table names in the database
  */
 	public function listSources($data = null) {
 		$cache = parent::listSources();
@@ -543,11 +543,11 @@ public function dropSchema(CakeSchema $schema, $table = null) {
 	}
 
 /**
- * Generate MySQL table parameter alteration statementes for a table.
+ * Generate MySQL table parameter alteration statements for a table.
  *
  * @param string $table Table to alter parameters for.
  * @param array $parameters Parameters to add & drop.
- * @return array Array of table property alteration statementes.
+ * @return array Array of table property alteration statements.
  * @todo Implement this method.
  */
 	protected function _alterTableParameters($table, $parameters) {
@@ -603,7 +603,7 @@ protected function _alterIndexes($table, $indexes) {
  * Returns an detailed array of sources (tables) in the database.
  *
  * @param string $name Table name to get parameters
- * @return array Array of tablenames in the database
+ * @return array Array of table names in the database
  */
 	public function listDetailedSources($name = null) {
 		$condition = '';

lib/Cake/Model/Datasource/Database/Postgres.php

@@ -153,7 +153,7 @@ public function enabled() {
  * Returns an array of tables in the database. If there are no tables, an error is raised and the application exits.
  *
  * @param mixed $data
- * @return array Array of tablenames in the database
+ * @return array Array of table names in the database
  */
 	public function listSources($data = null) {
 		$cache = parent::listSources();
@@ -296,7 +296,7 @@ public function getSequence($table, $field = 'id') {
  * Deletes all the records in a table and drops all associated auto-increment sequences
  *
  * @param mixed $table A string or model class representing the table to be truncated
- * @param boolean $reset true for resseting the sequence, false to leave it as is.
+ * @param boolean $reset true for resetting the sequence, false to leave it as is.
  *						and if 1, sequences are not modified
  * @return boolean	SQL TRUNCATE TABLE statement, false if not applicable.
  */
@@ -337,7 +337,7 @@ public function name($data) {
  * Generates the fields list of an SQL query.
  *
  * @param Model $model
- * @param string $alias Alias tablename
+ * @param string $alias Alias table name
  * @param mixed $fields
  * @param boolean $quote
  * @return array
@@ -397,7 +397,7 @@ public function fields($model, $alias = null, $fields = array(), $quote = true)
  * Quotes the fields in a function call.
  *
  * @param string $match matched string
- * @return string quoted strig
+ * @return string quoted string
  */
 	protected function _quoteFunctionField($match) {
 		$prepend = '';
@@ -737,7 +737,7 @@ public function fetchResult() {
  * Translates between PHP boolean values and PostgreSQL boolean values
  *
  * @param mixed $data Value to be translated
- * @param boolean $quote true to quote a boolean to be used in a query, flase to return the boolean value
+ * @param boolean $quote true to quote a boolean to be used in a query, false to return the boolean value
  * @return boolean Converted boolean value
  */
 	public function boolean($data, $quote = false) {

lib/Cake/Model/Datasource/Database/Sqlite.php

@@ -131,7 +131,7 @@ public function enabled() {
  * Returns an array of tables in the database. If there are no tables, an error is raised and the application exits.
  *
  * @param mixed $data
- * @return array Array of tablenames in the database
+ * @return array Array of table names in the database
  */
 	public function listSources($data = null) {
 		$cache = parent::listSources();
@@ -454,7 +454,7 @@ public function buildIndex($indexes, $table = null) {
 	}
 
 /**
- * Overrides DboSource::index to handle SQLite indexe introspection
+ * Overrides DboSource::index to handle SQLite index introspection
  * Returns an array of the indexes in given table name.
  *
  * @param string $model Name of model to inspect

lib/Cake/Model/Datasource/Database/Sqlserver.php

@@ -167,7 +167,7 @@ public function enabled() {
  * Returns an array of sources (tables) in the database.
  *
  * @param mixed $data
- * @return array Array of tablenames in the database
+ * @return array Array of table names in the database
  */
 	public function listSources($data = null) {
 		$cache = parent::listSources();
@@ -260,7 +260,7 @@ public function describe($model) {
  * Generates the fields list of an SQL query.
  *
  * @param Model $model
- * @param string $alias Alias tablename
+ * @param string $alias Alias table name
  * @param array $fields
  * @param boolean $quote
  * @return array
@@ -748,8 +748,8 @@ public function lastAffected($source = null) {
  * @param string $sql SQL statement
  * @param array $params list of params to be bound to query (supported only in select)
  * @param array $prepareOptions Options to be used in the prepare statement
- * @return mixed PDOStatement if query executes with no problem, true as the result of a succesfull, false on error
- * query returning no rows, suchs as a CREATE statement, false otherwise
+ * @return mixed PDOStatement if query executes with no problem, true as the result of a successful, false on error
+ * query returning no rows, such as a CREATE statement, false otherwise
  */
 	protected function _execute($sql, $params = array(), $prepareOptions = array()) {
 		$this->_lastAffected = false;