Completed
Pull Request — master (#5229)
by Matt
11:45
created
model/queries/SQLAssignmentRow.php 1 patch
Doc Comments   -3 removed lines patch added patch discarded remove patch
@@ -74,9 +74,6 @@
 block discarded – undo
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) {
Please login to merge, or discard this patch.
model/queries/SQLConditionalExpression.php 1 patch
Doc Comments   -4 removed lines patch added patch discarded remove patch
@@ -374,7 +374,6 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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) {
Please login to merge, or discard this patch.
model/queries/SQLExpression.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -125,7 +125,6 @@
 block discarded – undo
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));
Please login to merge, or discard this patch.
model/URLSegmentFilter.php 1 patch
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -106,7 +106,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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;
Please login to merge, or discard this patch.
parsers/BBCodeParser.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -165,7 +165,7 @@
 block discarded – undo
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('&amp;', '&lt;', '&gt;'), $this->content);
Please login to merge, or discard this patch.
parsers/HTML/HTMLBBCodeParser.php 1 patch
Doc Comments   +7 added lines, -2 removed lines patch added patch discarded remove patch
@@ -177,6 +177,10 @@  discard block
 block discarded – undo
177 177
 		$this->addFilters($this->_options['filters']);
178 178
 	}
179 179
 
180
+	/**
181
+	 * @param string $class
182
+	 * @param string $var
183
+	 */
180 184
 	static function &getStaticProperty($class, $var)
181 185
 	{
182 186
 		static $properties;
@@ -406,6 +410,7 @@  discard block
 block discarded – undo
406 410
 	 * array as an associative array.
407 411
 	 *
408 412
 	 * @param    string          string to build tag from
413
+	 * @param string $str
409 414
 	 * @return   array           tag in array format
410 415
 	 * @access   private
411 416
 	 * @see      _buildTagArray()
@@ -840,7 +845,7 @@  discard block
 block discarded – undo
840 845
 	/**
841 846
 	 * Quick method to do setText(), parse() and getParsed at once
842 847
 	 *
843
-	 * @return   none
848
+	 * @return   string
844 849
 	 * @access   public
845 850
 	 * @see      parse()
846 851
 	 * @see      $_text
@@ -856,7 +861,7 @@  discard block
 block discarded – undo
856 861
 	/**
857 862
 	 * Quick static method to do setText(), parse() and getParsed at once
858 863
 	 *
859
-	 * @return   none
864
+	 * @return   string
860 865
 	 * @access   public
861 866
 	 * @see      parse()
862 867
 	 * @see      $_text
Please login to merge, or discard this patch.
parsers/ShortcodeParser.php 1 patch
Doc Comments   +7 added lines, -1 removed lines patch added patch discarded remove patch
@@ -152,6 +152,9 @@  discard block
 block discarded – undo
152 152
 
153 153
 	// --------------------------------------------------------------------------------------------------------------
154 154
 
155
+	/**
156
+	 * @param DOMElement $node
157
+	 */
155 158
 	protected function removeNode($node) {
156 159
 		$node->parentNode->removeChild($node);
157 160
 	}
@@ -167,6 +170,9 @@  discard block
 block discarded – undo
167 170
 		}
168 171
 	}
169 172
 
173
+	/**
174
+	 * @param DOMElement $after
175
+	 */
170 176
 	protected function insertListAfter($new, $after) {
171 177
 		$doc = $after->ownerDocument; $parent = $after->parentNode; $next = $after->nextSibling;
172 178
 
@@ -347,6 +353,7 @@  discard block
 block discarded – undo
347 353
 	 *
348 354
 	 * @param string $content - The HTML string with [tag] style shortcodes embedded
349 355
 	 * @param array $tags - The tags extracted by extractTags
356
+	 * @param Closure $generator
350 357
 	 * @return string - The HTML string with [tag] style shortcodes replaced by markers
351 358
 	 */
352 359
 	protected function replaceTagsWithText($content, $tags, $generator) {
@@ -379,7 +386,6 @@  discard block
 block discarded – undo
379 386
 	 * We don't use markers with attributes because there's no point, it's easier to do all the matching
380 387
 	 * in-DOM after the XML parse
381 388
 	 *
382
-	 * @param DOMDocument $doc
383 389
 	 */
384 390
 	protected function replaceAttributeTagsWithContent($htmlvalue) {
385 391
 		$attributes = $htmlvalue->query('//@*[contains(.,"[")][contains(.,"]")]');
Please login to merge, or discard this patch.
search/filters/ComparisonFilter.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -34,7 +34,7 @@  discard block
 block discarded – undo
34 34
 	 * Handles SQL escaping for both numeric and string values
35 35
 	 *
36 36
 	 * @param DataQuery $query
37
-	 * @return $this|DataQuery
37
+	 * @return DataQuery
38 38
 	 */
39 39
 	protected function applyOne(DataQuery $query) {
40 40
 		$this->model = $query->applyRelation($this->relation);
@@ -50,7 +50,7 @@  discard block
 block discarded – undo
50 50
 	 * Handles SQL escaping for both numeric and string values
51 51
 	 *
52 52
 	 * @param DataQuery $query
53
-	 * @return $this|DataQuery
53
+	 * @return DataQuery
54 54
 	 */
55 55
 	protected function excludeOne(DataQuery $query) {
56 56
 		$this->model = $query->applyRelation($this->relation);
Please login to merge, or discard this patch.
search/filters/SearchFilter.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@  discard block
 block discarded – undo
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 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
 block discarded – undo
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();
Please login to merge, or discard this patch.