@@ -217,9 +217,8 @@ discard block |
||
| 217 | 217 | * Given the database configuration, this method will create the correct |
| 218 | 218 | * subclass of {@link SS_Database}. |
| 219 | 219 | * |
| 220 | - * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the |
|
| 220 | + * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the |
|
| 221 | 221 | * rest of the options, see the specific class. |
| 222 | - * @param string $name identifier for the connection |
|
| 223 | 222 | * |
| 224 | 223 | * @return SS_Database |
| 225 | 224 | */ |
@@ -413,7 +412,7 @@ discard block |
||
| 413 | 412 | |
| 414 | 413 | /** |
| 415 | 414 | * Create a new table. |
| 416 | - * @param string $tableName The name of the table |
|
| 415 | + * @param string $table The name of the table |
|
| 417 | 416 | * @param array$fields A map of field names to field types |
| 418 | 417 | * @param array $indexes A map of indexes |
| 419 | 418 | * @param array $options An map of additional options. The available keys are as follows: |
@@ -500,6 +499,8 @@ discard block |
||
| 500 | 499 | |
| 501 | 500 | /** |
| 502 | 501 | * @deprecated since version 4.0 Use DB::require_field instead |
| 502 | + * @param string $field |
|
| 503 | + * @param string $spec |
|
| 503 | 504 | */ |
| 504 | 505 | public static function requireField($table, $field, $spec) { |
| 505 | 506 | Deprecation::notice('4.0', 'Use DB::require_field instead'); |
@@ -563,7 +564,7 @@ discard block |
||
| 563 | 564 | /** |
| 564 | 565 | * Checks a table's integrity and repairs it if necessary. |
| 565 | 566 | * |
| 566 | - * @param string $tableName The name of the table. |
|
| 567 | + * @param string $table The name of the table. |
|
| 567 | 568 | * @return boolean Return true if the table has integrity after the method is complete. |
| 568 | 569 | */ |
| 569 | 570 | public static function check_and_repair_table($table) { |
@@ -97,7 +97,7 @@ discard block |
||
| 97 | 97 | * Return a date and time formatted as per a CMS user's settings. |
| 98 | 98 | * |
| 99 | 99 | * @param Member $member |
| 100 | - * @return boolean | string A time and date pair formatted as per user-defined settings. |
|
| 100 | + * @return false|string | string A time and date pair formatted as per user-defined settings. |
|
| 101 | 101 | */ |
| 102 | 102 | public function FormatFromSettings($member = null) { |
| 103 | 103 | require_once 'Zend/Date.php'; |
@@ -176,7 +176,7 @@ discard block |
||
| 176 | 176 | * Use {@link clear_mock_now()} to revert to the current system date. |
| 177 | 177 | * Caution: This sets a fixed date that doesn't increment with time. |
| 178 | 178 | * |
| 179 | - * @param SS_Datetime|string $datetime Either in object format, or as a SS_Datetime compatible string. |
|
| 179 | + * @param string $datetime Either in object format, or as a SS_Datetime compatible string. |
|
| 180 | 180 | */ |
| 181 | 181 | public static function set_mock_now($datetime) { |
| 182 | 182 | if($datetime instanceof SS_Datetime) { |
@@ -52,6 +52,9 @@ |
||
| 52 | 52 | return 0; |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | + /** |
|
| 56 | + * @param integer $value |
|
| 57 | + */ |
|
| 55 | 58 | public function prepValueForDB($value) { |
| 56 | 59 | if($value === true) { |
| 57 | 60 | return 1; |
@@ -236,6 +236,8 @@ discard block |
||
| 236 | 236 | } |
| 237 | 237 | |
| 238 | 238 | /** |
| 239 | + * @param string $currency |
|
| 240 | + * @param string $locale |
|
| 239 | 241 | * @return string |
| 240 | 242 | */ |
| 241 | 243 | public function getSymbol($currency = null, $locale = null) { |
@@ -247,6 +249,8 @@ discard block |
||
| 247 | 249 | } |
| 248 | 250 | |
| 249 | 251 | /** |
| 252 | + * @param string $currency |
|
| 253 | + * @param string $locale |
|
| 250 | 254 | * @return string |
| 251 | 255 | */ |
| 252 | 256 | public function getShortName($currency = null, $locale = null) { |
@@ -257,6 +261,8 @@ discard block |
||
| 257 | 261 | } |
| 258 | 262 | |
| 259 | 263 | /** |
| 264 | + * @param string $currency |
|
| 265 | + * @param string $locale |
|
| 260 | 266 | * @return string |
| 261 | 267 | */ |
| 262 | 268 | public function getName($currency = null, $locale = null) { |
@@ -17,7 +17,7 @@ |
||
| 17 | 17 | |
| 18 | 18 | /** |
| 19 | 19 | * @param string $name |
| 20 | - * @param DataOject $object The object that this is primary key for (should have a relation with $name) |
|
| 20 | + * @param DataObject $object The object that this is primary key for (should have a relation with $name) |
|
| 21 | 21 | */ |
| 22 | 22 | public function __construct($name = null, $object) { |
| 23 | 23 | $this->object = $object; |
@@ -71,8 +71,8 @@ |
||
| 71 | 71 | /** |
| 72 | 72 | * resizeRatio |
| 73 | 73 | * |
| 74 | - * @param int $width |
|
| 75 | - * @param int $height |
|
| 74 | + * @param integer $maxWidth |
|
| 75 | + * @param integer $maxHeight |
|
| 76 | 76 | * @return Image_Backend |
| 77 | 77 | */ |
| 78 | 78 | public function resizeRatio($maxWidth, $maxHeight, $useAsMinimum = false); |
@@ -33,6 +33,7 @@ discard block |
||
| 33 | 33 | |
| 34 | 34 | /** |
| 35 | 35 | * @deprecated since version 4.0 |
| 36 | + * @param boolean $value |
|
| 36 | 37 | */ |
| 37 | 38 | public function setDelete($value) { |
| 38 | 39 | Deprecation::notice('4.0', 'SQLQuery::setDelete is deprecated. Use toDelete instead'); |
@@ -47,6 +48,9 @@ discard block |
||
| 47 | 48 | return $this->isDelete; |
| 48 | 49 | } |
| 49 | 50 | |
| 51 | + /** |
|
| 52 | + * @return string |
|
| 53 | + */ |
|
| 50 | 54 | public function sql(&$parameters = array()) { |
| 51 | 55 | return $this->toAppropriateExpression()->sql($parameters); |
| 52 | 56 | } |
@@ -47,7 +47,7 @@ discard block |
||
| 47 | 47 | * column. Can contain a relation name in dot notation, which will automatically join |
| 48 | 48 | * the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and |
| 49 | 49 | * search the "Name" column when applying this filter to a SiteTree class). |
| 50 | - * @param mixed $value |
|
| 50 | + * @param boolean|string $value |
|
| 51 | 51 | * @param array $modifiers |
| 52 | 52 | */ |
| 53 | 53 | public function __construct($fullName, $value = false, array $modifiers = array()) { |
@@ -287,7 +287,7 @@ discard block |
||
| 287 | 287 | /** |
| 288 | 288 | * Determines case sensitivity based on {@link getModifiers()}. |
| 289 | 289 | * |
| 290 | - * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation. |
|
| 290 | + * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation. |
|
| 291 | 291 | */ |
| 292 | 292 | protected function getCaseSensitive() { |
| 293 | 293 | $modifiers = $this->getModifiers(); |
@@ -304,6 +304,10 @@ |
||
| 304 | 304 | // Delete files in the default uploads directory that match the name pattern. |
| 305 | 305 | // @param String $namePattern A regular expression applied to files in the directory. If the name matches |
| 306 | 306 | // the pattern, it is deleted. Directories, . and .. are excluded. |
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * @param string $namePattern |
|
| 310 | + */ |
|
| 307 | 311 | public function deleteTestUploadFiles($namePattern) { |
| 308 | 312 | $tmpFolder = ASSETS_PATH . "/" . Config::inst()->get('Upload', 'uploads_folder'); |
| 309 | 313 | $files = scandir($tmpFolder); |