Version 1.4

Author: Ronef

CHANGELOG.md

@@ -1,6 +1,26 @@
 # (MODX)EvolutionCMS.snippets.ddStringTools changelog
 
 
+## Version 1.4 (2020-04-19)
+* \+ Added the ability to remove placeholders like `[+placeholder+]`.
+* \* Refactoring, the `$modx->getConfig` method is used instead of the `$modx->config` field.
+* \* README:
+	* \* Style changes.
+	* \* Documentation → Parameters description: Small order changes.
+* \+ Composer.json → Require.
+
+
+## Version 1.3 (2019-10-20)
+* \* Attention! EvolutionCMS.libraries.ddTools >= 0.27 is required (because not tested in older versions).
+* \* Attention! EvolutionCMS.snippets.ddTypograph >= 2.4 is required if the `typography` parameter is used.
+* \+ Added the ability to text typography (see the `typography` parameter).
+* \+ README → Documentation:
+	* \+ Installation instructions.
+	* \+ Parameters description.
+	* \+ Examples.
+* \+ Composer.json.
+
+
 ## Version 1.2 (2019-08-09)
 * \+ Added an ability to parse Markdown (see the `parseMarkdown` parameter).
 

README.md

@@ -3,30 +3,36 @@
 Tools for modifying strings.
 
 
-## # Requires
+## Requires
+
 * PHP >= 5.4
 * [(MODX)EvolutionCMS](https://github.com/evolution-cms/evolution) >= 1.1
 * [(MODX)EvolutionCMS.libraries.ddTools](http://code.divandesign.biz/modx/ddtools) >= 0.27
 * [(MODX)EvolutionCMS.snippets.ddTypograph](https://code.divandesign.biz/modx/ddtypograph) >= 2.4  (if the `typography` parameter is used)
 * [PHP.libraries.Parsedown](https://github.com/erusev/parsedown) >= 1.8.0-beta-7 (contains in archive)
 
 
-## # Documentation
+## Documentation
+
+
+### Installation
+
 
+#### 1. Elements → Snippets: Create a new snippet with the following data
 
-### ## Installation
-1. Elements → Snippets: Create a new snippet with the following data:
-	1. Snippet name: `ddStringTools`.
-	2. Description: `<b>1.3</b> Tools for modifying strings.`.
-	3. Category: `Core`.
-	4. Parse DocBlock: `no`.
-	5. Snippet code (php): Insert content of the `ddStringTools_snippet.php` file from the archive.
-2. Elements → Manage Files:
-	1. Create a new folder `assets/snippets/ddStringTools/`.
-	2. Extract the archive to the folder (except `ddStringTools_snippet.php`).
+1. Snippet name: `ddStringTools`.
+2. Description: `<b>1.4</b> Tools for modifying strings.`.
+3. Category: `Core`.
+4. Parse DocBlock: `no`.
+5. Snippet code (php): Insert content of the `ddStringTools_snippet.php` file from the archive.
 
+#### 2. Elements → Manage Files:
 
-### ## Parameters description
+1. Create a new folder `assets/snippets/ddStringTools/`.
+2. Extract the archive to the folder (except `ddStringTools_snippet.php`).
+
+
+### Parameters description
 
 * `inputString`
 	* Desctription: The input string.
@@ -87,8 +93,8 @@ Tools for modifying strings.
 		* `1`
 	* Default value: `0`
 
-* `URLEncode`
-	* Desctription: URL-encode according to RFC 3986.
+* `removePlaceholders`
+	* Desctription: Remove placeholders like `[+placeholder+]`.
 	* Valid values:
 		* `0`
 		* `1`
@@ -100,12 +106,19 @@ Tools for modifying strings.
 		* `0`
 		* `1`
 	* Default value: `0`
+	
+* `URLEncode`
+	* Desctription: URL-encode according to RFC 3986.
+	* Valid values:
+		* `0`
+		* `1`
+	* Default value: `0`
 
 
-### ## Examples
+### Examples
 
 
-#### ### Convert characters to lowercase
+#### Convert characters to lowercase
 
 ```
 [[ddStringTools?
@@ -121,7 +134,7 @@ some string with different case
 ```
 
 
-#### ### Strip HTML and PHP tags from a string excluding `<p>` и `<a>`
+#### Strip HTML and PHP tags from a string excluding `<p>` и `<a>`
 
 ```html
 [[ddStringTools?
@@ -138,7 +151,7 @@ Returns
 ```
 
 
-#### ### Convert special characters to HTML entities
+#### Convert special characters to HTML entities
 
 ```html
 [[ddStringTools?
@@ -154,7 +167,7 @@ Returns
 ```
 
 
-#### ### URL-encode according to RFC 3986
+#### URL-encode according to RFC 3986
 
 ```
 [[ddStringTools?
@@ -170,7 +183,7 @@ tags%5B%5D%3DMaps%26tags%5B%5D%3DURLs
 ```
 
 
-#### ### Escape special characters for JavaScript
+#### Escape special characters for JavaScript
 
 ```html
 <script>
@@ -193,7 +206,7 @@ Returns
 ```
 
 
-#### ### Convert Markdown to HTML
+#### Convert Markdown to HTML
 
 ```
 [[ddStringTools?
@@ -214,7 +227,7 @@ Returns
 ```
 
 
-#### ### Typography text with optical alignment
+#### Typography text with optical alignment
 
 ```html
 [[ddStringTools?
@@ -233,4 +246,23 @@ Returns
 ```
 
 
-## # [Home page →](http://code.divandesign.biz/modx/ddstringtools)
+#### Remove placeholders like `[+placeholder+]`
+
+```html
+[[ddStringTools?
+	&inputString=`Some [+thing+] with [+placeholder1+] and [+placeholder2+].`
+	&removePlaceholders=`1`
+]]
+```
+
+Returns
+
+```html
+Some  with  and .
+```
+
+
+## [Home page →](http://code.divandesign.biz/modx/ddstringtools)
+
+
+<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />

composer.json

@@ -1,7 +1,7 @@
 {
 	"name": "dd/evolutioncms-snippets-ddstringtools",
 	"type": "modxevo-snippet",
-	"version": "1.3",
+	"version": "1.4",
 	"description": "Tools for modifying strings.",
 	"keywords": [
 		"modx",
@@ -21,5 +21,10 @@
 		"escape for js",
 		"js escaping",
 		"url encode"
-	]
+	],
+	"require": {
+		"php": ">=5.4.0",
+		"dd/modxevo-library-ddtools": ">=0.27",
+		"dd/modxevo-snippet-ddtypograph": ">=2.4"
+	}
 }

ddStringTools_snippet.php

@@ -1,18 +1,24 @@
 <?php
 /**
  * ddStringTools
- * @version 1.3 (2019-10-20)
+ * @version 1.4 (2020-04-19)
  * 
  * @see README.md
  * 
- * @copyright 2016–2019 DivanDesign {@link http://www.DivanDesign.biz }
+ * @copyright 2016–2020 DivanDesign {@link http://www.DivanDesign.biz }
  */
 
 //Include (MODX)EvolutionCMS.libraries.ddTools
-require_once($modx->getConfig('base_path') . 'assets/libs/ddTools/modx.ddtools.class.php');
+require_once(
+	$modx->getConfig('base_path') .
+	'assets/libs/ddTools/modx.ddtools.class.php'
+);
 
 //Inclide Parsedown lib
-require_once($modx->getConfig('base_path') . 'assets/snippets/ddStringTools/src/Parsedown/Parsedown.php');
+require_once(
+	$modx->getConfig('base_path') .
+	'assets/snippets/ddStringTools/src/Parsedown/Parsedown.php'
+);
 
 if (!isset($inputString)){
 	$inputString = '';
@@ -25,7 +31,7 @@
 ){
 	$inputString = mb_strtolower(
 		$inputString,
-		$modx->config['modx_charset']
+		$modx->getConfig('modx_charset')
 	);
 }
 
@@ -36,7 +42,7 @@
 ){
 	$inputString = mb_strtoupper(
 		$inputString,
-		$modx->config['modx_charset']
+		$modx->getConfig('modx_charset')
 	);
 }
 
@@ -62,7 +68,7 @@
 		array_merge(
 			(
 				isset($typography_params) ?
-				ddTools::encodedStringToArray($typography_params) :
+				\ddTools::encodedStringToArray($typography_params) :
 				[]
 			),
 			[
@@ -98,12 +104,24 @@
 	$inputString = htmlspecialchars($inputString);
 }
 
+//Remove placeholders like [+placeholder+]
+if (
+	isset($removePlaceholders) &&
+	$removePlaceholders == '1'
+){
+	$inputString = preg_replace(
+		'/(\[\+\S+?\+\])/m',
+		'',
+		$inputString
+	);
+}
+
 //Escape special characters for JS
 if (
 	isset($escapeForJS) &&
 	$escapeForJS == '1'
 ){
-	$inputString = ddTools::escapeForJS($inputString);
+	$inputString = \ddTools::escapeForJS($inputString);
 }
 
 //URL-encode according to RFC 3986