savitskyi-hub/bx-helpers

Local packages that are necessary for the development and support of the project

dev-master 2021-10-07 21:53 UTC

MIT

• Andrew Savitskyi

• composer
• bx-helpers
• savitskyi-hub

README

Примечание: Библиотека больше не поддерживается!

bx-helpers

Вспомогательная библиотека для удобной разработки и поддержки проекта на платформе 1С-Bitrix.

Установка/Настройка

1. Через Composer установить пакет (по рекомендациях 1С-Bitrix в директории /local/library/);

2. Перейти на страницу командной строки в административной панели и запустить процесс инсталяции необходимых зависимостей:

use SavitskyiHub\BxHelpers\Helpers\Install\Mail_Install_Highload;
use SavitskyiHub\BxHelpers\Helpers\Install\User_Group_Install;

new Mail_Install_Highload("УКАЗАТЬ_ПРЕФИКС");
new User_Group_Install();

1. Скинуть полностью кэш в разделе Настройки -> Настройки продукта -> Автокеширование -> Очистка файлов кеша выбрать "Все" и нажать "Начать";

2. Для почтовых событий установить получателей:

• перейти в раздел Настройки -> Настройки продукта -> Почтовые события -> Почтовые шаблоны;
• в фильтре по "Тип почтового события" заполнить "SAVITSKYI_BXHELPERS_HELPERS_MAIL" и перейти на страницу настроек почтового шаблона;
• в поле "Кому" заполнить необходимые адреса получателей (для администрации в случае ошибок будет приходить оповещение);

1. В файле init.php подключить следующий код:

use Bitrix\Main\Application;
use Bitrix\Main\EventManager;

// Include Autoload
if (file_exists(Application::getDocumentRoot().'/local/library/vendor/autoload.php')) {
	require_once(Application::getDocumentRoot().'/local/library/vendor/autoload.php');
	
	if (class_exists('\SavitskyiHub\BxHelpers\Helpers\BeforeProlog')) {
		EventManager::getInstance()->addEventHandler('main', 'OnBeforeProlog', ['\SavitskyiHub\BxHelpers\Helpers\BeforeProlog', 'Init']);
	}
}

1. Подключить необходимые скрипты и стили в шаблоне:

use SavitskyiHub\BxHelpers\Helpers\Main\Includes;

// Для стилей
Includes::libraryCss();

// Для скриптов
Includes::libraryJs();

Примечание: разместить подключение после плагинов и перед подключением скриптов проекта.

1. В директорию ПУТЬ_К_ДИРЕКТОРИИ_ШаБЛОНА/img/ загрузить необходимые изображения (главное чтобы они были):

• no-avatar.png;
• no-image.png;

1. Создать директорию /upload/helpers/handbook_sprite/ иначе создание спрайта для справочников не будет возможным

Проверка работы

Проверить отправку писем и логов (рассчитано что на сервере настроено почту), для этого необходимо произвести ошибку:

• в командной строке запустить выполнение следующего кода:

use SavitskyiHub\BxHelpers\Helpers\Main\User;

$testDebug = User::getInstance();
$testDebug->TEST_DEBUG;

• в результате на почту должно прийти оповещение об ошибке;
• в файле /local/logs/helpers-debug.log посмотреть чтобы была перехвачена ошибка;

Удаление

1. Перейти на страницу командной строки в административной панели и запустить процесс деинсталяции зависимостей:

use SavitskyiHub\BxHelpers\Helpers\Install\Mail_Uninstall_Highload;
use SavitskyiHub\BxHelpers\Helpers\Install\User_Group_Uninstall;

new Mail_Uninstall_Highload("УКАЗАТЬ_ПРЕФИКС");
new User_Group_Uninstall();

1. В файле init.php удалить код подключения что указан в установке;

2. Отключить подключения стилей и скриптов что указаны в установке;