@@ -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) { |
@@ -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); |
@@ -105,6 +105,9 @@ discard block |
||
105 | 105 | return $matches; |
106 | 106 | } |
107 | 107 | |
108 | + /** |
|
109 | + * @param string $string |
|
110 | + */ |
|
108 | 111 | function _unhtmlentities($string) { |
109 | 112 | $string = preg_replace('~&#x([0-9a-f]+);~ei', 'chr(hexdec("\\1"))', $string); |
110 | 113 | $string = preg_replace('~&#([0-9]+);~e', 'chr(\\1)', $string); |
@@ -118,6 +121,10 @@ discard block |
||
118 | 121 | |
119 | 122 | // Patch in multibyte support |
120 | 123 | if (!function_exists('mb_substr')) { |
124 | + |
|
125 | + /** |
|
126 | + * @param string $str |
|
127 | + */ |
|
121 | 128 | function mb_substr($str, $start, $len = '', $encoding="UTF-8"){ |
122 | 129 | $limit = strlen($str); |
123 | 130 |
@@ -45,6 +45,7 @@ |
||
45 | 45 | |
46 | 46 | /** |
47 | 47 | * Opens a link for pspell. |
48 | + * @return string |
|
48 | 49 | */ |
49 | 50 | function &_getPLink($lang) { |
50 | 51 | // Check for native PSpell support |