@@ -129,6 +129,7 @@ |
||
129 | 129 | |
130 | 130 | /** |
131 | 131 | * @param boolean |
132 | + * @param boolean $bool |
|
132 | 133 | */ |
133 | 134 | public function setAllowMultibyte($bool) { |
134 | 135 | $this->allowMultibyte = $bool; |
@@ -92,6 +92,9 @@ |
||
92 | 92 | return $return; |
93 | 93 | } |
94 | 94 | |
95 | + /** |
|
96 | + * @param boolean $index |
|
97 | + */ |
|
95 | 98 | function f($index) { |
96 | 99 | return stripslashes($this->row[$index]); |
97 | 100 | } |
@@ -63,6 +63,7 @@ discard block |
||
63 | 63 | * while automatically busting this cache every time the file is changed. |
64 | 64 | * |
65 | 65 | * @param bool |
66 | + * @param boolean $var |
|
66 | 67 | */ |
67 | 68 | public static function set_suffix_requirements($var) { |
68 | 69 | self::backend()->set_suffix_requirements($var); |
@@ -123,7 +124,7 @@ discard block |
||
123 | 124 | /** |
124 | 125 | * Return all registered custom scripts |
125 | 126 | * |
126 | - * @return array |
|
127 | + * @return string |
|
127 | 128 | */ |
128 | 129 | public static function get_custom_scripts() { |
129 | 130 | return self::backend()->get_custom_scripts(); |
@@ -531,7 +532,7 @@ discard block |
||
531 | 532 | /** |
532 | 533 | * Enable or disable the combination of CSS and JavaScript files |
533 | 534 | * |
534 | - * @param $enable |
|
535 | + * @param boolean $enable |
|
535 | 536 | */ |
536 | 537 | public function set_combined_files_enabled($enable) { |
537 | 538 | $this->combined_files_enabled = (bool) $enable; |
@@ -599,6 +600,7 @@ discard block |
||
599 | 600 | * Forces the JavaScript requirements to the end of the body, right before the closing tag |
600 | 601 | * |
601 | 602 | * @param bool |
603 | + * @param boolean $var |
|
602 | 604 | */ |
603 | 605 | public function set_force_js_to_bottom($var) { |
604 | 606 | $this->force_js_to_bottom = $var; |
@@ -638,7 +640,7 @@ discard block |
||
638 | 640 | /** |
639 | 641 | * Return all registered custom scripts |
640 | 642 | * |
641 | - * @return array |
|
643 | + * @return string |
|
642 | 644 | */ |
643 | 645 | public function get_custom_scripts() { |
644 | 646 | $requirements = ""; |
@@ -1051,7 +1053,7 @@ discard block |
||
1051 | 1053 | * @param array $files Array of filenames relative to docroot |
1052 | 1054 | * @param string $media |
1053 | 1055 | * |
1054 | - * @return bool|void |
|
1056 | + * @return false|null |
|
1055 | 1057 | */ |
1056 | 1058 | public function combine_files($combinedFileName, $files, $media = null) { |
1057 | 1059 | // duplicate check |
@@ -23,6 +23,7 @@ discard block |
||
23 | 23 | * |
24 | 24 | * By default, this is set to true so that it's clearer what's happening, but the predefined |
25 | 25 | * {@link GridFieldConfig} subclasses set this to false for flexibility. |
26 | + * @param boolean $throwExceptionOnBadDataType |
|
26 | 27 | */ |
27 | 28 | public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) { |
28 | 29 | $this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType; |
@@ -38,6 +39,7 @@ discard block |
||
38 | 39 | /** |
39 | 40 | * Check that this dataList is of the right data type. |
40 | 41 | * Returns false if it's a bad data type, and if appropriate, throws an exception. |
42 | + * @param SS_List $dataList |
|
41 | 43 | */ |
42 | 44 | protected function checkDataType($dataList) { |
43 | 45 | if($dataList instanceof SS_Filterable) { |
@@ -551,7 +551,7 @@ discard block |
||
551 | 551 | * The destinationObject must be written to the database already and have an ID. Writing is performed |
552 | 552 | * automatically when adding the new relations. |
553 | 553 | * |
554 | - * @param $sourceObject the source object to duplicate from |
|
554 | + * @param DataObject $sourceObject the source object to duplicate from |
|
555 | 555 | * @param $destinationObject the destination object to populate with the duplicated relations |
556 | 556 | * @return DataObject with the new many_many relations copied in |
557 | 557 | */ |
@@ -958,6 +958,7 @@ discard block |
||
958 | 958 | * @param $includeRelations Boolean Merge any existing relations (optional) |
959 | 959 | * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values. |
960 | 960 | * Only applicable with $priority='right'. (optional) |
961 | + * @param DataObject|null $rightObj |
|
961 | 962 | * @return Boolean |
962 | 963 | */ |
963 | 964 | public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) { |
@@ -1581,10 +1582,10 @@ discard block |
||
1581 | 1582 | * |
1582 | 1583 | * @param string $componentName Name of the component |
1583 | 1584 | * @param string|null $filter Deprecated. A filter to be inserted into the WHERE clause |
1584 | - * @param string|null|array $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted, |
|
1585 | + * @param string $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted, |
|
1585 | 1586 | * the static field $default_sort on the component class will be used. |
1586 | 1587 | * @param string $join Deprecated, use leftJoin($table, $joinClause) instead |
1587 | - * @param string|null|array $limit Deprecated. A limit expression to be inserted into the LIMIT clause |
|
1588 | + * @param string $limit Deprecated. A limit expression to be inserted into the LIMIT clause |
|
1588 | 1589 | * |
1589 | 1590 | * @return HasManyList The components of the one-to-many relationship. |
1590 | 1591 | */ |
@@ -2210,6 +2211,7 @@ discard block |
||
2210 | 2211 | * |
2211 | 2212 | * This is experimental, and is currently only a Postgres-specific enhancement. |
2212 | 2213 | * |
2214 | + * @param string $class |
|
2213 | 2215 | * @return array or false |
2214 | 2216 | */ |
2215 | 2217 | public function database_extensions($class){ |
@@ -2677,7 +2679,7 @@ discard block |
||
2677 | 2679 | * can be saved into the Image table. |
2678 | 2680 | * |
2679 | 2681 | * @param string $fieldName Name of the field |
2680 | - * @param mixed $value New field value |
|
2682 | + * @param mixed $val New field value |
|
2681 | 2683 | * @return DataObject $this |
2682 | 2684 | */ |
2683 | 2685 | public function setCastedField($fieldName, $val) { |
@@ -2697,6 +2699,7 @@ discard block |
||
2697 | 2699 | |
2698 | 2700 | /** |
2699 | 2701 | * {@inheritdoc} |
2702 | + * @param string $field |
|
2700 | 2703 | */ |
2701 | 2704 | public function castingHelper($field) { |
2702 | 2705 | if ($fieldSpec = $this->db($field)) { |
@@ -3061,6 +3064,7 @@ discard block |
||
3061 | 3064 | * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName) |
3062 | 3065 | * |
3063 | 3066 | * @param $fieldPath string |
3067 | + * @param string $fieldName |
|
3064 | 3068 | * @return string | null - will return null on a missing value |
3065 | 3069 | */ |
3066 | 3070 | public function relField($fieldName) { |
@@ -3129,7 +3133,7 @@ discard block |
||
3129 | 3133 | * @param string $callerClass The class of objects to be returned |
3130 | 3134 | * @param string|array $filter A filter to be inserted into the WHERE clause. |
3131 | 3135 | * Supports parameterised queries. See SQLQuery::addWhere() for syntax examples. |
3132 | - * @param string|array $sort A sort expression to be inserted into the ORDER |
|
3136 | + * @param string $sort A sort expression to be inserted into the ORDER |
|
3133 | 3137 | * BY clause. If omitted, self::$default_sort will be used. |
3134 | 3138 | * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead. |
3135 | 3139 | * @param string|array $limit A limit expression to be inserted into the LIMIT clause. |
@@ -3180,6 +3184,7 @@ discard block |
||
3180 | 3184 | |
3181 | 3185 | /** |
3182 | 3186 | * @deprecated |
3187 | + * @param string $class |
|
3183 | 3188 | */ |
3184 | 3189 | public function Aggregate($class = null) { |
3185 | 3190 | Deprecation::notice('4.0', 'Call aggregate methods on a DataList directly instead. In templates' |
@@ -3201,6 +3206,7 @@ discard block |
||
3201 | 3206 | |
3202 | 3207 | /** |
3203 | 3208 | * @deprecated |
3209 | + * @param string $relationship |
|
3204 | 3210 | */ |
3205 | 3211 | public function RelationshipAggregate($relationship) { |
3206 | 3212 | Deprecation::notice('4.0', 'Call aggregate methods on a relationship directly instead.'); |
@@ -3369,6 +3375,7 @@ discard block |
||
3369 | 3375 | |
3370 | 3376 | /** |
3371 | 3377 | * @see $sourceQueryParams |
3378 | + * @param string $key |
|
3372 | 3379 | * @return Mixed |
3373 | 3380 | */ |
3374 | 3381 | public function getSourceQueryParam($key) { |