Version 0.48

DivanDesign · Mar 26, 2021 · 8c66932 · 8c66932
2 parents 17ce710 + 2dbc906
commit 8c66932
Show file tree

Hide file tree

Showing 6 changed files with 86 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # (MODX)EvolutionCMS.libraries.ddTools changelog
 
 
+## Version 0.48 (2021-03-25)
+* \+ `\DDTools\Snippet`:
+	* \+ `$paramsTypes`: The new property. Overwrite in child classes if you want to convert some parameters types.
+	* \+ `prepareParams`: The parameter types will be converted respectively with `$this->paramsTypes`.
+
+
 ## Version 0.47 (2021-03-20)
 * \+ `\DDTools\ObjectTools::convertType`:
 	* \+ Added [HJSON](https://hjson.github.io/) support (closes #7).

diff --git a/CHANGELOG_ru.md b/CHANGELOG_ru.md
@@ -1,6 +1,12 @@
 # (MODX)EvolutionCMS.libraries.ddTools changelog
 
 
+## Версия 0.48 (2021-03-25)
+* \+ `\DDTools\Snippet`:
+	* \+ `$paramsTypes`: Новое свойство. Перекройте в дочерних классах если вы хотите сконвертировать типы параметров.
+	* \+ `prepareParams`: Типы параметров будут сконвертированы соответственно с `$this->paramsTypes`.
+
+
 ## Версия 0.47 (2021-03-20)
 * \+ `\DDTools\ObjectTools::convertType`:
 	* \+ Добавлена поддержка [HJSON](https://hjson.github.io/) (closes #7).

diff --git a/README.md b/README.md
@@ -487,6 +487,26 @@ Abstract class for snippets.
 	* Desctription: Key is parameter name, value is value.
 	* Valid values: `mixed`
 
+* `\DDTools\Snippet::$paramsTypes`
+	* Desctription: Overwrite in child classes if you want to convert some parameters types.  
+		Parameters types will be converted respectively with this field in `\DDTools\Snippet::prepareParams`.
+	* Valid values: `arrayAssociative`
+	* Visibility: `protected`
+
+* `\DDTools\Snippet::$paramsTypes[$paramName]`
+	* Desctription: The parameter type.  
+		Values are case insensitive (the following names are equal: `'stringjsonauto'`, `'stringJsonAuto'`, `'STRINGJSONAUTO'`, etc).
+	* Valid values:
+		* `'integer'`
+		* `'boolean'`
+		* `'objectAuto'`
+		* `'objectStdClass'`
+		* `'objectArray'`
+		* `'stringJsonAuto'`
+		* `'stringJsonObject'`
+		* `'stringJsonArray'`
+	* Visibility: `protected`
+
 * `\DDTools\Snippet::$renamedParamsCompliance`
 	* Desctription: Overwrite in child classes if you want to rename some parameters with backward compatibility (see `$params->compliance` of `\ddTools::verifyRenamedParams`).
 	* Valid values: `arrayAssociative`

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
 	"name": "dd/evolutioncms-libraries-ddtools",
 	"type": "modxevo-library-ddtools",
-	"version": "0.47.0",
+	"version": "0.48.0",
 	"description": "A library with various tools facilitating your work.",
 	"keywords": [
 		"modx",

diff --git a/modx.ddtools.class.php b/modx.ddtools.class.php
@@ -1,7 +1,7 @@
 <?php
 /**
  * EvolutionCMS.libraries.ddTools
- * @version 0.47 (2021-03-20)
+ * @version 0.48 (2021-03-25)
  * 
  * @see README.md
  * 

diff --git a/src/Snippet/Snippet.php b/src/Snippet/Snippet.php
@@ -28,6 +28,12 @@ abstract class Snippet {
 		 */
 		$params = [],
 
+		/**
+		 * @property $paramsTypes {arrayAssociative} — Overwrite in child classes if you want to convert some parameters types.
+		 * @property $paramsTypes[$paramName] {'integer'|'boolean'|'objectAuto'|'objectStdClass'|'objectArray'|'stringJsonAuto'|'stringJsonObject'|'stringJsonArray'} — The parameter type.
+		 */
+		$paramsTypes = [],
+
 		/**
 		 * @property $renamedParamsCompliance {arrayAssociative} — Overwrite in child classes if you want to rename some parameters with backward compatibility (see \ddTools::verifyRenamedParams).
 		 */
@@ -81,13 +87,15 @@ public function __construct($params = []){
 
 	/**
 	 * prepareParams
-	 * @version 1.0 (2021-03-10)
+	 * @version 1.1 (2021-03-24)
 	 * 
 	 * @param $params {stdClass|arrayAssociative|stringJsonObject|stringQueryFormatted}
 	 * 
 	 * @return {void}
 	 */
 	protected function prepareParams($params = []){
+		$this->params = (object) $this->params;
+
 		$params = \DDTools\ObjectTools::convertType([
 			'object' => $params,
 			'type' => 'objectStdClass'
@@ -102,10 +110,52 @@ protected function prepareParams($params = []){
 			]);
 		}
 
+		if (!empty($this->paramsTypes)){
+			foreach (
+				$this->paramsTypes as
+				$paramName =>
+				$paramType
+			){
+				$paramType = strtolower($paramType);
+
+				if ($paramType == 'integer'){
+					$params->{$paramName} = intval($params->{$paramName});
+				}elseif ($paramType == 'boolean'){
+					$params->{$paramName} = boolval($params->{$paramName});
+				}else{
+					//Convert defaults
+					if (
+						\DDTools\ObjectTools::isPropExists([
+							'object' => $this->params,
+							'propName' => $paramName
+						])
+					){
+						$this->params->{$paramName} = \DDTools\ObjectTools::convertType([
+							'object' => $this->params->{$paramName},
+							'type' => $paramType
+						]);
+					}
+
+					//Convert given
+					if (
+						\DDTools\ObjectTools::isPropExists([
+							'object' => $params,
+							'propName' => $paramName
+						])
+					){
+						$params->{$paramName} = \DDTools\ObjectTools::convertType([
+							'object' => $params->{$paramName},
+							'type' => $paramType
+						]);
+					}
+				}
+			}
+		}
+
 		$this->params = \DDTools\ObjectTools::extend([
 			'objects' => [
 				//Defaults
-				(object) $this->params,
+				$this->params,
 				//Given parameters
 				$params
 			]