Skip to content

Commit

Permalink
+ You can just call \DDTools\Snippet::runSnippet to run the snippet…
Browse files Browse the repository at this point in the history 
… without DB and eval.

+ `\ddDomainComparator\Snippet`: The new class. All snippet code was moved here.
  • Loading branch information
@Ronef
Ronef committed Mar 29, 2021
1 parent ccf3d56 commit 2e3bc45
Show file tree
Hide file tree
Showing 5 changed files with 395 additions and 303 deletions.
27 changes: 27 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,33 @@ The snippet doesn’t use third-party services, also it sends no requests. In ot
```


#### Run the snippet through `\DDTools\Snippet::runSnippet` without DB and eval

```php
\DDTools\Snippet::runSnippet([
'name' => 'ddTypograph',
'params' => [
'text' => "
There's nothing you can do that can't be done
Nothing you can sing that can't be sung

https://en.wikipedia.org/wiki/The_Beatles
",
'text_paragraphs' => true,
'text_autoLinks' => true
]
]);
```

Returns:

```
<p>There’s nothing you can do&nbsp;that can’t be&nbsp;done<br>
Nothing you can sing that can’t be&nbsp;sung</p>
<p><a href="https://en.wikipedia.org/wiki/The_Beatles">en.wikipedia.org/wiki/The_Beatles</a></p>
```


## Links

* [Home page](https://code.divandesign.biz/modx/ddtypograph)
Expand Down
27 changes: 27 additions & 0 deletions README_ru.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,33 @@
```


#### Запустить сниппет без DB и eval через `\DDTools\Snippet::runSnippet`

```php
\DDTools\Snippet::runSnippet([
'name' => 'ddTypograph',
'params' => [
'text' => "
There's nothing you can do that can't be done
Nothing you can sing that can't be sung

https://ru.wikipedia.org/wiki/The_Beatles
",
'text_paragraphs' => true,
'text_autoLinks' => true
]
]);
```

Вернёт:

```
<p>There’s nothing you can do&nbsp;that can’t be&nbsp;done<br>
Nothing you can sing that can’t be&nbsp;sung</p>
<p><a href="https://en.wikipedia.org/wiki/The_Beatles">en.wikipedia.org/wiki/The_Beatles</a></p>
```


## Ссылки

* [Home page](https://code.divandesign.ru/modx/ddtypograph)
Expand Down
307 changes: 4 additions & 303 deletions ddTypograph_snippet.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,309 +14,10 @@
require_once(
$modx->getConfig('base_path') .
'assets/libs/ddTools/modx.ddtools.class.php'
);

//Include PHP.libraries.EMT
require_once(
$modx->getConfig('base_path') .
'assets/snippets/ddTypograph/EMT.php'
);


//Renaming params with backward compatibility
$params = \ddTools::verifyRenamedParams([
'params' => $params,
'compliance' => [
'optAlign' => 'OptAlign',
'text_paragraphs' => 'Text_paragraphs',
'text_autoLinks' => 'Text_autoLinks',
'etc_unicodeConvert' => 'Etc_unicodeConvert'
],
'returnCorrectedOnly' => false
]);

//Defaults
$params = \DDTools\ObjectTools::extend([
'objects' => [
(object) [
//Required
'text' => '',
'optAlign' => false,
'text_paragraphs' => false,
'text_autoLinks' => false,
'etc_unicodeConvert' => true,
'noTags' => false,
'excludeTags' => 'notg,code'
],
$params
]
]);

$params->excludeTags = explode(
',',
strtolower($params->excludeTags)
);


$snippetResult = $params->text;


//Если есть что типографировать
if (strlen($snippetResult) > 4){
global $ddTypograph;

//Заменим кавычки, вставленные через спец. символы на обычные (а то не обрабатываются в библиотеке)
$snippetResult = str_replace(
'&#34;',
'"',
$snippetResult
);

if (!isset($ddTypograph)){
$ddTypograph = new EMTypograph();
}

//Safe tags
foreach (
$params->excludeTags as
$excludeTags_item
){
$excludeTags_item = trim($excludeTags_item);

//We don't need anything with default EMT tag
if ($excludeTags_item != 'notg'){
//Wrap <notg>
$snippetResult = str_ireplace(
[
//Tag start
'<' . $excludeTags_item,
//Tag end
'</' . $excludeTags_item . '>'
],
[
//Tag start
'<notg><' . $excludeTags_item,
//Tag end
'</' . $excludeTags_item . '></notg>'
],
$snippetResult
);
}
}

//Если нельзя добавлять теги к тексту
if ($params->noTags){
// $noTags = 'off';

$params->optAlign = 'off';
$params->text_paragraphs = 'off';
$params->text_autoLinks = 'off';

$etc_nobr_to_nbsp = 'on';
}else{
// $noTags = 'on';

$params->optAlign =
$params->optAlign ?
'on' :
'off'
;
$params->text_paragraphs =
$params->text_paragraphs ?
'on' :
'off'
;
$params->text_autoLinks =
$params->text_autoLinks ?
'on' :
'off'
;

$etc_nobr_to_nbsp = 'off';
}

$params->etc_unicodeConvert =
$params->etc_unicodeConvert ?
'on' :
'off'
;

$ddTypograph->setup([
//Расстановка «кавычек-елочек» первого уровня
'Quote.quotes' => 'on',
//Внутренние кавычки-лапки
'Quote.quotation' => 'on',

//Автоматическая простановка дефисов в обезличенных местоимениях и междометиях
'Dash.to_libo_nibud' => 'on',
//Расстановка дефисов между «из-за», «из-под»
'Dash.iz_za_pod' => 'on',
//Расстановка дефисов перед «-ка», «-де», «-кась».
'Dash.ka_de_kas' => 'on',

//Привязка союзов и предлогов к написанным после словам
'Nobr.super_nbsp' => 'on',
//Привязка союзов и предлогов к предыдущим словам в случае конца предложения
'Nobr.nbsp_in_the_end' => 'on',
//TODO: работает плоховато (в «+7 777 777 77 77» ставит неразнывные пробелы только в двух первых случаях), обсудить с Евгением
//Объединение в неразрывные конструкции номеров телефонов
// 'Nobr.phone_builder' => $noTags,
'Nobr.phone_builder' => 'on',
//Дополнительный формат номеров телефонов («+7(123)1234567» → «+7 123 123-45-67»)
// 'Nobr.phone_builder_v2' => $noTags,
'Nobr.phone_builder_v2' => 'on',
//Объединение IP-адресов.
'Nobr.ip_address' => 'off',
//Привязка инициалов к фамилиям («Иванов И. И.» → «Иванов&nbsp;И.&nbsp;И.»)
// 'Nobr.spaces_nobr_in_surname_abbr' => $noTags,
'Nobr.spaces_nobr_in_surname_abbr' => 'on',
//Расстановка точек у инициалов («Иванов И И» | «Иванов ИИ» → «Иванов И. И.»)
// 'Nobr.dots_for_surname_abbr' => $noTags,
'Nobr.dots_for_surname_abbr' => 'on',
//TODO: Не работает (по крайней мере, не удалось увидеть работу)
//Привязка градусов к числу
'Nobr.nbsp_celcius' => 'on',
//TODO: Параметр не ясен
//Обрамление пятисимвольных слов разделенных дефисом в неразрывные блоки
'Nobr.hyphen_nowrap_in_small_words' => 'off',
//Отмена переноса слова с дефисом
// 'Nobr.hyphen_nowrap' => $noTags,
'Nobr.hyphen_nowrap' => 'on',
//TODO: Тег «nobr» невалидный, а для «word-spacing» нет значения «nowrap», нужно использовать свойство «white-space».
//Использовать nowrap для неразрывных конструкций
'Nobr.nowrap' => 'on',

//Замена «(tm)» на символ торговой марки «™»
'Symbol.tm_replace' => 'on',
//Замена «(r)» на символ зарегистрированной торговой марки «®»
'Symbol.r_sign_replace' => 'on',
//Замена «(c)» на символ копирайта «©»
'Symbol.copy_replace' => 'on',
//Расстановка правильного апострофа в текстах
'Symbol.apostrophe' => 'on',
//TODO: Параметр не ясен
//Градусы по Фаренгейту
'Symbol.degree_f' => 'on',
//TODO: Не срабатывает в конце предложения
//Замена стрелок «<-» и «->» на символы «←» и «→»
'Symbol.arrows_symbols' => 'on',
//TODO: Параметр не ясен
//Расстановка дюйма после числа
'Symbol.no_inches' => 'on',

//Расстановка запятых перед «а» и «но»
'Punctmark.auto_comma' => 'on',
//Замена трех точек на знак многоточия («...» → «…»)
'Punctmark.hellip' => 'on',
//Замена сдвоенных знаков препинания на одинарные
'Punctmark.fix_pmarks' => 'on',
//Замена восклицательного и вопросительного знаков местами
'Punctmark.fix_excl_quest_marks' => 'on',
//Точка в конце текста, если её там нет
'Punctmark.dot_on_end' => 'off',

//Расстановка знака минус между числами
'Number.minus_between_nums' => 'on',
//TODO: Параметр не ясен
//Расстановка знака минус между диапозоном чисел
'Number.minus_in_numbers_range' => 'off',
//Замена «x» (и по-русски и по-английски) на символ «×» в размерных единицах
'Number.auto_times_x' => 'on',
//Замена дробей на соответствующие символы («1/2» → «½», «1/4» → «⅓», «3/4» → «¼»)
'Number.simple_fraction' => 'off',
//Математические знаки больше или равно/меньше или равно/плюс минус/неравно («>=» → «≥», «<=» → «≤», «+-» → «±», «!=» → «≠»)
'Number.math_chars' => 'on',
//Объединение триад чисел полупробелом (не разбивает на триады, просто заменяет обычный пробел на полупробел)
'Number.thinsp_between_number_triads' => 'on',
//Пробел между символом номера и числом
'Number.thinsp_between_no_and_number' => 'on',
//Пробел между символом параграфа и числом
'Number.thinsp_between_sect_and_number' => 'on',

//TODO: Параметр не ясен
//Установка тире и пробельных символов в периодах дат
'Date.years' => 'on',
//Расстановка тире и объединение в неразрывные периоды месяцев
'Date.mdash_month_interval' => 'off',
//Расстановка тире и объединение в неразрывные периоды дней
'Date.nbsp_and_dash_month_interval' => 'off',
//Привязка года к дате (« 01.01.2015г.» → « 01.01.2015&nbsp;г.»)
'Date.nobr_year_in_date' => 'on',

//Удаление лишних пробельных символов и табуляций
'Space.many_spaces_to_one' => 'on',
//Удаление пробела перед символом процента
'Space.clear_percent' => 'on',
//Удаление пробелов перед и после знаков препинания в предложении
'Space.clear_before_after_punct' => 'on',
//Расстановка пробелов после знаков препинания
'Space.autospace_after' => 'on',
//Удаление пробелов внутри скобок, а также расстановка пробела перед скобками
'Space.bracket_fix' => 'on',

//Форматирование денежных сокращений (расстановка пробелов и привязка названия валюты к числу)
'Abbr.nbsp_money_abbr' => 'on',
//Объединение сокращений «и т. д.», «и т. п.», «в т. ч.»
// 'Abbr.nobr_vtch_itd_itp' => $noTags,
'Abbr.nobr_vtch_itd_itp' => 'on',
//Расстановка пробелов перед сокращениями «см.», «им.»
'Abbr.nobr_sm_im' => 'on',
//Расстановка пробелов перед сокращениями «гл.», «стр.», «рис.», «илл.», «ст.», «п.»
'Abbr.nobr_acronym' => 'on',
//Расстановка пробелов в сокращениях «г.», «ул.», «пер.», «д.»
'Abbr.nobr_locations' => 'on',
//Расстановка пробелов перед сокращениями «dpi», «lpi»
'Abbr.nobr_abbreviation' => 'on',
//Объединение сокращений «P.S.», «P.P.S.»
// 'Abbr.ps_pps' => $noTags,
'Abbr.ps_pps' => 'on',
//Привязка сокращений форм собственности к названиям организаций
'Abbr.nbsp_org_abbr' => 'on',
//Привязка аббревиатуры «ГОСТ» к номеру
// 'Abbr.nobr_gost' => $noTags,
'Abbr.nobr_gost' => 'on',
//Установка пробельных символов в сокращении вольт
'Abbr.nobr_before_unit_volt' => 'on',
//Замена символов и привязка сокращений в размерных величинах («м», «см», «м2», …)
'Abbr.nbsp_before_unit' => 'on',

//TODO: Разобраться, что это за параметр и какие значения он может принимать
//Все настройки оптического выравнивания
// 'OptAlign.all' => 'off',
//Оптическое выравнивание открывающей кавычки
'OptAlign.oa_oquote' => $params->optAlign,
//Оптическое выравнивание для пунктуации (скобка и запятая)
'OptAlign.oa_obracket_coma' => $params->optAlign,
//TODO: Параметр не ясен
//Оптическое выравнивание кавычки
'OptAlign.oa_oquote_extra' => $params->optAlign,
//Inline стили или CSS-классы
'OptAlign.layout' => 'style',

//Простановка параграфов
'Text.paragraphs' => $params->text_paragraphs,
//Выделение ссылок из текста
'Text.auto_links' => $params->text_autoLinks,
//Выделение электронной почты из текста
'Text.email' => $params->text_autoLinks,
//Простановка переносов строк
'Text.breakline' => $params->text_paragraphs,
//Удаление повторяющихся слов
'Text.no_repeat_words' => 'off',

//Преобразовывать html-сущности в юникод
'Etc.unicode_convert' => $params->etc_unicodeConvert,
//Использовать символ «&nbsp;» вместо тегов для связывания
'Etc.nobr_to_nbsp' => $etc_nobr_to_nbsp,
//Разбиение числа на триады («10000» → «10&thinsp;000»)
'Etc.split_number_to_triads' => 'on'
]);

$ddTypograph->set_text($snippetResult);

//Типографируем
$snippetResult = $ddTypograph->apply();
}

return $snippetResult;
return \DDTools\Snippet::runSnippet([
'name' => 'ddTypograph',
'params' => $params
]);
?>
15 changes: 15 additions & 0 deletions require.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php
//Include (MODX)EvolutionCMS.libraries.ddTools
require_once(
//path to `assets`
dirname(
__DIR__,
2
).
'/libs/ddTools/modx.ddtools.class.php'
);

require_once('EMT.php');

require_once('src/Snippet.php');
?>
Loading

0 comments on commit 2e3bc45

Please sign in to comment.