EscaperInterface.php
1.31 KB
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
<?php 
namespace Phalcon {
	/**
	 * Phalcon\EscaperInterface initializer
	 */
	
	interface EscaperInterface {
		/**
		 * Sets the encoding to be used by the escaper
		 *
		 * @param string $encoding
		 */
		public function setEncoding($encoding);
		/**
		 * Returns the internal encoding used by the escaper
		 *
		 * @return string
		 */
		public function getEncoding();
		/**
		 * Sets the HTML quoting type for htmlspecialchars
		 *
		 * @param int $quoteType
		 */
		public function setHtmlQuoteType($quoteType);
		/**
		 * Escapes a HTML string
		 *
		 * @param string $text
		 * @return string
		 */
		public function escapeHtml($text);
		/**
		 * Escapes a HTML attribute string
		 *
		 * @param string $text
		 * @return string
		 */
		public function escapeHtmlAttr($text);
		/**
		 * Escape CSS strings by replacing non-alphanumeric chars by their hexadecimal representation
		 *
		 * @param string $css
		 * @return string
		 */
		public function escapeCss($css);
		/**
		 * Escape Javascript strings by replacing non-alphanumeric chars by their hexadecimal representation
		 *
		 * @param string $js
		 * @return string
		 */
		public function escapeJs($js);
		/**
		 * Escapes a URL. Internally uses rawurlencode
		 *
		 * @param string $url
		 * @return string
		 */
		public function escapeUrl($url);
	}
}