mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2025-01-18 18:46:17 +00:00
Spelling and grammar fixes
This commit is contained in:
parent
0f71254fe1
commit
8197f87dbc
45 changed files with 97 additions and 97 deletions
|
@ -84,7 +84,7 @@ class FileEngine extends CacheEngine {
|
|||
/**
|
||||
* 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 @@ class FileEngine extends CacheEngine {
|
|||
|
||||
/**
|
||||
* 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
|
||||
|
|
|
@ -88,7 +88,7 @@ class ConsoleShell extends AppShell {
|
|||
$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";
|
||||
|
|
|
@ -91,7 +91,7 @@ class FixtureTask extends BakeTask {
|
|||
|
||||
/**
|
||||
* Execution method always used for tasks
|
||||
* Handles dispatching to interactive, named, or all processeses.
|
||||
* Handles dispatching to interactive, named, or all processes.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
|
|
@ -516,7 +516,7 @@ class ModelTask extends BakeTask {
|
|||
* 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 @@ class ModelTask extends BakeTask {
|
|||
* 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) {
|
||||
|
|
|
@ -75,7 +75,7 @@ class PluginTask extends AppShell {
|
|||
}
|
||||
|
||||
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));
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
@ -90,7 +90,7 @@ abstract class BaseAuthenticate {
|
|||
}
|
||||
|
||||
/**
|
||||
* 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 class BaseAuthenticate {
|
|||
|
||||
/**
|
||||
* 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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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 @@ class EmailComponent extends Component {
|
|||
|
||||
/**
|
||||
* 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
|
||||
|
|
|
@ -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
|
||||
*
|
||||
|
|
|
@ -485,7 +485,7 @@ class RequestHandlerComponent extends Component {
|
|||
* '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()
|
||||
|
|
|
@ -55,7 +55,7 @@ class Object {
|
|||
* 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 @@ class Object {
|
|||
* 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 @@ class Object {
|
|||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
|
|
|
@ -259,7 +259,7 @@ class ContainableBehavior extends ModelBehavior {
|
|||
* @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) {
|
||||
|
|
|
@ -73,7 +73,7 @@ class TreeBehavior extends ModelBehavior {
|
|||
/**
|
||||
* 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 @@ class TreeBehavior extends ModelBehavior {
|
|||
/**
|
||||
* 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 @@ class TreeBehavior extends ModelBehavior {
|
|||
* 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.
|
||||
*
|
||||
|
|
|
@ -208,7 +208,7 @@ class BehaviorCollection extends ObjectCollection {
|
|||
/**
|
||||
* 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 @@ class BehaviorCollection extends ObjectCollection {
|
|||
*
|
||||
* @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])) {
|
||||
|
|
|
@ -181,7 +181,7 @@ class Mysql extends DboSource {
|
|||
* 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 @@ class Mysql extends DboSource {
|
|||
}
|
||||
|
||||
/**
|
||||
* 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 @@ class Mysql extends DboSource {
|
|||
* 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 = '';
|
||||
|
|
|
@ -153,7 +153,7 @@ class Postgres extends DboSource {
|
|||
* 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 @@ class Postgres extends DboSource {
|
|||
* 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 @@ class Postgres extends DboSource {
|
|||
* 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 @@ class Postgres extends DboSource {
|
|||
* 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 @@ class Postgres extends DboSource {
|
|||
* 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) {
|
||||
|
|
|
@ -131,7 +131,7 @@ class Sqlite extends DboSource {
|
|||
* 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 @@ class Sqlite extends DboSource {
|
|||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
|
|
|
@ -167,7 +167,7 @@ class Sqlserver extends DboSource {
|
|||
* 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 @@ class Sqlserver extends DboSource {
|
|||
* 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 @@ class Sqlserver extends DboSource {
|
|||
* @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;
|
||||
|
|
|
@ -135,7 +135,7 @@ class DboSource extends DataSource {
|
|||
protected $_queriesLogMax = 200;
|
||||
|
||||
/**
|
||||
* Caches serialzed results of executed queries
|
||||
* Caches serialized results of executed queries
|
||||
*
|
||||
* @var array Maximum number of queries in the queries log.
|
||||
*/
|
||||
|
@ -344,7 +344,7 @@ class DboSource extends DataSource {
|
|||
|
||||
/**
|
||||
* Returns an object to represent a database identifier in a query. Expression objects
|
||||
* are not sanitized or esacped.
|
||||
* are not sanitized or escaped.
|
||||
*
|
||||
* @param string $identifier A SQL expression to be used as an identifier
|
||||
* @return stdClass An object representing a database identifier to be used in a query
|
||||
|
@ -358,7 +358,7 @@ class DboSource extends DataSource {
|
|||
|
||||
/**
|
||||
* Returns an object to represent a database expression in a query. Expression objects
|
||||
* are not sanitized or esacped.
|
||||
* are not sanitized or escaped.
|
||||
*
|
||||
* @param string $expression An arbitrary SQL expression to be inserted into a query.
|
||||
* @return stdClass An object representing a database expression to be used in a query
|
||||
|
@ -418,7 +418,7 @@ class DboSource extends DataSource {
|
|||
* @param array $params list of params to be bound to query
|
||||
* @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 successful, false on error
|
||||
* query returning no rows, suchs as a CREATE statement, false otherwise
|
||||
* query returning no rows, such as a CREATE statement, false otherwise
|
||||
*/
|
||||
protected function _execute($sql, $params = array(), $prepareOptions = array()) {
|
||||
$sql = trim($sql);
|
||||
|
@ -744,7 +744,7 @@ class DboSource extends DataSource {
|
|||
* A read will either return the value or null.
|
||||
*
|
||||
* @param string $method Name of the method being cached.
|
||||
* @param string $key The keyname for the cache operation.
|
||||
* @param string $key The key name for the cache operation.
|
||||
* @param mixed $value The value to cache into memory.
|
||||
* @return mixed Either null on failure, or the value if its set.
|
||||
*/
|
||||
|
@ -1791,7 +1791,7 @@ class DboSource extends DataSource {
|
|||
* @param array $fields
|
||||
* @param boolean $quoteValues If values should be quoted, or treated as SQL snippets
|
||||
* @param boolean $alias Include the model alias in the field name
|
||||
* @return array Fields and values, quoted and preparted
|
||||
* @return array Fields and values, quoted and prepared
|
||||
*/
|
||||
protected function _prepareUpdateFields($model, $fields, $quoteValues = true, $alias = false) {
|
||||
$quotedAlias = $this->startQuote . $model->alias . $this->endQuote;
|
||||
|
@ -2048,7 +2048,7 @@ class DboSource extends DataSource {
|
|||
*
|
||||
* @param Model $model
|
||||
* @param mixed $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 existance 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.
|
||||
|
@ -2110,7 +2110,7 @@ class DboSource extends DataSource {
|
|||
* Converts model virtual fields into sql expressions to be fetched later
|
||||
*
|
||||
* @param Model $model
|
||||
* @param string $alias Alias tablename
|
||||
* @param string $alias Alias table name
|
||||
* @param mixed $fields virtual fields to be used on query
|
||||
* @return array
|
||||
*/
|
||||
|
@ -2128,7 +2128,7 @@ class DboSource extends DataSource {
|
|||
* 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 If false, returns fields array unquoted
|
||||
* @return array
|
||||
|
@ -2505,7 +2505,7 @@ class DboSource extends DataSource {
|
|||
* Auxiliary function to quote matches `Model.fields` from a preg_replace_callback call
|
||||
*
|
||||
* @param string $match matched string
|
||||
* @return string quoted strig
|
||||
* @return string quoted string
|
||||
*/
|
||||
protected function _quoteMatchedField($match) {
|
||||
if (is_numeric($match[0])) {
|
||||
|
|
|
@ -725,7 +725,7 @@ class Model extends Object {
|
|||
/**
|
||||
* Handles the lazy loading of model associations by looking in the association arrays for the requested variable
|
||||
*
|
||||
* @param string $name variable tested for existance in class
|
||||
* @param string $name variable tested for existence in class
|
||||
* @return boolean true if the variable exists (if is a not loaded model association it will be created), false otherwise
|
||||
*/
|
||||
public function __isset($name) {
|
||||
|
@ -1395,7 +1395,7 @@ class Model extends Object {
|
|||
* Returns a list of fields from the database, and sets the current model
|
||||
* data (Model::$data) with the record found.
|
||||
*
|
||||
* @param mixed $fields String of single fieldname, or an array of fieldnames.
|
||||
* @param mixed $fields String of single field name, or an array of field names.
|
||||
* @param mixed $id The ID of the record to read
|
||||
* @return array Array of database fields, or false if not found
|
||||
* @link http://book.cakephp.org/2.0/en/models/retrieving-your-data.html#model-read
|
||||
|
@ -1850,7 +1850,7 @@ class Model extends Object {
|
|||
}
|
||||
|
||||
/**
|
||||
* Backwards compatible passtrough method for:
|
||||
* Backwards compatible passthrough method for:
|
||||
* saveMany(), validateMany(), saveAssociated() and validateAssociated()
|
||||
*
|
||||
* Saves multiple individual records for a single model; Also works with a single record, as well as
|
||||
|
|
|
@ -483,7 +483,7 @@ class CakeRequest implements ArrayAccess {
|
|||
* ### Callback detectors
|
||||
*
|
||||
* Callback detectors allow you to provide a 'callback' type to handle the check. The callback will
|
||||
* recieve the request object as its only parameter.
|
||||
* receive the request object as its only parameter.
|
||||
*
|
||||
* e.g `addDetector('custom', array('callback' => array('SomeClass', 'somemethod')));`
|
||||
*
|
||||
|
|
|
@ -423,7 +423,7 @@ class CakeResponse {
|
|||
* will have the same effect as only doing `header('WWW-Authenticate: Not-Negotiate');`
|
||||
*
|
||||
* @param mixed $header. An array of header strings or a single header string
|
||||
* - an assotiative array of "header name" => "header value" is also accepted
|
||||
* - an associative array of "header name" => "header value" is also accepted
|
||||
* - an array of string headers is also accepted
|
||||
* @param mixed $value. The header value.
|
||||
* @return array list of headers to be sent
|
||||
|
@ -674,7 +674,7 @@ class CakeResponse {
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the correct headers to instruct the browser to dowload the response as a file.
|
||||
* Sets the correct headers to instruct the browser to download the response as a file.
|
||||
*
|
||||
* @param string $filename the name of the file as the browser will download the response
|
||||
* @return void
|
||||
|
|
|
@ -42,7 +42,7 @@ class DigestAuthentication {
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrive information about the authetication
|
||||
* Retrieve information about the authentication
|
||||
*
|
||||
* @param HttpSocket $http
|
||||
* @param array $authInfo
|
||||
|
|
|
@ -74,7 +74,7 @@ class HttpResponse implements ArrayAccess {
|
|||
public $raw = '';
|
||||
|
||||
/**
|
||||
* Contructor
|
||||
* Constructor
|
||||
*
|
||||
* @param string $message
|
||||
*/
|
||||
|
@ -168,7 +168,7 @@ class HttpResponse implements ArrayAccess {
|
|||
* Generic function to decode a $body with a given $encoding. Returns either an array with the keys
|
||||
* 'body' and 'header' or false on failure.
|
||||
*
|
||||
* @param string $body A string continaing the body to decode.
|
||||
* @param string $body A string containing the body to decode.
|
||||
* @param mixed $encoding Can be false in case no encoding is being used, or a string representing the encoding.
|
||||
* @return mixed Array of response headers and body or false.
|
||||
*/
|
||||
|
@ -191,7 +191,7 @@ class HttpResponse implements ArrayAccess {
|
|||
* Decodes a chunked message $body and returns either an array with the keys 'body' and 'header' or false as
|
||||
* a result.
|
||||
*
|
||||
* @param string $body A string continaing the chunked body to decode.
|
||||
* @param string $body A string containing the chunked body to decode.
|
||||
* @return mixed Array of response headers and body or false.
|
||||
* @throws SocketException
|
||||
*/
|
||||
|
@ -283,7 +283,7 @@ class HttpResponse implements ArrayAccess {
|
|||
* Parses cookies in response headers.
|
||||
*
|
||||
* @param array $header Header array containing one ore more 'Set-Cookie' headers.
|
||||
* @return mixed Either false on no cookies, or an array of cookies recieved.
|
||||
* @return mixed Either false on no cookies, or an array of cookies received.
|
||||
* @todo Make this 100% RFC 2965 confirm
|
||||
*/
|
||||
public function parseCookies($header) {
|
||||
|
@ -411,7 +411,7 @@ class HttpResponse implements ArrayAccess {
|
|||
}
|
||||
|
||||
/**
|
||||
* ArrayAccess - 0ffset Set
|
||||
* ArrayAccess - Offset Set
|
||||
*
|
||||
* @param mixed $offset
|
||||
* @param mixed $value
|
||||
|
|
|
@ -610,7 +610,7 @@ class HttpSocket extends CakeSocket {
|
|||
*
|
||||
* @param mixed $uri Either A $uri array, or a request string. Will use $this->config if left empty.
|
||||
* @param string $uriTemplate The Uri template/format to use.
|
||||
* @return mixed A fully qualified URL formated according to $uriTemplate, or false on failure
|
||||
* @return mixed A fully qualified URL formatted according to $uriTemplate, or false on failure
|
||||
*/
|
||||
protected function _buildUri($uri = array(), $uriTemplate = '%scheme://%user:%pass@%host:%port/%path?%query#%fragment') {
|
||||
if (is_string($uri)) {
|
||||
|
@ -712,7 +712,7 @@ class HttpSocket extends CakeSocket {
|
|||
|
||||
/**
|
||||
* This function can be thought of as a reverse to PHP5's http_build_query(). It takes a given query string and turns it into an array and
|
||||
* supports nesting by using the php bracket syntax. So this menas you can parse queries like:
|
||||
* supports nesting by using the php bracket syntax. So this means you can parse queries like:
|
||||
*
|
||||
* - ?key[subKey]=value
|
||||
* - ?key[]=value1&key[]=value2
|
||||
|
|
|
@ -56,7 +56,7 @@ class Dispatcher {
|
|||
* 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
|
||||
* want controller methods to be public and in-accesible by URL, then prefix them with a `_`.
|
||||
* 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
|
||||
* are also not accessible via URL.
|
||||
*
|
||||
|
|
|
@ -62,7 +62,7 @@ class CakeRoute {
|
|||
protected $_greedy = false;
|
||||
|
||||
/**
|
||||
* The compiled route regular expresssion
|
||||
* The compiled route regular expression
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
|
@ -343,7 +343,7 @@ class CakeRoute {
|
|||
}
|
||||
|
||||
/**
|
||||
* Apply persistent parameters to a url array. Persistant parameters are a special
|
||||
* Apply persistent parameters to a url array. Persistent parameters are a special
|
||||
* key used during route creation to force route parameters to persist when omitted from
|
||||
* a url array.
|
||||
*
|
||||
|
|
|
@ -83,7 +83,7 @@ abstract class CakeTestCase extends PHPUnit_Framework_TestCase {
|
|||
}
|
||||
|
||||
/**
|
||||
* Called when a test case method is about to start (to be overriden when needed.)
|
||||
* Called when a test case method is about to start (to be overridden when needed.)
|
||||
*
|
||||
* @param string $method Test method about to get executed.
|
||||
* @return void
|
||||
|
@ -92,7 +92,7 @@ abstract class CakeTestCase extends PHPUnit_Framework_TestCase {
|
|||
}
|
||||
|
||||
/**
|
||||
* Called when a test case method has been executed (to be overriden when needed.)
|
||||
* Called when a test case method has been executed (to be overridden when needed.)
|
||||
*
|
||||
* @param string $method Test method about that was executed.
|
||||
* @return void
|
||||
|
@ -215,7 +215,7 @@ abstract class CakeTestCase extends PHPUnit_Framework_TestCase {
|
|||
* )
|
||||
*
|
||||
* Important: This function is very forgiving about whitespace and also accepts any
|
||||
* permutation of attribute order. It will also allow whitespaces between specified tags.
|
||||
* permutation of attribute order. It will also allow whitespace between specified tags.
|
||||
*
|
||||
* @param string $string An HTML/XHTML/XML string
|
||||
* @param array $expected An array, see above
|
||||
|
|
|
@ -284,7 +284,7 @@ abstract class ControllerTestCase extends CakeTestCase {
|
|||
*
|
||||
* - `methods` Methods to mock on the controller. `_stop()` is mocked by default
|
||||
* - `models` Models to mock. Models are added to the ClassRegistry so they any
|
||||
* time they are instatiated the mock will be created. Pass as key value pairs
|
||||
* time they are instantiated the mock will be created. Pass as key value pairs
|
||||
* with the value being specific methods on the model to mock. If `true` or
|
||||
* no value is passed, the entire model will be mocked.
|
||||
* - `components` Components to mock. Components are only mocked on this controller
|
||||
|
|
|
@ -43,7 +43,7 @@ class CakeFixtureManager {
|
|||
protected $_loaded = array();
|
||||
|
||||
/**
|
||||
* Holds the fixture classes that where ins tantiated indexed by class name
|
||||
* Holds the fixture classes that where instantiated indexed by class name
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
|
@ -195,7 +195,7 @@ class CakeFixtureManager {
|
|||
}
|
||||
|
||||
/**
|
||||
* Trucantes the fixtures tables
|
||||
* Truncates the fixtures tables
|
||||
*
|
||||
* @param CakeTestCase $test the test to inspect for fixture unloading
|
||||
* @return void
|
||||
|
@ -213,7 +213,7 @@ class CakeFixtureManager {
|
|||
}
|
||||
|
||||
/**
|
||||
* Trucantes the fixtures tables
|
||||
* Truncates the fixtures tables
|
||||
*
|
||||
* @param CakeTestCase $test the test to inspect for fixture unloading
|
||||
* @return void
|
||||
|
|
|
@ -23,7 +23,7 @@ App::import('Model', 'ConnectionManager');
|
|||
/**
|
||||
* Data Sanitization.
|
||||
*
|
||||
* Removal of alpahnumeric characters, SQL-safe slash-added strings, HTML-friendly strings,
|
||||
* Removal of alphanumeric characters, SQL-safe slash-added strings, HTML-friendly strings,
|
||||
* and all of the above on arrays.
|
||||
*
|
||||
* @package Cake.Utility
|
||||
|
|
|
@ -253,7 +253,7 @@ class String {
|
|||
}
|
||||
|
||||
/**
|
||||
* Cleans up a String::insert() formated string with given $options depending on the 'clean' key in
|
||||
* Cleans up a String::insert() formatted string with given $options depending on the 'clean' key in
|
||||
* $options. The default method used is text but html is also available. The goal of this function
|
||||
* is to replace all whitespace and unneeded markup around placeholders that did not get replaced
|
||||
* by String::insert().
|
||||
|
|
|
@ -441,7 +441,7 @@ class Validation {
|
|||
* Check that value has a valid file extension.
|
||||
*
|
||||
* @param mixed $check Value to check
|
||||
* @param array $extensions file extenstions to allow
|
||||
* @param array $extensions file extensions to allow
|
||||
* @return boolean Success
|
||||
*/
|
||||
public static function extension($check, $extensions = array('gif', 'jpeg', 'png', 'jpg')) {
|
||||
|
|
|
@ -188,7 +188,7 @@ class Helper extends Object {
|
|||
}
|
||||
|
||||
/**
|
||||
* Provides backwards compatiblity access for setting values to the request object.
|
||||
* Provides backwards compatibility access for setting values to the request object.
|
||||
*
|
||||
* @param string $name Name of the property being accessed.
|
||||
* @param mixed $value
|
||||
|
@ -504,7 +504,7 @@ class Helper extends Object {
|
|||
|
||||
/**
|
||||
* Gets the currently-used model field of the rendering context.
|
||||
* Strips off fieldsuffixes such as year, month, day, hour, min, meridian
|
||||
* Strips off field suffixes such as year, month, day, hour, min, meridian
|
||||
* when the current entity is longer than 2 elements.
|
||||
*
|
||||
* @return string
|
||||
|
|
|
@ -86,7 +86,7 @@ class CacheHelper extends AppHelper {
|
|||
* @param string $file File to cache
|
||||
* @param string $out output to cache
|
||||
* @param boolean $cache Whether or not a cache file should be written.
|
||||
* @return string view ouput
|
||||
* @return string view output
|
||||
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/cache.html
|
||||
*/
|
||||
public function cache($file, $out, $cache = false) {
|
||||
|
|
|
@ -86,7 +86,7 @@ class FormHelper extends AppHelper {
|
|||
protected $_inputDefaults = array();
|
||||
|
||||
/**
|
||||
* An array of fieldnames that have been excluded from
|
||||
* An array of field names that have been excluded from
|
||||
* the Token hash used by SecurityComponent's validatePost method
|
||||
*
|
||||
* @see FormHelper::_secure()
|
||||
|
@ -592,7 +592,7 @@ class FormHelper extends AppHelper {
|
|||
*
|
||||
* @param boolean $lock Whether this field should be part of the validation
|
||||
* or excluded as part of the unlockedFields.
|
||||
* @param mixed $field Reference to field to be secured. Should be dot separted to indicate nesting.
|
||||
* @param mixed $field Reference to field to be secured. Should be dot separated to indicate nesting.
|
||||
* @param mixed $value Field value, if value should not be tampered with.
|
||||
* @return void
|
||||
*/
|
||||
|
@ -931,10 +931,10 @@ class FormHelper extends AppHelper {
|
|||
|
||||
if (isset($type)) {
|
||||
$map = array(
|
||||
'string' => 'text', 'datetime' => 'datetime',
|
||||
'string' => 'text', 'datetime' => 'datetime',
|
||||
'boolean' => 'checkbox', 'timestamp' => 'datetime',
|
||||
'text' => 'textarea', 'time' => 'time',
|
||||
'date' => 'date', 'float' => 'number',
|
||||
'text' => 'textarea', 'time' => 'time',
|
||||
'date' => 'date', 'float' => 'number',
|
||||
'integer' => 'number'
|
||||
);
|
||||
|
||||
|
|
|
@ -645,7 +645,7 @@ class HtmlHelper extends AppHelper {
|
|||
* Returns breadcrumbs as a (x)html list
|
||||
*
|
||||
* This method uses HtmlHelper::tag() to generate list and its elements. Works
|
||||
* similiary to HtmlHelper::getCrumbs(), so it uses options which every
|
||||
* similar to HtmlHelper::getCrumbs(), so it uses options which every
|
||||
* crumb was added with.
|
||||
*
|
||||
* @param array $options Array of html attributes to apply to the generated list elements.
|
||||
|
|
|
@ -569,7 +569,7 @@ abstract class JsBaseEngineHelper extends AppHelper {
|
|||
}
|
||||
|
||||
/**
|
||||
* Conveinence wrapper method for all common option processing steps.
|
||||
* Convenience wrapper method for all common option processing steps.
|
||||
* Runs _mapOptions, _prepareCallbacks, and _parseOptions in order.
|
||||
*
|
||||
* @param string $method Name of method processing options for.
|
||||
|
|
|
@ -295,7 +295,7 @@ class MootoolsEngineHelper extends JsBaseEngineHelper {
|
|||
* Requires the `Drag` and `Drag.Move` plugins from MootoolsMore
|
||||
*
|
||||
* Droppables in Mootools function differently from other libraries. Droppables
|
||||
* are implemented as an extension of Drag. So in addtion to making a get() selection for
|
||||
* are implemented as an extension of Drag. So in addition to making a get() selection for
|
||||
* the droppable element. You must also provide a selector rule to the draggable element. Furthermore,
|
||||
* Mootools droppables inherit all options from Drag.
|
||||
*
|
||||
|
|
|
@ -292,7 +292,7 @@ class PaginatorHelper extends AppHelper {
|
|||
*
|
||||
* - `escape` Whether you want the contents html entity encoded, defaults to true
|
||||
* - `model` The model to use, defaults to PaginatorHelper::defaultModel()
|
||||
* - `direction` The default directon to use when this link isn't active.
|
||||
* - `direction` The default direction to use when this link isn't active.
|
||||
*
|
||||
* @param string $key The name of the key that the recordset should be sorted.
|
||||
* @param string $title Title for the link. If $title is null $key will be used
|
||||
|
|
|
@ -255,7 +255,7 @@ class PrototypeEngineHelper extends JsBaseEngineHelper {
|
|||
*
|
||||
* #### Note: Requires scriptaculous to be loaded.
|
||||
*
|
||||
* The scriptaculous implementation of sortables does not suppot the 'start'
|
||||
* The scriptaculous implementation of sortables does not support the 'start'
|
||||
* and 'distance' options.
|
||||
*
|
||||
* @param array $options Array of options for the sortable.
|
||||
|
|
|
@ -90,7 +90,7 @@ class SessionHelper extends AppHelper {
|
|||
* echo $this->Session->flash('flash', array('params' => array('name' => $user['User']['name'])));
|
||||
* }}}
|
||||
*
|
||||
* This would pass the current user's name into the flash message, so you could create peronsonalized
|
||||
* This would pass the current user's name into the flash message, so you could create personalized
|
||||
* messages without the controller needing access to that data.
|
||||
*
|
||||
* Lastly you can choose the element that is rendered when creating the flash message. Using
|
||||
|
|
|
@ -183,7 +183,7 @@ class TextHelper extends AppHelper {
|
|||
}
|
||||
|
||||
/**
|
||||
* Convert all links and email adresses to HTML links.
|
||||
* Convert all links and email addresses to HTML links.
|
||||
*
|
||||
* @param string $text Text
|
||||
* @param array $options Array of HTML options.
|
||||
|
@ -357,7 +357,7 @@ class TextHelper extends AppHelper {
|
|||
*
|
||||
* @param array $list The list to be joined
|
||||
* @param string $and The word used to join the last and second last items together with. Defaults to 'and'
|
||||
* @param string $separator The separator used to join all othe other items together. Defaults to ', '
|
||||
* @param string $separator The separator used to join all the other items together. Defaults to ', '
|
||||
* @return string The glued together string.
|
||||
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::toList
|
||||
*/
|
||||
|
|
|
@ -58,7 +58,7 @@ class TimeHelper extends AppHelper {
|
|||
* windows safe and i18n aware format.
|
||||
*
|
||||
* @param string $format Format with specifiers for strftime function.
|
||||
* Accepts the special specifier %S which mimics th modifier S for date()
|
||||
* Accepts the special specifier %S which mimics the modifier S for date()
|
||||
* @param string $time UNIX timestamp
|
||||
* @return string windows safe and date() function compatible format for strftime
|
||||
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting
|
||||
|
@ -72,7 +72,7 @@ class TimeHelper extends AppHelper {
|
|||
}
|
||||
|
||||
/**
|
||||
* Auxiliary function to translate a matched specifier element from a regular expresion into
|
||||
* Auxiliary function to translate a matched specifier element from a regular expression into
|
||||
* a windows safe and i18n aware specifier
|
||||
*
|
||||
* @param array $specifier match from regular expression
|
||||
|
|
|
@ -517,7 +517,7 @@ class View extends Object {
|
|||
|
||||
/**
|
||||
* Allows a template or element to set a variable that will be available in
|
||||
* a layout or other element. Analagous to Controller::set().
|
||||
* a layout or other element. Analogous to Controller::set().
|
||||
*
|
||||
* @param mixed $one A string or an array of data.
|
||||
* @param mixed $two Value in case $one is a string (which then works as the key).
|
||||
|
|
Loading…
Add table
Reference in a new issue