prestashop helpers

Вспомогательные классы для PrestaShop CMS

Полнодокументированные вспомогательные классы для PrestaShop CMS (8, 1.7, 1.6, 1.5). С помощью этих помощников некоторые задачи программирования становятся проще и выполняются быстрее. Домашняя страница библиотеки.

Список помощников:

• ArrayHelper
• BackendHelper
• Датахелпер
• Диагностический помощник
• FileHelper
• FormHelper
• HtaccessHelper
• Логхелпер
• МодульПомощник
• ОбъектХелпер
• SecurityHelper
• StringHelper
• TranslateHelper
• УрлХелпер
• ValidateHelper
• ПродуктПомощник

Список контроллеров:

• Базовыймодульфронтконтроллер.php
• AjaxModuleFrontController.php

Список компонентов:

• Кэш
• КачествоСервис
• Автозагрузчик (используется Composer, который загружается)

Примеры

Каждый метод и класс полностью документированы, поэтому здесь приведено несколько примеров, т.е. по одному для каждого класса.

ArrayHelper , индексирующий массив.

 $array = [
    ['id' => '123', 'data' => 'abc'],
    ['id' => '345', 'data' => 'def'],
];
$result = ArrayHelper::index($array, 'id');
// The result is:
// [
//     '123' => ['id' => '123', 'data' => 'abc'],
//     '345' => ['id' => '345', 'data' => 'def'],
// ]

FormHelper , генерирующий исходный массив для select элемента.

 $array = [
    ['123' => 'abc'],
    ['345' => 'def'],
];
$result = FormHelper::generateList($array);
// The result is:
// [
//     ['id' => '123', 'name' => 'abc'],
//     ['id' => '345', 'name' => 'def']
// ]

// The usage in a form definition:
array(
    'type'    => 'select',
    'label'   => 'Example',
    'name'    => 'example',
    'options' => array(
        'query' => $result,
        'id'    => 'id',
        'name'  => 'name',
    ),
)

LogHelper , регистрирующий ошибку в модуле.

 public function example() {
    $this->log('An error occupied.');
}
public function log($messages, $level = AbstractLogger::WARNING) {
    LogHelper::log($messages, $level, $this->name, $this->id);
}

DiagnosticHelper , проверяющий, не переопределен ли метод.

 if (DiagnosticHelper::isMethodOverridden('AddressController', 'init')) {
    $this->_errors[] = $this->l('The AddressController::init() already overridden.');
}

AjaxModuleFrontController , создающий простой Ajax-контроллер для модуля.

 class ExampleAjaxModuleFrontController extends AjaxModuleFrontController {
    protected function actionSave() {
        $this->ajaxResponse->result  = true;
        $this->ajaxResponse->message = 'Success!';
    }
}
// The output result is:
// {"result":true,"data":null,"html":"","message":"Success!","errors":[]}

ModuleHelper , получение экземпляра модуля по заданному пути к каталогу.

 $path   = '/var/www/prestashop/modules/homecategoriez/classes'; 
$module = ModuleHelper::getInstanceByPath($path); /** @var HomeCategoriez $module The instance of the module: HomeCategoriez */

FileHelper , получая реальный максимальный размер файла, который можно загрузить на сайт.

 $sizeInBytes = FileHelper::getFileSizeUploadLimit();

Компонент Cache , кэширующий результат запроса к БД.

 public function getAllCustomers() {
    $cacheKey = CacheProvider::getKeyName(__METHOD__);

    $data = CacheProvider::getInstance()->get($cacheKey);
    if (false === $data) {
        $data = Db::getInstance()->executeS('SELECT * FROM ps_customer', true, false);
        CacheProvider::getInstance()->set($cacheKey, $data, 60 * 60 * 24);
    }

    return $data;
}

Autoloader : использование автозагрузчика Composer для автоматической загрузки классов PHP, например, в модуле путем добавления карты классов в файл composer.json .

 "autoload": {
  "classmap": [
    "classes/",
    "interfaces/"
  ]
}

Установка

Добавьте зависимость непосредственно в файл composer.json :

 "repositories": [
  {
    "type": "vcs",
    "url": "https://github.com/zapalm/prestashop-helpers"
  }
],
"require": {
  "php": ">=5.5",
  "zapalm/prestashop-helpers": "dev-master"
},

Как помочь проекту расти и получать обновления

Дайте звезду проекту. Вот и все! :)

Вклад в код

Требования к разработчикам кода

Авторы должны соблюдать следующие правила:

• Сделайте запрос на включение в ветку dev , а НЕ в главную ветку.
• Не обновляйте номер версии помощника.
• Следуйте стандартам кодирования PSR.

Подробности процесса для разработчиков кода

Участники, желающие редактировать файлы проекта, должны следовать следующему процессу:

1. Создайте свою учетную запись GitHub, если у вас ее еще нет.
2. Создайте форк проекта в своей учетной записи GitHub.
3. Клонируйте свою вилку на локальный компьютер.
4. Создайте ветку в локальном клоне проекта для ваших изменений.
5. Измените файлы в своей ветке. Обязательно соблюдайте стандарты кодирования.
6. Отправьте измененную ветку на свою ветку в своей учетной записи GitHub.
7. Создайте запрос на внесение изменений в ветку разработки проекта. Если вам нужна помощь в создании запроса на включение, прочтите страницу справки GitHub о создании запросов на включение.
8. Подождите, пока сопровождающий применит ваши изменения.

Не стесняйтесь создавать запрос на включение, даже если вам сложно применять стандарты кодирования.