Примеры позволяют быстро создавать однотипные включаемые файлы. Подсказки, которые находятся в тексте примера, помогают легко размещать включаемый код на странице.

Примеры может создавать администратор сайта или другие модули. Например, модуль «Честное голосование» создает свой пример, чтобы было удобно размещать компонент.

Чтобы сделать пример, необходимо создать файл с любым именем в папке /bitrix/php_interface/include/askaron.include/samples/.

Имена файлов у разных разработчиков не должны повторяться, поэтому если вы пишите модуль, то рекомендуется начинать имя файла с кода модуля. Например, для «Честного голосования» (askaron.ibvote) имя файла askaron.ibvote.iblock.vote.php.

В стандартных примерах включаемых файлов есть подробные комментарии. Примерное содержимое:
  • заголовок: <?if(!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true)die();?>
  • комментарий, в котором ссылка на документацию и подсказки с текстом для подстановки
  • код, который необходимо подставить.

Пример, файл date.php:


<?if(!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true)die();
/*
Текущая дата

Документация http://askaron.ru/api_help/course1/lesson16/

Напишите этот код:

CAskaronInclude::IncludeFile( "date.php" );

Или разместите этот текст в любом месте сайта:

<!--askaron.include
date.php
-->

*/
?><?=ConvertTimeStamp();?>


0  


 Дополнительные примеры включаемых файлов | Описание курса | Пример «Честное голосование» askaron.ibvote.iblock.vote.php