Passed
Branch api-functionality (902732)
by Toby
04:47
created

ElectionPositionRequest   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 83
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
wmc 4
eloc 17
dl 0
loc 83
rs 10
c 0
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 3 1
A getInstance() 0 3 1
A getAll() 0 14 1
A getByID() 0 12 1
1
<?php
2
/**
3
 * Election Position 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\ElectionPositionResponse;
11
12
/**
13
 * Class Election Position Request
14
 *
15
 * @package Twigger\UnionCloud\API\Elections\ElectionPositions
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 ElectionPositionRequest extends BaseRequest implements IRequest
23
{
24
    /**
25
     * Election Position Request constructor.
26
     *
27
     * @param Authentication $authentication
28
     * @param Configuration $configuration
29
     */
30
    public function __construct($authentication, $configuration)
31
    {
32
        parent::__construct($authentication, $configuration, ElectionPositionResponse::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 all election positions
60
     * 
61
     * @return $this|\Twigger\UnionCloud\API\Response\IResponse|\Twigger\UnionCloud\API\ResourceCollection
62
     * 
63
     * @throws \GuzzleHttp\Exception\GuzzleException
64
     * @throws \Twigger\UnionCloud\API\Exception\Request\RequestHistoryNotFound
65
     * @throws \Twigger\UnionCloud\API\Exception\Response\BaseResponseException
66
     */
67
    public function getAll()
68
    {
69
        $this->setAPIParameters(
70
            'election_positions',
71
            'GET'
72
        );
73
        
74
        $this->enableMode();
75
        $this->enablePagination();
76
        $this->enableTimes();
77
        
78
        $this->call();
79
        
80
        return $this->getReturnDetails();
81
    }
82
83
    /**
84
     * Get a specific election position
85
     *
86
     * @param integer $positionID ID of the election position
87
     * @return $this|\Twigger\UnionCloud\API\Response\IResponse|\Twigger\UnionCloud\API\ResourceCollection
88
     *
89
     * @throws \GuzzleHttp\Exception\GuzzleException
90
     * @throws \Twigger\UnionCloud\API\Exception\Request\RequestHistoryNotFound
91
     * @throws \Twigger\UnionCloud\API\Exception\Response\BaseResponseException
92
     */
93
    public function getByID($positionID)
94
    {
95
        $this->setAPIParameters(
96
            'election_positions/'.$positionID,
97
            'GET'
98
        );
99
100
        $this->enableMode();
101
102
        $this->call();
103
104
        return $this->getReturnDetails();
105
    }
106
107
}