prestashop helpers

Hilfsklassen für PrestaShop CMS

Vollständig dokumentierte Hilfsklassen für PrestaShop CMS (8, 1.7, 1.6, 1.5). Mit diesen Helfern werden einige Programmieraufgaben einfacher und schneller erledigt. Die Homepage der Bibliothek.

Helferliste:

• ArrayHelper
• BackendHelper
• DateHelper
• DiagnosticHelper
• FileHelper
• FormHelper
• HtaccessHelper
• LogHelper
• ModuleHelper
• ObjectHelper
• SecurityHelper
• StringHelper
• TranslateHelper
• URLHelper
• ValidateHelper
• ProduktHelper

Controller-Liste:

• BaseModuleFrontController.php
• AjaxModuleFrontController.php

Komponentenliste:

• Cache
• Qualitätsservice
• Autoloader (verwendeter Composer, der bootet)

Beispiele

Jede Methode und Klasse ist vollständig dokumentiert, daher finden Sie hier mehrere Beispiele, dh nur eines für jede Klasse.

ArrayHelper , Indizierung eines Arrays.

 $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 generiert ein Quellarray für ein select Element.

 $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 , Protokollierung eines Fehlers in einem Modul.

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

DiagnosticHelper prüft, ob eine Methode überschrieben wird.

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

AjaxModuleFrontController , wodurch ein einfacher Ajax-Controller für ein Modul erstellt wird.

 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 , ruft eine Instanz eines Moduls anhand des angegebenen Verzeichnispfads ab.

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

FileHelper , um eine tatsächliche maximale Dateigröße zu ermitteln, die auf eine Website hochgeladen werden kann.

 $sizeInBytes = FileHelper::getFileSizeUploadLimit();

Cache-Komponente , Zwischenspeicherung eines DB-Abfrageergebnisses.

 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 : Verwenden Sie den Autoloader von Composer, um PHP-Klassen automatisch zu laden, beispielsweise in einem Modul , indem Sie eine Klassenzuordnung zu Ihrer Datei composer.json hinzufügen.

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

Installation

Fügen Sie die Abhängigkeit direkt zu Ihrer composer.json Datei hinzu:

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

So helfen Sie dem Projekt, zu wachsen und Updates zu erhalten

Geben Sie dem Projekt den Stern . Das ist alles! :) :)

Mitwirken am Code

Anforderungen an Code-Mitwirkende

Mitwirkende müssen die folgenden Regeln befolgen:

• Stellen Sie Ihre Pull-Anfrage im Dev -Zweig , NICHT im Master -Zweig.
• Aktualisieren Sie keine Hilfsversionsnummer.
• Befolgen Sie die PSR-Codierungsstandards.

Einzelheiten zum Prozess für Code-Mitwirkende

Mitwirkende, die die Dateien des Projekts bearbeiten möchten, sollten dem folgenden Verfahren folgen:

1. Erstellen Sie Ihr GitHub-Konto, falls Sie noch keines haben.
2. Verzweigen Sie das Projekt in Ihr GitHub-Konto.
3. Klonen Sie Ihren Fork auf Ihren lokalen Computer.
4. Erstellen Sie für Ihre Änderungen einen Zweig in Ihrem lokalen Klon des Projekts.
5. Ändern Sie die Dateien in Ihrer Filiale. Beachten Sie unbedingt die Codierungsstandards.
6. Schieben Sie Ihren geänderten Branch in Ihren Fork in Ihrem GitHub-Konto.
7. Erstellen Sie eine Pull-Anfrage für Ihre Änderungen im Entwicklungszweig des Projekts. Wenn Sie Hilfe beim Erstellen einer Pull-Anfrage benötigen, lesen Sie die GitHub-Hilfeseite zum Erstellen von Pull-Anfragen.
8. Warten Sie, bis der Betreuer Ihre Änderungen übernimmt.

Zögern Sie nicht, eine Pull-Anfrage zu erstellen, auch wenn es für Sie schwierig ist, die Codierungsstandards anzuwenden.