Releasing 1.2.0

Author: technicalguru

README.md

@@ -22,8 +22,8 @@ This project is licensed under [GNU LGPL 3.0](LICENSE.md).
 
 ## By Composer
 
-```
-composer install technicalguru/utils
+```sh
+composer require technicalguru/utils
 ```
 
 ## By Package Download

src/TgUtils/DummyStringFilter.php

@@ -0,0 +1,25 @@
+<?php
+
+package TgUtils;
+
+/**
+ * An interface for not filtering string at all.
+ */
+public class DummyStringFilter implements StringFilter {
+
+	public static $INSTANCE = new DummyStringFilter();
+
+	public __construct() {
+	}
+
+	/**
+	 * Filters the given string and returns sanitized value.
+	 * @param string $s - string to sanitize (can be null)
+	 * @return the sanitized string.
+	 */
+	public filter($s) {
+		return $s;
+	}
+
+}
+

src/TgUtils/NoHtmlStringFilter.php

@@ -0,0 +1,26 @@
+<?php
+
+package TgUtils;
+
+/**
+ * An interface for filter strings from any HTML tags.
+ */
+public class NoHtmlStringFilter implements StringFilter {
+
+	public static $INSTANCE = new NoHtmlStringFilter();
+
+	public __construct() {
+	}
+
+	/**
+	 * Filters the given string and returns sanitized value.
+	 * @param string $s - string to sanitize (can be null)
+	 * @return the sanitized string.
+	 */
+	public filter($s) {
+		if ($s == NULL) return $s;
+		return strip_tags($s);
+	}
+
+}
+

src/TgUtils/Request.php

@@ -186,13 +186,15 @@ public function hasGetParam($key) {
 
 	/**
 	 * Returns the GET parameter value from the request.
-	 * @param string $key - the parameter name
-	 * @param mixed $default - the default value to return when parameter does not exist (optional, default is NULL).
+	 * @param string $key     - the parameter name
+	 * @param mixed  $default - the default value to return when parameter does not exist (optional, default is NULL).
+	 * @param object $filter  - a filter to sanitize the value.
 	 * @return mixed the parameter value or its default.
 	 */
-	public function getGetParam($key, $default = NULL) {
+	public function getGetParam($key, $default = NULL, $filter = NULL) {
 		$params = $this->getParams;
-		return isset($params[$key]) ? $params[$key] : $default;
+		if ($filter == NULL) $filter = StringFilters::$NO_HTML;
+		return isset($params[$key]) ? $filter->filter($params[$key]) : $default;
 	}
 
 	/**
@@ -214,13 +216,15 @@ public function hasPostParam($key) {
 
 	/**
 	 * Returns the POST parameter value from the request.
-	 * @param string $key - the parameter name
-	 * @param mixed $default - the default value to return when parameter does not exist (optional, default is NULL).
+	 * @param string $key     - the parameter name
+	 * @param mixed  $default - the default value to return when parameter does not exist (optional, default is NULL).
+	 * @param object $filter  - a filter to sanitize the value.
 	 * @return mixed the parameter value or its default.
 	 */
-	public function getPostParam($key, $default = NULL) {
+	public function getPostParam($key, $default = NULL, $filter = NULL) {
 		$params = $this->getPostParams();
-		return isset($params[$key]) ? $params[$key] : $default;
+		if ($filter == NULL) $filter = StringFilters::$NO_HTML;
+		return isset($params[$key]) ? $filter->filter($params[$key]) : $default;
 	}
 
 	/**

src/TgUtils/StringFilter.php

@@ -0,0 +1,18 @@
+<?php
+
+package TgUtils;
+
+/**
+ * An interface for filter strings from evil input.
+ */
+public interface StringFilter {
+
+	/**
+	 * Filters the given string and returns sanitized value.
+	 * @param string $s - string to sanitize (can be null)
+	 * @return the sanitized string.
+	 */
+	public filter($s);
+
+}
+

src/TgUtils/StringFilters.php

@@ -0,0 +1,14 @@
+<?php
+
+package TgUtils;
+
+/**
+ * Provides default string filters.
+ */
+public class StringFilters {
+
+	public static $DUMMY   = DummyStringFilter::$INSTANCE;
+	public static $NO_HTML = NoHtmlStringFilter::$INSTANCE;
+
+}
+