Completed
Pull Request — master (#5037)
by Damian
21:50
created
security/Member.php 1 patch
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -616,6 +616,7 @@  discard block
 block discarded – undo
616 616
 
617 617
 	/**
618 618
 	 * Utility for generating secure password hashes for this member.
619
+	 * @return string
619 620
 	 */
620 621
 	public function encryptWithUserSettings($string) {
621 622
 		if (!$string) return null;
@@ -766,7 +767,7 @@  discard block
 block discarded – undo
766 767
 	/**
767 768
 	 * Returns the current logged in user
768 769
 	 *
769
-	 * @return Member|null
770
+	 * @return DataObject|null
770 771
 	 */
771 772
 	public static function currentUser() {
772 773
 		$id = Member::currentUserID();
Please login to merge, or discard this patch.
security/RememberLoginHash.php 1 patch
Doc Comments   +6 added lines, -2 removed lines patch added patch discarded remove patch
@@ -76,6 +76,9 @@  discard block
 block discarded – undo
76 76
 		return $this->token;
77 77
 	}
78 78
 
79
+	/**
80
+	 * @param string $token
81
+	 */
79 82
 	public function setToken($token) {
80 83
 		$this->token = $token;
81 84
 	}
@@ -92,7 +95,7 @@  discard block
 block discarded – undo
92 95
 	/**
93 96
 	 * Creates a new random token and hashes it using the 
94 97
 	 * member information
95
-	 * @param Member The logged in user 
98
+	 * @param Member Member logged in user 
96 99
 	 * @return string The hash to be stored in the database
97 100
 	 */
98 101
 	public function getNewHash(Member $member){
@@ -106,7 +109,7 @@  discard block
 block discarded – undo
106 109
 	 * The device is assigned a globally unique device ID
107 110
 	 * The returned login hash stores the hashed token in the 
108 111
 	 * database, for this device and this member
109
-	 * @param Member The logged in user 
112
+	 * @param Member Member logged in user 
110 113
 	 * @return RememberLoginHash The generated login hash
111 114
 	 */
112 115
 	public static function generate(Member $member) {
@@ -149,6 +152,7 @@  discard block
 block discarded – undo
149 152
 	 * Deletes existing tokens for this member
150 153
 	 * if logout_across_devices is true, all tokens are deleted, otherwise
151 154
 	 * only the token for the provided device ID will be removed
155
+	 * @param string $alcDevice
152 156
 	 */
153 157
 	public static function clear(Member $member, $alcDevice = null) {
154 158
 		if(!$member->exists()) { return; }
Please login to merge, or discard this patch.
forms/htmleditor/HtmlEditorConfig.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -138,7 +138,7 @@
 block discarded – undo
138 138
 	 * Get the current value of an option
139 139
      *
140 140
 	 * @param string $key The key of the option to get
141
-	 * @return mixed The value of the specified option
141
+	 * @return string The value of the specified option
142 142
 	 */
143 143
 	abstract public function getOption($key);
144 144
 
Please login to merge, or discard this patch.
forms/htmleditor/HtmlEditorField.php 1 patch
Doc Comments   +9 added lines, -5 removed lines patch added patch discarded remove patch
@@ -49,7 +49,7 @@  discard block
 block discarded – undo
49 49
 	/**
50 50
 	 * Assign a new configuration instance or identifier
51 51
 	 *
52
-	 * @param string|HtmlEditorConfig $config
52
+	 * @param string $config
53 53
 	 * @return $this
54 54
 	 */
55 55
 	public function setEditorConfig($config) {
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
 	 *
64 64
 	 * @param string $name The internal field name, passed to forms.
65 65
 	 * @param string $title The human-readable field label.
66
-	 * @param mixed $value The value of the field.
66
+	 * @param integer $value The value of the field.
67 67
 	 * @param string $config HtmlEditorConfig identifier to be used. Default to the active one.
68 68
 	 */
69 69
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -168,6 +168,10 @@  discard block
 block discarded – undo
168 168
 
169 169
 	protected $controller, $name;
170 170
 
171
+	/**
172
+	 * @param Controller $controller
173
+	 * @param string $name
174
+	 */
171 175
 	public function __construct($controller, $name) {
172 176
 		parent::__construct();
173 177
 /*
@@ -200,7 +204,7 @@  discard block
 block discarded – undo
200 204
 	/**
201 205
 	 * Searches the SiteTree for display in the dropdown
202 206
 	 *
203
-	 * @return callback
207
+	 * @return DataList
204 208
 	 */
205 209
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
206 210
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -480,7 +484,7 @@  discard block
 block discarded – undo
480 484
 	/**
481 485
 	 * Find all anchors available on the given page.
482 486
 	 *
483
-	 * @return array
487
+	 * @return string
484 488
 	 */
485 489
 	public function getanchors() {
486 490
 		$id = (int)$this->getRequest()->getVar('PageID');
@@ -1038,7 +1042,7 @@  discard block
 block discarded – undo
1038 1042
 	/**
1039 1043
 	 * Get OEmbed type
1040 1044
 	 *
1041
-	 * @return string
1045
+	 * @return boolean
1042 1046
 	 */
1043 1047
 	public function getType() {
1044 1048
 		return $this->oembed->type;
Please login to merge, or discard this patch.
forms/htmleditor/TinyMCEConfig.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -392,7 +392,7 @@
 block discarded – undo
392 392
     /**
393 393
      * Get location of all editor.css files
394 394
      *
395
-     * @return array
395
+     * @return string[]
396 396
      */
397 397
     protected function getEditorCSS() {
398 398
         $editor = array();
Please login to merge, or discard this patch.
model/HTMLValue.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -144,7 +144,7 @@
 block discarded – undo
144 144
 	/**
145 145
 	 * Make an xpath query against this HTML
146 146
 	 *
147
-	 * @param $query string - The xpath query string
147
+	 * @param string $query string - The xpath query string
148 148
 	 * @return DOMNodeList
149 149
 	 */
150 150
 	public function query($query) {
Please login to merge, or discard this patch.