1: <?php
2:
3: namespace Alpha\Util;
4:
5: /**
6: * A filter class for filtering user input from text fields.
7: *
8: * @since 1.0
9: *
10: * @author John Collins <dev@alphaframework.org>
11: * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
12: * @copyright Copyright (c) 2015, John Collins (founder of Alpha Framework).
13: * All rights reserved.
14: *
15: * <pre>
16: * Redistribution and use in source and binary forms, with or
17: * without modification, are permitted provided that the
18: * following conditions are met:
19: *
20: * * Redistributions of source code must retain the above
21: * copyright notice, this list of conditions and the
22: * following disclaimer.
23: * * Redistributions in binary form must reproduce the above
24: * copyright notice, this list of conditions and the
25: * following disclaimer in the documentation and/or other
26: * materials provided with the distribution.
27: * * Neither the name of the Alpha Framework nor the names
28: * of its contributors may be used to endorse or promote
29: * products derived from this software without specific
30: * prior written permission.
31: *
32: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
33: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
34: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
35: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
37: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
40: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
42: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
44: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45: * </pre>
46: */
47: class InputFilter
48: {
49: /**
50: * The encoding method which applies the filters.
51: *
52: * @param string $text
53: * @param bool $allowHTML
54: *
55: * @return string
56: *
57: * @since 1.0
58: */
59: public static function encode($text, $allowHTML = false)
60: {
61: if (!get_magic_quotes_gpc()) {
62: if ($allowHTML) {
63: return $text;
64: } else {
65: return htmlentities($text, ENT_COMPAT, 'utf-8');
66: }
67: } else {
68: if ($allowHTML) {
69: return $text;
70: } else {
71: return htmlentities($text, ENT_COMPAT, 'utf-8');
72: }
73: }
74: }
75:
76: /**
77: * The decoding method which reverses the filters.
78: *
79: * @param string $text
80: * @param bool $allowHTML
81: *
82: * @return string
83: *
84: * @since 1.0
85: */
86: public static function decode($text, $allowHTML = false)
87: {
88: if (!get_magic_quotes_gpc()) {
89: if ($allowHTML) {
90: return $text;
91: } else {
92: return html_entity_decode($text);
93: }
94: } elseif ($allowHTML) {
95: return $text;
96: } else {
97: return html_entity_decode($text);
98: }
99: }
100: }
101: