diff --git a/docs/ru/programmers/api-functions/api-append-by-ref.xml b/docs/ru/programmers/api-functions/api-append-by-ref.xml index 1b5ebb74..0555d5b6 100644 --- a/docs/ru/programmers/api-functions/api-append-by-ref.xml +++ b/docs/ru/programmers/api-functions/api-append-by-ref.xml @@ -1,22 +1,20 @@ - - - append_by_ref - - - void append_by_ref - string varname - mixed var - - - void append_by_ref - string varname - mixed var - boolean merge - - - + + + + append_by_ref + + + + + <methodsynopsis> + <type>void</type><methodname>append_by_ref</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>merge</parameter></methodparam> + </methodsynopsis> + <para> Эта функция используется для добавления значений к шаблону по ссылке. Если вы добавляете переменную по ссылке то, соответсвенно, можете изменять значение переменной, на которую она ссылается. Для объектов, @@ -25,26 +23,21 @@ пояснения. Если вы устанавливаете необязательный третий параметр в true, то значение не добавляется, а сливается с текущим массивом. </para> - <note> - <title>Техническое замечание - - Параметр слияния связан с ключами массива, поэтому, если вы объеденяете - два не ассоциативных массива, они могут переписать некоторые значения друг друга или - выдать массив с непоследовательными ключами. В этом заключается некоторое отличие - от функции array_merge() в PHP, которая удаляет нумерацию ключей и перенумеровывает их. - - - - append_by_ref - + ¬e.parameter.merge; + + append_by_ref + append_by_ref("Name",$myname); -$smarty->append_by_ref("Address",$address); +$smarty->append_by_ref("Address",$address); +?> ]]> - - - + + + + - - - append - - - void append - mixed var - - - void append - string varname - mixed var - - - void append - string varname - mixed var - boolean merge - - - - Функция используется для добавления элемента в назначенный (assigned) массив. - Если вы добавляете к строковому значению, оно конвертируется в значение - массива, и, затем добавляется. Вы можете передавать пары имя/значение - явно, или в виде ассоциативного массива, состоящего из пар имя/значение. + + + + append + + + + + <methodsynopsis> + <type>void</type><methodname>append</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>void</type><methodname>append</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>merge</parameter></methodparam> + </methodsynopsis> + <para> + Функция используется для добавления элемента в назначенный (assigned) массив. + Если вы добавляете к строковому значению, оно конвертируется в значение + массива, и, затем добавляется. Вы можете передавать пары имя/значение + явно, или в виде ассоциативного массива, состоящего из пар имя/значение. Если вы устанавливаете необязательный третий параметр в true, то значение будет не добавлено, а слито с текущим массивом. - </para> - <note> - <title>Техническое замечание - - Параметр слияния связан с ключами массива, поэтому, если вы - объеденяете два не ассоциативных массива, они могут переписать - некоторые значения друг друга или выдать массив с непоследовательными - ключами. В этом заключается некоторое отличие от функции array_merge() - в PHP, которая удаляет нумерацию ключей и перенумеровывает их. - - - append - + ¬e.parameter.merge; + + append + append("Name","Fred"); $smarty->append("Address",$address); + // передача ассоциативного массива -$smarty->append(array("city" => "Lincoln","state" => "Nebraska")); +$smarty->append(array("city" => "Lincoln","state" => "Nebraska")); +?> ]]> - - - + + + + - - - assign_by_ref - - - void assign_by_ref - string varname - mixed var - - - + + + + assign_by_ref + + + + + <methodsynopsis> + <type>void</type><methodname>assign_by_ref</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> Эта функция используется для передачи значения переменной - в шаблон по ссылке, вместо создания ее копии. Смотрите - руководство PHP на предмет ссылок на переменные для + в шаблон по ссылке, вместо создания ее копии. Смотрите + руководство PHP на предмет ссылок на переменные для более глубокого пояснения. </para> <note> <title>Техническое замечание Функция используется для передачи значения в шаблон по ссылке. - Если вы назначаете переменную по ссылке, то имеете возможность - менять значение переменной, на которую она ссылается. + Если вы назначаете переменную по ссылке, то имеете возможность + менять значение переменной, на которую она ссылается. Что касается объектов, то assign_by_ref() помогает избежать копирования переданных в шаблон объектов в памяти. Смотрите руководство PHP на предмет ссылок на переменные. @@ -29,15 +32,18 @@ assign_by_ref - + assign_by_ref("Name",$myname); -$smarty->assign_by_ref("Address",$address); -]]> - - - +$smarty->assign_by_ref('Name', $myname); +$smarty->assign_by_ref('Address', $address); +?> +]]> + + + + - - - assign - - - void assign - mixed var - - - void assign - string varname - mixed var - - - + + + + assign + + + + + <methodsynopsis> + <type>void</type><methodname>assign</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>void</type><methodname>assign</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> Функция используется для присвоения значений в шаблонах. Вы можете явно передавать пары имя/значение, или ассоциативные массивы, содержащие пары имя/значение. </para> <example> <title>assign - + assign("Name","Fred"); -$smarty->assign("Address",$address); +$smarty->assign('Name', 'Fred'); +$smarty->assign('Address', $address); // передача ассоциативного массива -$smarty->assign(array("city" => "Lincoln","state" => "Nebraska")); -]]> - - - +$smarty->assign(array("city" => "Lincoln", "state" => "Nebraska")); +?> +]]> + + + + - - - clear_all_assign - - - void clear_all_assign - - - - + + + + clear_all_assign + + + + + <methodsynopsis> + <type>void</type><methodname>clear_all_assign</methodname> + <void /> + </methodsynopsis> + <para> Очищает все ранее присвоенные значения переменных. </para> <example> <title>clear_all_assign - + clear_all_assign(); +clear_all_assign(); +?> ]]> - - - + + + + - - - clear_all_cache - - - void clear_all_cache - int expire time - - - - Очищает кэш шаблона целиком. В качестве необязательного - параметра, вы можете указать минимальное время в секундах, - которое должно пройти перед тем, как кэш будет очищен. + + + + clear_all_cache + + + + + <methodsynopsis> + <type>void</type><methodname>clear_all_cache</methodname> + <methodparam choice="opt"><type>int</type><parameter>expire_time</parameter></methodparam> + </methodsynopsis> + <para> + Полностью очищает кэш шаблонов. В качестве необязательного + параметра, вы можете указать минимальный возраст файлов кэша в секундах, + по достижению которого они будут очищены. </para> <example> <title>clear_all_cache - + clear_all_cache(); -]]> - - - +$smarty->clear_all_cache(); +?> +]]> + + + + - - - clear_assign - - - void clear_assign - string var - - - + + + + clear_assign + + + + + <methodsynopsis> + <type>void</type><methodname>clear_assign</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> Очищает присвоенное ранее значение переменной. Это может быть как обычная переменная, так и массив некоторых значений. </para> <example> <title>clear_assign - + clear_assign("Name"); // очистить значения несколько переменных -$smarty->clear_assign(array("Name","Address","Zip")); -]]> - - - +$smarty->clear_assign(array("Name", "Address", "Zip")); +?> +]]> + + + + - - - clear_cache - - voidclear_cache - stringtemplate - stringcache id - stringcompile id - intexpire time - - + + + + clear_cache + + + + + <methodsynopsis> + <type>void</type><methodname>clear_cache</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>expire_time</parameter></methodparam> + </methodsynopsis> + <para> Очищает кэш указанного шаблона. Если у вас есть - несколько кэшированных копий шаблона, вы можете - очистить конкретную копию, указав cache id в - качестве второго параметра. Вы так же можете передать - compile id в качестве третьего параметра или - "сгруппировать" шаблоны вместе и удалить группу. + несколько кэшированных копий шаблона, вы можете + очистить конкретную копию, указав <parameter>cache_id</parameter> в + качестве второго параметра. Вы так же можете передать + compile id в качестве третьего параметра или + "сгруппировать" шаблоны вместе и удалить группу. Для получения дополнительной информации, смотрите <link linkend="caching">раздел "Кэширование"</link>. - В качестве необязательного четвертого параметра вы - можете указать минимальное время в секундах, в + В качестве необязательного четвертого параметра вы + можете указать минимальное время в секундах, в течение которого кэш будет существовать перед очисткой. </para> <example> <title>clear_cache - + clear_cache("index.tpl"); -// очистить кэшированную копию с конкретным cache id +// очистить кэшированную копию с конкретным cache id // при множественном кэшировании шаблона -$smarty->clear_cache("index.tpl","CACHEID"); -]]> - - - +$smarty->clear_cache("index.tpl", "CACHEID"); +?> +]]> + + + + - - - clear_compiled_tpl - - - void clear_compiled_tpl - string tpl_file - - - - Очищает указанную откомпилированную версию шаблона, + + + + clear_compiled_tpl + + + + + <methodsynopsis> + <type>void</type><methodname>clear_compiled_tpl</methodname> + <methodparam choice="opt"><type>string</type><parameter>tpl_file</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>exp_time</parameter></methodparam> + </methodsynopsis> + <para> + Очищает указанную откомпилированную версию шаблона, или все откомпилированные файлы шаблона если ничего не указано. - Эта функция только для опытных пользователей и обычно в ее + Если вы передадите аргумент compile_id, только откомпилированные версии + шаблонов с этим compile_id будут очищены. Если вы передадите аргумент exp_time, только + откомпилированные версии шаблонов старше exp_time секунд будут очищены. + По умолчанию очищаются все откомпилированные версии шаблонов независимо от их возраста. + Эта функция только для опытных пользователей и обычно в ее использовании необходимости нет. </para> <example> <title>clear_compiled_tpl - + clear_compiled_tpl("index.tpl"); // очистить всю директорию с откомпилированными шаблонами -$smarty->clear_compiled_tpl(); -]]> - - - +$smarty->clear_compiled_tpl(); +?> +]]> + + + + - - - clear_config - - voidclear_config - stringvar - - - Функция очищает все назначенные конфигурационные + + + + clear_config + + + + + <methodsynopsis> + <type>void</type><methodname>clear_config</methodname> + <methodparam choice="opt"><type>string</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> + Функция очищает все назначенные конфигурационные переменные. Если передано имя переменной, значит очищается только она. </para> <example> <title>clear_config - + clear_config(); // очищаем только одну переменную -$smarty->clear_config('foobar'); -]]> - - - +$smarty->clear_config('foobar'); +?> +]]> + + + + - - - config_load - - voidconfig_load - stringfile - stringsection - - - Функция загружает данные из файла конфигурации - (config file) и помещает их в шаблон. Это - аналог функции шаблона - config_load. - - - Техническое замечание + + + + config_load + + + + + <methodsynopsis> + <type>void</type><methodname>config_load</methodname> + <methodparam><type>string</type><parameter>file</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>section</parameter></methodparam> + </methodsynopsis> <para> - Как в Smarty 2.4.0, переменные шаблона подставляются при - вызове fetch() или display(). Кофигурационные переменные, - загружаемые при вызове config_load() всегда глобальны. - Для повышения скорости работы, конфигурационные файлы тоже - компилируются и к ним применительны <link - linkend="variable.force.compile">force_compile</link> и <link - linkend="variable.compile.check">compile_check</link> настройки. + Функция загружает данные из файла конфигурации + (config file) и помещает их в шаблон. Это + аналог функции шаблона + <link linkend="language.function.config.load">config_load</link>. </para> - </note> - <example> - <title>config_load - + + Техническое замечание + + Начиная с версии Smarty 2.4.0, переменные шаблона подставляются при + вызове fetch() или display(). Кофигурационные переменные, + загружаемые при вызове config_load() всегда глобальны. + Для повышения скорости работы, конфигурационные файлы тоже + компилируются и к ним применительны настройки force_compile и compile_check. + + + + config_load + config_load('my.conf'); // загрузка секции конфигурационного файла -$smarty->config_load('my.conf','foobar'); -]]> - - - +$smarty->config_load('my.conf','foobar'); +?> +]]> + + + + - - - display - - voiddisplay - stringtemplate - stringcache_id - stringcompile_id - - - Функция отоброжает шаблон. Укажите верный типtemplate resource - и путь. В качестве необязательного второго параметра, + + + + display + + + + + <methodsynopsis> + <type>void</type><methodname>display</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + </methodsynopsis> + <para> + Функция отоброжает шаблон. Укажите верный тип <link + linkend="template.resources">ресурса шаблонов</link> + и путь. В качестве необязательного второго параметра, вы можете передать cache id. Смотрите <link linkend="caching">раздел "Кэширование"</link> для дополнительной информации. </para> - <para> - В качестве необязательного третьего параметра, можно - передать compile id. Это необходимо в том случае, если - вы хотите скомпилировать разные версии одного и того - же шаблона, например для того, чтобы иметь различные - откомпилированные версии шаблона для различных языков. - Также, compile_id может быть полезен в том случае, если - более чем один $template_dir но только один $compile_dir. - В таком случае, установите различные compile_id для каждого - $template_dir, иначе, шаблоны, имеющие одинаковые номера - перезапишут друг друга. Также, вы можете установить переменную - <link linkend="variable.compile.id">$compile_id</link> однажды, - вместо того, чтобы передавать ее при каждом вызове display(). - </para> + ¶meter.compileid; <example> <title>display - + caching = true; @@ -56,20 +49,22 @@ if(!$smarty->is_cached("index.tpl")) } -// отображаем вывод -$smarty->display("index.tpl"); -]]> +// отображаем результат +$smarty->display("index.tpl"); +?> +]]> Используйте синтаксис template resources для - отображения файлов, находящихся вне $template_dir директории. + linkend="template.resources">ресурсов шаблонов для + отображения файлов, находящихся вне директории $template_dir. Примеры отображения шаблонов из различных ресурсов - + display("/usr/local/include/templates/header.tpl"); @@ -80,11 +75,13 @@ $smarty->display("file:/usr/local/include/templates/header.tpl"); $smarty->display("file:C:/www/pub/templates/header.tpl"); // вставка из ресурса под названием "db" -$smarty->display("db:header.tpl"); -]]> - - - +$smarty->display("db:header.tpl"); +?> +]]> + + + + - - - fetch - - stringfetch - stringtemplate - stringcache_id - stringcompile_id - + + + + fetch + + + + + <methodsynopsis> + <type>string</type><methodname>fetch</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + </methodsynopsis> <para> Функция возвращает вывод шаблона вместо его отображения на экран. Укажите верный тип <link - linkend="template.resources">template resource</link> + linkend="template.resources">ресурса шаблонов</link> и путь. В качестве необязательного второго параметра можно передать cache id. Смотрите <link linkend="caching">раздел - "Кэширование"</link> для получения дополнительной информации. - </para> - <para> - В качестве необязательного третьего параметра, можно - передать compile id. Это необходимо в том случае, если - вы хотите скомпилировать разные версии одного и того же - шаблона, например для того, чтобы иметь различные - откомпилированные версии шаблона для различных языков. - Также, compile_id может быть полезен в том случае, если - более чем один $template_dir но только один $compile_dir. - В таком случае, установите различные compile_id для каждого - $template_dir, иначе, шаблоны, имеющие одинаковые номера - перезапишут друг друга. Также, вы можете установить переменную - <link linkend="variable.compile.id">$compile_id</link> однажды, - вместо того, чтобы передавать ее при каждом вызове fetch(). + "Кэширование";</link> для получения дополнительной информации. </para> + ¶meter.compileid; + <para> <example> <title>fetch - + is_cached("index.tpl")) // перехватываем вывод $output = $smarty->fetch("index.tpl"); -// здесь выполняем какие либо действия с $output +// здесь выполняем какие-либо действия с $output -echo $output; -]]> - - - +echo $output; +?> +]]> + + + + + - - - get_config_vars - - arrayget_config_vars - stringvarname - - - Возвращает значение переданной конфигурационной переменной. Если ни одного - параметра не передавалось, то будет возвращен массив всех конфигурационных переменных. - - - get_config_vars - + + + + get_config_vars + + + + + <methodsynopsis> + <type>array</type><methodname>get_config_vars</methodname> + <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <para> + Возвращает значение переданной конфигурационной переменной. Если аргумент не передан, + то будет возвращен массив всех конфигурационных переменных. + </para> + <example> + <title>get_config_vars + get_config_vars('foo'); // получаем все загруженные конфигурационные переменные шаблона $config_vars = $smarty->get_config_vars(); -// смотрим что у нас получилось -print_r($config_vars); -]]> - - - +// смотрим, что у нас получилось +print_r($config_vars); +?> +]]> + + + + - - - get_registered_object - - - array get_registered_object - string object_name - - - + + + + get_registered_object + + + + + <methodsynopsis> + <type>array</type><methodname>get_registered_object</methodname> + <methodparam><type>string</type><parameter>object_name</parameter></methodparam> + </methodsynopsis> + <para> Возвращает ссылку на зарегестрированный объект. Может быть полезно в случае необходимости получения прямого доступа к - зарегестрированному объекту. - </para> - <example> - <title>get_registered_object - + зарегестрированному объекту из пользовательской функции. + + + get_registered_object + &get_registered_object($params['object']); // теперь используем $obj_ref как ссылку на объект } -} -]]> - - - +} +?> +]]> + + + + - - - get_template_vars - - arrayget_template_vars - stringvarname - - - Возвращает значение переменной. Если параметров нет, - то возвращается массив со всеми назначенными переменными. - - - get_template_vars - + + + + get_template_vars + + + + + <methodsynopsis> + <type>array</type><methodname>get_template_vars</methodname> + <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <para> + Возвращает значение переменной. Если аргумент не передан, + будет возвращен массив всех назначенными переменными. + </para> + <example> + <title>get_template_vars + get_template_vars('foo'); // получаем все назначенные переменные шаблона $tpl_vars = $smarty->get_template_vars(); -// поглядим что из этого вышло -print_r($tpl_vars); -]]> - - - +// поглядим, что из этого вышло +print_r($tpl_vars); +?> +]]> + + + + - - - is_cached - - - void is_cached - string template - [string cache_id] - - - + + + + is_cached + + + + + <methodsynopsis> + <type>bool</type><methodname>is_cached</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + </methodsynopsis> + <para> Возвращает true если существует кэш для указанного шаблона. - Работает только в том случае, если значение<link + Работает только в том случае, если значение <link linkend="variable.caching">caching</link> установлено в true. </para> <example> <title>is_cached - + caching = true; if(!$smarty->is_cached("index.tpl")) { // обращаемся к БД, назначаем переменные } -$smarty->display("index.tpl"); +$smarty->display("index.tpl"); +?> ]]> - Так же вы можете передавать cache id в качестве необязательного второго + Также вы можете передавать cache id в качестве необязательного второго параметра, если у вас используется множественное кэширование шаблона. + + Также вы можете передавать compile id в качестве необязательного третьего параметра. + Если вы не передадите этот параметр, будет использован текущий + $compile_id. + + + Если вы не хотите передавать cache id, но хотите передать compile + id, вы должны передать null в качестве cache id. + is_cached при множественном кэшировании шаблона - + caching = true; -if(!$smarty->is_cached("index.tpl","FrontPage")) { +if(!$smarty->is_cached("index.tpl", "FrontPage")) { // обращаемся к БД, назначаем переменные } -$smarty->display("index.tpl","FrontPage"); -]]> +$smarty->display("index.tpl", "FrontPage"); +?> +]]> - + + + + Техническое замечание + + Если is_cached возвращает true, при этом она загружает + кэшированный вывод и хранит его в памяти. Любые последующие вызовы + display() или + fetch() + будут возвращать этот хранимый в памяти вывод и не будут пытаться перезагрузить + файл кэша. Это предотвращает неприятную ситуацию, которая может возникнуть если + другой процесс очищает кэш между вызовами is_cached и + display в предыдущем примере. Это также означает, что + clear_cache() + и другие изменения настроек кэширования могут не вступить в силу после того, как + is_cached вернула true. + + + + - - - load_filter - - - void load_filter - string type - string name - - - + + + + load_filter + + + + + <methodsynopsis> + <type>void</type><methodname>load_filter</methodname> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> Эта функция может быть использована для загрузки плагина фильтра. Первый аргумент определяет тип загружаемого фильтра и может быть одним из следующих: - 'pre', 'post', или 'output'. Второй аргумент - определяет имя плагина фильтра, к примеру, 'trim'. + 'pre', 'post' или 'output'. Второй аргумент + определяет имя плагина фильтра, к примеру 'trim'. </para> <example> <title>Загрузка плагинов фильтров - + load_filter('pre', 'trim'); // загружаем префильтр под названием 'trim' $smarty->load_filter('pre', 'datefooter'); // загружаем еще один префильтр - 'datefooter' -$smarty->load_filter('output', 'compress'); // загружаем фильтр вывода 'compress' -]]> - - - +$smarty->load_filter('output', 'compress'); // загружаем фильтр вывода 'compress' +?> +]]> + + + + - - - register_block - - - void register_block - string name - string impl - - - - Используйте для динамической регистрации плагинов - блоковых функций. В качестве аргументов передаются + + + + register_block + + + + + <methodsynopsis> + <type>void</type><methodname>register_block</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + <methodparam><type>bool</type><parameter>cacheable</parameter></methodparam> + <methodparam><type>mixed</type><parameter>cache_attrs</parameter></methodparam> + </methodsynopsis> + <para> + Используйте для динамической регистрации плагинов + блоковых функций. В качестве аргументов передаются имя блоковой функции и имя функции, реализующей ее. </para> + <para> + Коллбек-функцией php <parameter>impl</parameter> может быть (a) строка, + содержащая имя функции, или (b) массив вида + <literal>array(&$object, $method)</literal>, где + <literal>&$object</literal> является ссылкой на + объект, а <literal>$method</literal> является строкой, + содержащей имя метода, или (c) массив в форме + <literal>array($class, $method)</literal>, где + <literal>$class</literal> является именем класса, а + <literal>$method</literal> является методом этого + класса. + </para> + <para> + <parameter>cacheable</parameter> и <parameter>cache_attrs</parameter> + в большинстве случаев могут быть опущены. Смотрите <link + linkend="caching.cacheable">Управление кэшированием результатов работы плагинов</link> + для получения информации об их правильном использовании. + </para> <example> <title>register_block register_block("translate", "do_translation"); -function do_translation ($params, $content, &$smarty) { - if ($content) { - $lang = $params['lang']; - // выполняем перевод $content - echo $translation; - } +function do_translation ($params, $content, &$smarty, &$repeat) +{ + if (isset($content)) { + $lang = $params['lang']; + // выполняем перевод $content + return $translation; + } } ?> - -{* template *} +]]> + + + Содержимое шаблона: + + + - - - + + + + - - - register_compiler_function - - - void register_compiler_function - string name - string impl - - - + + + + register_compiler_function + + + + + <methodsynopsis> + <type>bool</type><methodname>register_compiler_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + <methodparam><type>bool</type><parameter>cacheable</parameter></methodparam> + </methodsynopsis> + <para> Используется для динамической регистрации плагина функции компилятора. - Передается наименование функции компилятора, далее список функций. + Передается наименование функции компилятора, далее имя функции, реализующей ее. </para> -</sect1> + <para> + Коллбек-функцией php <parameter>impl</parameter> может быть (a) строка, + содержащая имя функции, или (b) массив вида + <literal>array(&$object, $method)</literal>, где + <literal>&$object</literal> является ссылкой на + объект, а <literal>$method</literal> является строкой, + содержащей имя метода, или (c) массив в форме + <literal>array($class, $method)</literal>, где + <literal>$class</literal> является именем класса, а + <literal>$method</literal> является методом этого + класса. + </para> + <para> + <parameter>cacheable</parameter> и <parameter>cache_attrs</parameter> + в большинстве случаев могут быть опущены. Смотрите <link + linkend="caching.cacheable">Управление кэшированием результатов работы плагинов</link> + для получения информации об их правильном использовании. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-register-function.xml b/docs/ru/programmers/api-functions/api-register-function.xml index 4d3e965b..e1e6c567 100644 --- a/docs/ru/programmers/api-functions/api-register-function.xml +++ b/docs/ru/programmers/api-functions/api-register-function.xml @@ -1,22 +1,45 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.register.function"> - <title>register_function - - - void register_function - string name - string impl - - - - Используется для динамической регистрации плагинов функций шаблона. - Передается наименование функции шаблона и наименование выполняемой функции. - + + + + register_function + + + + + <methodsynopsis> + <type>void</type><methodname>register_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + <methodparam><type>bool</type><parameter>cacheable</parameter></methodparam> + <methodparam><type>mixed</type><parameter>cache_attrs</parameter></methodparam> + </methodsynopsis> + <para> + Используется для динамической регистрации плагинов функций шаблона. + Передается наименование функции шаблона и имя функции, реализующей ее. + </para> + <para> + Коллбек-функцией php <parameter>impl</parameter> может быть (a) строка, + содержащая имя функции, или (b) массив вида + <literal>array(&$object, $method)</literal>, где + <literal>&$object</literal> является ссылкой на + объект, а <literal>$method</literal> является строкой, + содержащей имя метода, или (c) массив в форме + <literal>array($class, $method)</literal>, где + <literal>$class</literal> является именем класса, а + <literal>$method</literal> является методом этого + класса. + </para> + <para> + <parameter>cacheable</parameter> и <parameter>cache_attrs</parameter> + в большинстве случаев могут быть опущены. Смотрите <link + linkend="caching.cacheable">Управление кэшированием результатов работы плагинов</link> + для получения информации об их правильном использовании. + </para> <example> <title>register_function - + register_function("date_now", "print_current_date"); @@ -28,11 +51,13 @@ function print_current_date ($params) { } // теперь вы можете использовать ее в Smarty чтобы вывести текущую дату: {date_now} -// или {date_now format="%Y/%m/%d"} чтобы задать формат. -]]> - - - +// или {date_now format="%Y/%m/%d"} чтобы задать формат. +?> +]]> + + + + - - - register_modifier - - - void register_modifier - string name - string impl - - - + + + + register_modifier + + + + + <methodsynopsis> + <type>void</type><methodname>register_modifier</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + </methodsynopsis> + <para> Используйте функцию для динамической регистрации плагина модификатора. В функцию передаются имя модификатора и имя функции, реализующей его. </para> - <example> - <title>register_modifier - + + Коллбек-функцией php impl может быть (a) строка, + содержащая имя функции, или (b) массив вида + array(&$object, $method), где + &$object является ссылкой на + объект, а $method является строкой, + содержащей имя метода, или (c) массив в форме + array($class, $method), где + $class является именем класса, а + $method является методом этого + класса. + + + cacheable и cache_attrs + в большинстве случаев могут быть опущены. Смотрите Управление кэшированием результатов работы плагинов + для получения информации об их правильном использовании. + + + register_modifier + register_modifier("sslash","stripslashes"); +$smarty->register_modifier("sslash"," stripslashes"); -// теперь можно использовать {$var|sslash} чтобы вырезать слеши из переменной -]]> - - - +// теперь можно использовать {$var|sslash} чтобы вырезать слеши из переменной +?> +]]> + + + + - - - register_object - - - void register_object - string object_name - object $object - array allowed methods/properties - boolean format - - - - Функция регестрирует объект для использования в шаблоне. Смотрите - раздел "Объекты" - для примеров. - - + + + + register_object + + + + + <methodsynopsis> + <type>void</type><methodname>register_object</methodname> + <methodparam><type>string</type><parameter>object_name</parameter></methodparam> + <methodparam><type>object</type><parameter>object</parameter></methodparam> + <methodparam><type>array</type><parameter>allowed_methods_properties</parameter></methodparam> + <methodparam><type>boolean</type><parameter>format</parameter></methodparam> + <methodparam><type>array</type><parameter>block_methods</parameter></methodparam> + </methodsynopsis> + <para> + Функция регестрирует объект для использования в шаблоне. Обратитесь к + <link linkend="advanced.features.objects">разделу "Объекты"</link> + за примерами. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-register-outputfilter.xml b/docs/ru/programmers/api-functions/api-register-outputfilter.xml index aaeb59c2..176035ab 100644 --- a/docs/ru/programmers/api-functions/api-register-outputfilter.xml +++ b/docs/ru/programmers/api-functions/api-register-outputfilter.xml @@ -1,22 +1,38 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.register.outputfilter"> - <title>register_outputfilter - - - void register_outputfilter - string function_name - - - - Используйте функцию для динамической регистрации фильтров - вывода, чтобы управлять выводом шаблона перед тем, как он - будет показан в браузере. Смотрите - фильтры вывода - шаблонов для дополнительной информации. - - + + + + register_outputfilter + + + + + <methodsynopsis> + <type>void</type><methodname>register_outputfilter</methodname> + <methodparam><type>mixed</type><parameter>function</parameter></methodparam> + </methodsynopsis> + <para> + Используйте функцию для динамической регистрации фильтров + вывода, чтобы управлять выводом шаблона перед тем, как он + будет отображен. Обратитесь к + <link linkend="advanced.features.outputfilters">фильтрам + вывода шаблонов</link> для получения дополнительной информации. + </para> + <para> + Коллбек-функцией php <parameter>function</parameter> может быть (a) строка, + содержащая имя функции, или (b) массив вида + <literal>array(&$object, $method)</literal>, где + <literal>&$object</literal> является ссылкой на + объект, а <literal>$method</literal> является строкой, + содержащей имя метода, или (c) массив в форме + <literal>array($class, $method)</literal>, где + <literal>$class</literal> является именем класса, а + <literal>$method</literal> является методом этого + класса. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-register-postfilter.xml b/docs/ru/programmers/api-functions/api-register-postfilter.xml index 01ddc1bb..7da839d7 100644 --- a/docs/ru/programmers/api-functions/api-register-postfilter.xml +++ b/docs/ru/programmers/api-functions/api-register-postfilter.xml @@ -1,21 +1,37 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.register.postfilter"> - <title>register_postfilter - - - void register_postfilter - string function_name - - - - Используйте функцию для динамической регистрации постфильтров, - в целях управления выводом шаблонов уже после их компиляции. - Смотрите постфильтры - шаблонов для получения дополнительной информации. - - + + + + register_postfilter + + + + + <methodsynopsis> + <type>void</type><methodname>register_postfilter</methodname> + <methodparam><type>mixed</type><parameter>function</parameter></methodparam> + </methodsynopsis> + <para> + Используйте функцию для динамической регистрации постфильтров, + в целях управления выводом шаблонов уже после их компиляции. + Обратитесь к <link linkend="advanced.features.postfilters">постфильтрам + шаблонов</link> для получения дополнительной информации. + </para> + <para> + Коллбек-функцией php <parameter>function</parameter> может быть (a) строка, + содержащая имя функции, или (b) массив вида + <literal>array(&$object, $method)</literal>, где + <literal>&$object</literal> является ссылкой на + объект, а <literal>$method</literal> является строкой, + содержащей имя метода, или (c) массив в форме + <literal>array($class, $method)</literal>, где + <literal>$class</literal> является именем класса, а + <literal>$method</literal> является методом этого + класса. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-register-prefilter.xml b/docs/ru/programmers/api-functions/api-register-prefilter.xml index fc1275ee..7f72bebf 100644 --- a/docs/ru/programmers/api-functions/api-register-prefilter.xml +++ b/docs/ru/programmers/api-functions/api-register-prefilter.xml @@ -1,21 +1,37 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.register.prefilter"> - <title>register_prefilter - - - void register_prefilter - string function_name - - - - Используйте функцию для динамической регистрации префильтра, - в целях управления содержимым вывода шаблона перед его компиляцией. - Смотрите префильтры - шаблонов для дополнительной информации. - - + + + + register_prefilter + + + + + <methodsynopsis> + <type>void</type><methodname>register_prefilter</methodname> + <methodparam><type>mixed</type><parameter>function</parameter></methodparam> + </methodsynopsis> + <para> + Используйте функцию для динамической регистрации префильтра, + в целях управления содержимым шаблона перед его компиляцией. + Обратитесь к <link linkend="advanced.features.prefilters">префильтрам + шаблонов</link> для получения дополнительной информации. + </para> + <para> + Коллбек-функцией php <parameter>function</parameter> может быть (a) строка, + содержащая имя функции, или (b) массив вида + <literal>array(&$object, $method)</literal>, где + <literal>&$object</literal> является ссылкой на + объект, а <literal>$method</literal> является строкой, + содержащей имя метода, или (c) массив в форме + <literal>array($class, $method)</literal>, где + <literal>$class</literal> является именем класса, а + <literal>$method</literal> является методом этого + класса. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-register-resource.xml b/docs/ru/programmers/api-functions/api-register-resource.xml index ee13ba4e..5ca7477c 100644 --- a/docs/ru/programmers/api-functions/api-register-resource.xml +++ b/docs/ru/programmers/api-functions/api-register-resource.xml @@ -1,33 +1,58 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.register.resource"> - <title>register_resource - - - void register_resource - string name - array resource_funcs - - - - Используйте эту функцию, чтобы динамически зарегистрировать - плагин ресурса в Smarty. Передается имя ресурса и массив PHP-функций. - Смотрите template resources - для дополнительной информации. - - - register_resource - + + + + register_resource + + + + + <methodsynopsis> + <type>void</type><methodname>register_resource</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>array</type><parameter>resource_funcs</parameter></methodparam> + </methodsynopsis> + <para> + Используйте эту функцию, чтобы динамически зарегистрировать + плагин ресурса в Smarty. Передается имя ресурса и массив php-функций. + Обратитесь к <link linkend="template.resources">ресурсам шаблонов</link> + для получениядополнительной информации. + </para> + <note> + <title>Техническое замечание + + Имя ресурса должно состоять минимум из двух букв. Однобуквенные + имена ресурсов будут игнорироваться и испольщоваться как часть файлового + пути, например $smarty->display('c:/path/to/index.tpl'); + + + + Массив php-функций resource_funcs + должен содержать 4 или 5 элементов. + В случае четырех элементов, элементы являются + соответствующими коллбек-функциями: "source", + "timestamp", "secure" и "trusted" функции ресурса. + В случае пяти элементов, первый элемент должен быть + ссылкой на объект или имя класса, объект или класс которого + реализовывает ресурс, а 4 следующих элементов должны быть названиями методов, + реализующимх "source", "timestamp", "secure" и "trusted". + + + register_resource + register_resource("db", array("db_get_template", "db_get_timestamp", "db_get_secure", - "db_get_trusted")); -]]> - - - + "db_get_trusted")); +?> +]]> + + + + - - - template_exists - - - bool template_exists - string template - - - - Эта функция проверяет, существует ли определенный шаблон. + + + + template_exists + + + + + <methodsynopsis> + <type>bool</type><methodname>template_exists</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + </methodsynopsis> + <para> + Эта функция проверяет, существует ли определенный шаблон. Здесь можно указать путь к шаблону в файловой системе или строку ресурса, соответствующую шаблону. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-trigger-error.xml b/docs/ru/programmers/api-functions/api-trigger-error.xml index be0a07fa..4274769c 100644 --- a/docs/ru/programmers/api-functions/api-trigger-error.xml +++ b/docs/ru/programmers/api-functions/api-trigger-error.xml @@ -1,23 +1,27 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.trigger.error"> - <title>trigger_error - - - void trigger_error - string error_msg - [int level] - - - - Эта функция может быть использована для вывода сообщения об - ошибке средствами Smarty. Параметр level - может быть равен одному из значений, используемых для PHP-функции - trigger_error(), т.е. E_USER_NOTICE, E_USER_WARNING, и др. + + + + trigger_error + + + + + <methodsynopsis> + <type>void</type><methodname>trigger_error</methodname> + <methodparam><type>string</type><parameter>error_msg</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> + <para> + Эта функция может быть использована для вывода сообщения об + ошибке средствами Smarty. Параметр <parameter>level</parameter> + может быть равен одному из значений, используемых для PHP-функции + trigger_error(), т.е. E_USER_NOTICE, E_USER_WARNING, и др. По умолчанию установлено значение E_USER_WARNING. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-unregister-block.xml b/docs/ru/programmers/api-functions/api-unregister-block.xml index fcacff6b..2f8c7725 100644 --- a/docs/ru/programmers/api-functions/api-unregister-block.xml +++ b/docs/ru/programmers/api-functions/api-unregister-block.xml @@ -1,19 +1,23 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.unregister.block"> - <title>unregister_block - - - void unregister_block - string name - - - + + + + unregister_block + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_block</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> Используйте функцию для динамической дерегистрации плагина блоковой функции. В качестве аргумента передается имя функции. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-unregister-compiler-function.xml b/docs/ru/programmers/api-functions/api-unregister-compiler-function.xml index 12aa597d..4fcd8443 100644 --- a/docs/ru/programmers/api-functions/api-unregister-compiler-function.xml +++ b/docs/ru/programmers/api-functions/api-unregister-compiler-function.xml @@ -1,20 +1,24 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.unregister.compiler.function"> - <title>unregister_compiler_function - - - void unregister_compiler_function - string name - - - - Используйте функцию для динамической дерегистрации + + + + unregister_compiler_function + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_compiler_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Используйте функцию для динамической дерегистрации функции компиляции. В качестве аргумента передается имя функции компиляции. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-unregister-function.xml b/docs/ru/programmers/api-functions/api-unregister-function.xml index 5a60366c..41f8c08d 100644 --- a/docs/ru/programmers/api-functions/api-unregister-function.xml +++ b/docs/ru/programmers/api-functions/api-unregister-function.xml @@ -1,29 +1,35 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.unregister.function"> - <title>unregister_function - - - void unregister_function - string name - - - + + + + unregister_function + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> Используйте функцию для динамической деригистрации плагина функции шаблона. В качестве аргумента передается имя функции шаблона. </para> <example> <title>unregister_function - + unregister_function("fetch"); -]]> - - - +$smarty->unregister_function("fetch"); +?> +]]> + + + + - - - unregister_modifier - - - void unregister_modifier - string name - - - - Используйте функцию для динамической дерегистрации - плагина модификатора. В качестве аргумента передается + + + + unregister_modifier + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_modifier</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Используйте функцию для динамической дерегистрации + плагина модификатора. В качестве аргумента передается имя модификатора. </para> <example> <title>unregister_modifier - + unregister_modifier("strip_tags"); -]]> - - - +$smarty->unregister_modifier("strip_tags"); +?> +]]> + + + + - - - unregister_object - - - void unregister_object - string object_name - - - + + + + unregister_object + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_object</methodname> + <methodparam><type>string</type><parameter>object_name</parameter></methodparam> + </methodsynopsis> + <para> Используется для дерегистрации объекта. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-unregister-outputfilter.xml b/docs/ru/programmers/api-functions/api-unregister-outputfilter.xml index ee718823..eb334768 100644 --- a/docs/ru/programmers/api-functions/api-unregister-outputfilter.xml +++ b/docs/ru/programmers/api-functions/api-unregister-outputfilter.xml @@ -1,18 +1,22 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.unregister.outputfilter"> - <title>unregister_outputfilter - - - void unregister_outputfilter - string function_name - - - + + + + unregister_outputfilter + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_outputfilter</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> + <para> Используйте функцию для динамической дерегистрации фильтра вывода. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-unregister-postfilter.xml b/docs/ru/programmers/api-functions/api-unregister-postfilter.xml index e465bf8f..ed611113 100644 --- a/docs/ru/programmers/api-functions/api-unregister-postfilter.xml +++ b/docs/ru/programmers/api-functions/api-unregister-postfilter.xml @@ -1,18 +1,22 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> <!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.unregister.postfilter"> - <title>unregister_postfilter - - - void unregister_postfilter - string function_name - - + + + unregister_postfilter + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_postfilter</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> <para> Используйте функцию для динамической дерегистрации постфильтра. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-unregister-prefilter.xml b/docs/ru/programmers/api-functions/api-unregister-prefilter.xml index c63be039..d2b357f9 100644 --- a/docs/ru/programmers/api-functions/api-unregister-prefilter.xml +++ b/docs/ru/programmers/api-functions/api-unregister-prefilter.xml @@ -1,18 +1,22 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.unregister.prefilter"> - <title>unregister_prefilter - - - void unregister_prefilter - string function_name - - - + + + + unregister_prefilter + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_prefilter</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> + <para> Используйте для динамической дерегистрации префильтра. - </para> -</sect1> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/ru/programmers/api-functions/api-unregister-resource.xml b/docs/ru/programmers/api-functions/api-unregister-resource.xml index 2b6dbe8a..46772d31 100644 --- a/docs/ru/programmers/api-functions/api-unregister-resource.xml +++ b/docs/ru/programmers/api-functions/api-unregister-resource.xml @@ -1,27 +1,33 @@ <?xml version="1.0" encoding="windows-1251"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: tony2001 Status: ready --> -<sect1 id="api.unregister.resource"> - <title>unregister_resource - - - void unregister_resource - string name - - - - Используйте функцию для динамической дерегистрации + + + + unregister_resource + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_resource</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Используйте функцию для динамической дерегистрации плагина ресурса. В качестве аргумента передается имя ресурса. - </para> - <example> - <title>unregister_resource - + + + unregister_resource + unregister_resource("db"); -]]> - - - +unregister_resource("db"); +?> +]]> + + + + - + $autoload_filters @@ -12,13 +12,16 @@ autoload_filters = array('pre' => array('trim', 'stamp'), - 'output' => array('convert')); +autoload_filters = array('pre' => array('trim', 'stamp'), + 'output' => array('convert')); +?> ]]> - + + - + $cache_dir Имя каталога, в котором хранится кэш шаблонов. По умолчанию установлено в "./cache". Это означает, что поиск каталога с кэшем - будет производиться в том же каталоге, в котором выполняется + будет производиться в том же каталоге, в котором выполняется скрипт. Вы также можете использовать собственную функцию-обработчик для управления файлами кэша, которая будет игнорировать этот параметр. @@ -14,7 +14,7 @@ Техническое замечание При установке этого параметра можно использовать как относительные, - так и абсолютные пути. Для создаваемых файлов include_path не используется. + так и абсолютные пути. Для создаваемых файлов include_path не используется. diff --git a/docs/ru/programmers/api-variables/variable-cache-handler-func.xml b/docs/ru/programmers/api-variables/variable-cache-handler-func.xml index 56030c74..d7ea696f 100644 --- a/docs/ru/programmers/api-variables/variable-cache-handler-func.xml +++ b/docs/ru/programmers/api-variables/variable-cache-handler-func.xml @@ -1,13 +1,14 @@ - + $cache_handler_func Вы можете добавить собственную функцию для управления файлами кэша вместо вызовов встроенного метода, используя $cache_dir. - Подробнее см. в разделе, описывающем функции для работы - с кэшем. + За дополнительной информацией обратитесь к разделу + Управление + кэшированием. - + $cache_lifetime @@ -10,12 +10,12 @@ $cache_lifetime. Значение переменной -1 задает неограниченное время жизни кэша. Значение переменной 0 вызовет постоянную его регенерацию (подходит только для тестирования, для отключения кэширования более - целесообразно устанавливать + целесообразно устанавливать $caching = false.) Если $force_compile - активировано, файлы кэша будут каждый раз будут регенерироваться, + активировано, файлы кэша каждый раз будут регенерироваться, отключая таким образом кэширование. Вы можете очистить сразу все файлы кэша, используя функцию clear_all_cache(), или в случае с конкретными файлами (группами) кэша - при помощи функции @@ -26,7 +26,7 @@ Если вы хотите назначить конкретным шаблонам собственное время жизни их кэша, вы можете сделать это путем установки $caching - = 2, затем установкой $cache_lifetime в нужное значение перед вызовом + = 2, затем установкой $cache_lifetime в нужное значение перед вызовом display() или fetch(). diff --git a/docs/ru/programmers/api-variables/variable-php-handling.xml b/docs/ru/programmers/api-variables/variable-php-handling.xml index 06a367a9..c7b1fc3c 100644 --- a/docs/ru/programmers/api-variables/variable-php-handling.xml +++ b/docs/ru/programmers/api-variables/variable-php-handling.xml @@ -1,28 +1,28 @@ - + - - $php_handling - - This tells Smarty how to handle PHP code embedded in the - templates. There are four possible settings, default being - SMARTY_PHP_PASSTHRU. Note that this does NOT affect php code - within {php}{/php} - tags in the template. - - - SMARTY_PHP_PASSTHRU - Smarty echos tags as-is. - SMARTY_PHP_QUOTE - Smarty quotes the tags as - html entities. - SMARTY_PHP_REMOVE - Smarty removes the tags from - the templates. - SMARTY_PHP_ALLOW - Smarty will execute the tags - as PHP code. - - - NOTE: Embedding PHP code into templates is highly discouraged. - Use custom functions or - modifiers instead. - + + + $php_handling + + Этот параметр говорит Smarty, как обращаться с PHP-кодом, встроенным в + шаблоны. Существует четыре возможных значения, значением по умолчанию является + SMARTY_PHP_PASSTHRU. Обратите внимание, что это НЕ влияет на PHP-код + внутри тэгов {php}{/php} + в шаблоне. + + + SMARTY_PHP_PASSTHRU - Smarty показывает тэги без обработки. + SMARTY_PHP_QUOTE - Smarty превращает спецсимволы тэгов в HTML-сущности. + SMARTY_PHP_REMOVE - Smarty удаляет тэги из шалона. + SMARTY_PHP_ALLOW - Smarty будет выполнять теги как PHP-код. + + + + Встраивать PHP-код в шаблоны весьма не рекоммендуется. + Вместо этого, используется пользовательские функции или + модификаторы. + + \ No newline at end of file +--> diff --git a/docs/ru/programmers/api-variables/variable-plugins-dir.xml b/docs/ru/programmers/api-variables/variable-plugins-dir.xml index 36f4d98f..76fbecb0 100644 --- a/docs/ru/programmers/api-variables/variable-plugins-dir.xml +++ b/docs/ru/programmers/api-variables/variable-plugins-dir.xml @@ -1,20 +1,21 @@ - + + $plugins_dir - This is the directories where Smarty will look for the plugins that it - needs. Default is "plugins" under the SMARTY_DIR. If you supply a - relative path, Smarty will first look under the SMARTY_DIR, then - relative to the cwd (current working directory), then relative to each - entry in your PHP include path. + Это директории, в которых Smarty будет искать необходимые ему плагины. + По умолчанию это поддиректория "plugins" директории SMARTY_DIR. Если вы + укажете относительный путь, Smarty будет в первую очередь искать относительно SMARTY_DIR, + затем оносительно текущей рабочей директории (cwd, current working directory), затем относительно + каждой директории в PHP-директиве include_path. - Technical Note + Техническое замечание - For best performance, do not setup your plugins_dir to have to use the - PHP include path. Use an absolute pathname, or a path relative to - SMARTY_DIR or the cwd. + Для улучшения производительности, не нужно настраивать plugins_dir для использования + include_path. Используйте абсолютные пути или относительные пути от + SMARTY_DIR или текущей рабочей директории. diff --git a/docs/ru/programmers/api-variables/variable-request-vars-order.xml b/docs/ru/programmers/api-variables/variable-request-vars-order.xml index ca671cd0..b4548271 100644 --- a/docs/ru/programmers/api-variables/variable-request-vars-order.xml +++ b/docs/ru/programmers/api-variables/variable-request-vars-order.xml @@ -1,10 +1,11 @@ - + + $request_vars_order - The order in which request variables are registered, similar to - variables_order in php.ini + Порядок, в котором будут регистрироваться переменные запроса, + наподобие variables_order из php.ini + $secure_dir - This is an array of all local directories that are considered - secure. {include} and {fetch} use this when security is enabled. + Это массив всех локальных директори, которые считаются безопасными. + {include} и {fetch} используют этот параметр при влюченном безопасном режиме. + $security - $security true/false, default is false. Security is good for - situations when you have untrusted parties editing the templates - (via ftp for example) and you want to reduce the risk of system - security compromises through the template language. Turning on - security enforces the following rules to the template language, - unless specifially overridden with $security_settings: + $security true/false, по умолчанию false. Безопасность (security) + полезна в ситуациях, когда ваши шаблоны редактируют лица, + не заслуживающе вашего доверия (например, через ftp) и вы хотите + сократить риски взлома системы с помощью языка шаблонов. + Включение безопасного режима накладывает следующие ограничения + на язык шаблонов, если только они не изменяются параметром $security_settings: - If $php_handling is set to SMARTY_PHP_ALLOW, this is - implicitly changed to SMARTY_PHP_PASSTHRU - PHP functions are not allowed in IF statements, - except those specified in the $security_settings - templates can only be included from directories - listed in the $secure_dir array - local files can only be fetched from directories - listed in the $secure_dir array using {fetch} - {php}{/php} tags are not allowed - PHP functions are not allowed as modifiers, except - those specified in the $security_settings + Если $php_handling установлен в SMARTY_PHP_ALLOW, это + неявно меняет его на SMARTY_PHP_PASSTHRU + PHP-функции запрещены в условиях IF, + кроме тех, которые указаны в $security_settings + Шаблоны могут быть подключены только из директорий, + перечисленных в массиве $secure_dir + Локальные файлы могут быть прочитаны при помощи {fetch} + только из директорий, перечисленных в массиве $secure_dir + Тэги {php}{/php} запрещены + PHP-функции запрещено использовать в виде модификаторов, + кроме тех, которые указаны в $security_settings - - $template_dir - - This is the name of the default template directory. If you do - not supply a resource type when including files, they will be - found here. By default this is "./templates", meaning that it - will look for the templates directory in the same directory as - the executing php script. - - - Technical Note - - It is not recommended to put this directory under - the web server document root. - - + + + $template_dir + + Это название директории шаблонов по умолчанию. Если вы не + передадите тип ресурса во время подключения файлов, они будут + искаться здесь. Значение по умолчанию - "./templates", а это значит, что + движок будет искать шаблоны в поддиректории templates той директории, в которой + выполняется php-скрипт. + + + Техническое замечание + + Не рекоммендуется размещать эту директорию в пределах + корневой директории веб-сервера. + + + $trusted_dir - $trusted_dir is only for use when $security is enabled. This is an array - of all directories that are considered trusted. Trusted directories are - where you keep php scripts that are executed directly from the templates - with {include_php}. + $trusted_dir используется только при включенном параметре $security. Это массив + всех директорий, которые считаются надёжными. Надёжные директории - это директории, + в которых вы храните свои php-скрипты, которые включаются прямо в шаблоны при помощи + директивы {include_php}. + $use_sub_dirs - Set this to false if your PHP environment does not allow the creation of - sub directories by Smarty. Sub directories are more efficient, so use them - if you can. + Установите это в false если ваше окружение PHP не разрешает создание директорий + от имени Smarty. Поддиректории более эффективны, так что используйте их, + если можете. + + Техническое замечание + + Начиная с версии Smarty 2.6.2, значением по умолчанию для use_sub_dirs является false. + + - + Блоковые функции @@ -30,14 +30,14 @@ $params['start'] или использовать extract($params) для импорта. Атрибуты, переданные в открывающем тэге доступны для вашей функции - до обработки закрывающего тэга включительно. + до обработки закрывающего тэга включительно. Значение переменной $content зависит от того, - вызывается ли ваша функция для отрывающего тэга или вызов происходит при закрытии тэга. + вызывается ли ваша функция для открывающего тэга или вызов происходит при закрытии тэга. В случае с открывающим тэгом, это значение будет равно null, а в случае закрывающего тэга, значение будет равно содержимому блока в шаблоне. - Заметьте, что этот блок шаблона уже будет обработан + Заметьте, что этот блок шаблона уже будет обработан Smarty и на выводе вы получите результат обработки, а не исходный код шаблона. @@ -54,7 +54,7 @@ Блоковая функция - + +} +?> ]]> diff --git a/docs/ru/programmers/plugins/plugins-compiler-functions.xml b/docs/ru/programmers/plugins/plugins-compiler-functions.xml index 34163a9f..2925707c 100644 --- a/docs/ru/programmers/plugins/plugins-compiler-functions.xml +++ b/docs/ru/programmers/plugins/plugins-compiler-functions.xml @@ -1,14 +1,14 @@ - + Функции компилятора - Функции компилятора, как вы наверное догадались, вызываются - только в процессе компиляции шаблона. Они могут быть полезными + Функции компилятора, как вы наверное догадались, вызываются + только в процессе компиляции шаблона. Они могут быть полезными для вставки кода PHP или чувствительного ко времени статического - контента в шаблон. Если одновременно зарегестрированы две - одноименные функции - пользовательская и компилятора, то приоритет + контента в шаблон. Если одновременно зарегестрированы две + одноименные функции - пользовательская и компилятора, то приоритет будет у функции компилятора. @@ -19,7 +19,7 @@ - Функция компилятора имеет два параметра: строку аргументов тэга - + Функция компилятора имеет два параметра: строку аргументов тэга - чаще всего это все, что следует от наименования функции до правого ограничителя, и объект Smarty. Функция должна возвращать PHP-код для вствки в скомпилированный шаблон. @@ -31,7 +31,7 @@ Простой пример функции компилятора - + _current_file . " compiled at " . date('Y-m-d H:M') Результирующий код PHP в скомпилированном шаблоне будет выглядеть примерно так: - + +?> ]]> diff --git a/docs/ru/programmers/plugins/plugins-functions.xml b/docs/ru/programmers/plugins/plugins-functions.xml index e939caae..a72fb67a 100644 --- a/docs/ru/programmers/plugins/plugins-functions.xml +++ b/docs/ru/programmers/plugins/plugins-functions.xml @@ -1,6 +1,6 @@ - + Функции шаблона @@ -19,7 +19,7 @@ Вывод (возвращаемое значение) функции будет подставлен в место расположения - тега функции в шаблоне (функция fetch например). + тега функции в шаблоне (функция fetch например). В качестве альтернативы, функция может выполнять какие либо действия без какого-либо вывода (assign функция). @@ -36,7 +36,7 @@ Функция-плагин с выводом - + +?> ]]> @@ -71,13 +71,13 @@ function smarty_function_eightball($params, &$smarty) Функция-плагин без вывода - + assign($var, $value); } -?> +?> ]]> diff --git a/docs/ru/programmers/plugins/plugins-inserts.xml b/docs/ru/programmers/plugins/plugins-inserts.xml index 59ccae86..ad599e85 100644 --- a/docs/ru/programmers/plugins/plugins-inserts.xml +++ b/docs/ru/programmers/plugins/plugins-inserts.xml @@ -1,6 +1,6 @@ - + Вставки @@ -27,12 +27,12 @@ Плагин вставки - + +?> ]]> diff --git a/docs/ru/programmers/plugins/plugins-modifiers.xml b/docs/ru/programmers/plugins/plugins-modifiers.xml index 8c27eb69..08fe7e27 100644 --- a/docs/ru/programmers/plugins/plugins-modifiers.xml +++ b/docs/ru/programmers/plugins/plugins-modifiers.xml @@ -1,6 +1,6 @@ - + Модификаторы @@ -34,7 +34,7 @@ Этот плагин в своей основе является аналогом одной из PHP-функций. Он не имеет никаких дополнительных параметров. - + Более сложный модификатор - + +?> ]]> diff --git a/docs/ru/programmers/plugins/plugins-naming-conventions.xml b/docs/ru/programmers/plugins/plugins-naming-conventions.xml index 1dfefe04..7802083b 100644 --- a/docs/ru/programmers/plugins/plugins-naming-conventions.xml +++ b/docs/ru/programmers/plugins/plugins-naming-conventions.xml @@ -1,6 +1,6 @@ - + Соглашение об именах @@ -22,7 +22,7 @@ function modifier - block + block compiler prefilter postfilter @@ -32,7 +32,7 @@ - и name (имя) соответствует правилам наименования идентификаторов в PHP + и name (имя) соответствует правилам наименования идентификаторов в PHP (только буквы, цифры и знак подчеркивания). diff --git a/docs/ru/programmers/plugins/plugins-outputfilters.xml b/docs/ru/programmers/plugins/plugins-outputfilters.xml index d74560e4..0b3e3896 100644 --- a/docs/ru/programmers/plugins/plugins-outputfilters.xml +++ b/docs/ru/programmers/plugins/plugins-outputfilters.xml @@ -1,6 +1,6 @@ - + Фильтры вывода @@ -31,7 +31,7 @@ * Файл: outputfilter.protect_email.php * Тип: outputfilter * Имя: protect_email - * Назначение: Конвертировать символ @ в адресах email в %40 для + * Назначение: Конвертировать символ @ в адресах email в %40 для * простейшей защиты от спамботов. * ------------------------------------------------------------- */ diff --git a/docs/ru/programmers/plugins/plugins-prefilters-postfilters.xml b/docs/ru/programmers/plugins/plugins-prefilters-postfilters.xml index c9623a47..78e48fd1 100644 --- a/docs/ru/programmers/plugins/plugins-prefilters-postfilters.xml +++ b/docs/ru/programmers/plugins/plugins-prefilters-postfilters.xml @@ -1,6 +1,6 @@ - + Префильтры/Постфильтры @@ -17,7 +17,7 @@ Префильтры используются для обработки исходного кода шаблона непосредственно перед компиляцией. Первый параметр функции префильтра - это - исходный код шаблона, который, возможно, уже изменен другими префильтрами. + исходный код шаблона, который, возможно, уже изменен другими префильтрами. Такой плагин возвращает модифицированый исходный код. Заметьте, что этот исходный код нигде не сохраняется, он используется только для компиляции. @@ -38,7 +38,7 @@ Плагин префильтра - + Плагин постфильтра - + - + Ресурсы @@ -12,7 +12,7 @@ Необходимо 4 функции для того, чтобы зарегестрировать каждый тип ресурса. Каждая такая функция получает запрашиваемый ресурс в качестве - первого параметра и объект Smarty как последний параметр. + первого параметра и объект Smarty как последний параметр. Остальные параметры зависят от функции. @@ -60,7 +60,7 @@ Третья функция возвращает true или - false в зависимости от того, является ли + false в зависимости от того, является ли запрашиваемый ресурс безопасным. Эта функция используется только для ресурсов шаблона, но в любом случае должна быть определена. @@ -80,12 +80,12 @@ Плагин ресурса - + +?> ]]> diff --git a/docs/ru/programmers/plugins/plugins-writing.xml b/docs/ru/programmers/plugins/plugins-writing.xml index 54eb1b4f..8c93d60c 100644 --- a/docs/ru/programmers/plugins/plugins-writing.xml +++ b/docs/ru/programmers/plugins/plugins-writing.xml @@ -1,16 +1,16 @@ - + Написание плагинов Smarty может подгружать плагины автоматически из - файловой системы или регистрировать их во время выполнения - (at runtime) посредством одной из register_* API функций. + файловой системы или регистрировать их во время выполнения + (at runtime) посредством одной из register_* API функций. Их также можно дерегистрировать, используя unregister_* API функции. - Плагинам, которые регистрируются во время выполнения, + Плагинам, которые регистрируются во время выполнения, могут присваиваться имена не соответствующие правилам соглашения об именах. @@ -18,12 +18,18 @@ (как в некоторых случаях с плагинами, поставляемыми вместе со Smarty), то такой плагин можно загрузить следующим образом: - - require_once SMARTY_DIR . 'plugins/function.html_options.php'; + +_get_plugin_filepath('function', 'html_options'); +?> +]]> - Важно знать, что объект Smarty всегда посылается в плагин как последний - параметер (за исключением модификаторов). + Важно знать, что объект Smarty всегда передаётся в плагин последним параметром + (за двумя исключениями: модификатором объект Smarty вообще не передаётся, а + блоки получают &$repeat следом за объектом Smarty + в целях обратной совместимости с ранними версиями Smarty).