View GitHub Repository CommonCode

Schedule Inspection
Subscribe
Completed
Branch — MagicUser (b8f336)
by Patrick
03:44
created
Status
Category
Toggle Patches
Auth/class.User.php 1 patch
Doc Comments   +19 added lines, -19 removed lines patch added patch discarded remove patch 
@@ -50,7 +50,7 @@  discard block
 
 block discarded – undo
50 50 
     /**
51 51 
      * The email address for the user
52 52 
      *
53 
-     * @return boolean|string The user's email address
53 
+     * @return boolean The user's email address
54 54 
      */
55 55 
     public function getEmail()
56 56 
     {
 
@@ -60,7 +60,7 @@  discard block
 
 block discarded – undo
60 60 
     /**
61 61 
      * The user ID for the user
62 62 
      *
63 
-     * @return boolean|string The user's ID or username
63 
+     * @return boolean The user's ID or username
64 64 
      */
65 65 
     public function getUid()
66 66 
     {
 
@@ -70,7 +70,7 @@  discard block
 
 block discarded – undo
70 70 
     /**
71 71 
      * The photo for the user
72 72 
      *
73 
-     * @return boolean|string The user's photo as a binary string
73 
+     * @return boolean The user's photo as a binary string
74 74 
      */
75 75 
     public function getPhoto()
76 76 
     {
 
@@ -80,7 +80,7 @@  discard block
 
 block discarded – undo
80 80 
     /**
81 81 
      * The phone number for the user
82 82 
      *
83 
-     * @return boolean|string The user's phone number
83 
+     * @return boolean The user's phone number
84 84 
      */
85 85 
     public function getPhoneNumber()
86 86 
     {
 
@@ -90,7 +90,7 @@  discard block
 
 block discarded – undo
90 90 
     /**
91 91 
      * The organziation for the user
92 92 
      *
93 
-     * @return boolean|string The user's organization
93 
+     * @return boolean The user's organization
94 94 
      */
95 95 
     public function getOrganization()
96 96 
     {
 
@@ -100,7 +100,7 @@  discard block
 
 block discarded – undo
100 100 
     /**
101 101 
      * The list of titles for the user
102 102 
      *
103 
-     * @return boolean|array The user's title(s) in short format
103 
+     * @return boolean The user's title(s) in short format
104 104 
      */
105 105 
     public function getTitles()
106 106 
     {
 
@@ -110,7 +110,7 @@  discard block
 
 block discarded – undo
110 110 
     /**
111 111 
      * The list of titles for the user
112 112 
      *
113 
-     * @return boolean|array The user's title(s) in user friendly strings
113 
+     * @return boolean The user's title(s) in user friendly strings
114 114 
      *
115 115 
      * @SuppressWarnings("StaticAccess")
116 116 
      */
 
@@ -148,7 +148,7 @@  discard block
 
 block discarded – undo
148 148 
     /**
149 149 
      * The state the user's mailing address is in
150 150 
      *
151 
-     * @return boolean|string The user's state from their mailing address
151 
+     * @return boolean The user's state from their mailing address
152 152 
      */
153 153 
     public function getState()
154 154 
     {
 
@@ -158,7 +158,7 @@  discard block
 
 block discarded – undo
158 158 
     /**
159 159 
      * The city the user's mailing address is in
160 160 
      *
161 
-     * @return boolean|string The user's city from their mailing address
161 
+     * @return boolean The user's city from their mailing address
162 162 
      */
163 163 
     public function getCity()
164 164 
     {
 
@@ -168,7 +168,7 @@  discard block
 
 block discarded – undo
168 168 
     /**
169 169 
      * The last name for the user
170 170 
      *
171 
-     * @return boolean|string The user's last name
171 
+     * @return boolean The user's last name
172 172 
      */
173 173 
     public function getLastName()
174 174 
     {
 
@@ -178,7 +178,7 @@  discard block
 
 block discarded – undo
178 178 
     /**
179 179 
      * The nick name for the user
180 180 
      *
181 
-     * @return boolean|string The user's nick name
181 
+     * @return boolean The user's nick name
182 182 
      */
183 183 
     public function getNickName()
184 184 
     {
 
@@ -188,7 +188,7 @@  discard block
 
 block discarded – undo
188 188 
     /**
189 189 
      * The street address for the user
190 190 
      *
191 
-     * @return boolean|string The user's street address
191 
+     * @return boolean The user's street address
192 192 
      */
193 193 
     public function getAddress()
194 194 
     {
 
@@ -198,7 +198,7 @@  discard block
 
 block discarded – undo
198 198 
     /**
199 199 
      * The postal (zip) code for the user's mailing address
200 200 
      *
201 
-     * @return boolean|string The user's postal code
201 
+     * @return boolean The user's postal code
202 202 
      */
203 203 
     public function getPostalCode()
204 204 
     {
 
@@ -208,7 +208,7 @@  discard block
 
 block discarded – undo
208 208 
     /**
209 209 
      * The country the user's mailing address is in
210 210 
      *
211 
-     * @return boolean|string The user's country from their mailing address
211 
+     * @return boolean The user's country from their mailing address
212 212 
      */
213 213 
     public function getCountry()
214 214 
     {
 
@@ -220,7 +220,7 @@  discard block
 
 block discarded – undo
220 220 
      *
221 221 
      * This is the same as Areas in Flipside speak.
222 222 
      *
223 
-     * @return boolean|array The user's orgnaiational units
223 
+     * @return boolean The user's orgnaiational units
224 224 
      */
225 225 
     public function getOrganizationUnits()
226 226 
     {
 
@@ -230,7 +230,7 @@  discard block
 
 block discarded – undo
230 230 
     /**
231 231 
      * The supplemental login types that the user can use to login
232 232 
      *
233 
-     * @return boolean|array The user's login providers
233 
+     * @return boolean The user's login providers
234 234 
      */
235 235 
     public function getLoginProviders()
236 236 
     {
 
@@ -240,7 +240,7 @@  discard block
 
 block discarded – undo
240 240 
     /**
241 241 
      * The groups the user is a part of
242 242 
      *
243 
-     * @return boolean|array The user's Auth\Group structures
243 
+     * @return boolean The user's Auth\Group structures
244 244 
      */
245 245 
     public function getGroups()
246 246 
     {
 
@@ -716,7 +716,7 @@  discard block
 
 block discarded – undo
716 716 
      *
717 717 
      * @param stdClass $data The user's new data
718 718 
      *
719 
-     * @return boolean true if the user's data was changed, false otherwise
719 
+     * @return boolean|null true if the user's data was changed, false otherwise
720 720 
      */
721 721 
     public function editUser($data)
722 722 
     {
 
@@ -743,7 +743,7 @@  discard block
 
 block discarded – undo
743 743 
     /**
744 744 
      * Obtain the user's password reset hash
745 745 
      *
746 
-     * @return string|false A hash if available, false otherwise
746 
+     * @return boolean A hash if available, false otherwise
747 747 
      */
748 748 
     public function getPasswordResetHash()
749 749 
     {
Please login to merge, or discard this patch.