ChannelHangupRequest::getChannel()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 4
Ratio 100 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 4
loc 4
ccs 0
cts 4
cp 0
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
crap 2
1
<?php
2
3
/*
4
 * Copyright 2014 Brian Smith <[email protected]>.
5
 *
6
 * Licensed under the Apache License, Version 2.0 (the "License");
7
 * you may not use this file except in compliance with the License.
8
 * You may obtain a copy of the License at
9
 *
10
 *      http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing, software
13
 * distributed under the License is distributed on an "AS IS" BASIS,
14
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
 * See the License for the specific language governing permissions and
16
 * limitations under the License.
17
 */
18
19
namespace phparia\Events;
20
21
use phparia\Client\AriClient;
22
use phparia\Resources\Channel;
23
24
/**
25
 * A hangup was requested on the channel.
26
 *
27
 * @author Brian Smith <[email protected]>
28
 * @todo Add cause constants
29
 */
30 View Code Duplication
class ChannelHangupRequest extends Event implements IdentifiableEventInterface
31
{
32
    /**
33
     * @var int (optional) - Integer representation of the cause of the hangup.
34
     */
35
    private $cause;
36
37
    /**
38
     * @var \phparia\Resources\Channel The channel on which the hangup was requested.
39
     */
40
    private $channel;
41
42
    /**
43
     * @var boolean (optional) - Whether the hangup request was a soft hangup request.
44
     */
45
    private $soft;
46
47
    /**
48
     * @return int
49
     */
50
    public function getCause()
51
    {
52
        return $this->cause;
53
    }
54
55
    /**
56
     * @return Channel
57
     */
58
    public function getChannel()
59
    {
60
        return $this->channel;
61
    }
62
63
    /**
64
     * @return boolean
65
     */
66
    public function getSoft()
67
    {
68
        return $this->soft;
69
    }
70
71
    public function getEventId()
72
    {
73
        return "{$this->getType()}_{$this->getChannel()->getId()}";
74
    }
75
76
    /**
77
     * @param AriClient $client
78
     * @param string $response
79
     */
80
    public function __construct(AriClient $client, $response)
81
    {
82
        parent::__construct($client, $response);
83
84
        $this->cause = $this->getResponseValue('cause');
85
        $this->channel = $this->getResponseValue('channel', '\phparia\Resources\Channel', $client);
86
        $this->soft = $this->getResponseValue('soft');
87
    }
88
}
89