Some cleanups/improvements
[mailer.git] / inc / code-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 02/28/2009 *
4  * ===================                          Last change: 02/28/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : code-functions.php                               *
8  * -------------------------------------------------------------------- *
9  * Short description : Functions for handling status codes              *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Funktionen zum Umgang mit Status-Funktionen      *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
20  * For more information visit: http://mxchange.org                      *
21  *                                                                      *
22  * This program is free software; you can redistribute it and/or modify *
23  * it under the terms of the GNU General Public License as published by *
24  * the Free Software Foundation; either version 2 of the License, or    *
25  * (at your option) any later version.                                  *
26  *                                                                      *
27  * This program is distributed in the hope that it will be useful,      *
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
30  * GNU General Public License for more details.                         *
31  *                                                                      *
32  * You should have received a copy of the GNU General Public License    *
33  * along with this program; if not, write to the Free Software          *
34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Adds a code key/value pair to $GLOBALS
44 function addCode ($key, $value) {
45         $GLOBALS['status_codes'][$key] = $value;
46 }
47
48 // Gets a code from the $GLOBALS registry or triggers an error if not found
49 function getCode ($key) {
50         // Is the key set?
51         if (!isCodeSet($key)) {
52                 // Abort here
53                 reportBug(__FUNCTION__, __LINE__, sprintf('%s[%s:] Code %s is not set.',
54                         __FUNCTION__,
55                         __LINE__,
56                         $key
57                 ));
58         } // END - if
59
60         // Return it
61         return $GLOBALS['status_codes'][$key];
62 }
63
64 // Checks whether a specified status code is set
65 function isCodeSet ($key) {
66         // Simply use isset()
67         return (isset($GLOBALS['status_codes'][$key]));
68 }
69
70 // Get hex-decimal value from given error code
71 function getHexErrorCode ($errorCode) {
72         // Convert it
73         $hex = str_pad(dechex($errorCode), 3, '0', STR_PAD_LEFT);
74
75         // Return it
76         return $hex;
77 }
78
79 // [EOF]
80 ?>