users.php
4.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/users
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageUsers extends JGithubPackage
{
protected $name = 'Users';
protected $packages = array('emails', 'followers', 'keys');
/**
* Get a single user.
*
* @param string $user The users login name.
*
* @throws DomainException
*
* @return object
*/
public function get($user)
{
// Build the request path.
$path = '/users/' . $user;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get the current authenticated user.
*
* @throws DomainException
*
* @return mixed
*/
public function getAuthenticatedUser()
{
// Build the request path.
$path = '/user';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Update a user.
*
* @param string $name The full name
* @param string $email The email
* @param string $blog The blog
* @param string $company The company
* @param string $location The location
* @param string $hireable If he is unemplayed :P
* @param string $bio The biometrical DNA fingerprint (or smthng...)
*
* @throws DomainException
*
* @return mixed
*/
public function edit($name = '', $email = '', $blog = '', $company = '', $location = '', $hireable = '', $bio = '')
{
$data = array(
'name' => $name,
'email' => $email,
'blog' => $blog,
'company' => $company,
'location' => $location,
'hireable' => $hireable,
'bio' => $bio,
);
// Build the request path.
$path = '/user';
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), json_encode($data))
);
}
/**
* Get all users.
*
* This provides a dump of every user, in the order that they signed up for GitHub.
*
* @param integer $since The integer ID of the last User that you’ve seen.
*
* @throws DomainException
* @return mixed
*/
public function getList($since = 0)
{
// Build the request path.
$path = '/users';
$path .= ($since) ? '?since=' . $since : '';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/*
* Legacy methods
*/
/**
* Get a single user.
*
* @param string $user The users login name.
*
* @deprecated use users->get()
*
* @throws DomainException
*
* @return mixed
*/
public function getUser($user)
{
return $this->get($user);
}
/**
* Update a user.
*
* @param string $name The full name
* @param string $email The email
* @param string $blog The blog
* @param string $company The company
* @param string $location The location
* @param string $hireable If he is unemplayed :P
* @param string $bio The biometrical DNA fingerprint (or smthng...)
*
* @deprecated use users->edit()
*
* @throws DomainException
*
* @return mixed
*/
public function updateUser($name = '', $email = '', $blog = '', $company = '', $location = '', $hireable = '', $bio = '')
{
return $this->edit($name = '', $email = '', $blog = '', $company = '', $location = '', $hireable = '', $bio = '');
}
/**
* Get all users.
*
* This provides a dump of every user, in the order that they signed up for GitHub.
*
* @param integer $since The integer ID of the last User that you’ve seen.
*
* @deprecated use users->getList()
*
* @throws DomainException
* @return mixed
*/
public function getUsers($since = 0)
{
return $this->getList($since);
}
}