Разработчикам. Добавление модулей.

 

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

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

Для подключения модуля разработчика выделена переменная apx для передачи названия модуля, т.е. чтобы подключить сторонний модуль, достаточно выполнить передачу данных из меню личного кабинета:

<a href="user.php?REQ=authorize&apx=названиемодуля">Модуль разработчика</a>

В стандартной схеме, используется переменная mod, например:

<a href="user.php?REQ=authorize&mod=card">Печать визитной карточки</a>

Для процедуры обработки этой переменной и соответственно подключения модулей разработчиков подготовлены 3 файла:

users/apx.php
users/template/apx_left.php
users/template/apx_right.php

В файле users/apx.php аналогичным образом обрабатывается переменная apx, как и в файле users/user.php переменная mod.

Т.е. для подключения модуля разработчика в личном кабинете, достаточно дописать в файле apx.php  код:

case "названиемодуля":
require ('modules/файлмодуля.php');
$mLogi = "Модуль разработчика";
break;

названиемодуля – название модуля стороннего разработчика, которая передает переменная apx (см. выше)

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

$mLogi = "Модуль разработчика"; - выделенная переменная для записи логов клиента каталога.

Для добавления ссылки модуля разработчика в левое меню (панель управления) личного кабинета, используется файл users/template/apx_left.php

Для подключения раздела в этом меню достаточно дописать код ссылки, после ?> в конец файла

Например:

<tr>
<td width="30" align="center"><img src="<? echo "$def_mainlocation"; ?>/users/template/images/иконкамодуля.png" width="16" height="16"></td>
<td align="left" height="23" class="mainmenu"><a href="user.php?REQ=authorize&apx=названиемодуля">Модуль разработчика</a></td>
</tr>

 

иконкамодуля – картинка модуля разработчика. По умолчанию, изображения хранятся в папке users/template/images/

названиемодуля - название модуля стороннего разработчика, которая передает переменная apx

Модуль разработчика – название модуля разработчика

Для добавления ссылки модуля разработчика в правое меню личного кабинета, используется файл users/template/apx_right.php

Аналогично, как описано выше, для подключения раздела в этом меню достаточно дописать код ссылки, после ?> в конец файла

Например:

<tr>
<td width="32"><img src="<? echo "$def_mainlocation"; ?>/users/template/images/иконкамодуля.png" width="30" height="30"></td>
<td width="206" align="left" class="mainmenu"><a href="user.php?REQ=authorize&apx=названиемодуля">Модуль разработчика</a></td>
</tr>

Использование отдельной переменной apx и файлов меню для разработчиков, избавит пользователя скрипта после каждого обновления новой версии изменять код основных файлов скрипта, прописывать обработку переменной mod в файле users/user.php и добавлять разделы меню личного кабинета.

Пример подключения модуля стороннего разработчика:

Разработан модуль. Разработчик присвоил название модуля – modulraz. Файл модуля размещен в папке users/modules/ и носит имя modulraz1.php Переход в управление этим модулем должен быть в правом меню личного кабинета.

  1. Добавляем в файл users/template/apx_right.php, код

<tr>
<td width="32"><img src="<? echo "$def_mainlocation"; ?>/users/template/images/ modulraz.png" width="30" height="30"></td>
<td width="206" align="left" class="mainmenu"><a href="user.php?REQ=authorize&apx=modulraz ">Модуль разработчика 1</a></td>
</tr>

2. В файл users/apx.php добавляем обработку этой переменной

case " modulraz":
require ('modules/ modulraz1.php');
$mLogi = "Модуль разработчика 1";
break;

Процедура выполнена.

Разработчик должен позаботиться, чтобы в коде все запросы шли на переменную apx. Довольно часто разработчики используют в качестве заготовки стандартные модули, рекомендуем с помощью текстового редактора заменить все переменные mod, на apx для избежания ошибки в работе модуля.




Яндекс.Метрика