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

EventTypeRequest::getAll()   A

Complexity

Conditions 2
Paths 1

Size

Total Lines 15
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 8
dl 0
loc 15
rs 10
c 0
b 0
f 0
cc 2
nc 1
nop 1
1
<?php
2
/**
3
 * Event Type 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\EventTypeResponse;
11
12
/**
13
 * Class Event Type Request
14
 *
15
 * @package Twigger\UnionCloud\API\Events\EventTypes
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 EventTypeRequest extends BaseRequest implements IRequest
23
{
24
    /**
25
     * Event Type Request constructor.
26
     *
27
     * @param Authentication $authentication
28
     * @param Configuration $configuration
29
     */
30
    public function __construct($authentication, $configuration)
31
    {
32
        parent::__construct($authentication, $configuration, EventTypeResponse::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 event types
60
     * 
61
     * @param boolean $inUse If true, only events not older than 2 months will be returned.
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 getAll($inUse = true)
70
    {
71
        $this->setAPIParameters(
72
            'event_types',
73
            'GET'
74
        );
75
76
        $this->addQueryParameter('in_use', ($inUse?'true':'false'));
77
78
        $this->enablePagination();
79
        $this->enableTimes();
80
        
81
        $this->call();
82
        
83
        return $this->getReturnDetails();
84
    }
85
86
}