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
|
<?php
//
// +----------------------------------------------------------------------+
// | PHP Version 4 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2002 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.02 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Stig Bakken <ssb@fast.no> |
// | |
// +----------------------------------------------------------------------+
//
// $Id$
require_once "PEAR.php";
define('PEAR_COMMAND_FAILURE', 0);
define('PEAR_COMMAND_SUCCESS', 1);
define('PEAR_COMMAND_PARTIAL', 2);
/**
* PEAR_CommandResponse is for returning an "environment-neutral"
* response to the application when a PEAR command is done. This
* means that there should be no HTML markup etc. in the message. The
* application should try rendering the message "as-is" with
* linebreaks and preferably a fixed-width font.
*/
class PEAR_CommandResponse extends PEAR
{
/** Status code (one of the PEAR_COMMAND_* constants
* @var int
*/
var $status = null;
/** Message for user, in plain text.
* @var string
*/
var $message = '';
/** Character set/encoding of $message.
* @var string
*/
var $encoding = 'ISO-8859-1';
/**
* Constructor. Not very exciting.
*
* @param int Command status, one of:
* PEAR_COMMAND_SUCCESS : the command was successful
* PEAR_COMMAND_FAILURE : the command failed
* PEAR_COMMAND_PARTIAL : the command was successful,
* but requires some other command to complete the
* operation (for example if the user must confirm
* something).
* @param string Message for the user.
* @param string (optional) What character encoding the message
* is in, defaults to ISO-8859-1.
* @access public
*/
function PEAR_CommandRepsonse($status, $message, $encoding = null)
{
if ($encoding !== null) {
$this->setEncoding($encoding);
}
$this->status = $status;
$this->message = $message;
}
/**
* Get the response status code.
* @return int response status code
* @access public
*/
function getStatus()
{
return $this->status;
}
/**
* Get the response message.
* @return string response message
* @access public
*/
function getMessage()
{
return $this->message;
}
/**
* Get the response message charset encoding.
* @return string response message charset encoding
* @access public
*/
function getEncoding()
{
return $this->encoding;
}
/**
* Set the response message charset encoding.
* @param string Which encoding to use, valid charsets are currently
* ISO-8859-{1-15} and UTF-8.
* @return bool true if the encoding was valid, false if not
* @access public
*/
function setEncoding($encoding)
{
if (preg_match('/^ISO-8859-([1-9]|1[1-5])$/i', $encoding) ||
strcasecmp('UTF-8', $encoding) == 0) {
$this->encoding = $encoding;
return true;
}
return false;
}
}
?>
|
