ChannelStatus.php
3.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<?php
/**
* ChannelStatus 'Helper'. See: http://www.voip-info.org/wiki/view/channel+status
*
* PHP Version 5
*
* @category Pagi
* @package Client
* @author Marcelo Gornstein <[email protected]>
* @license http://marcelog.github.com/PAGI/ Apache License 2.0
* @version SVN: $Id$
* @link http://marcelog.github.com/PAGI/
*
* Copyright 2011 Marcelo Gornstein <[email protected]>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
namespace PAGI\Client;
/**
* ChannelStatus 'Helper'. See: http://www.voip-info.org/wiki/view/channel+status
*
* PHP Version 5
*
* @category Pagi
* @package Client
* @author Marcelo Gornstein <[email protected]>
* @license http://marcelog.github.com/PAGI/ Apache License 2.0
* @link http://marcelog.github.com/PAGI/
*/
class ChannelStatus
{
/**
* Down and Available.
* @var integer
*/
const DOWN_AVAILABLE = 0;
/**
* Channel is down, but reserved.
* @var integer
*/
const DOWN_RESERVED = 1;
/**
* Channel is off hook.
* @var integer
*/
const OFF_HOOK = 2;
/**
* Digits (or equivalent) have been dialed.
* @var integer
*/
const DIGITS_DIALED = 3;
/**
* Line is ringing.
* @var integer
*/
const LINE_RINGING = 4;
/**
* Remote end is ringing.
* @var integer
*/
const REMOTE_RINGING = 5;
/**
* Channel is up and running (normal operation).
* @var integer
*/
const LINE_UP = 6;
/**
* Line is busy.
* @var integer
*/
const LINE_BUSY = 7;
/**
* This will return the human readable description for the given channel
* status. See class constants. (False if the status is invalid).
*
* @param integer $status Channel status.
*
* @return string
*/
public static function toString($status)
{
switch ($status) {
case self::DOWN_AVAILABLE:
return 'Channel is down and available';
case self::DOWN_RESERVED:
return 'Channel is down, but reserved';
case self::OFF_HOOK:
return 'Channel is off hook';
case self::DIGITS_DIALED:
return 'Digits (or equivalent) have been dialed';
case self::LINE_RINGING:
return 'Line is ringing';
case self::REMOTE_RINGING:
return 'Remote end is ringing';
case self::LINE_UP:
return 'Line is up';
case self::LINE_BUSY:
return 'Line is busy';
default:
return false;
}
}
}