Completed
Pull Request — master (#7083)
by Sam
07:25
created
src/i18n/i18n.php 1 patch
Doc Comments   +1 added lines, -6 removed lines patch added patch discarded remove patch
@@ -141,12 +141,7 @@
 block discarded – undo
141 141
      * @param string $entity Entity that identifies the string. It must be in the form
142 142
      * "Namespace.Entity" where Namespace will be usually the class name where this
143 143
      * string is used and Entity identifies the string inside the namespace.
144
-     * @param mixed $arg,... Additional arguments are parsed as such:
145
-     *  - Next string argument is a default. Pass in a `|` pipe-delimited value with `{count}`
146
-     *    to do pluralisation.
147
-     *  - Any other string argument after default is context for i18nTextCollector
148
-     *  - Any array argument in any order is an injection parameter list. Pass in a `count`
149
-     *    injection parameter to pluralise.
144
+     * @param string $arg
150 145
      * @return string
151 146
      */
152 147
     public static function _t($entity, $arg = null)
Please login to merge, or discard this patch.
src/ORM/Filters/SearchFilter.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -74,7 +74,7 @@  discard block
 block discarded – undo
74 74
      *  column. Can contain a relation name in dot notation, which will automatically join
75 75
      *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
76 76
      *  search the "Name" column when applying this filter to a SiteTree class).
77
-     * @param mixed $value
77
+     * @param string $value
78 78
      * @param array $modifiers
79 79
      */
80 80
     public function __construct($fullName = null, $value = false, array $modifiers = array())
@@ -188,7 +188,7 @@  discard block
 block discarded – undo
188 188
     /**
189 189
      * Gets supported modifiers for this filter
190 190
      *
191
-     * @return array
191
+     * @return string[]
192 192
      */
193 193
     public function getSupportedModifiers()
194 194
     {
@@ -428,7 +428,7 @@  discard block
 block discarded – undo
428 428
     /**
429 429
      * Determines case sensitivity based on {@link getModifiers()}.
430 430
      *
431
-     * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
431
+     * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
432 432
      */
433 433
     protected function getCaseSensitive()
434 434
     {
Please login to merge, or discard this patch.
src/ORM/DataList.php 1 patch
Doc Comments   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -556,7 +556,7 @@  discard block
 block discarded – undo
556 556
      * Check if the given field specification could be interpreted as an unquoted relation name
557 557
      *
558 558
      * @param string $field
559
-     * @return bool
559
+     * @return integer
560 560
      */
561 561
     protected function isValidRelationName($field)
562 562
     {
@@ -669,7 +669,7 @@  discard block
 block discarded – undo
669 669
      * @param int $order A numerical index to control the order that joins are added to the query; lower order values
670 670
      * will cause the query to appear first. The default is 20, and joins created automatically by the
671 671
      * ORM have a value of 10.
672
-     * @param array $parameters Any additional parameters if the join is a parameterised subquery
672
+     * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
673 673
      * @return static
674 674
      */
675 675
     public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array())
@@ -688,7 +688,7 @@  discard block
 block discarded – undo
688 688
      * @param int $order A numerical index to control the order that joins are added to the query; lower order values
689 689
      * will cause the query to appear first. The default is 20, and joins created automatically by the
690 690
      * ORM have a value of 10.
691
-     * @param array $parameters Any additional parameters if the join is a parameterised subquery
691
+     * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
692 692
      * @return static
693 693
      */
694 694
     public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array())
@@ -836,7 +836,7 @@  discard block
 block discarded – undo
836 836
      * Return the maximum value of the given field in this DataList
837 837
      *
838 838
      * @param string $fieldName
839
-     * @return mixed
839
+     * @return string
840 840
      */
841 841
     public function max($fieldName)
842 842
     {
@@ -847,7 +847,7 @@  discard block
 block discarded – undo
847 847
      * Return the minimum value of the given field in this DataList
848 848
      *
849 849
      * @param string $fieldName
850
-     * @return mixed
850
+     * @return string
851 851
      */
852 852
     public function min($fieldName)
853 853
     {
@@ -858,7 +858,7 @@  discard block
 block discarded – undo
858 858
      * Return the average value of the given field in this DataList
859 859
      *
860 860
      * @param string $fieldName
861
-     * @return mixed
861
+     * @return string
862 862
      */
863 863
     public function avg($fieldName)
864 864
     {
@@ -869,7 +869,7 @@  discard block
 block discarded – undo
869 869
      * Return the sum of the values of the given field in this DataList
870 870
      *
871 871
      * @param string $fieldName
872
-     * @return mixed
872
+     * @return string
873 873
      */
874 874
     public function sum($fieldName)
875 875
     {
@@ -928,7 +928,7 @@  discard block
 block discarded – undo
928 928
     /**
929 929
      * Restrict the columns to fetch into this DataList
930 930
      *
931
-     * @param array $queriedColumns
931
+     * @param string[] $queriedColumns
932 932
      * @return static
933 933
      */
934 934
     public function setQueriedColumns($queriedColumns)
@@ -1174,7 +1174,7 @@  discard block
 block discarded – undo
1174 1174
     /**
1175 1175
      * Returns item stored in list with index $key
1176 1176
      *
1177
-     * @param mixed $key
1177
+     * @param integer $key
1178 1178
      * @return DataObject
1179 1179
      */
1180 1180
     public function offsetGet($key)
Please login to merge, or discard this patch.
src/ORM/FieldType/DBDatetime.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -85,7 +85,7 @@  discard block
 block discarded – undo
85 85
      * Return a date and time formatted as per a CMS user's settings.
86 86
      *
87 87
      * @param Member $member
88
-     * @return boolean | string A time and date pair formatted as per user-defined settings.
88
+     * @return null|string | string A time and date pair formatted as per user-defined settings.
89 89
      */
90 90
     public function FormatFromSettings($member = null)
91 91
     {
@@ -190,7 +190,7 @@  discard block
 block discarded – undo
190 190
      * Use {@link clear_mock_now()} to revert to the current system date.
191 191
      * Caution: This sets a fixed date that doesn't increment with time.
192 192
      *
193
-     * @param DBDatetime|string $datetime Either in object format, or as a DBDatetime compatible string.
193
+     * @param string $datetime Either in object format, or as a DBDatetime compatible string.
194 194
      * @throws Exception
195 195
      */
196 196
     public static function set_mock_now($datetime)
Please login to merge, or discard this patch.
src/ORM/ManyManyThroughList.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -130,7 +130,7 @@
 block discarded – undo
130 130
     }
131 131
 
132 132
     /**
133
-     * @param mixed $item
133
+     * @param Tests\ManyManyThroughListTest\Item $item
134 134
      * @param array $extraFields
135 135
      */
136 136
     public function add($item, $extraFields = [])
Please login to merge, or discard this patch.
src/ORM/Queries/SQLSelect.php 1 patch
Doc Comments   +1 added lines, -3 removed lines patch added patch discarded remove patch
@@ -380,7 +380,7 @@  discard block
 block discarded – undo
380 380
      *
381 381
      * @param string $value
382 382
      * @param string $defaultDirection
383
-     * @return array A two element array: array($column, $direction)
383
+     * @return string[] A two element array: array($column, $direction)
384 384
      */
385 385
     private function getDirectionFromString($value, $defaultDirection = null)
386 386
     {
@@ -482,7 +482,6 @@  discard block
 block discarded – undo
482 482
      * @see SQLSelect::addWhere() for syntax examples
483 483
      *
484 484
      * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
485
-     * @param mixed $having,... Unlimited additional predicates
486 485
      * @return $this Self reference
487 486
      */
488 487
     public function setHaving($having)
@@ -498,7 +497,6 @@  discard block
 block discarded – undo
498 497
      * @see SQLSelect::addWhere() for syntax examples
499 498
      *
500 499
      * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
501
-     * @param mixed $having,... Unlimited additional predicates
502 500
      * @return $this Self reference
503 501
      */
504 502
     public function addHaving($having)
Please login to merge, or discard this patch.
src/View/Parsers/Diff.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -161,7 +161,7 @@
 block discarded – undo
161 161
     }
162 162
 
163 163
     /**
164
-     * @param string|bool|array $content If passed as an array, values will be concatenated with a comma.
164
+     * @param string $content If passed as an array, values will be concatenated with a comma.
165 165
      * @return array
166 166
      */
167 167
     public static function getHTMLChunks($content)
Please login to merge, or discard this patch.
src/Forms/TreeDropdownField.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -313,7 +313,7 @@  discard block
 block discarded – undo
313 313
 
314 314
     /**
315 315
      * @param array $properties
316
-     * @return string
316
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
317 317
      */
318 318
     public function Field($properties = array())
319 319
     {
@@ -479,7 +479,7 @@  discard block
 block discarded – undo
479 479
 
480 480
     /**
481 481
      * Marking a specific node in the tree as disabled
482
-     * @param $node
482
+     * @param DataObject $node
483 483
      * @return boolean
484 484
      */
485 485
     public function nodeIsDisabled($node)
Please login to merge, or discard this patch.
src/ORM/Hierarchy/MarkedSet.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -380,7 +380,7 @@  discard block
 block discarded – undo
380 380
      *
381 381
      * @param DataObject $node
382 382
      * @param int $depth
383
-     * @return array|string
383
+     * @return callable
384 384
      */
385 385
     protected function getSubtree($node, $depth = 0)
386 386
     {
@@ -613,7 +613,7 @@  discard block
 block discarded – undo
613 613
     /**
614 614
      * Expose the given object in the tree, by marking this page and all it ancestors.
615 615
      *
616
-     * @param DataObject|Hierarchy $childObj
616
+     * @param DataObject $childObj
617 617
      * @return $this
618 618
      */
619 619
     public function markToExpose(DataObject $childObj)
@@ -758,7 +758,7 @@  discard block
 block discarded – undo
758 758
     /**
759 759
      * Check if this node has too many children
760 760
      *
761
-     * @param DataObject|Hierarchy $node
761
+     * @param DataObject $node
762 762
      * @param int $count Children count (if already calculated)
763 763
      * @return bool
764 764
      */
Please login to merge, or discard this patch.