@@ -74,9 +74,6 @@ |
||
74 | 74 | * Given a list of assignments in any user-acceptible format, normalise the |
75 | 75 | * value to a common array('SQL' => array(parameters)) format |
76 | 76 | * |
77 | - * @param array $predicates List of assignments. |
|
78 | - * The key of this array should be the field name, and the value the assigned |
|
79 | - * literal value, or an array with parameterised information. |
|
80 | 77 | * @return array List of normalised assignments |
81 | 78 | */ |
82 | 79 | protected function normaliseAssignments(array $assignments) { |
@@ -374,7 +374,6 @@ discard block |
||
374 | 374 | * @see SQLConditionalExpression::addWhere() for syntax examples |
375 | 375 | * |
376 | 376 | * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries |
377 | - * @param mixed $where,... Unlimited additional predicates |
|
378 | 377 | * @return self Self reference |
379 | 378 | */ |
380 | 379 | public function setWhere($where) { |
@@ -460,7 +459,6 @@ discard block |
||
460 | 459 | * </code> |
461 | 460 | * |
462 | 461 | * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries |
463 | - * @param mixed $where,... Unlimited additional predicates |
|
464 | 462 | * @return self Self reference |
465 | 463 | */ |
466 | 464 | public function addWhere($where) { |
@@ -476,7 +474,6 @@ discard block |
||
476 | 474 | * @see SQLConditionalExpression::addWhere() |
477 | 475 | * |
478 | 476 | * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries |
479 | - * @param mixed $filters,... Unlimited additional predicates |
|
480 | 477 | * @return self Self reference |
481 | 478 | */ |
482 | 479 | public function setWhereAny($filters) { |
@@ -490,7 +487,6 @@ discard block |
||
490 | 487 | * @see SQLConditionalExpression::addWhere() |
491 | 488 | * |
492 | 489 | * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries |
493 | - * @param mixed $filters,... Unlimited additional predicates |
|
494 | 490 | * @return self Self reference |
495 | 491 | */ |
496 | 492 | public function addWhereAny($filters) { |
@@ -125,7 +125,6 @@ |
||
125 | 125 | * Copies the query parameters contained in this object to another |
126 | 126 | * SQLExpression |
127 | 127 | * |
128 | - * @param SQLExpression $expression The object to copy properties to |
|
129 | 128 | */ |
130 | 129 | protected function copyTo(SQLExpression $object) { |
131 | 130 | $target = array_keys(get_object_vars($object)); |
@@ -115,7 +115,6 @@ discard block |
||
115 | 115 | * </code> |
116 | 116 | * |
117 | 117 | * @param string|array $fields Field names should be ANSI SQL quoted. Array keys should be unquoted. |
118 | - * @param boolean $clear Clear existing select fields? |
|
119 | 118 | * @return $this Self reference |
120 | 119 | */ |
121 | 120 | public function setSelect($fields) { |
@@ -352,7 +351,7 @@ discard block |
||
352 | 351 | * |
353 | 352 | * @param string $value |
354 | 353 | * @param string $defaultDirection |
355 | - * @return array A two element array: array($column, $direction) |
|
354 | + * @return string[] A two element array: array($column, $direction) |
|
356 | 355 | */ |
357 | 356 | private function getDirectionFromString($value, $defaultDirection = null) { |
358 | 357 | if(preg_match('/^(.*)(asc|desc)$/i', $value, $matches)) { |
@@ -447,7 +446,6 @@ discard block |
||
447 | 446 | * @see SQLSelect::addWhere() for syntax examples |
448 | 447 | * |
449 | 448 | * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries |
450 | - * @param mixed $having,... Unlimited additional predicates |
|
451 | 449 | * @return self Self reference |
452 | 450 | */ |
453 | 451 | public function setHaving($having) { |
@@ -462,7 +460,6 @@ discard block |
||
462 | 460 | * @see SQLSelect::addWhere() for syntax examples |
463 | 461 | * |
464 | 462 | * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries |
465 | - * @param mixed $having,... Unlimited additional predicates |
|
466 | 463 | * @return self Self reference |
467 | 464 | */ |
468 | 465 | public function addHaving($having) { |
@@ -50,6 +50,7 @@ discard block |
||
50 | 50 | * Create a new UnsavedRelationList |
51 | 51 | * |
52 | 52 | * @param string $dataClass The DataObject class used in the relation |
53 | + * @param string $relationName |
|
53 | 54 | */ |
54 | 55 | public function __construct($baseClass, $relationName, $dataClass) { |
55 | 56 | $this->baseClass = $baseClass; |
@@ -142,7 +143,7 @@ discard block |
||
142 | 143 | * Add a number of items to the relation. |
143 | 144 | * |
144 | 145 | * @param array $items Items to add, as either DataObjects or IDs. |
145 | - * @return DataList |
|
146 | + * @return UnsavedRelationList |
|
146 | 147 | */ |
147 | 148 | public function addMany($items) { |
148 | 149 | foreach($items as $item) { |
@@ -177,7 +178,6 @@ discard block |
||
177 | 178 | /** |
178 | 179 | * Remove the items from this list with the given IDs |
179 | 180 | * |
180 | - * @param array $idList |
|
181 | 181 | */ |
182 | 182 | public function removeMany($items) { |
183 | 183 | $this->items = array_diff($this->items, $items); |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | protected $transliterator; |
107 | 107 | |
108 | 108 | /** |
109 | - * @return SS_Transliterator|NULL |
|
109 | + * @return SS_Transliterator |
|
110 | 110 | */ |
111 | 111 | public function getTransliterator() { |
112 | 112 | if($this->transliterator === null && $this->config()->default_use_transliterator) { |
@@ -129,6 +129,7 @@ discard block |
||
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; |
@@ -786,7 +786,7 @@ discard block |
||
786 | 786 | /** |
787 | 787 | * Get the latest published DataObject. |
788 | 788 | * |
789 | - * @return DataObject |
|
789 | + * @return string |
|
790 | 790 | */ |
791 | 791 | public function latestPublished() { |
792 | 792 | // Get the root data object class - this will have the version field |
@@ -805,8 +805,8 @@ discard block |
||
805 | 805 | /** |
806 | 806 | * Move a database record from one stage to the other. |
807 | 807 | * |
808 | - * @param fromStage Place to copy from. Can be either a stage name or a version number. |
|
809 | - * @param toStage Place to copy to. Must be a stage name. |
|
808 | + * @param fromStage integer to copy from. Can be either a stage name or a version number. |
|
809 | + * @param toStage string to copy to. Must be a stage name. |
|
810 | 810 | * @param createNewVersion Set this to true to create a new version number. By default, the existing version |
811 | 811 | * number will be copied over. |
812 | 812 | */ |
@@ -980,6 +980,7 @@ discard block |
||
980 | 980 | /** |
981 | 981 | * Return the base table - the class that directly extends DataObject. |
982 | 982 | * |
983 | + * @param string $stage |
|
983 | 984 | * @return string |
984 | 985 | */ |
985 | 986 | public function baseTable($stage = null) { |
@@ -1134,7 +1135,6 @@ discard block |
||
1134 | 1135 | * @param string $stage The name of the stage. |
1135 | 1136 | * @param string $filter A filter to be inserted into the WHERE clause. |
1136 | 1137 | * @param boolean $cache Use caching. |
1137 | - * @param string $orderby A sort expression to be inserted into the ORDER BY clause. |
|
1138 | 1138 | * |
1139 | 1139 | * @return DataObject |
1140 | 1140 | */ |
@@ -46,6 +46,7 @@ discard block |
||
46 | 46 | * |
47 | 47 | * @param $url Human-readable URL. |
48 | 48 | * @returns string/bool URL of an endpoint, or false if no matching provider exists. |
49 | + * @return string |
|
49 | 50 | */ |
50 | 51 | protected static function find_endpoint($url) { |
51 | 52 | foreach(self::get_providers() as $scheme=>$endpoint) { |
@@ -261,6 +262,9 @@ discard block |
||
261 | 262 | parent::__construct(); |
262 | 263 | } |
263 | 264 | |
265 | + /** |
|
266 | + * @return string |
|
267 | + */ |
|
264 | 268 | public function getOembedURL() { |
265 | 269 | return $this->url; |
266 | 270 | } |
@@ -319,6 +323,7 @@ discard block |
||
319 | 323 | |
320 | 324 | /** |
321 | 325 | * Wrap the check for looking into Oembed JSON within $this->data. |
326 | + * @param string $field |
|
322 | 327 | */ |
323 | 328 | public function hasField($field) { |
324 | 329 | $this->loadData(); |
@@ -165,7 +165,7 @@ |
||
165 | 165 | * Main BBCode parser method. This takes plain jane content and |
166 | 166 | * runs it through so many filters |
167 | 167 | * |
168 | - * @return Text |
|
168 | + * @return string |
|
169 | 169 | */ |
170 | 170 | public function parse() { |
171 | 171 | $this->content = str_replace(array('&', '<', '>'), array('&', '<', '>'), $this->content); |