Merge pull request #2188 from ravage84/model-docblocks

Some DocBlock improvements for Model.php
This commit is contained in:
Mark Story 2013-10-24 05:13:36 -07:00
commit 287a526d94

View file

@ -665,7 +665,8 @@ class Model extends Object implements CakeEventListener {
* 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.
* @param boolean|integer|string|array $id Set this ID for this model on startup,
* can also be an array of options, see above.
* @param string $table Name of database table to use.
* @param string $ds DataSource connection name.
*/
@ -1552,7 +1553,7 @@ class Model extends Object implements CakeEventListener {
/**
* This function is a convenient wrapper class to create(false) and, as the name suggests, clears the id, data, and validation errors.
*
* @return always boolean TRUE upon success
* @return boolean Always true upon success
* @see Model::create()
*/
public function clear() {
@ -3302,7 +3303,7 @@ class Model extends Object implements CakeEventListener {
*
* Additionally it populates the validationErrors property of the model with the same array.
*
* @param string $options An optional array of custom options to be made available in the beforeValidate callback
* @param array|string $options An optional array of custom options to be made available in the beforeValidate callback
* @return array Array of invalid fields and their error messages
* @see Model::validates()
*/