Skip to content
Permalink
Browse files

`a` / `an` typo fixes fot API

  • Loading branch information...
antograssiot committed Jul 30, 2014
1 parent 4bee5b4 commit aa42b80a4d386913a0b83ec1b18f396851f24919
@@ -197,7 +197,7 @@ public static function configured() {
/**
* Drops a cache engine. Deletes the cache configuration information
* If the deleted configuration is the last configuration using an certain engine,
* If the deleted configuration is the last configuration using a certain engine,
* the Engine instance is also unset.
*
* @param string $name A currently configured cache config you wish to remove.
@@ -381,7 +381,7 @@ protected function _generateRecords($tableInfo, $recordCount = 1) {
}
/**
* Convert a $records array into a a string.
* Convert a $records array into a string.
*
* @param array $records Array of records to be converted to string
* @return string A string value of the $records array.
@@ -248,7 +248,7 @@ protected function _interactive() {
* 'singularHumanName', 'pluralHumanName', 'fields', 'foreignKeys',
* 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'
*
* @return array Returns an variables to be made available to a view template
* @return array Returns a variables to be made available to a view template
*/
protected function _loadController() {
if (!$this->controllerName) {
@@ -47,7 +47,7 @@ public static function getStderr() {
}
/**
* Handle a exception in the console environment. Prints a message to stderr.
* Handle an exception in the console environment. Prints a message to stderr.
*
* @param Exception $exception The exception to handle
* @return void
@@ -170,7 +170,7 @@ public function __construct($stream = 'php://stdout') {
* Outputs a single or multiple messages to stdout. If no parameters
* are passed, outputs just a newline.
*
* @param string|array $message A string or a an array of strings to output
* @param string|array $message A string or an array of strings to output
* @param int $newlines Number of newlines to append
* @return int Returns the number of bytes returned from writing to stdout.
*/
@@ -45,7 +45,7 @@ class HelpFormatter {
protected $_maxOptions = 6;
/**
* Build the help formatter for a an OptionParser
* Build the help formatter for an OptionParser
*
* @param ConsoleOptionParser $parser The option parser help is being generated for.
*/
@@ -594,7 +594,7 @@ public function wrapText($text, $options = array()) {
* 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
* @param string|array $message A string or an array of strings to output
* @param int $newlines Number of newlines to append
* @param int $level The message's output level, see above.
* @return int|bool Returns the number of bytes returned from writing to stdout.
@@ -618,7 +618,7 @@ public function out($message = null, $newlines = 1, $level = Shell::NORMAL) {
* Outputs a single or multiple error messages to stderr. If no parameters
* are passed outputs just a newline.
*
* @param string|array $message A string or a an array of strings to output
* @param string|array $message A string or an array of strings to output
* @param int $newlines Number of newlines to append
* @return void
* @link http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::err
@@ -590,7 +590,7 @@ public static function location($className) {
* not construct any classes contained in the files. It will only find and require() the file.
*
* @param string|array $type The type of Class if passed as a string, or all params can be passed as
* an single array to $type.
* a single array to $type.
* @param string $name Name of the Class or a unique name for the file
* @param bool|array $parent boolean true if Class Parent should be searched, accepts key => value
* array('parent' => $parent, 'file' => $file, 'search' => $search, 'ext' => '$ext');
@@ -33,7 +33,7 @@ class CakePlugin {
protected static $_plugins = array();
/**
* Loads a plugin and optionally loads bootstrapping, routing files or loads a initialization function
* Loads a plugin and optionally loads bootstrapping, routing files or loads an initialization function
*
* Examples:
*
@@ -35,7 +35,7 @@
*
* You can implement application specific exception handling in one of a few ways:
*
* - Create a AppController::appError();
* - Create an AppController::appError();
* - Create a subclass of ExceptionRenderer and configure it to be the `Exception.renderer`
*
* #### Using AppController::appError();
@@ -696,7 +696,7 @@ protected function _buildIndexSubPart($lengths, $column) {
}
/**
* Returns an detailed array of sources (tables) in the database.
* Returns a detailed array of sources (tables) in the database.
*
* @param string $name Table name to get parameters
* @return array Array of table names in the database
@@ -3246,7 +3246,7 @@ public function createSchema($schema, $tableName = null) {
}
/**
* Generate a alter syntax from CakeSchema::compare()
* Generate an alter syntax from CakeSchema::compare()
*
* @param mixed $compare The comparison data.
* @param string $table The table name.
@@ -950,7 +950,7 @@ public function expires($time = null) {
}
/**
* Sets the Last-Modified header for the response by taking an modification time
* Sets the Last-Modified header for the response by taking a modification time
* If called with no parameters it will return the current Last-Modified value
*
* ## Examples:
@@ -1003,7 +1003,7 @@ public function notModified() {
* parameters are passed, then an array with the current Vary header
* value is returned
*
* @param string|array $cacheVariances a single Vary string or a array
* @param string|array $cacheVariances a single Vary string or an array
* containing the list for variances.
* @return array
*/
@@ -1206,7 +1206,7 @@ public static function stripPlugin($base, $plugin = null) {
/**
* Instructs the router to parse out file extensions from the URL.
*
* For example, http://example.com/posts.rss would yield an file extension of "rss".
* For example, http://example.com/posts.rss would yield a file extension of "rss".
* The file extension itself is made available in the controller as
* `$this->params['ext']`, and is used by the RequestHandler component to
* automatically switch to alternate layouts and templates, and load helpers
@@ -197,7 +197,7 @@ public function offset($offset = false, $seek = SEEK_SET) {
}
/**
* Prepares a ASCII string for writing. Converts line endings to the
* Prepares an ASCII string for writing. Converts line endings to the
* correct terminator for the current platform. If Windows, "\r\n" will be used,
* all other platforms will use "\n"
*
@@ -234,7 +234,7 @@ public function setPriority($name, $priority = null) {
}
/**
* Disables callbacks on a object or array of objects. Public object methods are still
* Disables callbacks on an object or array of objects. Public object methods are still
* callable as normal.
*
* @param string|array $name CamelCased name of the objects(s) to disable (string or array)
@@ -910,7 +910,7 @@ public static function flatten($data, $separator = '.') {
}
/**
* Expand/unflattens an string to an array
* Expand/unflattens a string to an array
*
* For example, unflattens an array that was collapsed with `Set::flatten()`
* into a multi-dimensional array. So, `array('0.Foo.Bar' => 'Far')` becomes
@@ -325,7 +325,7 @@ protected static function _createChild($data) {
}
/**
* Returns this XML structure as a array.
* Returns this XML structure as an array.
*
* @param SimpleXMLElement|DOMDocument|DOMNode $obj SimpleXMLElement, DOMDocument or DOMNode instance
* @return array Array representation of the XML structure.
@@ -329,7 +329,7 @@ public function tagIsInvalid() {
* If an array is passed and $options argument is empty, the array will be used as options.
* If `false` no model is used.
* @param array $options An array of html attributes and options.
* @return string An formatted opening FORM tag.
* @return string A formatted opening FORM tag.
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-create
*/
public function create($model = null, $options = array()) {
@@ -1483,7 +1483,7 @@ public function checkbox($fieldName, $options = array()) {
* - `hiddenField` - boolean to indicate if you want the results of radio() to include
* a hidden input with a value of ''. This is useful for creating radio sets that non-continuous
* - `disabled` - Set to `true` or `disabled` to disable all the radio buttons.
* - `empty` - Set to `true` to create a input with the value '' as the first option. When `true`
* - `empty` - Set to `true` to create an input with the value '' as the first option. When `true`
* the radio label will be 'empty'. Set this option to a string to control the label value.
*
* @param string $fieldName Name of a field, like this "Modelname.fieldname"
@@ -2257,7 +2257,7 @@ public function year($fieldName, $minYear = null, $maxYear = null, $attributes =
* ### Attributes:
*
* - `monthNames` - If false, 2 digit numbers will be used instead of text.
* If a array, the given array will be used.
* If an array, the given array will be used.
* - `empty` - If true, the empty select option is shown. If a string,
* that string is displayed as the empty element.
* - `value` The selected value of the input.
@@ -2455,7 +2455,7 @@ public function meridian($fieldName, $attributes = array()) {
* ### Attributes:
*
* - `monthNames` If false, 2 digit numbers will be used instead of text.
* If a array, the given array will be used.
* If an array, the given array will be used.
* - `minYear` The lowest year to use in the year select
* - `maxYear` The maximum year to use in the year select
* - `interval` The interval for the minutes select. Defaults to 1
@@ -2933,7 +2933,7 @@ protected function _generateOptions($name, $options = array()) {
* Disabling the field using the `disabled` option, will also omit the field from being
* part of the hashed key.
*
* This method will convert a numerically indexed 'disabled' into a associative
* This method will convert a numerically indexed 'disabled' into an associative
* value. FormHelper's internals expect associative options.
*
* @param string $field Name of the field to initialize options for.
@@ -476,7 +476,7 @@ protected function _utf8ToHex($string) {
abstract public function serializeForm($options = array());
/**
* Parse an options assoc array into an JavaScript object literal.
* Parse an options assoc array into a JavaScript object literal.
* Similar to object() but treats any non-integer value as a string,
* does not include `{ }`
*
@@ -225,7 +225,7 @@ public function effect($name, $options = array()) {
}
/**
* Create an new Request.
* Create a new Request.
*
* Requires `Request`. If you wish to use 'update' key you must have ```Request.HTML```
* if you wish to do Json requests you will need ```JSON``` and ```Request.JSON```.

0 comments on commit aa42b80

Please sign in to comment.
You can’t perform that action at this time.