Completed
Push — member-groupset-delete ( a90a9a )
by Loz
11:22
created
admin/code/ModelAdmin.php 1 patch
Doc Comments   +8 added lines, -1 removed lines patch added patch discarded remove patch
@@ -120,6 +120,9 @@  discard block
 block discarded – undo
120 120
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/javascript/ModelAdmin.js');
121 121
 	}
122 122
 
123
+	/**
124
+	 * @param string $action
125
+	 */
123 126
 	public function Link($action = null) {
124 127
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
125 128
 		return parent::Link($action);
@@ -219,6 +222,9 @@  discard block
 block discarded – undo
219 222
 		return $form;
220 223
 	}
221 224
 
225
+	/**
226
+	 * @return GridFieldComponent
227
+	 */
222 228
 	public function getList() {
223 229
 		$context = $this->getSearchContext();
224 230
 		$params = $this->getRequest()->requestVar('q');
@@ -274,6 +280,7 @@  discard block
 block discarded – undo
274 280
 
275 281
 	/**
276 282
 	 * Unsanitise a model class' name from a URL param
283
+	 * @param string $class
277 284
 	 * @return string
278 285
 	 */
279 286
 	protected function unsanitiseClassName($class) {
@@ -414,7 +421,7 @@  discard block
 block discarded – undo
414 421
 	 * @param array $data
415 422
 	 * @param Form $form
416 423
 	 * @param SS_HTTPRequest $request
417
-	 * @return bool|null
424
+	 * @return false|null
418 425
 	 */
419 426
 	public function import($data, $form, $request) {
420 427
 		if(!$this->showImportForm || (is_array($this->showImportForm)
Please login to merge, or discard this patch.
forms/gridfield/GridFieldExportButton.php 1 patch
Doc Comments   +3 added lines, -1 removed lines patch added patch discarded remove patch
@@ -82,6 +82,7 @@  discard block
 block discarded – undo
82 82
 
83 83
 	/**
84 84
 	 * Handle the export, for both the action button and the URL
85
+ 	 * @param GridField $gridField
85 86
  	 */
86 87
 	public function handleExport($gridField, $request = null) {
87 88
 		$now = Date("d-m-Y-H-i");
@@ -96,7 +97,7 @@  discard block
 block discarded – undo
96 97
 	 * Generate export fields for CSV.
97 98
 	 *
98 99
 	 * @param GridField $gridField
99
-	 * @return array
100
+	 * @return string
100 101
 	 */
101 102
 	public function generateExportFileData($gridField) {
102 103
 		$separator = $this->csvSeparator;
@@ -206,6 +207,7 @@  discard block
 block discarded – undo
206 207
 
207 208
 	/**
208 209
 	 * @param boolean
210
+	 * @param boolean $bool
209 211
 	 */
210 212
 	public function setCsvHasHeader($bool) {
211 213
 		$this->csvHasHeader = $bool;
Please login to merge, or discard this patch.
view/Requirements.php 1 patch
Doc Comments   +6 added lines, -4 removed lines patch added patch discarded remove patch
@@ -63,6 +63,7 @@  discard block
 block discarded – undo
63 63
 	 * while automatically busting this cache every time the file is changed.
64 64
 	 *
65 65
 	 * @param bool
66
+	 * @param boolean $var
66 67
 	 */
67 68
 	public static function set_suffix_requirements($var) {
68 69
 		self::backend()->set_suffix_requirements($var);
@@ -123,7 +124,7 @@  discard block
 block discarded – undo
123 124
 	/**
124 125
 	 * Return all registered custom scripts
125 126
 	 *
126
-	 * @return array
127
+	 * @return string
127 128
 	 */
128 129
 	public static function get_custom_scripts() {
129 130
 		return self::backend()->get_custom_scripts();
@@ -531,7 +532,7 @@  discard block
 block discarded – undo
531 532
 	/**
532 533
 	 * Enable or disable the combination of CSS and JavaScript files
533 534
 	 *
534
-	 * @param $enable
535
+	 * @param boolean $enable
535 536
 	 */
536 537
 	public function set_combined_files_enabled($enable) {
537 538
 		$this->combined_files_enabled = (bool) $enable;
@@ -599,6 +600,7 @@  discard block
 block discarded – undo
599 600
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
600 601
 	 *
601 602
 	 * @param bool
603
+	 * @param boolean $var
602 604
 	 */
603 605
 	public function set_force_js_to_bottom($var) {
604 606
 		$this->force_js_to_bottom = $var;
@@ -638,7 +640,7 @@  discard block
 block discarded – undo
638 640
 	/**
639 641
 	 * Return all registered custom scripts
640 642
 	 *
641
-	 * @return array
643
+	 * @return string
642 644
 	 */
643 645
 	public function get_custom_scripts() {
644 646
 		$requirements = "";
@@ -1051,7 +1053,7 @@  discard block
 block discarded – undo
1051 1053
 	 * @param array  $files            Array of filenames relative to docroot
1052 1054
 	 * @param string $media
1053 1055
 	 *
1054
-	 * @return bool|void
1056
+	 * @return false|null
1055 1057
 	 */
1056 1058
 	public function combine_files($combinedFileName, $files, $media = null) {
1057 1059
 		// duplicate check
Please login to merge, or discard this patch.
core/Config.php 1 patch
Doc Comments   +23 added lines, -9 removed lines patch added patch discarded remove patch
@@ -470,11 +470,17 @@  discard block
 block discarded – undo
470 470
 
471 471
 	protected $extraConfigSources = array();
472 472
 
473
+	/**
474
+	 * @param string $class
475
+	 */
473 476
 	public function extraConfigSourcesChanged($class) {
474 477
 		unset($this->extraConfigSources[$class]);
475 478
 		$this->cache->clean("__{$class}");
476 479
 	}
477 480
 
481
+	/**
482
+	 * @param integer $sourceOptions
483
+	 */
478 484
 	protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags) {
479 485
 		$tags[] = "__{$class}";
480 486
 		$tags[] = "__{$class}__{$name}";
@@ -648,15 +654,6 @@  discard block
 block discarded – undo
648 654
 	 *
649 655
 	 * @param string $class The class to remove a configuration value from
650 656
 	 * @param string $name The configuration name
651
-	 * @param mixed $key An optional key to filter against.
652
-	 *   If referenced config value is an array, only members of that array that match this key will be removed
653
-	 *   Must also match value if provided to be removed
654
-	 * @param mixed $value And optional value to filter against.
655
-	 *   If referenced config value is an array, only members of that array that match this value will be removed
656
-	 *   If referenced config value is not an array, value will be removed only if it matches this argument
657
-	 *   Must also match key if provided and referenced config value is an array to be removed
658
-	 *
659
-	 * Matching is always by "==", not by "==="
660 657
 	 */
661 658
 	public function remove($class, $name /*,$key = null*/ /*,$value = null*/) {
662 659
 		$argc = func_num_args();
@@ -735,6 +732,10 @@  discard block
 block discarded – undo
735 732
 		$this->cache = $cloned;
736 733
 	}
737 734
 
735
+	/**
736
+	 * @param integer $key
737
+	 * @param integer $val
738
+	 */
738 739
 	public function set($key, $val, $tags = array()) {
739 740
 		// Find an index to set at
740 741
 		$replacing = null;
@@ -803,6 +804,9 @@  discard block
 block discarded – undo
803 804
 		}
804 805
 	}
805 806
 
807
+	/**
808
+	 * @param string $tag
809
+	 */
806 810
 	public function clean($tag = null) {
807 811
 		if ($tag) {
808 812
 			foreach ($this->cache as $i => $v) {
@@ -834,6 +838,10 @@  discard block
 block discarded – undo
834 838
 		$this->cache = array();
835 839
 	}
836 840
 
841
+	/**
842
+	 * @param integer $key
843
+	 * @param integer $val
844
+	 */
837 845
 	public function set($key, $val, $tags = array()) {
838 846
 		foreach($tags as $t) {
839 847
 			if(!isset($this->tags[$t])) {
@@ -852,6 +860,9 @@  discard block
 block discarded – undo
852 860
 		return $this->miss ? ($this->hit / $this->miss) : 0;
853 861
 	}
854 862
 
863
+	/**
864
+	 * @param integer $key
865
+	 */
855 866
 	public function get($key) {
856 867
 		list($hit, $result) = $this->checkAndGet($key);
857 868
 		return $hit ? $result : false;
@@ -871,6 +882,9 @@  discard block
 block discarded – undo
871 882
 		}
872 883
 	}
873 884
 
885
+	/**
886
+	 * @param string $tag
887
+	 */
874 888
 	public function clean($tag = null) {
875 889
 		if($tag) {
876 890
 			if(isset($this->tags[$tag])) {
Please login to merge, or discard this patch.
filesystem/GD.php 1 patch
Doc Comments   +8 added lines patch added patch discarded remove patch
@@ -150,6 +150,7 @@  discard block
 block discarded – undo
150 150
 	 * successfully, the manipulation's cache key is removed.
151 151
 	 *
152 152
 	 * @param string $filename
153
+	 * @param string $manipulation
153 154
 	 * @return boolean
154 155
 	 */
155 156
 	public function failedResample($filename, $manipulation) {
@@ -428,6 +429,10 @@  discard block
 block discarded – undo
428 429
 			return $useAsMinimum ? $this->resizeByWidth( $maxWidth ) : $this->resizeByHeight( $maxHeight );
429 430
 	}
430 431
 
432
+	/**
433
+	 * @param resource $image
434
+	 * @param string $webColor
435
+	 */
431 436
 	public static function color_web2gd($image, $webColor, $transparencyPercent = 0) {
432 437
 		if(substr($webColor,0,1) == "#") $webColor = substr($webColor,1);
433 438
 		$r = hexdec(substr($webColor,0,2));
@@ -546,6 +551,9 @@  discard block
 block discarded – undo
546 551
 		return $output;
547 552
 	}
548 553
 
554
+	/**
555
+	 * @param string $dirname
556
+	 */
549 557
 	public function makeDir($dirname) {
550 558
 		if(!file_exists(dirname($dirname))) $this->makeDir(dirname($dirname));
551 559
 		if(!file_exists($dirname)) mkdir($dirname, Config::inst()->get('Filesystem', 'folder_create_mask'));
Please login to merge, or discard this patch.
model/Versioned.php 1 patch
Doc Comments   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -765,7 +765,7 @@  discard block
 block discarded – undo
765 765
 	 * Extend permissions to include additional security for objects that are not published to live.
766 766
 	 *
767 767
 	 * @param Member $member
768
-	 * @return bool|null
768
+	 * @return false|null
769 769
 	 */
770 770
 	public function canView($member = null) {
771 771
 		// Invoke default version-gnostic canView
@@ -839,7 +839,7 @@  discard block
 block discarded – undo
839 839
 	 *
840 840
 	 * @param string $stage
841 841
 	 * @param Member $member
842
-	 * @return bool
842
+	 * @return boolean|string
843 843
 	 */
844 844
 	public function canViewStage($stage = 'Live', $member = null) {
845 845
 		$oldMode = Versioned::get_reading_mode();
@@ -905,7 +905,7 @@  discard block
 block discarded – undo
905 905
 	/**
906 906
 	 * Is the latest version of the object published?
907 907
 	 *
908
-	 * @return bool
908
+	 * @return string
909 909
 	 */
910 910
 	public function latestPublished() {
911 911
 		// Get the root data object class - this will have the version field
@@ -1029,7 +1029,7 @@  discard block
 block discarded – undo
1029 1029
 	 * @param string $limit
1030 1030
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
1031 1031
 	 * @param string $having
1032
-	 * @return DataList
1032
+	 * @return ArrayList
1033 1033
 	 */
1034 1034
 	public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
1035 1035
 		return $this->allVersions($filter, $sort, $limit, $join, $having);
@@ -1043,7 +1043,7 @@  discard block
 block discarded – undo
1043 1043
 	 * @param  string $limit
1044 1044
 	 * @param  string $join Deprecated, use leftJoin($table, $joinClause) instead
1045 1045
 	 * @param  string $having
1046
-	 * @return DataList
1046
+	 * @return ArrayList
1047 1047
 	 */
1048 1048
 	public function allVersions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
1049 1049
 		// Make sure the table names are not postfixed (e.g. _Live)
@@ -1361,7 +1361,7 @@  discard block
 block discarded – undo
1361 1361
 	 * @param string     $filter         A filter to be inserted into the WHERE clause.
1362 1362
 	 * @param string     $sort           A sort expression to be inserted into the ORDER BY clause.
1363 1363
 	 * @param string     $join           Deprecated, use leftJoin($table, $joinClause) instead
1364
-	 * @param string|int $limit          A limit on the number of records returned from the database.
1364
+	 * @param integer $limit          A limit on the number of records returned from the database.
1365 1365
 	 * @param string     $containerClass The container class for the result set (default is DataList)
1366 1366
 	 *
1367 1367
 	 * @return DataList A modified DataList designated to the specified stage
Please login to merge, or discard this patch.
security/Security.php 1 patch
Doc Comments   +4 added lines, -5 removed lines patch added patch discarded remove patch
@@ -496,7 +496,7 @@  discard block
 block discarded – undo
496 496
 	 * Combine the given forms into a formset with a tabbed interface
497 497
 	 *
498 498
 	 * @param array $forms List of LoginForm instances
499
-	 * @return string
499
+	 * @return HTMLText
500 500
 	 */
501 501
 	protected function generateLoginFormSet($forms) {
502 502
 		$viewData = new ArrayData(array(
@@ -676,7 +676,6 @@  discard block
 block discarded – undo
676 676
 	 * - t: plaintext token
677 677
 	 *
678 678
 	 * @param Member $member Member object associated with this link.
679
-	 * @param string $autoLoginHash The auto login token.
680 679
 	 */
681 680
 	public static function getPasswordResetLink($member, $autologinToken) {
682 681
 		$autologinToken      = urldecode($autologinToken);
@@ -767,7 +766,7 @@  discard block
 block discarded – undo
767 766
 	/**
768 767
 	 * Factory method for the lost password form
769 768
 	 *
770
-	 * @return Form Returns the lost password form
769
+	 * @return Security Returns the lost password form
771 770
 	 */
772 771
 	public function ChangePasswordForm() {
773 772
 		return Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -951,7 +950,7 @@  discard block
 block discarded – undo
951 950
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
952 951
 	 * @param string $algorithm One of the available password encryption
953 952
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
954
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
953
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
955 954
 	 */
956 955
 	public static function set_password_encryption_algorithm($algorithm) {
957 956
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1106,7 +1105,7 @@  discard block
 block discarded – undo
1106 1105
 	/**
1107 1106
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
1108 1107
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
1109
-	 * @param $flag True or false
1108
+	 * @param boolean $flag True or false
1110 1109
 	 */
1111 1110
 	public static function set_ignore_disallowed_actions($flag) {
1112 1111
 		self::$ignore_disallowed_actions = $flag;
Please login to merge, or discard this patch.
filesystem/ImagickBackend.php 1 patch
Doc Comments   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -80,7 +80,7 @@  discard block
 block discarded – undo
80 80
 	 *
81 81
 	 * Get the backend-specific resource handling the manipulations. Replaces Image::getGD()
82 82
 	 *
83
-	 * @return mixed
83
+	 * @return ImagickBackend
84 84
 	 */
85 85
 	public function getImageResource() {
86 86
 		return $this;
@@ -111,7 +111,7 @@  discard block
 block discarded – undo
111 111
 	 *
112 112
 	 * @param int $width
113 113
 	 * @param int $height
114
-	 * @return Image_Backend
114
+	 * @return null|ImagickBackend
115 115
 	 */
116 116
 	public function resize($width, $height) {
117 117
 		if(!$this->valid()) return;
@@ -141,9 +141,9 @@  discard block
 block discarded – undo
141 141
 	/**
142 142
 	 * resizeRatio
143 143
 	 *
144
-	 * @param int $width
145
-	 * @param int $height
146
-	 * @return Image_Backend
144
+	 * @param integer $maxWidth
145
+	 * @param integer $maxHeight
146
+	 * @return null|ImagickBackend
147 147
 	 */
148 148
 	public function resizeRatio($maxWidth, $maxHeight, $useAsMinimum = false) {
149 149
 		if(!$this->valid()) return;
@@ -163,7 +163,7 @@  discard block
 block discarded – undo
163 163
 	 * resizeByWidth
164 164
 	 *
165 165
 	 * @param int $width
166
-	 * @return Image_Backend
166
+	 * @return null|ImagickBackend
167 167
 	 */
168 168
 	public function resizeByWidth($width) {
169 169
 		if(!$this->valid()) return;
@@ -178,7 +178,7 @@  discard block
 block discarded – undo
178 178
 	 * resizeByHeight
179 179
 	 *
180 180
 	 * @param int $height
181
-	 * @return Image_Backend
181
+	 * @return null|ImagickBackend
182 182
 	 */
183 183
 	public function resizeByHeight($height) {
184 184
 		if(!$this->valid()) return;
@@ -195,7 +195,7 @@  discard block
 block discarded – undo
195 195
 	 * @param int $width
196 196
 	 * @param int $height
197 197
 	 * @param int $transparencyPercent
198
-	 * @return Image_Backend
198
+	 * @return null|ImagickBackend
199 199
 	 */
200 200
 	public function paddedResize($width, $height, $backgroundColor = "FFFFFF", $transparencyPercent = 0) {
201 201
 		//keep the % within bounds of 0-100
@@ -217,7 +217,7 @@  discard block
 block discarded – undo
217 217
 	/**
218 218
 	 * Convert a percentage (or 'true') to a two char hex code to signifiy the level of an alpha channel
219 219
 	 *
220
-	 * @param $percent
220
+	 * @param integer $percent
221 221
 	 * @return string
222 222
 	 */
223 223
 	public function calculateAlphaHex($percent) {
@@ -238,7 +238,7 @@  discard block
 block discarded – undo
238 238
 	 *
239 239
 	 * @param int $width
240 240
 	 * @param int $height
241
-	 * @return Image_Backend
241
+	 * @return null|ImagickBackend
242 242
 	 */
243 243
 	public function croppedResize($width, $height) {
244 244
 		if(!$this->valid()) return;
Please login to merge, or discard this patch.