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 156 157 158 159 160 161 162 163 164 165 166 167 168 169
|
<?php
/**
* A very base error class.
*
* Provides a basic uniform API for setting and testing error conditions and
* error messages.
*
* @version $Id: Error.class,v 1.5 2003/02/12 17:23:47 bigdisk Exp $
* @author Tim Perdue <tperdue@valnux.com>
* @date 2000-08-28
*
* This file is part of GForge.
*
* GForge is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* GForge is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GForge; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
class Error {
/**
* The current error state.
*
* @var bool $error_state.
*/
var $error_state;
/**
* The current error message(s).
*
* @var string $error_message.
*/
var $error_message;
/**
* Error() - Constructor.
* Constructor for the Error class.
* Sets the error state to false.
*
*/
function Error() {
//nothing
$this->error_state=false;
}
/**
* setError() - Sets the error string.
* Set the error string $error_message to the value of $string
# and enable the $error_state flag.
*
* @param string The error string to set.
*
*/
function setError($string) {
$this->error_state=true;
$this->error_message=$string;
}
/**
* clearError() - Clear the current error.
* Clear the current error string and disable the $error_state flag.
*
*/
function clearError() {
$this->error_state=false;
$this->error_message='';
}
/**
* getErrorMessage() - Retrieve the error message string.
* Returns the value of $error_message.
*
* @return $error_message The current error message string.
*
*/
function getErrorMessage() {
if ($this->error_state) {
return $this->error_message;
} else {
return 'No Error';
}
}
/**
* isError() - Determines the current error state.
* This function returns the current value of $error_state.
*
* @return $error_state The boolean error status.
*
*/
function isError() {
return $this->error_state;
}
/**
* setPermissionDeniedError() - sets a Permission Denied error
* retrieves the localized error string for Permission Denied and calls exit_error()
*
*
*/
function setPermissionDeniedError(){
global $Language;
exit_error($Language->getText('general','error'),$Language->getText('general','permdenied'));
}
/**
* setInvalidEmailError() - sets a Invalid Email error
* retrieves the localized error string for Invalid Email and calls exit_error()
*
*
*/
function setInvalidEmailError(){
global $Language;
exit_error($Language->getText('general','error'),$Language->getText('general','invalid_email'));
}
/**
* setOnUpdateError() - sets an On Update Error
* retrieves the localized error string for On Update and calls exit_error()
*
* * @param string The db result to be written.
*
*/
function setOnUpdateError($result=""){
global $Language;
exit_error($Language->getText('general','error'),$Language->getText('general','error_on_update',$result));
}
/**
* setGroupIdError() - sets an Group ID Error
* retrieves the localized error string for Group ID and calls exit_error()
*
*
*/
function setGroupIdError(){
global $Language;
exit_error($Language->getText('general','error'),$Language->getText('general','error_group_id'));
}
/**
* setMissingParamsError() - sets an Group ID Error
* retrieves the localized error string for missing pparamsand calls exit_error()
*
*
*/
function setMissingParamsError(){
global $Language;
exit_error($Language->getText('general','error'),$Language->getText('general','error_missing_params'));
}
}
?>
|