Merge pull request #4 from phishy/master

fixed spelling errors

action/Controller.php

@@ -279,7 +279,7 @@ public function render(array $options = array()) {
 	 *                returned. Set to `false` to render a body as well.
 	 *              - `'exit'` _boolean_: Exit immediately after rendering. Defaults to `false`.
 	 *                Because `redirect()` does not exit by default, you should always prefix calls
-	 *                with a `return` statement, so that the action is always immedately exited.
+	 *                with a `return` statement, so that the action is always immediately exited.
 	 * @return object Returns the instance of the `Response` object associated with this controller.
 	 * @filter This method can be filtered.
 	 */

analysis/Logger.php

@@ -18,7 +18,7 @@
  *
  * When configuring adapters, you may specify one or more priorities for each, using the
  * `'priority'` key. This key can be a single priority level (string), or an array of multiple
- * levels. When a log message is written, all adpaters that are configured to accept the priority
+ * levels. When a log message is written, all adapters that are configured to accept the priority
  * level with which the message was written will receive the message.
  *
  * {{{
@@ -37,7 +37,7 @@
  *
  * {{{ Logger::write('alert', 'This is an alert-level message that will be logged in 2 places'); }}}
  *
- * Messages can also be written using the log priorty as a method name:
+ * Messages can also be written using the log priority as a method name:
  *
  * {{{ Logger::alert('This is an alert-level message that will be logged in 2 places'); }}}
  *

console/Request.php

@@ -9,7 +9,7 @@
 namespace lithium\console;
 
 /**
- * The `Request` class reprents a console request and holds information about it's
+ * The `Request` class represents a console request and holds information about it's
  * environment as well as passed arguments.
  *
  * @see lithium\console\Dispatcher

console/Router.php

@@ -10,7 +10,7 @@
 
 /**
  * The `Router` class uses an instance of `lithium\console\Request`, which represents an incoming
- * command-line invokation, to parse the correct command, and sub-command(s) and parameters, which
+ * command-line invocation, to parse the correct command, and sub-command(s) and parameters, which
  * are used by `lithium\console\Dispatcher` to load and execute the proper `Command` class.
  */
 class Router extends \lithium\core\Object {

core/Adaptable.php

@@ -311,7 +311,7 @@ protected static function _config($name) {
 	 * @param string $name The name of the configuration which is being accessed. This is the key
 	 *               name containing the specific set of configuration passed into `config()`.
 	 * @param array $config Contains the configuration assigned to `$name`. If this configuration is
-	 *              segregated by environment, then this will contian the configuration for the
+	 *              segregated by environment, then this will contain the configuration for the
 	 *              current environment.
 	 * @return array Returns the final array of settings for the given named configuration.
 	 */

core/ErrorHandler.php

@@ -65,7 +65,7 @@ class ErrorHandler extends \lithium\core\StaticObject {
 
 	/**
 	 * Setup basic error handling checks/types, as well as register the error and exception
-	 * hanlders.
+	 * handlers.
 	 *
 	 * Called on static class initialization (i.e. when first loaded).
 	 *

core/Libraries.php

@@ -172,7 +172,7 @@ class Libraries {
 	 *
 	 * Supposing you wanted to have the option of further organizing jobs by class type (some jobs
 	 * are related to updating caches, others to sending notifications, etc.), you can specify
-	 * mulitple paths per class type, with varying levels of specificity:
+	 * multiple paths per class type, with varying levels of specificity:
 	 * {{{
 	 * Libraries::paths(array('job' => array(
 	 * 	'{:library}\extensions\job\{:class}\{:name}',
@@ -479,7 +479,7 @@ public static function load($class, $require = false) {
 	 * @param string $class The class name to locate the physical file for. If `$options['dirs']` is
 	 *        set to `true`, `$class` may also be a namespace name, in which case the corresponding
 	 *        directory will be located.
-	 * @param array $options Options for converting `$class` to a phyiscal path:
+	 * @param array $options Options for converting `$class` to a physical path:
 	 *        - `'dirs'`: Defaults to `false`. If `true`, will attempt to case-sensitively look up
 	 *          directories in addition to files (in which case `$class` is assumed to actually be a
 	 *          namespace).

data/Collection.php

@@ -11,7 +11,7 @@
 /**
  * The `Collection` class extends the generic `lithium\util\Collection` class to provide
  * context-specific features for working with sets of data persisted by a backend data store. This
- * is a general abstraction that operates on abitrary sets of data from either relational or
+ * is a general abstraction that operates on arbitrary sets of data from either relational or
  * non-relational data stores.
  */
 abstract class Collection extends \lithium\util\Collection {

data/Entity.php

@@ -78,7 +78,7 @@ class Entity extends \lithium\core\Object {
 	/**
 	 * An array of key/value pairs corresponding to fields that should be updated using atomic
 	 * incrementing / decrementing operations. Keys match field names, and values indicate the value
-	 * each field should be incremented or decrememnted by.
+	 * each field should be incremented or decremented by.
 	 *
 	 * @see lithium\data\Entity::increment()
 	 * @see lithium\data\Entity::decrement()
@@ -314,7 +314,7 @@ public function update($id = null, array $data = array()) {
 	 * Defaults to `1` if no value is specified. Throws an exception if the specified field is
 	 * non-numeric.
 	 *
-	 * @param string $field The name of the field to be incrememnted.
+	 * @param string $field The name of the field to be incremented.
 	 * @param string $value The value to increment the field by. Defaults to `1` if this parameter
 	 *               is not specified.
 	 * @return integer Returns the current value of `$field`, based on the value retrieved from the

data/Source.php

@@ -63,7 +63,7 @@ abstract class Source extends \lithium\core\Object {
 	 * Constructor. Sets defaults and returns object.
 	 *
 	 * Options defined:
-	 * - 'autoConnect' `boolean` If true, a connection is made on initialisation. Defaults to true.
+	 * - 'autoConnect' `boolean` If true, a connection is made on initialization. Defaults to true.
 	 *
 	 * @param array $config
 	 * @return Source object

g11n/Locale.php

@@ -118,7 +118,7 @@ public static function decompose($locale) {
 	 * Returns a locale in its canonical form with tags formatted properly.
 	 *
 	 * @param string $locale A locale in an arbitrary form (i.e. `'ZH-HANS-HK_REVISED'`).
-	 * @return string A locale in it's canoncial form (i.e. `'zh_Hans_HK_REVISED'`).
+	 * @return string A locale in it's canonical form (i.e. `'zh_Hans_HK_REVISED'`).
 	 */
 	public static function canonicalize($locale) {
 		$tags = static::decompose($locale);
@@ -180,7 +180,7 @@ public static function cascade($locale) {
 	 *
 	 * @link http://www.ietf.org/rfc/rfc4647.txt
 	 * @param array $locales Locales to match against `$locale`.
-	 * @param string $locale A locale in it's canoncial form (i.e. `'zh_Hans_HK_REVISED'`).
+	 * @param string $locale A locale in it's canonical form (i.e. `'zh_Hans_HK_REVISED'`).
 	 * @return string|void The matched locale.
 	 */
 	public static function lookup($locales, $locale) {
@@ -203,7 +203,7 @@ public static function lookup($locales, $locale) {
 	 * @see lithium\g11n\Locale::lookup()
 	 * @param object|array $request An action or console request object or an array of locales.
 	 * @param array $available A list of locales to negotiate the preferred locale with.
-	 * @return string|void The preferred locale in it's canoncial form (i.e. `'fr_CA'`).
+	 * @return string|void The preferred locale in it's canonical form (i.e. `'fr_CA'`).
 	 */
 	public static function preferred($request, $available = null) {
 		if (is_array($request)) {
@@ -231,7 +231,7 @@ public static function preferred($request, $available = null) {
 	 *
 	 * @link http://www.ietf.org/rfc/rfc2616.txt
 	 * @param object $request An instance of `lithium\action\Request`.
-	 * @return array Preferred locales in their canoncial form (i.e. `'fr_CA'`).
+	 * @return array Preferred locales in their canonical form (i.e. `'fr_CA'`).
 	 */
 	protected static function _preferredAction($request) {
 		$regex  = '(?P<locale>[\w\-]+)+(?:;q=(?P<quality>[0-9]+\.[0-9]+))?';
@@ -252,16 +252,16 @@ protected static function _preferredAction($request) {
 	 * Detects preferred locales from a console request by looking at certain
 	 * environment variables. The environment variables may be present or not
 	 * depending on your system. If multiple variables are present the following
-	 * hierachy is used: `'LANGUAGE'`,  `'LC_ALL'`, `'LANG'`.
+	 * hierarchy is used: `'LANGUAGE'`,  `'LC_ALL'`, `'LANG'`.
 	 *
 	 * The locales of the `'LC_ALL'` and the `'LANG'` are formatted according
 	 * to the posix standard: `language(_territory)(.encoding)(@modifier)`.
-	 * Locales having such a format are automatically canoncialized and transformed
+	 * Locales having such a format are automatically canonicalized and transformed
 	 * into the `Locale` class' format.
 	 *
 	 * @link http://www.linux.com/archive/feature/53781
 	 * @param object $request An instance of `lithium\console\Request`.
-	 * @return array Preferred locales in their canoncial form (i.e. `'fr_CA'`).
+	 * @return array Preferred locales in their canonical form (i.e. `'fr_CA'`).
 	 */
 	protected static function _preferredConsole($request) {
 		$regex = '(?P<locale>[\w\_]+)(\.|@|$)+';

net/Socket.php

@@ -94,15 +94,15 @@ abstract public function read();
 	 * Writes data to the socket.
 	 *
 	 * @param mixed $data
-	 * @return boolean `true` if data has been succesfully written, `false` otherwise.
+	 * @return boolean `true` if data has been successfully written, `false` otherwise.
 	 */
 	abstract public function write($data);
 
 	/**
 	 * Sets the timeout on the socket *connection*.
 	 *
 	 * @param integer $time Seconds after the connection times out.
-	 * @return booelan `true` if timeout has been set, `false` otherwise.
+	 * @return Boolean `true` if timeout has been set, `false` otherwise.
 	 */
 	abstract public function timeout($time);
 

security/Password.php

@@ -42,7 +42,7 @@ class Password {
 	 *   resulting in the same hash; this prevents a potential attacker from
 	 *   compromising user accounts by using a database of most commonly used
 	 *   passwords.
-	 * - The salt generator's count interator can be increased within Lithium
+	 * - The salt generator's count iterator can be increased within Lithium
 	 *   or your application as computer hardware becomes faster; this results
 	 *   in slower hash generation, without invalidating existing passwords.
 	 *

security/validation/RequestToken.php

@@ -154,7 +154,7 @@ public static function key(array $options = array()) {
 	 * @param array $options The options to use when matching the key to the token:
 	 *              - `'sessionKey'` _string_: The key used when reading the token from the session.
 	 * @return boolean Returns `true` if the hash key is a cryptographic match to the stored
-	 *         session token. Returns `false` on failure, which indiciates a forged request attempt.
+	 *         session token. Returns `false` on failure, which indicates a forged request attempt.
 	 */
 	public static function check($key, array $options = array()) {
 		$defaults = array('sessionKey' => 'security.token');

storage/Cache.php

@@ -31,7 +31,7 @@
  * ));}}}
  *
  * Each adapter provides a consistent interface for the basic cache operations of `write`, `read`,
- * `delete` and `clear`, which can be used interchangably between all adapters. Some adapters
+ * `delete` and `clear`, which can be used interchangeably between all adapters. Some adapters
  * may provide additional methods that are not consistently available across other adapters.
  * To make use of these, it is always possible to call:
  *
@@ -234,7 +234,7 @@ public static function increment($name, $key, $offset = 1, array $options = arra
 	 * from the given cache configuration.
 	 *
 	 * @param string $name
-	 * @param string $key Key of numeric cache item to dercrement
+	 * @param string $key Key of numeric cache item to decrement
 	 * @param integer $offset Offset to decrement - defaults to 1.
 	 * @param mixed $options Options for this method.
 	 * @return integer|boolean Item's new value on successful decrement, false otherwise

storage/Session.php

@@ -12,7 +12,7 @@
 
 /**
  * The `Session` static class provides a consistent interface to configure and utilize the
- * different persistent storage adatpers included with Lithium, as well as your own adapters.
+ * different persistent storage adapters included with Lithium, as well as your own adapters.
  *
  * The Session layer of Lithium inherits from the common `Adaptable` class, which provides
  * the generic configuration setting & retrieval logic, as well as the logic required to
@@ -22,7 +22,7 @@
  * process, which will then be available to you in all other parts of your application.
  *
  * Each adapter provides a consistent interface for the basic cache operations of `write`, `read`
- * and `delete`, which can be used interchangably between all adapters.
+ * and `delete`, which can be used interchangeably between all adapters.
  *
  * For more information on `Session` methods and specific adapters, please see their relevant
  * documentation.

template/Helper.php

@@ -131,7 +131,7 @@ protected function _options(array $defaults, array $scope) {
 	 *
 	 * @param string $method name of method that is calling the render (for context filters)
 	 * @param string $string template key (in Helper::_strings) to render
-	 * @param array $params associatied array of template inserts {:key} will be replaced by value
+	 * @param array $params associated array of template inserts {:key} will be replaced by value
 	 * @param array $options
 	 * @return string Rendered HTML
 	 */

template/TemplateException.php

@@ -10,7 +10,7 @@
 
 /**
  * A `TemplateException` is thrown whenever a view template cannot be found, or a called template is
- * not readible or accessible for rendering. Also used by the view compiler if a compiled template
+ * not readable or accessible for rendering. Also used by the view compiler if a compiled template
  * cannot be written.
  */
 class TemplateException extends \RuntimeException {

template/View.php

@@ -193,7 +193,7 @@ class View extends \lithium\core\Object {
 	 *            templates. Defaults to `File`.
 	 *          - `'renderer'` _mixed_: Populates the view/layout with the data set from the
 	 *            controller. Defaults to `'File'`.
-	 *          - `request`: The request object to be made available in the view. Defalts to `null`.
+	 *          - `request`: The request object to be made available in the view. Defaults to `null`.
 	 *          - `vars`: Defaults to `array()`.
 	 * @return void
 	 */

test/Unit.php

@@ -536,11 +536,11 @@ public function assertCookie($expected, $headers = null) {
 	/**
 	 * Assert Cookie data is *not* set in headers.
 	 *
-	 * The value passed to `exepected` is an array of the cookie data, with at least the key and
+	 * The value passed to `expected` is an array of the cookie data, with at least the key and
 	 * value expected, but can support any of the following keys:
 	 * 	- `key`: the expected key
 	 * 	- `value`: the expected value
-	 * 	- `path`: optionally specifiy a path
+	 * 	- `path`: optionally specify a path
 	 * 	- `name`: optionally specify the cookie name
 	 * 	- `expires`: optionally assert a specific expire time
 	 *

util/Collection.php

@@ -134,7 +134,7 @@ class Collection extends \lithium\core\Object implements \ArrayAccess, \Iterator
 	 *
 	 * - A `to()` method, which handles the actual conversion.
 	 *
-	 * Once a class implements these methods, it may be registered per the followng:
+	 * Once a class implements these methods, it may be registered per the following:
 	 * {{{
 	 * Collection::formats('\lithium\net\http\Media');
 	 * }}}

util/Validator.php

@@ -12,7 +12,7 @@
 use InvalidArgumentException;
 
 /**
- * The `Validator` class provies static access to commonly used data validation logic. These common
+ * The `Validator` class provides static access to commonly used data validation logic. These common
  * routines cover HTML form input data such as phone and credit card numbers, dates and postal
  * codes, but also include general checks for regular expressions and booleans and numericality.
  *
@@ -30,7 +30,7 @@
  *
  * Data can also be validated against multiple rules, each having their own associated error
  * message. The rule structure is array-based and hierarchical based on rule names and
- * messages. Resposes match the keys present in the `$data` parameter of `check()` up with an array
+ * messages. Responses match the keys present in the `$data` parameter of `check()` up with an array
  * of rules which they violate.
  *
  * {{{ embed:lithium\tests\cases\util\ValidatorTest::testCheckMultipleHasFirstError(1-15) }}}