Passed
Push — 1.11.x ( bce6cd...c146d9 )
by Angel Fernando Quiroz
12:25
created

main/webservices/api/example/authenticate.php (1 issue)

1
<?php
2
3
/* For licensing terms, see /license.txt */
4
5
require_once __DIR__.'/../../../../vendor/autoload.php';
6
/**
7
 * Test example to user API v2.php.
8
 *
9
 * Using Guzzle' HTTP client to call the API endpoint and make requests.
10
 * Change URL on the first lines of createUser() below to suit your needs.
11
 */
12
13
use GuzzleHttp\Client as Client;
14
15
// set your URL, username and password here to use it for all webservices in this test file.
16
$webserviceURL = 'https://YOURCHAMILO/main/webservices/api/';
17
$webserviceUsername = 'USERNAME';
18
$webservicePassword = 'PASSWORD';
19
20
/**
21
 * Make a request to get the API key for admin user.
22
 *
23
 * @throws Exception
24
 *
25
 * @return string
26
 */
27
function authenticate()
28
{
29
    global $webserviceURL;
30
    global $webserviceUsername;
31
    global $webservicePassword;
32
    $client = new Client([
33
        'base_uri' => $webserviceURL,
34
    ]);
35
36
    $response = $client->post('v2.php', [
37
        'form_params' => [
38
            'action' => 'authenticate',
39
            'username' => $webserviceUsername,
40
            'password' => $webservicePassword,
41
        ],
42
    ]);
43
44
    if ($response->getStatusCode() !== 200) {
45
        throw new Exception('Entry denied with code : '.$response->getStatusCode());
46
    }
47
48
    $jsonResponse = json_decode($response->getBody()->getContents());
49
50
    if ($jsonResponse->error) {
51
        throw new Exception('Authentication failed because : '.$jsonResponse->message);
52
    }
53
54
    return $jsonResponse->data->apiKey;
55
}
56
57
$apiKey = authenticate();
0 ignored issues
show
The call to authenticate() has too few arguments starting with WSUser. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

57
$apiKey = /** @scrutinizer ignore-call */ authenticate();

This check compares calls to functions or methods with their respective definitions. If the call has less arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.

Loading history...
58
echo 'user API Key: '.$apiKey;
59