Документация для разработчиков
Темная тема

Файл описания типов сайта .sites.php

Файл .sites.php определяет шаги Выбор типа сайта и Установка сайта в цепочке шагов мастера создания сайта. Тип сайта – сущность, которая может объединять группы шаблонов, шаблоны, сервисы. От выбора типа сайта может зависеть дальнейший выбор группы шаблонов, шаблонов сайта, сервисов. Если файла .sites.php нет в папке мастера, то шаги Выбор типа сайта и Установка сайта отсутствуют.

Структура типичного файла .sites.php такова:

<?
if(!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true) die();
$arWizardSites = Array(
	"homepage" => Array(
		"NAME" => "Сайт-визитка",
		"DESCRIPTION" => "Представляет набор страниц, создаваемых пользователем. ",
		"FILES" => Array(
			Array("FROM" => "public/homepage/", "TO" => "/"),
			Array("DELETE" => "/special_file.php"),
		),
		"DEFAULT" => "Y",
		"INSTALL_STEPS" => Array(
			"SCRIPT" => "scripts/homepage_site.php",
			"STEPS" => Array(
				"homepagestep1" => "HomePageStep1",
				"homepagestep2" => "HomePageStep2",
				"homepagestep3" => "HomePageStep3",
			)
		),
	),
	"blog" => Array(
		"NAME" => "Блог",
		"DESCRIPTION" => "Публичный сетевой дневник пользователя.",
		"FILES" => Array(
			Array("FROM" => "public/blog/", "TO" => "/"),
		),
		"SELECT_STEPS" => Array(
			"SCRIPT" => "scripts/blog_site.php",
			"STEPS" => Array(
				"blogstep1" => "BlogStep1",
				"blogstep2" => "BlogStep2",
			)
		),
    	),
	"gallery" => Array(
		"NAME" => "Фотогалерея",
		"DESCRIPTION" => "Фотогалерея",
		"FILES" => Array(
			Array("FROM" => "public/gallery/", "TO" => "/"),
		),
	),
);
?>

В файле .sites.php определяется массив $arWizardSites, состоящий из элементов следующего вида:

"ID сайта" => Array(
	"NAME" => имя сайта,
	"DESCRIPTION" => описание сайта,
	"SCREENSHOT" => путь относительно папки мастера к изображению сайта,
	"PREVIEW" => путь относительно папки мастера к уменьшенной копии изображения сайта,
	"DEFAULT" => если равно "Y", то данный сайт будет выбран по умолчанию
	"SELECT_STEPS" => массив, описывающий дополнительные шаги после шага Выбор сайта
	Array(
		"SCRIPT" => путь к файлу с классами шагов относительно папки мастера
		"STEPS" => массив шагов, добавляемых в мастер
		Array(
			"ID шага 1" => "Имя класса шага 1",
			"ID шага 2" => "Имя класса шага 2",
			…
		)
	),
	"INSTALL_STEPS" => массив, описывающий дополнительные шаги после шага Установка сайта
	Array(
		"SCRIPT" => путь к файлу с классами относительно папки мастера,
		"STEPS" => массив шагов, добавляемых в мастер
		Array(
			ID шага 1" => "Имя класса шага 1",
			ID шага 2" => "Имя класса шага 2",
			…
		)
	),
	"FILES" => массив, описывающий файлы для копирования/удаления
	Array(
		Array(
			"FROM" => путь к каталогу (файлу) относительно папки мастера,
			содержимое которого нужно скопировать,
			"TO" => путь к файлу или папке относительно корня сайта,
			куда будут скопированы файлы,
			"REWRITE" => перезаписывать ли существующие файлы; 
			необязательный параметр, по умолчанию равен "Y" (перезаписывать),
			"RECURSIVE" => копировать ли рекурсивно все подкаталоги и файлы, 
			входящие в путь, указанный в параметре FROM; необязательный параметр,
			по умолчанию равен "Y" (копировать рекурсивно),
			"DELETE" => путь к папке (файлу), которую нужно удалить 
		),
		…
	)
),


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх