Browse Source

Improved docblocks

ADmad 13 years ago
parent
commit
56df02f720
1 changed files with 6 additions and 2 deletions
  1. 6 2
      lib/Cake/Model/Model.php

+ 6 - 2
lib/Cake/Model/Model.php

@@ -1599,8 +1599,12 @@ class Model extends Object implements CakeEventListener {
  * @param array $data Data to save.
  * @param array $data Data to save.
  * @param boolean|array $validate Either a boolean, or an array.
  * @param boolean|array $validate Either a boolean, or an array.
  *   If a boolean, indicates whether or not to validate before saving.
  *   If a boolean, indicates whether or not to validate before saving.
- *   If an array, allows control of validate, callbacks, and fieldList
- * @param array $fieldList List of fields to allow to be written
+ *   If an array, can have following keys:
+ *   - `validate`: Set to true/false to enable or disable validation.
+ *   - `fieldList`: An array of fields you want to allow for saving.
+ *   - `callbacks`: Set to false to disable callbacks. Using 'before' or 'after'
+ *      will enable only those callbacks.
+ * @param array $fieldList List of fields to allow to be saved
  * @return mixed On success Model::$data if its not empty or true, false on failure
  * @return mixed On success Model::$data if its not empty or true, false on failure
  * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html
  * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html
  */
  */