Sceluswe / XSS-Escaper

src/Escaper/CEscaper.php

Indentation +35 added lines, -35 removed lines

@@ -23,10 +23,10 @@ 
 	}
 	
 	/** Sets the used charset for the esacpeHTML and escapeXML function.
-	*
-	* @param $value, the string/value to escape.
-	*
-	*/
+	 *
+	 * @param $value, the string/value to escape.
+	 *
+	 */
 	public function setEncoding($value)
 	{
 		$_SESSION['escaper_charset'] = strip_tags($value);
@@ -34,20 +34,20 @@ 
 	}
 	
 	/** Returns the used charset for the esacpeHTML and escapeXML function.
-	*
-	* @return the current charset as a string.
-	*/
+	 *
+	 * @return the current charset as a string.
+	 */
 	public function getEncoding()
 	{
 		return $this->CHARSET;
 	}
 	
 	/** Escapes HTML string using htmlspecialchars().
-	*
-	* @param $string, the untrusted string to escape.
-	*
-	* @return $result, escaped string.
-	*/
+	 *
+	 * @param $string, the untrusted string to escape.
+	 *
+	 * @return $result, escaped string.
+	 */
 	public function escapeHTML($value)
 	{
 		$result = htmlspecialchars($value, ENT_QUOTES | ENT_SUBSTITUTE, $this->CHARSET);
@@ -57,11 +57,11 @@ 
 	}
 	
 	/** Escapes non-alphanumeric characters in an untrusted string for HTML attribute values.
-	*
-	* @param $string, the untrusted string to escape.
-	*
-	* @return $result, escaped string.
-	*/
+	 *
+	 * @param $string, the untrusted string to escape.
+	 *
+	 * @return $result, escaped string.
+	 */
 	public function escapeHTMLattr($value)
 	{
 		$result = preg_replace_callback("/[\W]/", function ($matches){
@@ -73,11 +73,11 @@ 
 	}
 	
 	/** Escapes non-alphanumeric characters in an untrusted string for JS input values.
-	*
-	* @param $string, the untrusted string to escape.
-	*
-	* @return $result, escaped string.
-	*/
+	 *
+	 * @param $string, the untrusted string to escape.
+	 *
+	 * @return $result, escaped string.
+	 */
 	public function escapeJs($value)
 	{
 		$result = preg_replace_callback("/[\W]/", function ($matches){
@@ -89,11 +89,11 @@ 
 	}
 	
 	/** Escapes non-alphanumeric characters in an untrusted string for CSS input values.
-	*
-	* @param $string, the untrusted string to escape.
-	*
-	* @return $result, escaped string.
-	*/
+	 *
+	 * @param $string, the untrusted string to escape.
+	 *
+	 * @return $result, escaped string.
+	 */
 	public function escapeCSS($value)
 	{
 		$result = preg_replace_callback("/[\W]/", function ($matches){
@@ -105,20 +105,20 @@ 
 	}
 	
 	/** Escapes data that is to be inserted in a URL not the whole URL itself.
-	* 
-	* @param $string, the untrusted string to escape.
-	*
-	* @return, escaped string.
-	*/
+	 * 
+	 * @param $string, the untrusted string to escape.
+	 *
+	 * @return, escaped string.
+	 */
 	public function escapeUrl($value)
 	{
 		return rawurlencode($value);
 	}
 	
 	/**
-	* Aliases to HTML functions for semantic value.
-	* XML escaping is identical to HTML escaping.
-	*/
+	 * Aliases to HTML functions for semantic value.
+	 * XML escaping is identical to HTML escaping.
+	 */
 	public function escapeXml($value)
 	{
 		return $this->escapeHTML($value);

Spacing +3 added lines, -3 removed lines

@@ -64,7 +64,7 @@ 
 	*/
 	public function escapeHTMLattr($value)
 	{
-		$result = preg_replace_callback("/[\W]/", function ($matches){
+		$result = preg_replace_callback("/[\W]/", function($matches) {
 			return "&#x" . bin2hex($matches[0]) . ";";
 		}, 
 		$value);
@@ -80,7 +80,7 @@ 
 	*/
 	public function escapeJs($value)
 	{
-		$result = preg_replace_callback("/[\W]/", function ($matches){
+		$result = preg_replace_callback("/[\W]/", function($matches) {
 			return "\\x" . bin2hex($matches[0]);
 		}, 
 		$value);
@@ -96,7 +96,7 @@ 
 	*/
 	public function escapeCSS($value)
 	{
-		$result = preg_replace_callback("/[\W]/", function ($matches){
+		$result = preg_replace_callback("/[\W]/", function($matches) {
 			return "\\" . bin2hex($matches[0]) . " ";
 		}, 
 		$value);

Doc Comments +9 added lines, -1 removed lines

@@ -25,6 +25,7 @@ 
 	/** Sets the used charset for the esacpeHTML and escapeXML function.
 	*
 	* @param $value, the string/value to escape.
+	* @param string $value
 	*
 	*/
 	public function setEncoding($value)
@@ -35,7 +36,7 @@ 
 	
 	/** Returns the used charset for the esacpeHTML and escapeXML function.
 	*
-	* @return the current charset as a string.
+	* @return string current charset as a string.
 	*/
 	public function getEncoding()
 	{
@@ -75,6 +76,7 @@ 
 	/** Escapes non-alphanumeric characters in an untrusted string for JS input values.
 	*
 	* @param $string, the untrusted string to escape.
+	* @param string $value
 	*
 	* @return $result, escaped string.
 	*/
@@ -91,6 +93,7 @@ 
 	/** Escapes non-alphanumeric characters in an untrusted string for CSS input values.
 	*
 	* @param $string, the untrusted string to escape.
+	* @param string $value
 	*
 	* @return $result, escaped string.
 	*/
@@ -107,6 +110,7 @@ 
 	/** Escapes data that is to be inserted in a URL not the whole URL itself.
 	* 
 	* @param $string, the untrusted string to escape.
+	* @param string $value
 	*
 	* @return, escaped string.
 	*/
@@ -118,12 +122,16 @@ 
 	/**
 	* Aliases to HTML functions for semantic value.
 	* XML escaping is identical to HTML escaping.
+	* @param string $value
 	*/
 	public function escapeXml($value)
 	{
 		return $this->escapeHTML($value);
 	}
 
+	/**
+	 * @param string $value
+	 */
 	public function escapeXmlAttr($value)
 	{
 		return $this->escapeHTMLattr($value);

autoloader.php

Indentation +21 added lines, -21 removed lines

@@ -13,30 +13,30 @@
  */
 spl_autoload_register(function ($class) {
 
-    // project-specific namespace prefix
-    //$prefix = 'Foo\\Bar\\';
-    $prefix = 'Scelus\\';
+	// project-specific namespace prefix
+	//$prefix = 'Foo\\Bar\\';
+	$prefix = 'Scelus\\';
 
-    // base directory for the namespace prefix
-    $base_dir = __DIR__ . '/src/';
+	// base directory for the namespace prefix
+	$base_dir = __DIR__ . '/src/';
 
-    // does the class use the namespace prefix?
-    $len = strlen($prefix);
-    if (strncmp($prefix, $class, $len) !== 0) {
-        // no, move to the next registered autoloader
-        return;
-    }
+	// does the class use the namespace prefix?
+	$len = strlen($prefix);
+	if (strncmp($prefix, $class, $len) !== 0) {
+		// no, move to the next registered autoloader
+		return;
+	}
 
-    // get the relative class name
-    $relative_class = substr($class, $len);
+	// get the relative class name
+	$relative_class = substr($class, $len);
 
-    // replace the namespace prefix with the base directory, replace namespace
-    // separators with directory separators in the relative class name, append
-    // with .php
-    $file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
+	// replace the namespace prefix with the base directory, replace namespace
+	// separators with directory separators in the relative class name, append
+	// with .php
+	$file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
 
-    // if the file exists, require it
-    if (file_exists($file)) {
-        require $file;
-    }
+	// if the file exists, require it
+	if (file_exists($file)) {
+		require $file;
+	}
 });
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
  * @param string $class The fully-qualified class name.
  * @return void
  */
-spl_autoload_register(function ($class) {
+spl_autoload_register(function($class) {
 
     // project-specific namespace prefix
     //$prefix = 'Foo\\Bar\\';

test/Escaper/CEscaperTest.php

Indentation +35 added lines, -35 removed lines

@@ -11,16 +11,16 @@ 
 class CEscaperTest extends \PHPUnit_Framework_TestCase
 {
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testConstructorSuccess() {
 		$el = new \Scelus\Escaper\CEscaper();
 
-        $res = $el->getEncoding();
-        $exp = 'UTF-8';
-        $this->assertEquals($res, $exp, "Created element name missmatch.");
+		$res = $el->getEncoding();
+		$exp = 'UTF-8';
+		$this->assertEquals($res, $exp, "Created element name missmatch.");
 	}
 
 	/**
@@ -42,10 +42,10 @@ 
 	}
 
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testEscapeHTML() {
 		$el = new \Scelus\Escaper\CEscaper();
 		
@@ -56,10 +56,10 @@ 
 	}
 
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testEscapeHTMLattr() {
 		$el = new \Scelus\Escaper\CEscaper();
 		
@@ -70,10 +70,10 @@ 
 	}
 
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testEscapeUrl() {
 		$el = new \Scelus\Escaper\CEscaper();
 		
@@ -84,10 +84,10 @@ 
 	}
 
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testEscapeCSS() {
 		$el = new \Scelus\Escaper\CEscaper();
 		
@@ -98,10 +98,10 @@ 
 	}
 
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testEscapeJs() {
 		$el = new \Scelus\Escaper\CEscaper();
 		$argument = "'; alert(100); var x='";
@@ -111,10 +111,10 @@ 
 	}
 
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testEscapeXML() {
 		$el = new \Scelus\Escaper\CEscaper();
 		$argument = '></div><h1>myattack</h1>';
@@ -124,10 +124,10 @@ 
 	}
 
 	/**
-	* Test 
-	*
-	* @return void
-	*/
+	 * Test 
+	 *
+	 * @return void
+	 */
 	public function testEscapeXmlattr() {
 		$el = new \Scelus\Escaper\CEscaper();
 		$argument = '"><h1>Hello</table';