-
Notifications
You must be signed in to change notification settings - Fork 0
/
PVResponse.php
155 lines (131 loc) · 4.73 KB
/
PVResponse.php
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<?php
class PVResponse implements PVResponseInterface {
protected $_statusMessages;
public function __construct() {
$this -> _statusMessages = self::getDefaultStatusMessages();
return $this;
}
/**
* Creates an html response to display to the. The response can be override by setting the body
* to a value other than an empty string.
*
* @param int $status The status is the status code that will be sent as a header
* @param string $body The body of that will be displayed to the user. If no body is set, a default html template will be display with the status code
* @param array $options An array of options that define how content will be displayed
* -'content_type' _string_: The type of content that will be displayed. Default is text/html
* -'message' _string_: A message that can be displayed us no body is set. Default is empty string.
*
* @return string $response A response generated based on the variables
* @access public
*/
public function createResponse($status, $body = '', $options = array()) {
$defaults = array(
'content_type' => 'text/html',
'message' => ''
);
$options += $defaults;
extract($options);
$status_header = 'HTTP/1.1 ' . $status . ' ' . $this ->getStatusMessage($status);
header($status_header);
header('Content-type: ' . $content_type);
if ($body != '') {
return $body;
} else {
$signature = ($_SERVER['SERVER_SIGNATURE'] == '') ? $_SERVER['SERVER_SOFTWARE'] . ' Server at ' . $_SERVER['SERVER_NAME'] . ' Port ' . $_SERVER['SERVER_PORT'] : $_SERVER['SERVER_SIGNATURE'];
$body = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>' . $status . ' ' . self::getStatusMessage($status) . '</title>
</head>
<body>
<h1>' . self::getStatusMessage($status) . '</h1>
<p>' . $message . '</p>
<hr />
<address>' . $signature . '</address>
</body>
</html>';
return $body;
}
}
/**
* Set message to be used. This will ovveride the default ones that are currently
* being used.
*
* @param array $messages An array that the key is the interger that is a status and the value the description of the code
* @param array $options An array that can be used to define how the status codes are added
* -'use_message_defaults' _boolean_: Default is true and if set to true, will be the status codes that come with the class
*
* @return void
* @access public
*/
public function setStatusMessages($messages, $options = array()) {
$defaults = array('use_message_defaults' => true);
$options += $defaults;
if($options['use_message_defaults'])
$messages += self::getDefaultStatusMessages();
$this -> _statusMessages = $messages;
}
/**
* Returns the message to a status based on the code that is passed.
*
* @param int $status An interger value representing the status code
*
* @return string $message Returns a message if found, otherwise returns false
* @access public
*/
public function getStatusMessage($status) {
return (isset($this -> _statusMessages[$status])) ? $this -> _statusMessages[$status] : '';
}
/**
* Get the default status messages associated with a status.
*
* @return array $messages Return an array in wich the key is the status and the value is a message
* @access public
*/
protected static function getDefaultStatusMessages() {
$status = Array(
100 => 'Continue',
101 => 'Switching Protocols',
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
306 => '(Unused)',
307 => 'Temporary Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Request Entity Too Large',
414 => 'Request-URI Too Long',
415 => 'Unsupported Media Type',
416 => 'Requested Range Not Satisfiable',
417 => 'Expectation Failed',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported');
return $status;
}
}