Passed
Push — master ( 7fc19c...13cdec )
by Toby
04:11 queued 10s
created

ElectionStandingRequest::getByElection()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 14
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 8
dl 0
loc 14
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
/**
3
 * Election Standing Request class
4
 */
5
namespace Twigger\UnionCloud\API\Request;
6
7
8
use Twigger\UnionCloud\API\Auth\Authentication;
9
use Twigger\UnionCloud\API\Configuration;
10
use Twigger\UnionCloud\API\Response\ElectionStandingResponse;
11
12
/**
13
 * Class Election Standing Request
14
 *
15
 * @package Twigger\UnionCloud\API\Elections\ElectionStandings
16
 *
17
 * @license    https://opensource.org/licenses/GPL-3.0  GNU Public License v3
18
 *
19
 * @author     Toby Twigger <[email protected]>
20
 *
21
 */
22
class ElectionStandingRequest extends BaseRequest implements IRequest
23
{
24
    /**
25
     * Election Standing Request constructor.
26
     *
27
     * @param Authentication $authentication
28
     * @param Configuration $configuration
29
     */
30
    public function __construct($authentication, $configuration)
31
    {
32
        parent::__construct($authentication, $configuration, ElectionStandingResponse::class);
33
    }
34
35
36
    /**
37
     * Gets the current instance
38
     *
39
     * @return $this
40
     *
41
     */
42
    public function getInstance()
43
    {
44
        return $this;
45
    }
46
47
48
49
    /*
50
    |--------------------------------------------------------------------------
51
    | API Endpoint Definitions
52
    |--------------------------------------------------------------------------
53
    |
54
    | Define your API endpoints below here
55
    |
56
    */
57
58
    /**
59
     * Get election standings for an election
60
     * 
61
     * @param integer $electionID ID of the election
62
     * 
63
     * @return $this|\Twigger\UnionCloud\API\Response\IResponse|\Twigger\UnionCloud\API\ResourceCollection
64
     * 
65
     * @throws \GuzzleHttp\Exception\GuzzleException
66
     * @throws \Twigger\UnionCloud\API\Exception\Request\RequestHistoryNotFound
67
     * @throws \Twigger\UnionCloud\API\Exception\Response\BaseResponseException
68
     */
69
    public function getByElection($electionID)
70
    {
71
        $this->setAPIParameters(
72
            'elections/'.$electionID.'/election_standings',
73
            'GET'
74
        );
75
        
76
        $this->enableMode();
77
        $this->enablePagination();
78
        $this->enableTimes();
79
        
80
        $this->call();
81
        
82
        return $this->getReturnDetails();
83
    }
84
85
}