From 2fca902af489dd9f720824f3b7a21a6fe1727d10 Mon Sep 17 00:00:00 2001 From: iassasin Date: Wed, 9 Aug 2017 11:39:09 +0300 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B0=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82?= =?UTF-8?q?=D0=B0=D1=86=D0=B8=D1=8F=20=D0=BA=20=D0=BD=D0=B0=D1=81=D1=82?= =?UTF-8?q?=D1=80=D0=BE=D0=B9=D0=BA=D0=B0=D0=BC=20(#22)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api.md | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/docs/api.md b/docs/api.md index 24dca75..df59910 100644 --- a/docs/api.md +++ b/docs/api.md @@ -5,15 +5,34 @@ --- ```php -public static function Template::init($tplpath, $cache_enabled = true) +public static function Template::init($tplpath, TemplateOptions $options = null) ``` - Инициализирует шаблонизатор, задает каталог, хранящий шаблоны (файлы .html) + Инициализирует phplate, задает каталог, хранящий шаблоны (файлы .html) - **`string $tplpath`** - путь к каталогу, содержащему шаблоны сайта -- **`boolean $cache_enabled`** - определяет, включено ли кэширование результатов компиляции шаблонов (в файлы .ctpl) +- **`TemplateOptions $options`** - определяет настройки phplate - **Возвращаемое значение**: нет +`TemplateOptions` содержит следующие методы: +- `getDateFormat()` и `setDateFormat(string $format)` + - Управление форматом по-умолчанию для пайп-функции `date` + - Значение по-умолчанию: `Y-m-d H:i:s` +- `getCacheEnabled()` и `setCacheEnabled(boolean $value)` + - Управление кэшированием результата компиляции шаблона (в файлы .ctpl) + - Значение по-умолчанию: `true` +- `getAutoSafeEnabled()` и `setAutoSafeEnabled(boolean $value)` + - Управление автоматическим применением пайп-функции `safe` для всего вывода в [блоке аргументов](syntax.md) + - Значение по-умолчанию: `true` + +Пример настройки: +```php +Template::init($_SERVER['DOCUMENT_ROOT'].'/templates/', (new TemplateOptions) + ->setCacheEnabled(true) + ->setAutoSafeEnabled(true) +); +``` + --- ```php @@ -23,9 +42,10 @@ public static function Template::addUserFunctionHandler($f) Назначает пользовательский обработчик пайп-функций - **`function $f`** - функция вида **`function ($val, $fargs)`** - - **`mixed $val`** - исходное значение - - **`array $fargs`** - массив переданных пайп-функции аргументов - - **Возвращаемое значение**: новое значение `$val` + - **`mixed $val`** - исходное значение + - **`array $fargs`** - массив переданных пайп-функции аргументов + - **Возвращаемое значение**: новое значение `$val` +- **Возвращаемое значение**: нет --- @@ -61,4 +81,4 @@ public static function Template::build_str($tplstr, $values) - **`string $tplstr`** - код шаблона, в который подставляются аргументы, аналогично содержимому файлов шаблонов - **`array $values`** - аргументы шаблона, могут быть чем угодно -- **Возвращаемое значение**: **`string`**, шаблон с подставленными аргументами \ No newline at end of file +- **Возвращаемое значение**: **`string`**, шаблон с подставленными аргументами