UserModel::updateUserStatus() - Code Metrics - Inspection of "Add Get user status" - gnello/php-mattermost-driver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

unknown

created 2018-02-01 07:50 UTC

UserModel::updateUserStatus() A

↳ Parent: UserModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	2

<?php
/**
 * This Driver is based entirely on official documentation of the Mattermost Web
 * Services API and you can extend it by following the directives of the documentation.
 *
 * God bless this mess.
 *
 * @author Luca Agnello <[email protected]>
 * @link https://api.mattermost.com/
 */

namespace Gnello\Mattermost\Models;

/**
 * Class UserEntity
 *
 * @package Gnello\MattermostRestApi\Entities
 */
class UserModel extends AbstractModel
{
    /**
     * @var string
     */
    public static $endpoint = '/users';

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function loginToUserAccount(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/login', $requestOptions);
    }

    /**
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function logoutOfUserAccount()
    {
        return $this->client->post(self::$endpoint . '/logout');
    }

    /**
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getAuthenticatedUser()
    {
        return $this->client->get(self::$endpoint . '/me');
    }

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function createUser(array $requestOptions)
    {
        return $this->client->post(self::$endpoint, $requestOptions);
    }

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUsers(array $requestOptions)
    {
        return $this->client->get(self::$endpoint, $requestOptions);
    }

    /**
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUsersByIds(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/ids', $requestOptions);
    }

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function searchUsers(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/search', $requestOptions);
    }

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function autocompleteUsers(array $requestOptions)
    {
        return $this->client->get(self::$endpoint . '/autocomplete', $requestOptions);
    }

    /**
     * @param $userId
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUser($userId)
    {
        return $this->client->get(self::$endpoint . '/' . $userId);
    }

    /**
     * @param $userId
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function updateUser($userId, array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/' . $userId, $requestOptions);
    }

    /**
     * @param $userId
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function deactivateUserAccount($userId)
    {
        return $this->client->delete(self::$endpoint . '/' . $userId);
    }

    /**
     * @param $userId
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function patchUser($userId, array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/' . $userId . '/patch', $requestOptions);
    }

    /**
     * @param $userId
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function updateUserRoles($userId, array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/' . $userId . '/roles', $requestOptions);
    }

    /**
     * @param $userId
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function updateUserActive($userId, array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/' . $userId . '/active', $requestOptions);
    }

    /**
     * @param $userId
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUserProfileImage($userId)
    {
        return $this->client->get(self::$endpoint . '/' . $userId . '/image');
    }

    /**
     * @param $userId
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function setUserProfileImage($userId, array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/' . $userId . '/image', $requestOptions, 'multipart');
    }

    /**
     * @param $username
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUserByUsername($username)
    {
        return $this->client->get(self::$endpoint . '/username/' . $username);
    }

    /**
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUsersByUsernames(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/usernames/', $requestOptions);
    }

    /**
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function resetPassword(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/password/reset', $requestOptions);
    }
    
    /**
     * @param $userId
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function updateUserMfa($userId, array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/' . $userId . '/mfa', $requestOptions);
    }

    /**
     * @param $userId
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function generateMfaSecret($userId, array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/' . $userId . '/mfa/generate', $requestOptions);
    }

    /**
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function checkMfa(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/mfa', $requestOptions);
    }

    /**
     * @param $userId
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function updateUserPassword($userId, array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/' . $userId . '/password', $requestOptions);
    }

    /**
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function sendPasswordResetEmail(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/password/reset/send', $requestOptions);
    }

    /**
     * @param $email
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUserByEmail($email)
    {
        return $this->client->get(self::$endpoint . '/email/' . $email);
    }

    /**
     * @param $userId
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUserSessions($userId)
    {
        return $this->client->get(self::$endpoint . '/' . $userId . '/sessions');
    }

    /**
     * @param $userId
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function revokeUserSession($userId, array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/' . $userId . '/sessions/revoke', $requestOptions);
    }

    /**
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function attachMobileDevice(array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/sessions/device', $requestOptions);
    }

    /**
     * @param $userId
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUserAudits($userId)
    {
        return $this->client->get(self::$endpoint . '/' . $userId . '/audits');
    }

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function verifyUserEmail(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/email/verify', $requestOptions);
    }

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function sendVerificationEmail(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/email/verify/send', $requestOptions);
    }

    /**
     * @param array $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function switchLoginMethod(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/login/switch', $requestOptions);
    }

    /**
     * @param $userId
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function createToken($userId, array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/' . $userId . '/tokens', $requestOptions);
    }

    /**
     * @param $userId
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getTokens($userId, array $requestOptions)
    {
        return $this->client->get(self::$endpoint . '/' . $userId . '/tokens', $requestOptions);
    }

    /**
     * @param $tokenId
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getToken($tokenId)
    {
        return $this->client->get(self::$endpoint . '/tokens/' . $tokenId);
    }

    /**
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function revokeToken(array $requestOptions)
    {
        return $this->client->post(self::$endpoint . '/users/tokens/revoke', $requestOptions);
    }
    
    /**
     * @param $userId
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function getUserStatus($userId)
    {
        return $this->client->get(self::$endpoint . '/' . $userId . '/status');
    }

    /**
     * @param $userId
     * @param $requestOptions
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function updateUserStatus($userId, array $requestOptions)
    {
        return $this->client->put(self::$endpoint . '/' . $userId . '/status', $requestOptions);
    }

}


1			<?php
2			/**
3			* This Driver is based entirely on official documentation of the Mattermost Web
4			* Services API and you can extend it by following the directives of the documentation.
5			*
6			* God bless this mess.
7			*
8			* @author Luca Agnello <[email protected]>
9			* @link https://api.mattermost.com/
10			*/
11
12			namespace Gnello\Mattermost\Models;
13
14			/**
15			* Class UserEntity
16			*
17			* @package Gnello\MattermostRestApi\Entities
18			*/
19			class UserModel extends AbstractModel
20			{
21			/**
22			* @var string
23			*/
24			public static $endpoint = '/users';
25
26			/**
27			* @param array $requestOptions
28			* @return \Psr\Http\Message\ResponseInterface
29			*/
30			public function loginToUserAccount(array $requestOptions)
31			{
32			return $this->client->post(self::$endpoint . '/login', $requestOptions);
33			}
34
35			/**
36			* @return \Psr\Http\Message\ResponseInterface
37			*/
38			public function logoutOfUserAccount()
39			{
40			return $this->client->post(self::$endpoint . '/logout');
41			}
42
43			/**
44			* @return \Psr\Http\Message\ResponseInterface
45			*/
46			public function getAuthenticatedUser()
47			{
48			return $this->client->get(self::$endpoint . '/me');
49			}
50
51			/**
52			* @param array $requestOptions
53			* @return \Psr\Http\Message\ResponseInterface
54			*/
55			public function createUser(array $requestOptions)
56			{
57			return $this->client->post(self::$endpoint, $requestOptions);
58			}
59
60			/**
61			* @param array $requestOptions
62			* @return \Psr\Http\Message\ResponseInterface
63			*/
64			public function getUsers(array $requestOptions)
65			{
66			return $this->client->get(self::$endpoint, $requestOptions);
67			}
68
69			/**
70			* @param $requestOptions
71			* @return \Psr\Http\Message\ResponseInterface
72			*/
73			public function getUsersByIds(array $requestOptions)
74			{
75			return $this->client->post(self::$endpoint . '/ids', $requestOptions);
76			}
77
78			/**
79			* @param array $requestOptions
80			* @return \Psr\Http\Message\ResponseInterface
81			*/
82			public function searchUsers(array $requestOptions)
83			{
84			return $this->client->post(self::$endpoint . '/search', $requestOptions);
85			}
86
87			/**
88			* @param array $requestOptions
89			* @return \Psr\Http\Message\ResponseInterface
90			*/
91			public function autocompleteUsers(array $requestOptions)
92			{
93			return $this->client->get(self::$endpoint . '/autocomplete', $requestOptions);
94			}
95
96			/**
97			* @param $userId
98			* @return \Psr\Http\Message\ResponseInterface
99			*/
100			public function getUser($userId)
101			{
102			return $this->client->get(self::$endpoint . '/' . $userId);
103			}
104
105			/**
106			* @param $userId
107			* @param array $requestOptions
108			* @return \Psr\Http\Message\ResponseInterface
109			*/
110			public function updateUser($userId, array $requestOptions)
111			{
112			return $this->client->put(self::$endpoint . '/' . $userId, $requestOptions);
113			}
114
115			/**
116			* @param $userId
117			* @return \Psr\Http\Message\ResponseInterface
118			*/
119			public function deactivateUserAccount($userId)
120			{
121			return $this->client->delete(self::$endpoint . '/' . $userId);
122			}
123
124			/**
125			* @param $userId
126			* @param array $requestOptions
127			* @return \Psr\Http\Message\ResponseInterface
128			*/
129			public function patchUser($userId, array $requestOptions)
130			{
131			return $this->client->put(self::$endpoint . '/' . $userId . '/patch', $requestOptions);
132			}
133
134			/**
135			* @param $userId
136			* @param array $requestOptions
137			* @return \Psr\Http\Message\ResponseInterface
138			*/
139			public function updateUserRoles($userId, array $requestOptions)
140			{
141			return $this->client->put(self::$endpoint . '/' . $userId . '/roles', $requestOptions);
142			}
143
144			/**
145			* @param $userId
146			* @param array $requestOptions
147			* @return \Psr\Http\Message\ResponseInterface
148			*/
149			public function updateUserActive($userId, array $requestOptions)
150			{
151			return $this->client->put(self::$endpoint . '/' . $userId . '/active', $requestOptions);
152			}
153
154			/**
155			* @param $userId
156			* @return \Psr\Http\Message\ResponseInterface
157			*/
158			public function getUserProfileImage($userId)
159			{
160			return $this->client->get(self::$endpoint . '/' . $userId . '/image');
161			}
162
163			/**
164			* @param $userId
165			* @param array $requestOptions
166			* @return \Psr\Http\Message\ResponseInterface
167			*/
168			public function setUserProfileImage($userId, array $requestOptions)
169			{
170			return $this->client->post(self::$endpoint . '/' . $userId . '/image', $requestOptions, 'multipart');
171			}
172
173			/**
174			* @param $username
175			* @return \Psr\Http\Message\ResponseInterface
176			*/
177			public function getUserByUsername($username)
178			{
179			return $this->client->get(self::$endpoint . '/username/' . $username);
180			}
181
182			/**
183			* @param $requestOptions
184			* @return \Psr\Http\Message\ResponseInterface
185			*/
186			public function getUsersByUsernames(array $requestOptions)
187			{
188			return $this->client->post(self::$endpoint . '/usernames/', $requestOptions);
189			}
190
191			/**
192			* @param $requestOptions
193			* @return \Psr\Http\Message\ResponseInterface
194			*/
195			public function resetPassword(array $requestOptions)
196			{
197			return $this->client->post(self::$endpoint . '/password/reset', $requestOptions);
198			}
199
200			/**
201			* @param $userId
202			* @param $requestOptions
203			* @return \Psr\Http\Message\ResponseInterface
204			*/
205			public function updateUserMfa($userId, array $requestOptions)
206			{
207			return $this->client->put(self::$endpoint . '/' . $userId . '/mfa', $requestOptions);
208			}
209
210			/**
211			* @param $userId
212			* @param $requestOptions
213			* @return \Psr\Http\Message\ResponseInterface
214			*/
215			public function generateMfaSecret($userId, array $requestOptions)
216			{
217			return $this->client->post(self::$endpoint . '/' . $userId . '/mfa/generate', $requestOptions);
218			}
219
220			/**
221			* @param $requestOptions
222			* @return \Psr\Http\Message\ResponseInterface
223			*/
224			public function checkMfa(array $requestOptions)
225			{
226			return $this->client->post(self::$endpoint . '/mfa', $requestOptions);
227			}
228
229			/**
230			* @param $userId
231			* @param $requestOptions
232			* @return \Psr\Http\Message\ResponseInterface
233			*/
234			public function updateUserPassword($userId, array $requestOptions)
235			{
236			return $this->client->put(self::$endpoint . '/' . $userId . '/password', $requestOptions);
237			}
238
239			/**
240			* @param $requestOptions
241			* @return \Psr\Http\Message\ResponseInterface
242			*/
243			public function sendPasswordResetEmail(array $requestOptions)
244			{
245			return $this->client->post(self::$endpoint . '/password/reset/send', $requestOptions);
246			}
247
248			/**
249			* @param $email
250			* @return \Psr\Http\Message\ResponseInterface
251			*/
252			public function getUserByEmail($email)
253			{
254			return $this->client->get(self::$endpoint . '/email/' . $email);
255			}
256
257			/**
258			* @param $userId
259			* @return \Psr\Http\Message\ResponseInterface
260			*/
261			public function getUserSessions($userId)
262			{
263			return $this->client->get(self::$endpoint . '/' . $userId . '/sessions');
264			}
265
266			/**
267			* @param $userId
268			* @param array $requestOptions
269			* @return \Psr\Http\Message\ResponseInterface
270			*/
271			public function revokeUserSession($userId, array $requestOptions)
272			{
273			return $this->client->post(self::$endpoint . '/' . $userId . '/sessions/revoke', $requestOptions);
274			}
275
276			/**
277			* @param $requestOptions
278			* @return \Psr\Http\Message\ResponseInterface
279			*/
280			public function attachMobileDevice(array $requestOptions)
281			{
282			return $this->client->put(self::$endpoint . '/sessions/device', $requestOptions);
283			}
284
285			/**
286			* @param $userId
287			* @return \Psr\Http\Message\ResponseInterface
288			*/
289			public function getUserAudits($userId)
290			{
291			return $this->client->get(self::$endpoint . '/' . $userId . '/audits');
292			}
293
294			/**
295			* @param array $requestOptions
296			* @return \Psr\Http\Message\ResponseInterface
297			*/
298			public function verifyUserEmail(array $requestOptions)
299			{
300			return $this->client->post(self::$endpoint . '/email/verify', $requestOptions);
301			}
302
303			/**
304			* @param array $requestOptions
305			* @return \Psr\Http\Message\ResponseInterface
306			*/
307			public function sendVerificationEmail(array $requestOptions)
308			{
309			return $this->client->post(self::$endpoint . '/email/verify/send', $requestOptions);
310			}
311
312			/**
313			* @param array $requestOptions
314			* @return \Psr\Http\Message\ResponseInterface
315			*/
316			public function switchLoginMethod(array $requestOptions)
317			{
318			return $this->client->post(self::$endpoint . '/login/switch', $requestOptions);
319			}
320
321			/**
322			* @param $userId
323			* @param $requestOptions
324			* @return \Psr\Http\Message\ResponseInterface
325			*/
326			public function createToken($userId, array $requestOptions)
327			{
328			return $this->client->post(self::$endpoint . '/' . $userId . '/tokens', $requestOptions);
329			}
330
331			/**
332			* @param $userId
333			* @param $requestOptions
334			* @return \Psr\Http\Message\ResponseInterface
335			*/
336			public function getTokens($userId, array $requestOptions)
337			{
338			return $this->client->get(self::$endpoint . '/' . $userId . '/tokens', $requestOptions);
339			}
340
341			/**
342			* @param $tokenId
343			* @return \Psr\Http\Message\ResponseInterface
344			*/
345			public function getToken($tokenId)
346			{
347			return $this->client->get(self::$endpoint . '/tokens/' . $tokenId);
348			}
349
350			/**
351			* @param $requestOptions
352			* @return \Psr\Http\Message\ResponseInterface
353			*/
354			public function revokeToken(array $requestOptions)
355			{
356			return $this->client->post(self::$endpoint . '/users/tokens/revoke', $requestOptions);
357			}
358
359			/**
360			* @param $userId
361			* @return \Psr\Http\Message\ResponseInterface
362			*/
363			public function getUserStatus($userId)
364			{
365			return $this->client->get(self::$endpoint . '/' . $userId . '/status');
366			}
367
368			/**
369			* @param $userId
370			* @param $requestOptions
371			* @return \Psr\Http\Message\ResponseInterface
372			*/
373			public function updateUserStatus($userId, array $requestOptions)
374			{
375			return $this->client->put(self::$endpoint . '/' . $userId . '/status', $requestOptions);
376			}
377
378			}
379

gnello / php-mattermost-driver

Pull Request — master (#14)

UserModel::updateUserStatus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like