bagnum / BA-TG-Sender
CI/CD
Реестр контейнеров и пакетов

02. Установка и настройка.md

Установка

  1. Скачайте архив с проектом BA-TG-Sender и распакуйте его в любом удобном месте.
  2. Из папки classes возьмите все файлы и скопируйте в каталог вашего сайта, где хранятся другие классы и плагины.

Подключение файлов

Подключение файлов - стандартное для PHP. Добавьте в файл, где классы будут использоваться (обычно - index.php) сделующий код:

include('путь_до_файла/BA_RequestDataFilter.php');
include('путь_до_файла/BA_FieldChecker.php');
include('путь_до_файла/BA_TelegramSender.php');
include('путь_до_файла/BA_FileUploader.php');
include('путь_до_файла/BA_KeyValue_combinator.php');

Примеры подключения файлов

Если каталог classes расположен в той-же папке, что и вызывающий файл:

include(__DIR__.'путь_до_файла/BA_FieldChecker.php');

Если в другом каталоге, используйте путь от корня:

include('/путь_до_файла/BA_TelegramSender.php');

Подключение классов

Внимание!

В данном проекте классы размещаются в каталоге “classes” и пространстве имён с названием "classes".

Если на вашем сайте не используются пространства имён (например - у вас простой самописный сайт), откройте файлы BA_RequestDataFilter; BA_FieldChecker; BA_KeyValue_combinator; BA_FileUploader; BA_TelegramSender;

и закомментируйте в них строчку

namespace classes;

расположенную в начале каждого файла (или удалите эту строчку совсем):

//namespace classes;
// или
/* namespace classes; */

Если на вашем сайте используются пространства имён (сайт с системой управления контентом или простым движком), добавьте к коду из раздела “Подключение файлов” следующие строки:

use classes\BA_RequestDataFilter;
use classes\BA_FieldChecker;
use classes\BA_KeyValue_combinator;
use classes\BA_FileUploader;
use classes\BA_TelegramSender;

где “classes” - пространство имён, в котором размещаются классы.

Создание объектов

Стандартным для PHP образом:

$fieldChecker = new BA_FieldChecker();
$combinator = new BA_KeyValue_combinator();
$uploader = new BA_FileUploader();
$tgSender = new BA_TelegramSender();

Класс BA_RequestDataFilter использует статические методы и не требует создания объекта.

Классы готовы к работе.

Пример подключения библиотеки

include(__DIR__.'/classes/BA_RequestDataFilter.php');
include(__DIR__.'/classes/BA_FieldChecker.php');
include(__DIR__.'/classes/BA_TelegramSender.php');
include(__DIR__.'/classes/BA_FileUploader.php');
include(__DIR__.'/classes/BA_KeyValue_combinator.php');

use classes\BA_RequestDataFilter;
use classes\BA_FieldChecker;
use classes\BA_KeyValue_combinator;
use classes\BA_FileUploader;
use classes\BA_TelegramSender;

$fieldChecker = new BA_FieldChecker();
$combinator = new BA_KeyValue_combinator();
$uploader = new BA_FileUploader();
$tgSender = new BA_TelegramSender();

В данном примере подключаемые файлы лежат в каталоге “classes” и в пространстве имён “classes”, а подключение производится в index.php, находящемся в корне сайта. DIR - системная константа, содержащая путь к текущему каталогу.

Класс BA_RequestDataFilter использует статические методы и не требует создания объекта.