prestashop helpers

Clases de ayuda para PrestaShop CMS

Clases de ayuda completamente documentadas para PrestaShop CMS (8, 1.7, 1.6, 1.5). Con estos ayudantes, algunas tareas de programación se vuelven más simples y más rápidas. La página de inicio de la biblioteca.

Lista de ayudantes:

• Ayudante de matriz
• Ayudante de backend
• Ayudante de fecha
• Ayudante de diagnóstico
• Ayudante de archivos
• Ayudante de formulario
• HtaccessHelper
• Ayudante de registro
• Ayudante del módulo
• Ayudante de objetos
• Ayudante de seguridad
• Ayudante de cuerdas
• TraducirAyudante
• Ayudante de URL
• ValidarAyudante
• Ayudante de Producto

Lista de controladores:

• BaseModuleFrontController.php
• AjaxModuleFrontController.php

Lista de componentes:

• Cache
• CalidadServicio
• Autocargador (compositor usado que va al arranque)

Ejemplos

Cada método y clase está completamente documentado, por lo que aquí hay varios ejemplos, es decir, solo uno para cada clase.

ArrayHelper , indexando una matriz.

 $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 , generando una matriz fuente para un 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 un error en un 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 , que comprueba si se anula un método.

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

AjaxModuleFrontController , creando un controlador Ajax simple para un 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 , que obtiene una instancia de un módulo mediante una ruta de directorio determinada.

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

FileHelper , obteniendo un tamaño de archivo máximo real que se puede cargar en un sitio.

 $sizeInBytes = FileHelper::getFileSizeUploadLimit();

Componente de caché , que almacena en caché el resultado de una consulta de base de datos.

 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 , que utiliza el cargador automático de Composer para cargar automáticamente clases PHP, por ejemplo, en un módulo agregando classmap a su archivo composer.json .

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

Instalación

Agregue la dependencia directamente a su archivo composer.json :

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

Cómo ayudar al proyecto a crecer y obtener actualizaciones

Dale la estrella al proyecto. ¡Eso es todo! :)

Contribuyendo al código

Requisitos para los contribuyentes de código

Los contribuyentes deben seguir las siguientes reglas:

• Realice su solicitud de extracción en la rama de desarrollo , NO en la rama maestra .
• No actualice un número de versión auxiliar.
• Siga los estándares de codificación PSR.

Proceso en detalles para contribuyentes de código

Los contribuyentes que deseen editar los archivos del proyecto deben seguir el siguiente proceso:

1. Crea tu cuenta de GitHub, si aún no tienes una.
2. Bifurca el proyecto en tu cuenta de GitHub.
3. Clona tu bifurcación en tu máquina local.
4. Cree una rama en su clon local del proyecto para sus cambios.
5. Cambie los archivos en su sucursal. Asegúrese de seguir los estándares de codificación.
6. Empuje su rama modificada a su bifurcación en su cuenta de GitHub.
7. Cree una solicitud de extracción para sus cambios en la rama de desarrollo del proyecto. Si necesita ayuda para realizar una solicitud de extracción, lea la página de ayuda de GitHub sobre cómo crear solicitudes de extracción.
8. Espere a que el mantenedor aplique sus cambios.

No dude en crear una solicitud de extracción si incluso le resulta difícil aplicar los estándares de codificación.