prestashop helpers

Aulas auxiliares para PrestaShop CMS

Classes auxiliares totalmente documentadas para PrestaShop CMS (8, 1.7, 1.6, 1.5). Com esses ajudantes algumas tarefas de programação tornam-se mais simples e rápidas. A página inicial da biblioteca.

Lista de ajudantes:

• ArrayHelper
• Auxiliar de back-end
• Ajudante de data
• Auxiliar de diagnóstico
• Ajudante de arquivo
• FormHelper
• HtaccessHelper
• LogHelper
• Módulo Auxiliar
• Ajudante de Objeto
• Ajudante de segurança
• StringHelper
• TradutorAjudante
• Ajudante de URL
• ValidarHelper
• Ajudante de produto

Lista de controladores:

• BaseModuleFrontController.php
• AjaxModuleFrontController.php

Lista de componentes:

• Cache
• QualidadeServiço
• Autoloader (composer usado que inicializa)

Exemplos

Cada método e classe está totalmente documentado, então aqui estão vários exemplos, ou seja, apenas um para cada classe.

ArrayHelper , indexando um array.

 $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 , gerando um array de origem para um elemento 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 , registrando um erro em um módulo.

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

DiagnosticHelper , verificando se um método foi substituído.

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

AjaxModuleFrontController , criando um controlador Ajax simples para um módulo.

 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 , obtendo uma instância de um módulo por determinado caminho de diretório.

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

FileHelper , obtendo um tamanho máximo real de arquivo que pode ser carregado em um site.

 $sizeInBytes = FileHelper::getFileSizeUploadLimit();

Componente de cache , armazenando em cache um resultado de consulta de banco de dados.

 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 , usando o autoloader do Composer para carregar automaticamente classes PHP, por exemplo, em um módulo adicionando classmap ao seu arquivo composer.json .

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

Instalação

Adicione a dependência diretamente ao seu arquivo composer.json :

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

Como ajudar o projeto a crescer e obter atualizações

Dê a estrela ao projeto. Isso é tudo! :)

Contribuindo para o código

Requisitos para contribuidores de código

Os colaboradores devem seguir as seguintes regras:

• Faça sua solicitação pull no branch dev , NÃO no branch master .
• Não atualize um número de versão auxiliar.
• Siga os padrões de codificação PSR.

Processo detalhado para contribuidores de código

Os colaboradores que desejarem editar os arquivos do projeto deverão seguir o seguinte processo:

1. Crie sua conta GitHub, caso ainda não tenha uma.
2. Bifurque o projeto para sua conta GitHub.
3. Clone seu fork em sua máquina local.
4. Crie uma ramificação em seu clone local do projeto para suas alterações.
5. Altere os arquivos em sua ramificação. Certifique-se de seguir os padrões de codificação.
6. Envie seu branch alterado para seu fork em sua conta GitHub.
7. Crie uma solicitação pull para suas alterações no branch dev do projeto. Se precisar de ajuda para fazer uma solicitação pull, leia a página de ajuda do GitHub sobre como criar solicitações pull.
8. Aguarde o mantenedor aplicar suas alterações.

Não hesite em criar uma solicitação pull se for difícil para você aplicar os padrões de codificação.