Completed
Pull Request — master (#5433)
by Sam
14:07 queued 01:48
created
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/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/DatabaseAdmin.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -107,7 +107,7 @@  discard block
 block discarded – undo
107 107
 	/**
108 108
 	 * Gets the url to return to after build
109 109
 	 *
110
-	 * @return string|null
110
+	 * @return string
111 111
 	 */
112 112
 	protected function getReturnURL() {
113 113
 		$url = $this->request->getVar('returnURL');
@@ -152,7 +152,7 @@  discard block
 block discarded – undo
152 152
 	/**
153 153
 	 * Returns the timestamp of the time that the database was last built
154 154
 	 *
155
-	 * @return string Returns the timestamp of the time that the database was
155
+	 * @return integer|null Returns the timestamp of the time that the database was
156 156
 	 *                last built
157 157
 	 */
158 158
 	public static function lastBuilt() {
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/DB.php 1 patch
Doc Comments   +5 added lines, -4 removed lines patch added patch discarded remove patch
@@ -217,9 +217,8 @@  discard block
 block discarded – undo
217 217
 	 * Given the database configuration, this method will create the correct
218 218
 	 * subclass of {@link SS_Database}.
219 219
 	 *
220
-	 * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
220
+	 * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
221 221
 	 *                        rest of the options, see the specific class.
222
-	 * @param string $name identifier for the connection
223 222
 	 *
224 223
 	 * @return SS_Database
225 224
 	 */
@@ -413,7 +412,7 @@  discard block
 block discarded – undo
413 412
 
414 413
 	/**
415 414
 	 * Create a new table.
416
-	 * @param string $tableName The name of the table
415
+	 * @param string $table The name of the table
417 416
 	 * @param array$fields A map of field names to field types
418 417
 	 * @param array $indexes A map of indexes
419 418
 	 * @param array $options An map of additional options.  The available keys are as follows:
@@ -500,6 +499,8 @@  discard block
 block discarded – undo
500 499
 
501 500
 	/**
502 501
 	 * @deprecated since version 4.0 Use DB::require_field instead
502
+	 * @param string $table
503
+	 * @param string $field
503 504
 	 */
504 505
 	public static function requireField($table, $field, $spec) {
505 506
 		Deprecation::notice('4.0', 'Use DB::require_field instead');
@@ -563,7 +564,7 @@  discard block
 block discarded – undo
563 564
 	/**
564 565
 	 * Checks a table's integrity and repairs it if necessary.
565 566
 	 *
566
-	 * @param string $tableName The name of the table.
567
+	 * @param string $table The name of the table.
567 568
 	 * @return boolean Return true if the table has integrity after the method is complete.
568 569
 	 */
569 570
 	public static function check_and_repair_table($table) {
Please login to merge, or discard this patch.
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.