Просмотр файла mc-2.7.0/docs/dev.modules.html

Конкурс дизайнеров на 15000 рублей
Свежие Креативы и море позитива !!!
Размер файла: 12.96Kb 
  1. <html>
  2.     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3.     <html xmlns="http://www.w3.org/1999/xhtml">
  4.         <head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  5.             <title>Документация по MobileCMS</title>
  6.             <link rel="stylesheet" href="style.css" type="text/css" />
  7.         </head>
  8.  
  9.         <body><div class="navheader">
  10.                 <table width="100%" summary="Navigation header">
  11.                     <tr>
  12.                         <th align="center">Документация по MobileCMS</th>
  13.                     </tr>
  14.                     <tr>
  15.                         <th align="center">Структура модулей и их разработка</th>
  16.                     </tr>
  17.                 </table>
  18.                 <hr />
  19.             </div>
  20.  
  21.             <div class="refsect1">
  22.                 <h2>Введение</h2>
  23.                 <p class="classname">
  24.                     Модули в MobileCMS состоят из 4х основных частей:<br />
  25.                     <ul>
  26.                         <li>Файл <strong class="command"><b>module.ini</b></strong> - содержит важную информацию о модуле</li>
  27.                         <li>Папка <strong class="command"><b>controllers</b></strong> - содержит контроллеры модуля</li>
  28.                         <li>Папка <strong class="command"><b>views</b></strong> - содержит шаблоны модуля</li>
  29.                         <li>Папка <strong class="command"><b>helpers</b></strong> - содержит хелперы (помощники) модуля</li>
  30.                     </ul>
  31.                     Также модули могут содержать и другие необходимые для работы файлы и папки.<br />
  32.                     <br />
  33.                     Рассмотрим структуру модулей более подробно на примере тестового модуля.
  34.                 </p>
  35.             </div>
  36.  
  37.             <div><br /></div>
  38.  
  39.             <div class="refsect1">
  40.                 <h2>module.ini</h2>
  41.                 Файл <strong class="command"><b>module.ini</b></strong> содержит важную информацию о модуле, необходимую для его установки. Основные компоненты файла:
  42.                 <ul>
  43.                     <li><strong class="command"><b>name</b></strong> - название модуля, в названии могут быть только латинские буквы, цифры и знаки подчеркивания, например,  <strong class="command">test</strong> (обязательный пареметр)</li>
  44.                     <li><strong class="command"><b>title</b></strong> - отображаемое имя модуля, например, <strong class="command">Тест</strong> (обязательный пареметр)</li>
  45.                     <li><strong class="command"><b>admin_link</b></strong> - ссылка на управление модулем в панеле управления, формат как для первого параметра функции <strong class="command">a_url()</strong> (сегменты ссылки), например, <strong class="command">test/admin</strong> (не обязательный пареметр, используется только если есть управление модулем из панели управления)</li>
  46.                     <li><strong class="command"><b>description</b></strong> - краткое описание модуля, например, <strong class="command">Тестовый модуль</strong> (не обязательный пареметр)</li>
  47.                     <li><strong class="command"><b>author</b></strong> - автор модуля, например, <strong class="command">Ant0ha</strong> (не обязательный пареметр)</li>
  48.                     <li><strong class="command"><b>version</b></strong> - версия модуля, например, <strong class="command">0.1</strong> (не обязательный пареметр)</li>
  49.                 </ul>
  50.                 Пример module.ini:<br />
  51.                 <pre class="programlisting">
  52. name = "test"
  53. title = "Тест"
  54. admin_link = "test/admin"
  55. description = "Тестовый модуль"
  56. author = "Ant0ha"
  57. version = "0.1"</pre>
  58.             </div>
  59.  
  60.             <div><br /></div>
  61.  
  62.             <div class="refsect1">
  63.                 <h2>controllers</h2>
  64.                 Папка <strong class="command"><b>controllers</b></strong> содержит контроллеры модуля. Контроллер - это основная часть модуля, где выполняется логика скрипта.<br />
  65.                 Рассмотрим примеры простых контроллеров тестового модуля.<br />
  66.                 <br />
  67.                 Файл <strong class="command"><b>controllers/test.php</b></strong><br />
  68.                 <pre class="programlisting">
  69. &lt;?php
  70. /**
  71. * Контроллеры модулей происходят от класса Controller.
  72. * Название контроллера происходит от названия модуля с большой буквы с окончанием _Controller
  73. */
  74. class Test_Controller extends Controller {
  75. 	/**
  76. 	* Доступ к контроллеру (укажем 0 чтобы разрешить доступ каждому пользователю)
  77. 	*/
  78. 	public $access_level = 0;
  79. 	
  80. 	/**
  81. 	* Метод вызываемый по умолчанию
  82. 	*/
  83. 	public function action_index() {
  84. 		# Вызовем главный и единственный метод нашего контроллера
  85. 		$this->action_hello_world();
  86. 	}
  87. 	
  88. 	/**
  89. 	* Метод выводит "Hello world!"
  90. 	*/
  91. 	public function action_hello_world() {
  92. 		# Ассигнуем переменную для теста модуля
  93. 		$this->tpl->assign(array(
  94. 			'hello' => "Hello world!"
  95. 		));
  96. 		
  97. 		# Подключаем шаблон нашего метода, шаблон приведен ниже, в описании views
  98. 		# Будет подключен файл modules/test/views/default/hello_world.tpl
  99. 		$this->tpl->display('hello_world');
  100. 	}
  101. }
  102. ?&gt;</pre>
  103.                 <br />
  104.                 Так выглядит простой контроллер нашего тестового модуля, показыающий всем фразу "Hello world!", теперь расмотрим самый простой контроллер нашего модуля для панели управления.<br />
  105.                 <br />
  106.                 Файл <strong class="command"><b>controllers/test_admin.php</b></strong><br />
  107.                 <pre class="programlisting">
  108. &lt;?php
  109. class Test_Admin_Controller extends Controller {
  110. 	/**
  111. 	* В доступе к контроллеру пропишем 10, т.е. он доступен только админам сайта.
  112. 	* Чтобы разрешить доступ и модерам, можно будет прописать 8.
  113. 	*/
  114. 	public $access_level = 10;
  115. 	/**
  116. 	* Тема, используемая в контроллере, для админки необходимо указать "admin"
  117. 	*/
  118. 	public $template_theme = 'admin';
  119. 	
  120. 	/**
  121. 	* Метод вызываемый по умолчанию
  122. 	*/
  123. 	public function action_index() {
  124. 		# Вызовем главный и единственный метод нашего контроллера
  125. 		$this->action_hello_admin();
  126. 	}
  127. 	
  128. 	/**
  129. 	* Метод выводит "Hello Admin!"
  130. 	*/
  131. 	public function action_hello_admin() {
  132. 		# Ассигнуем переменную для теста модуля
  133. 		$this->tpl->assign(array(
  134. 			'hello' => "Hello Admin!"
  135. 		));
  136. 		
  137. 		# Подключаем шаблон нашего метода, шаблон приведен ниже, в описании views
  138. 		# Будет подключен файл modules/test/views/admin/hello_admin.tpl
  139. 		$this->tpl->display('hello_admin');
  140. 	}
  141. }
  142. ?&gt;</pre>
  143.             </div>
  144.  
  145.             <div><br /></div>
  146.  
  147.             <div class="refsect1">
  148.                 <h2>helpers</h2>
  149.                 Папка <strong class="command"><b>helpers</b></strong> содержит хелперы (помощники) модуля. Это служебные php файлы, помогающие в работе модуля.<br />
  150.                 Обычно в helpers модуля присутствуют 2 хелпера - инсталлер и виджет, рассмотрим их более детально.<br />
  151.                 <br />
  152.                 Файл <strong class="command"><b>helpers/test_installer.php</b></strong> (название файла состоит из названия модуля и окончания <strong class="command">_installer.php</strong>) предназначен для выполнения каких-либо действий во время установки и деинсталляции модуля, если никаких действий не требуется, то этот файл не обязателен.<br />
  153.                 <pre class="programlisting">
  154. &lt;?php
  155. /**
  156. * Название класса инсталлятора также состоит из названия модуля и окончания _installer
  157. */
  158. class test_installer {
  159. 	/**
  160. 	* Метод для установки модуля
  161. 	*/
  162. 	public static function install(&$db) {
  163. 		# Создадим таблицу a_test, якобы нужную нашему модулю test
  164. 		$db->query("CREATE TABLE`a_test` (
  165. 			`item_id` INT NOT NULL AUTO_INCREMENT PRIMARY KEY ,
  166. 			`item` VARCHAR( 30 ) NOT NULL
  167. 			) ENGINE = InnoDB ;
  168. 		");
  169. 	}
  170. 	
  171. 	/**
  172. 	* Метод для удаления модуля
  173. 	*/
  174. 	public static function uninstall(&$db) {
  175. 		$db->query("DROP TABLE a_test");
  176. 	}
  177. }
  178. &gt;</pre>
  179.  
  180.                 В инсталляторе можно не только создавать/удалять таблицы, но так же и создавать/удалять файлы и папки, добавлять правила роутинга, события и т.д.<br />
  181.                 <br />
  182.                 Файл <strong class="command"><b>helpers/test_widget.php</b></strong> (название файла состоит из названия модуля и окончания <strong class="command">_widget.php</strong>) предназначен для вывода какой-либо информации на главную страницу сайта.<br />
  183.                 <pre class="programlisting">
  184. &lt;?php
  185. /**
  186. * Название класса виджета также состоит из названия модуля и окончания _widget
  187. */
  188. class test_widget {
  189. 	/**
  190. 	* Показ виджета
  191. 	*/
  192. 	public static function display($widget_id) {
  193.   		return 'Это виджет тестового модуля&lt;br /&gt;';
  194. 	}
  195. 	
  196. 	/**
  197. 	* Настройка виджета
  198. 	*/
  199. 	public static function setup($widget) {
  200. 		a_notice('Данный виджет не требует настройки', a_url('index_page/admin'));
  201. 	}
  202. }
  203. &gt;</pre>
  204.                 <br />
  205.                 Виджет может быть намного сложнее, выводить динамическую информацию и иметь более сложные настройки, для примера можете посмотреть виджет модуля загрузок в <strong class="command">modules/downloads/helpers/downloads_widget.php</strong> вашей копии MobileCMS<br />
  206.                 <br />
  207.                 Также хелперы модулей могут (и это очень рекомендуется) содержать частоиспользуемые методы (функции) в модуле, для примера взгляните хелпер модуля смайлов <strong class="command">modules/smiles/helpers/smiles.php</strong>
  208.             </div>
  209.  
  210.             <div><br /><br /></div>
  211.  
  212.             <div class="navfooter"><hr />
  213.                 <table width="100%" summary="Navigation footer">
  214.                     <tr>
  215.                         <td width="40%" align="left"><a href="dev.general_functions.html">Пред</a></td>
  216.                         <td width="20%" align="center"><a href="index.html">На уровень выше</a></td>
  217.                         <td width="40%" align="right"><a href="dev.module_main.html">След</a></td>
  218.                     </tr>
  219.                     <tr>
  220.                         <td width="40%" align="left" valign="top">Главные методы ядра</td>
  221.                         <td width="20%" align="center">Содержание</td>
  222.                         <td width="40%" align="right" valign="top">Методы модуля main</td>
  223.                     </tr>
  224.                 </table>
  225.             </div>
  226.  
  227.         </body>
  228.     </html>