Completed
Pull Request — 3.4 (#6199)
by Jono
10:15
created
forms/TabSet.php 1 patch
Doc Comments   -2 removed lines patch added patch discarded remove patch
@@ -29,8 +29,6 @@
 block discarded – undo
29 29
 
30 30
 	/**
31 31
 	 * @param string $name Identifier
32
-	 * @param string $title (Optional) Natural language title of the tabset
33
-	 * @param Tab|TabSet $unknown All further parameters are inserted as children into the TabSet
34 32
 	 */
35 33
 	public function __construct($name) {
36 34
 		$args = func_get_args();
Please login to merge, or discard this patch.
forms/TimeField.php 1 patch
Doc Comments   +7 added lines patch added patch discarded remove patch
@@ -50,6 +50,10 @@  discard block
 block discarded – undo
50 50
 	 */
51 51
 	protected $valueObj = null;
52 52
 
53
+	/**
54
+	 * @param string $name
55
+	 * @param string $title
56
+	 */
53 57
 	public function __construct($name, $title = null, $value = ""){
54 58
 		if(!$this->locale) {
55 59
 			$this->locale = i18n::get_locale();
@@ -228,6 +232,9 @@  discard block
 block discarded – undo
228 232
 		return $this->castedCopy('TimeField_Readonly');
229 233
 	}
230 234
 
235
+	/**
236
+	 * @param string $class
237
+	 */
231 238
 	public function castedCopy($class) {
232 239
 		$copy = parent::castedCopy($class);
233 240
 		if($copy->hasMethod('setConfig')) {
Please login to merge, or discard this patch.
i18n/i18n.php 1 patch
Doc Comments   +5 added lines, -2 removed lines patch added patch discarded remove patch
@@ -118,7 +118,7 @@  discard block
 block discarded – undo
118 118
 
119 119
 	/**
120 120
 	 * Return an instance of the cache used for i18n data.
121
-	 * @return Zend_Cache
121
+	 * @return Zend_Cache_Core
122 122
 	 */
123 123
 	public static function get_cache() {
124 124
 		return SS_Cache::factory('i18n', 'Output', array('lifetime' => null, 'automatic_serialization' => true));
@@ -2156,6 +2156,7 @@  discard block
 block discarded – undo
2156 2156
 
2157 2157
 	/**
2158 2158
 	 * @param String
2159
+	 * @param string $name
2159 2160
 	 * @return Zend_Translate
2160 2161
 	 */
2161 2162
 	public static function get_translator($name) {
@@ -2169,6 +2170,7 @@  discard block
 block discarded – undo
2169 2170
 	 * @param Zend_Translate Needs to implement {@link i18nTranslateAdapterInterface}
2170 2171
 	 * @param String If left blank will override the default translator.
2171 2172
 	 * @param Int
2173
+	 * @param string $name
2172 2174
 	 */
2173 2175
 	public static function register_translator($translator, $name, $priority = 10) {
2174 2176
 		if (!is_int($priority)) throw new InvalidArgumentException("register_translator expects an int priority");
@@ -2298,7 +2300,7 @@  discard block
 block discarded – undo
2298 2300
 	 *
2299 2301
 	 * @see get_locale_name()
2300 2302
 	 *
2301
-	 * @param mixed $code Language code
2303
+	 * @param string $code Language code
2302 2304
 	 * @param boolean $native If true, the native name will be returned
2303 2305
 	 * @return Name of the language
2304 2306
 	 */
@@ -2455,6 +2457,7 @@  discard block
 block discarded – undo
2455 2457
 	 *
2456 2458
 	 * Note: Does not check for {@link $allowed_locales}.
2457 2459
 	 *
2460
+	 * @param string $locale
2458 2461
 	 * @return boolean
2459 2462
 	 */
2460 2463
 	public static function validate_locale($locale) {
Please login to merge, or discard this patch.
i18n/i18nTextCollector.php 1 patch
Doc Comments   +6 added lines, -1 removed lines patch added patch discarded remove patch
@@ -712,7 +712,8 @@  discard block
 block discarded – undo
712 712
 	 * Input for langArrayCodeForEntitySpec() should be suitable for insertion
713 713
 	 * into single-quoted strings, so needs to be escaped already.
714 714
 	 *
715
-	 * @param string $entity The entity name, e.g. CMSMain.BUTTONSAVE
715
+	 * @param string $entitySpec The entity name, e.g. CMSMain.BUTTONSAVE
716
+	 * @param string $locale
716 717
 	 */
717 718
 	public function langArrayCodeForEntitySpec($entityFullName, $entitySpec, $locale) {
718 719
 		$php = '';
@@ -775,6 +776,9 @@  discard block
 block discarded – undo
775 776
 		return true;
776 777
 	}
777 778
 
779
+	/**
780
+	 * @param string $locale
781
+	 */
778 782
 	public function getYaml($entities, $locale) {
779 783
 		// Unflatten array
780 784
 		$entitiesNested = array();
@@ -843,6 +847,7 @@  discard block
 block discarded – undo
843 847
 
844 848
 	/**
845 849
 	 * Parses a template and returns any translatable entities
850
+	 * @param string $template
846 851
 	 */
847 852
 	public static function GetTranslatables($template) {
848 853
 		self::$entities = array();
Please login to merge, or discard this patch.
model/connect/DBSchemaManager.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -38,7 +38,6 @@  discard block
 block discarded – undo
38 38
 	/**
39 39
 	 * Injector injection point for database controller
40 40
 	 *
41
-	 * @param SS_Database $connector
42 41
 	 */
43 42
 	public function setDatabase(SS_Database $database) {
44 43
 		$this->database = $database;
@@ -104,6 +103,7 @@  discard block
 block discarded – undo
104 103
 	 *
105 104
 	 * @var callable $callback
106 105
 	 * @throws Exception
106
+	 * @param Closure $callback
107 107
 	 */
108 108
 	public function schemaUpdate($callback) {
109 109
 		// Begin schema update
@@ -476,7 +476,7 @@  discard block
 block discarded – undo
476 476
 	/**
477 477
 	 * Given an index spec determines the index type
478 478
 	 *
479
-	 * @param array|string $spec
479
+	 * @param string $spec
480 480
 	 * @return string
481 481
 	 */
482 482
 	protected function determineIndexType($spec) {
@@ -544,7 +544,7 @@  discard block
 block discarded – undo
544 544
 	/**
545 545
 	 * Returns true if the given table is exists in the current database
546 546
 	 *
547
-	 * @param string $table Name of table to check
547
+	 * @param string $tableName Name of table to check
548 548
 	 * @return boolean Flag indicating existence of table
549 549
 	 */
550 550
 	abstract public function hasTable($tableName);
Please login to merge, or discard this patch.
model/connect/MySQLSchemaManager.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -115,6 +115,9 @@
 block discarded – undo
115 115
 		$this->query("ALTER TABLE \"$tableName\" $alterations");
116 116
 	}
117 117
 
118
+	/**
119
+	 * @param string $tableName
120
+	 */
118 121
 	public function isView($tableName) {
119 122
 		$info = $this->query("SHOW /*!50002 FULL*/ TABLES LIKE '$tableName'")->record();
120 123
 		return $info && strtoupper($info['Table_type']) == 'VIEW';
Please login to merge, or discard this patch.
model/DataDifferencer.php 1 patch
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -47,6 +47,7 @@
 block discarded – undo
47 47
 	 *
48 48
 	 * @param DataObject (Optional)
49 49
 	 * @param DataObject
50
+	 * @param DataObject|null $fromRecord
50 51
 	 */
51 52
 	public function __construct($fromRecord, DataObject $toRecord) {
52 53
 		if(!$toRecord) user_error("DataDifferencer constructed without a toRecord", E_USER_WARNING);
Please login to merge, or discard this patch.
model/DataList.php 1 patch
Doc Comments   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * Returns a new DataList instance with the specified query parameter assigned
158 158
 	 *
159 159
 	 * @param string|array $keyOrArray Either the single key to set, or an array of key value pairs to set
160
-	 * @param mixed $val If $keyOrArray is not an array, this is the value to set
160
+	 * @param string $val If $keyOrArray is not an array, this is the value to set
161 161
 	 * @return DataList
162 162
 	 */
163 163
 	public function setDataQueryParam($keyOrArray, $val = null) {
@@ -619,7 +619,7 @@  discard block
 block discarded – undo
619 619
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
620 620
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
621 621
 	 * ORM have a value of 10.
622
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
622
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
623 623
 	 * @return DataList
624 624
 	 */
625 625
 	public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -637,7 +637,7 @@  discard block
 block discarded – undo
637 637
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
638 638
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
639 639
 	 * ORM have a value of 10.
640
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
640
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
641 641
 	 * @return DataList
642 642
 	 */
643 643
 	public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -764,7 +764,7 @@  discard block
 block discarded – undo
764 764
 	 * Return the maximum value of the given field in this DataList
765 765
 	 *
766 766
 	 * @param string $fieldName
767
-	 * @return mixed
767
+	 * @return string
768 768
 	 */
769 769
 	public function max($fieldName) {
770 770
 		return $this->dataQuery->max($fieldName);
@@ -774,7 +774,7 @@  discard block
 block discarded – undo
774 774
 	 * Return the minimum value of the given field in this DataList
775 775
 	 *
776 776
 	 * @param string $fieldName
777
-	 * @return mixed
777
+	 * @return string
778 778
 	 */
779 779
 	public function min($fieldName) {
780 780
 		return $this->dataQuery->min($fieldName);
@@ -784,7 +784,7 @@  discard block
 block discarded – undo
784 784
 	 * Return the average value of the given field in this DataList
785 785
 	 *
786 786
 	 * @param string $fieldName
787
-	 * @return mixed
787
+	 * @return string
788 788
 	 */
789 789
 	public function avg($fieldName) {
790 790
 		return $this->dataQuery->avg($fieldName);
@@ -794,7 +794,7 @@  discard block
 block discarded – undo
794 794
 	 * Return the sum of the values of the given field in this DataList
795 795
 	 *
796 796
 	 * @param string $fieldName
797
-	 * @return mixed
797
+	 * @return string
798 798
 	 */
799 799
 	public function sum($fieldName) {
800 800
 		return $this->dataQuery->sum($fieldName);
@@ -846,7 +846,7 @@  discard block
 block discarded – undo
846 846
 	/**
847 847
 	 * Restrict the columns to fetch into this DataList
848 848
 	 *
849
-	 * @param array $queriedColumns
849
+	 * @param string[] $queriedColumns
850 850
 	 * @return DataList
851 851
 	 */
852 852
 	public function setQueriedColumns($queriedColumns) {
@@ -1119,7 +1119,7 @@  discard block
 block discarded – undo
1119 1119
 	/**
1120 1120
 	 * Returns item stored in list with index $key
1121 1121
 	 *
1122
-	 * @param mixed $key
1122
+	 * @param integer $key
1123 1123
 	 * @return DataObject
1124 1124
 	 */
1125 1125
 	public function offsetGet($key) {
Please login to merge, or discard this patch.
model/fieldtypes/Currency.php 1 patch
Doc Comments   +6 added lines patch added patch discarded remove patch
@@ -23,6 +23,9 @@  discard block
 block discarded – undo
23 23
 	 */
24 24
 	private static $currency_symbol = '$';
25 25
 
26
+	/**
27
+	 * @param string $name
28
+	 */
26 29
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
27 30
 		parent::__construct($name, $wholeSize, $decimalSize, $defaultValue);
28 31
 	}
@@ -46,6 +49,9 @@  discard block
 block discarded – undo
46 49
 		else return $val;
47 50
 	}
48 51
 
52
+	/**
53
+	 * @param string $value
54
+	 */
49 55
 	public function setValue($value, $record = null, $markChanged = true) {
50 56
 		$matches = null;
51 57
 		if(is_numeric($value)) {
Please login to merge, or discard this patch.