Разработчикам

CMain::IncludeFile()

Гость

03.03.2005 16:29:57

Здравствуйте, я пытаюсь разобраться с работой данной функции. На форуме нашел одно упоминание, так понял, что функция сложная. В хелпе ее вообще нет. Опишите, пожалуйста, ее поподробнее.
Кстати, может где-нибудь есть более подробная справка по системе?

Dmitry Valyanov

Администратор

Сообщений: 2015 Баллов: 237 Регистрация: 30.12.2002

03.03.2005 19:04:35

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

Ниже предварительное описание функции CMain::IncludeFile():

Код

$APPLICATION->IncludeFile($rel_path, $arParams = Array(), $arFunctionParams = Array())

параметры:
$rel_path - путь относительно корня шаблона
$arParams - массив параметров для включаемого шаблона
$arFunctionParams - массив параметров для этой функции, сейчас это:
  WORKFLOW - участвует включаемый файл в документооборте при изменении(true|false) =false
  MODE - режим для редактирования (text|html|php) =php
  LANG - язык в который будет переход в адм раздел =LANGUAGE_ID
  BACK_URL - куда вернуться после редактирования $REQUEST_URI
  TEMPLATE - путь к файлу шаблону (при создании нового)
  SHOW_BORDER - показывать рамку и иконки для редактирования (true|false) =true

Гость

04.03.2005 12:22:17

Спасибо за помощь
Но здесь много неясного для меня.
Именно, что она делает в принципе?
В шаблоне написано следующее:
IncludeFile("top_items.php", "php")
"top_items.php"-по вашим словам должен быть путь относительно корня шаблона, как это понимать? "php"-тут передается строка, а по вашим словам здесь может быть только массив.

Цитата
Подробное описание функций доступно во встроенной системе помощи.

Что вы имеете ввиду?
В помощи к последней версии, которую я скачивал с сайта, я не нашел никакой информации. В общем, по этой функции(и по другим тоже) очень много вопросов. Возможно, где то можно скачать более полное описание?

Гость

04.03.2005 15:15:12

Цитата
Постигающий Битрикс пишет: Именно, что она делает в принципе?

Данная функция предназначена для подключения на странице различных файлов, в том числе и компонент.

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

Если иконка имеет красный цвет - это означает что подключенный файл являеся компонентом и входит в дистрибутив модуля и перед редактированием он будет предварительно скопирован в каталог /bitrix/templates/[текущий шаблон сайта].

Если же иконка имеет голубой цвет - это означает что данный файл находится либо в каталоге /bitrix/templates/.default/, либо в каталоге /bitrix/templates/[текущий шаблон сайта].

Если будут выведены две иконки (красная и синяя), это означает что подключенный файл является компонентой, а также то что существуют два файла с одинаковым именем, один из которых находится в каталоге /bitrix/templates/[текущий шаблон сайта]/, либо в каталоге /bitrix/templates/.default(синяя иконка), а другой - в каталоге /bitrix/modules/[ID модуля]/install/templates/ (красная иконка).

Цитата
Постигающий Битрикс пишет: В помощи к последней версии, которую я скачивал с сайта, я не нашел никакой информации.

В данный момент документация к 4-ой версии системы в разработке.

Гость	#5 04.03.2005 21:31:10 Vitaliy Kaplich, конечно, спасибо, но я спрашивал вас не про панель, а непосредственно про саму эту функцию. Мой вопрос остается в силе. Спасибо.

Dmitry Valyanov

Администратор

Сообщений: 2015 Баллов: 237 Регистрация: 30.12.2002

05.03.2005 11:42:35

Добрый день,

Виталий привел еще одну часть из описания функции.
Функция позволяет включать в код страницы компоненты или вызов произвольных файлов.

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

В зависимости от параметров подключения статические файлы могут быть открыты для редактирования в различных режимах (text, php, html).

Приведенный в дистрибутиве пример использует устаревший синтаксис, о чем вы справедливо заметили.

Правильное использование:

Код

<?
// включаемая область для раздела
$APPLICATION->IncludeFile($APPLICATION->GetCurDir()."sect_inc.php", Array(), Array(
    "MODE"      => "html",                                           // будет редактировать в веб-редакторе
    "NAME"      => "Редактирование включаемой области раздела",      // текст всплывающей подсказки на иконке
    "TEMPLATE"  => "section_include_template.php"                    // имя шаблона для нового файла
    ));
?>

Код для подключения компонент как правило вставляется автоматически при добавлении компоненты на страницу в визуальном режиме.

Гость

17.03.2005 23:25:51

Здравствуйте еще раз. Все-таки, я так и не разобрался с этой функцией. Объясните пожалуйста следующий пример из шаблона:
<?$APPLICATION->IncludeFile("sale/sale_pieces/basket_line.php", Array("PERSONAL_PAGE"=>"/personal/index.php", "BASKET_PAGE"=>"/personal/basket.php"));?>
Что тут вообще происходит?
В частности, я так понимаю, что инклудится файл basket_line.php .Почему именно он?
Спасибо!

Гость

18.03.2005 13:21:17

Цитата
Постигающий Битрикс пишет: Здравствуйте еще раз. Все-таки, я так и не разобрался с этой функцией. Объясните пожалуйста следующий пример из шаблона:

Создайте пожта обращение в техподдержке. Вам будет предоставлна страница из нового хелпа по данной функции а также даны по возможности все разъяснения.

Гость

25.03.2005 21:31:13

У меня другой вопрос, не думаю, что это есть в хелпе.
Мне интересно, каким образом, я не разобрался, происходит нахождение файла для подключения в IncludeFile. Я смотрел в шаблоне header.php - там подключаются файлы из папки, находящейся в той же папке, что header.php. В других ситуациях как то по другому. Объясните, пожалуйста.
Спасибо.

Гость	#10 26.03.2005 02:05:50 Создайте пожта обращение в техподдержку. Я вам запакую и перешлю новый хелп. Там еще не все дописано по главному модулю, но в принципе функции уже почти все.

Гость	#11 26.03.2005 21:16:12 Лучше я вам оставлю свой ящик ildar_kh@inbox.ru Если не трудно, то отправьте туда пожалуйста.

Гость

#12

29.03.2005 23:53:31

Спасибо, хелп я получил, НО
о функции IncludeFile нет там даже упоминания! При том, что эта функция используется даже в тексте главного шаблона! Я прошу вас, ответьте мне на элементарный вопрос. КАК она работает? Что она присоединяет в каждом из случаев?
Вот примеры:
1)$APPLICATION->IncludeFile("top_items.php", "php")
2)$APPLICATION->IncludeFile("sale/sale_pieces/basket_line.php", Array("PERSONAL_PAGE"=>"/personal/index.php", "BASKET_PAGE"=>"/personal/basket.php"))
3)$APPLICATION->IncludeFile("main/site_panel.php", "php")

Если есть еще какие-то типичные случаи, то, пожалуйста, объясните и их тоже. Объясните, по каким признакам происходит разделение случаев? Еще вопрос, второй параметр, там где "php" - там я ставил html,txt-результат был неизменен.

Гость

#13

29.03.2005 23:58:20

Функция IncludeFile описана в классе CMain главного модуля в разделе для разработчиков. Индекс поиска остался старый так что по нему искать пока нельзя.

Цитата
Постигающий Битрикс пишет: Что она присоединяет в каждом из случаев?

В описании этой функции представлен и объяснен алгоритм поиска компонент. Параметры ее также описаны.

CMain::IncludeFile()

Продукты

Управление сайтом

Битрикс24

Интернет-магазин + CRM

Решения

Для интернет-магазинов

Каталог готовых решений

Внедрение

Выбрать партнера

Проверить партнера

Стать партнером