Version 2.3

DivanDesign · Jun 3, 2023 · f40b6cd · f40b6cd
2 parents 1f70676 + 845ef80
commit f40b6cd
Show file tree

Hide file tree

Showing 7 changed files with 136 additions and 92 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # (MODX)EvolutionCMS.snippets.ddIf changelog
 
 
+## Version 2.3 (2023-06-03)
+* \+ Parameters → `operator` → Valid values → `'isIncludes'`: The new valid value. Case-sensitive check if `operand1` contains `operand2` (see README → Examples).
+* \* `\ddTools::getTpl` is used instead of `$modx->getTpl` (means a bit less bugs).
+* \* Attention! (MODX)EvolutionCMS.libraries.ddTools >= 0.60 is required.
+
+
 ## Version 2.2 (2021-04-30)
 * \+ Parameters → `operator`:
 	* \+ Added the ability to check if `operand1` is just white space (see README).
@@ -93,5 +99,5 @@
 	* \* `falseChunk`: Has been renamed from `falseChank`.
 
 
-<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />
+<link rel="stylesheet" type="text/css" href="https://raw.githack.com/DivanDesign/CSS.ddMarkdown/master/style.min.css" />
 <style>ul{list-style:none;}</style>
diff --git a/CHANGELOG_ru.md b/CHANGELOG_ru.md
@@ -1,6 +1,12 @@
 # (MODX)EvolutionCMS.snippets.ddIf changelog
 
 
+## Версия 2.3 (2023-06-03)
+* \+ Параметры → `operator` → Допустимые значения → `'isIncludes'`: Новое значение. Проверяет, содержит ли `operand1` в себе `operand2` с учётом регистра, (см. README → Примеры).
+* \* `\ddTools::getTpl` используется вместо `$modx->getTpl` (стало чуть меньше багов).
+* \* Внимание! Требуется (MODX)EvolutionCMS.libraries.ddTools >= 0.60.
+
+
 ## Версия 2.2 (2021-04-30)
 * \+ Параметры → `operator`:
 	* \+ Добавлена возможность проверить, что строка `operand1` содержит только пробельные символы (см. README).
@@ -93,5 +99,5 @@
 	* \* `falseChunk`: Переименован из `falseChank`.
 
 
-<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />
+<link rel="stylesheet" type="text/css" href="https://raw.githack.com/DivanDesign/CSS.ddMarkdown/master/style.min.css" />
 <style>ul{list-style:none;}</style>
diff --git a/README.md b/README.md
@@ -7,34 +7,13 @@ This snippet compares different values and returns required chunk or string.
 
 * PHP >= 5.6
 * [(MODX)EvolutionCMS](https://github.com/evolution-cms/evolution) >= 1.1
-* [(MODX)EvolutionCMS.libraries.ddTools](https://code.divandesign.biz/modx/ddtools) >= 0.49.1
+* [(MODX)EvolutionCMS.libraries.ddTools](https://code.divandesign.ru/modx/ddtools) >= 0.60
 
 
-## Documentation
+## Installation
 
 
-### Installation
-
-
-#### Manually
-
-
-##### 1. Elements → Snippets: Create a new snippet with the following data
-
-1. Snippet name: `ddIf`.
-2. Description: `<b>2.2</b> This snippet compares different values and returns required chunk or string.`.
-3. Category: `Core`.
-4. Parse DocBlock: `no`.
-5. Snippet code (php): Insert content of the `ddIf_snippet.php` file from the archive.
-
-
-##### 2. Elements → Manage Files
-
-1. Create a new folder `assets/snippets/ddIf/`.
-2. Extract the archive to the folder (except `ddIf_snippet.php`).
-
-
-#### Using [(MODX)EvolutionCMS.libraries.ddInstaller](https://github.com/DivanDesign/EvolutionCMS.libraries.ddInstaller)
+### Using [(MODX)EvolutionCMS.libraries.ddInstaller](https://github.com/DivanDesign/EvolutionCMS.libraries.ddInstaller)
 
 Just run the following PHP code in your sources or [Console](https://github.com/vanchelo/MODX-Evolution-Ajax-Console):
 
@@ -56,7 +35,25 @@ require_once(
 * If `ddIf` is already exist on your site, `ddInstaller` will check it version and update it if needed.
 
 
-### Parameters description
+### Manually
+
+
+#### 1. Elements → Snippets: Create a new snippet with the following data
+
+1. Snippet name: `ddIf`.
+2. Description: `<b>2.3</b> This snippet compares different values and returns required chunk or string.`.
+3. Category: `Core`.
+4. Parse DocBlock: `no`.
+5. Snippet code (php): Insert content of the `ddIf_snippet.php` file from the archive.
+
+
+#### 2. Elements → Manage Files
+
+1. Create a new folder `assets/snippets/ddIf/`.
+2. Extract the archive to the folder (except `ddIf_snippet.php`).
+
+
+## Parameters description
 
 * `operand1`
 	* Desctription: The first operand for comparing.  
@@ -83,6 +80,7 @@ require_once(
 		* `'inArray'`
 		* `'isNumeric'`
 		* `'isWhitespace'` — checks if `operand1` is just white space (an empty string is also considered as white space)
+		* `'isIncludes'` — case-sensitive check if `operand1` contains `operand2`
 	* Default value: `'=='`
 
 * `trueChunk`
@@ -119,7 +117,7 @@ require_once(
 	* Valid values:
 		* `stringJsonObject` — as [JSON](https://en.wikipedia.org/wiki/JSON)
 		* `stringHjsonObject` — as [HJSON](https://hjson.github.io/)
-		* `stringQueryFormated` — as [Query string](https://en.wikipedia.org/wiki/Query_string)
+		* `stringQueryFormatted` — as [Query string](https://en.wikipedia.org/wiki/Query_string)
 		* It can also be set as a native PHP object or array (e. g. for calls through `$modx->runSnippet`):
 			* `arrayAssociative`
 			* `object`
@@ -132,10 +130,10 @@ require_once(
 	* Default value: —
 
 
-### Examples
+## Examples
 
 
-#### String comparison
+### String comparison
 
 ```
 [[ddIf?
@@ -154,7 +152,7 @@ The strings are not equal.
 ```
 
 
-#### Checks if a value exists in an array
+### Checks if a value exists in an array
 
 ```
 [[ddIf?
@@ -173,7 +171,26 @@ Exists.
 ```
 
 
-#### Checks if a `operand1` value is number or not
+### Check if `operand1` contains `operand2`
+
+```
+[[ddIf?
+	&operand1=`The quick brown fox jumps over the lazy dog.`
+	&operator=`isIncludes`
+	&operand2=`fox`
+	&trueChunk=`@CODE:“fox” is found`
+	&falseChunk=`@CODE:“fox” is not found`
+]]
+```
+
+Returns:
+
+```
+“fox” is found
+```
+
+
+### Checks if a `operand1` value is number or not
 
 ```
 [[ddIf?
@@ -191,7 +208,7 @@ Number.
 ```
 
 
-#### Checks if a `operand1` value is just white space or not
+### Checks if a `operand1` value is just white space or not
 
 Any number of spaces / tabs / new lines / etc are considered as white space.
 An empty string is also considered as white space.
@@ -233,7 +250,7 @@ All you need is love.
 ```
 
 
-#### Number comparison and pass additional data to chunks
+### Number comparison and pass additional data to chunks
 
 ```
 [[ddIf?
@@ -279,7 +296,7 @@ Let `[*general_price*]` be equal to `120`, then the snippet returns:
 ```
 
 
-#### Run the snippet through `\DDTools\Snippet::runSnippet` without DB and eval
+### Run the snippet through `\DDTools\Snippet::runSnippet` without DB and eval
 
 ```php
 //Include (MODX)EvolutionCMS.libraries.ddTools
@@ -302,9 +319,10 @@ require_once(
 
 ## Links
 
-* [Home page](https://code.divandesign.biz/modx/ddif)
+* [Home page](https://code.divandesign.ru/modx/ddif)
 * [Telegram chat](https://t.me/dd_code)
 * [Packagist](https://packagist.org/packages/dd/evolutioncms-snippets-ddif)
+* [GitHub](https://github.com/DivanDesign/EvolutionCMS.snippets.ddIf)
 
 
-<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />
+<link rel="stylesheet" type="text/css" href="https://raw.githack.com/DivanDesign/CSS.ddMarkdown/master/style.min.css" />
diff --git a/README_ru.md b/README_ru.md
@@ -7,34 +7,13 @@
 
 * PHP >= 5.6
 * [(MODX)EvolutionCMS](https://github.com/evolution-cms/evolution) >= 1.1
-* [(MODX)EvolutionCMS.libraries.ddTools](https://code.divandesign.biz/modx/ddtools) >= 0.49.1
+* [(MODX)EvolutionCMS.libraries.ddTools](https://code.divandesign.ru/modx/ddtools) >= 0.60
 
 
-## Документация
+## Установка
 
 
-### Установка
-
-
-#### Вручную
-
-
-##### 1. Элементы → Сниппеты: Создайте новый сниппет со следующими параметрами
-
-1. Название сниппета: `ddIf`.
-2. Описание: `<b>2.2</b> Сравнивает значения и выводит необходимый чанк или строку.`.
-3. Категория: `Core`.
-4. Анализировать DocBlock: `no`.
-5. Код сниппета (php): Вставьте содержимое файла `ddIf_snippet.php` из архива.
-
-
-##### 2. Элементы → Управление файлами
-
-1. Создайте новую папку `assets/snippets/ddIf/`.
-2. Извлеките содержимое архива в неё (кроме файла `ddIf_snippet.php`).
-
-
-#### Используя [(MODX)EvolutionCMS.libraries.ddInstaller](https://github.com/DivanDesign/EvolutionCMS.libraries.ddInstaller)
+### Используя [(MODX)EvolutionCMS.libraries.ddInstaller](https://github.com/DivanDesign/EvolutionCMS.libraries.ddInstaller)
 
 Просто вызовите следующий код в своих исходинках или модуле [Console](https://github.com/vanchelo/MODX-Evolution-Ajax-Console):
 
@@ -56,7 +35,25 @@ require_once(
 * Если `ddIf` уже есть на вашем сайте, `ddInstaller` проверит его версию и обновит, если нужно. 
 
 
-### Описание параметров
+### Вручную
+
+
+#### 1. Элементы → Сниппеты: Создайте новый сниппет со следующими параметрами
+
+1. Название сниппета: `ddIf`.
+2. Описание: `<b>2.3</b> Сравнивает значения и выводит необходимый чанк или строку.`.
+3. Категория: `Core`.
+4. Анализировать DocBlock: `no`.
+5. Код сниппета (php): Вставьте содержимое файла `ddIf_snippet.php` из архива.
+
+
+#### 2. Элементы → Управление файлами
+
+1. Создайте новую папку `assets/snippets/ddIf/`.
+2. Извлеките содержимое архива в неё (кроме файла `ddIf_snippet.php`).
+
+
+## Описание параметров
 
 * `operand1`
 	* Описание: Первое значение для сравнения.  
@@ -83,6 +80,7 @@ require_once(
 		* `'inArray'`
 		* `'isNumeric'`
 		* `'isWhitespace'` — проверяет, что строка `operand1` содержит только пробельные символы (пустая строка также считается пробельным символом)
+		* `'isIncludes'` — проверяет, содержит ли `operand1` в себе `operand2` (с учётом регистра)
 	* Значение по умолчанию: `'=='`
 
 * `trueChunk`
@@ -119,7 +117,7 @@ require_once(
 	* Допустимые значения:
 		* `stringJsonObject` — в виде [JSON](https://ru.wikipedia.org/wiki/JSON)
 		* `stringHjsonObject` — в виде [HJSON](https://hjson.github.io/)
-		* `stringQueryFormated` — в виде [Query string](https://en.wikipedia.org/wiki/Query_string)
+		* `stringQueryFormatted` — в виде [Query string](https://en.wikipedia.org/wiki/Query_string)
 		* Также может быть задан, как нативный PHP объект или массив (например, для вызовов через `$modx->runSnippet`).
 			* `arrayAssociative`
 			* `object`
@@ -132,10 +130,10 @@ require_once(
 	* Значение по умолчанию: —
 
 
-### Примеры
+## Примеры
 
 
-#### Сравнение двух строк
+### Сравнение двух строк
 
 ```
 [[ddIf?
@@ -154,7 +152,7 @@ require_once(
 ```
 
 
-#### Присутствует ли значение в массиве
+### Присутствует ли значение в массиве
 
 ```
 [[ddIf?
@@ -173,7 +171,26 @@ require_once(
 ```
 
 
-#### Является ли `operand1` числом
+### Содержит ли `operand1` в себе `operand2`
+
+```
+[[ddIf?
+	&operand1=`Быстрая коричневая лиса перепрыгнула через ленивую собаку.`
+	&operator=`isIncludes`
+	&operand2=`лиса`
+	&trueChunk=`@CODE:«лиса» найдена`
+	&falseChunk=`@CODE:«лиса» не найдена`
+]]
+```
+
+Вернёт:
+
+```
+«лиса» найдена
+```
+
+
+### Является ли `operand1` числом
 
 ```
 [[ddIf?
@@ -191,7 +208,7 @@ require_once(
 ```
 
 
-#### Содержит ли `operand1` что-то, кроме пробельных символов
+### Содержит ли `operand1` что-то, кроме пробельных символов
 
 Любое количество пробелов / табуляторов / новых строк / etc трактуются пробельными.
 Пустая строка также считается пробельным символом.
@@ -233,7 +250,7 @@ All you need is love.
 ```
 
 
-#### Сравнение двух чисел и передача дополнительных данных в чанки
+### Сравнение двух чисел и передача дополнительных данных в чанки
 
 ```
 [[ddIf?
@@ -279,7 +296,7 @@ All you need is love.
 ```
 
 
-#### Запустить сниппет через `\DDTools\Snippet::runSnippet` без DB и eval
+### Запустить сниппет через `\DDTools\Snippet::runSnippet` без DB и eval
 
 ```php
 //Подключение (MODX)EvolutionCMS.libraries.ddTools
@@ -305,6 +322,7 @@ require_once(
 * [Home page](https://code.divandesign.ru/modx/ddif)
 * [Telegram chat](https://t.me/dd_code)
 * [Packagist](https://packagist.org/packages/dd/evolutioncms-snippets-ddif)
+* [GitHub](https://github.com/DivanDesign/EvolutionCMS.snippets.ddIf)
 
 
-<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />
+<link rel="stylesheet" type="text/css" href="https://raw.githack.com/DivanDesign/CSS.ddMarkdown/master/style.min.css" />