Действия

Установочный файл компонента в Joomla 1.5

Материал из База знаний Joomla

Большинство из описанных в данном примере полей не обязательны для заполнения, потому в реальных установочных пакетах содержимое этого файла может быть намного лаконичнее.

 
<?xml version="1.0" encoding="utf-8"?>
 
<install type="component" version="1.5.0"> <!-- так же возможен атрибут method="upgrade", при котором установщик,
						заменит существующий компонент устанавливаемым в случае если компонент
						с таким названием уже установлен в системе -->
	<name>hello_world</name>
	<!-- Элементы ниже необязательны и их значения могут быть введены в произвольном формате -->
	<creationDate>2007 01 17</creationDate>
	<author>John Doe</author>
	<authorEmail>john.doe@example.org</authorEmail>
	<authorUrl>http://www.example.org</authorUrl>
	<copyright>Copyright Info</copyright>
	<license>License Info</license>
	<!-- Строка версии записывается в таблицу компонентов -->
	<version>Component Version String</version>
	<!-- Поле description необязательно и по умолчанию равно значению поля name -->
	<description>Описание компонента ...</description>
 
	<!-- Пользовательский файл установки компонента -->
	<installfile>install.eventlist.php</installfile>
 
	<!-- Пользовательский файл удаления компонента -->
	<uninstallfile>uninstall.eventlist.php</uninstallfile>
 
	<!-- SQL-скрипты, исполняемые при установке компонента -->
	<install>
		<sql>
			<file driver="mysql" charset="utf8">install.mysql.utf8.sql</file>
			<file driver="mysql">install.mysql.nonutf8.sql</file>
		</sql>
	</install>
 
	<!-- SQL-скрипты, исполняемые при удалении компонента -->
	<uninstall>
		<sql>
			<file driver="mysql" charset="utf8">uninstall.mysql.utf8.sql</file>
			<file driver="mysql">uninstall.mysql.nonutf8.sql</file>
		</sql>
	</uninstall>
 
	<!-- Файлы и директории, копируемые из установочного архива в директорию компонента на сайте -->
	<files>
		<filename>index.html</filename>
		<filename>test.php</filename>
                <folder>views</folder>
	</files>
 
	<!-- Файлы переводов -->
	<languages>
		<language tag="en-GB">en-GB.com_test.ini</language>
		<language tag="de-DE">de-DE.com_test.ini</language>
		<language tag="nl-NL">nl-NL.com_test.ini</language>
	</languages>
 
	<!-- Мультимедийные файлы, копируются в media/{значение атрибута 'destination'} -->
	<media destination="com_test">
		<filename>image.png</filename>
		<filename>flash.swf</filename>
	</media>
 
	<administration>
 
		<!-- Меню администратора -->
		<menu img="components/com_test/assets/test-16.png">EventList</menu>
		<submenu>
			<!-- Все символы '&' должны быть заменены на '&amp;'. Установочный файл должен быть действительным XML-файлом, чтобы его мог обработать установщик -->
			<menu link="option=com_helloworld&amp;task=hello&amp;who=world">Hello World!</menu>
			<!-- Также можно указывать значения отдельных атрибутов ссылки вместо указания адреса: -->
			<menu img="icon" task="hello" controller="z" view="a" layout="b" sub="c">Hello Again!</menu>
			<menu view="test" layout="foo">Testing Foo Layout</menu>
		</submenu>
 
		<!-- Файлы и директории, копируемые из установочного архива в директорию компонента в панели администрирования -->
		<!-- Обратите внимание на то, что значение атрибута 'folder' содержит имя ИСХОДНОЙ директории
			в установочном архиве, относительно которой задаются пути перечисленных ниже файлов.
			В данном случае, файл /my_admin_dir/index.html будет скопирован в /administrator/components/com_hello_world/index.html;
			а файл /my_admin_dir/admin.test.php будет скопирован в /administrator/components/com_hello_world/admin.test.php -->
		<files folder="my_admin_dir">
			<filename>index.html</filename>
			<filename>admin.test.php</filename>
		</files>
 
		<!-- Файлы переводов для интерфейса панели администрирования -->
		<languages folder="admin">
			<language tag="en-GB">en-GB.com_test.ini</language>
			<language tag="de-DE">de-DE.com_test.ini</language>
			<language tag="nl-NL">nl-NL.com_test.ini</language>
		</languages>
 
		<!-- Мультимедийные файлы для панели администрирования -->
		<media folder="admin" destination="com_test">
			<filename>admin-image.png</filename>
			<filename>admin-flash.swf</filename>
		</media>
	</administration>
 
	<!-- Настраиваемые параметры компонента в панели администрирования. Для плагинов и модулей отображаются на странице
		настройки модуля, для компонента подключаются отдельно на каждую страницу интерфейса функцией
			JToolBarHelper::preferences( 'com_hello_world' ); -->
	<params>
		<param name="my_text_param" type="text" default="Значение" label="Текстовое поле:" description="Однострочное текстовое поле" size="31" />
		<param name="my_big_text_param" type="textarea" label="Многострочное текстовое поле" rows="5" cols="40" />
 
		<param name="@spacer" type="spacer" default="" label="" description="" /> <!-- разделитель -->
 
		<param name="my_list_param" type="list" default="foo" label="Выпадающий список:">
			<option value="foo">Вариант 1</option>
			<option value="bar">Вариант 2</option>
		</param>
		<param name="my_radio_param" type="radio" default="0" label="Переключаемые значения:">
			<option value="1">Вкл.</option>
			<option value="0">Выкл.</option>
		</param>
		<advanced>
			<param name="my_geek_param" type="text" default="Значение" label="Текстовое поле:" description="Однострочное текстовое поле" size="31" />
		</advanced>
	</params>
	<params group="Другая вкладка">
		<param name="my_foo_param" type="text" label="Текстовое поле:" description="Однострочное текстовое поле" size="31" />
	</params>
</install>
 

См. также

Ссылки