Cấu trúc file của một Prestashop module

Một module được cấu thành bởi nhiều files, tất cả files được lưu trong một folder có cùng tên với module, các modules của Prestashop được lưu trư trong folder: ProJect_name_foler/modules/
Dưới đây là các files và folder cho một Prestashop 1.6 modules:

Chỉ có ba cái đầu tiên là cần thiết cho một module cơ bản: the main file, file cấu hình(Prestashop tự đông tạp ra) và icon file. Tất cả những thứ khác có thể sử dụng nếu như cần thiết, module có thể làm việc nếu không có chúng. Module có thể có nhiều tập tin và thư mục khác khi cần thiết.

Nếu bạn muốn sử dụng thư viện, bạn nên có một folder chuyên dụng. Tên folder có tên như sau: lib, libs, libraries, sdk, vendor, vendors...

Tạo một module nào

Chúng ta hãy đi tạo một module đơn giản. Điều sẽ cho phép bạn hiểu hơn về cấu trúc module Prestashop. We will set name là "My module".
Đầu tiên tạo module folder, trong /modules folder. no phải có tên cùng tên module, không khoảng cách. chỉ có chữ vào số, dấu gạch nối và dấu gạch dưới, tất cả chữ thường: /mymodule.
Folder phải chứa file chính, một file PHP same như tên của module folder, Nó sẽ xử lí hầu hết các quá trình của module: mymodule.php

Điều này là đủ cho một module cơ bản nhưng ta có thể thêm nhiều tệp hoặc folder sau này khi cần đến.

The constant test

ở đầu mỗi file PHP trong Prestashop chúng ta cần có đoạn code sau.

<?php   
if (!defined('_PS_VERSION_'))
  exit;

Điều này sẽ kiểm tra Prestashop version luôn phải tồn tại và nếu nó không tồn tại nó sẽ stop module. Mục đích của điều này là để ngăn chặn các truy cập từ bên ngoài và tải các tập tin trực tiếp.

Lưu ý, theo tiêu chuẩn của Prestashop thì chúng ta không sử dụng đóng thẻ php ?>

Class chính mymodule.php

file chính chứ class chính của module(cũng có thể định nghĩa các class khác nếu cần nhưng không nên định nghĩ trong cùng 1 file). Prestashop sử dụng OOP và các modules của nó cũng vậy.
Tên class phải giống tên của module và tên file chính nhưng sử dụng CamelCase(cách viết lạc đà). ví dụ: MyModule.
Hơn nữa class này phải extend từ Module class để có thể kế thừa tất cả các methods và thuộc tính.

<?php
if (!defined('_PS_VERSION_'))
  exit;
 
class MyModule extends Module
{
}

ngoài việc extend từ Module class thì bạn có thể extend từ các class khác như: PaymentModule, ModuleGridEngine, ModuleGraph... tùy vào nhu cầu sử dụng module.
Ở giai đoạn này, Nếu bạn coppy folder mymodule và folder /modules thì mymodule có thể tồn tại trong "Modules" page back office, trong "Other Module" tab mặc dù không tên không có logo.

Phương thức constuctor

Bây giờ, Chúng ta sẽ viết code vào phương thức constructor của class mymodule. constructor là một function trong class tự động được gọi khi you tạo mới mới instance của class. Trong Prestashop, Constructor là phương thức được gọi đầu tiên khi module load bởi Prestashop.

<?php
if (!defined('_PS_VERSION_'))
  exit;
 
class MyModule extends Module
{
  public function __construct()
  {
    $this->name = 'mymodule';
    $this->tab = 'front_office_features';
    $this->version = '1.0.0';
    $this->author = 'Firstname Lastname';
    $this->need_instance = 0;
    $this->ps_versions_compliancy = array('min' => '1.5', 'max' => 1.6);
    $this->bootstrap = true;
 
    parent::__construct();
 
    $this->displayName = $this->l('My module');
    $this->description = $this->l('Description of my module.');
 
    $this->confirmUninstall = $this->l('Are you sure you want to uninstall?');
 
    if (!Configuration::get('MYMODULE_NAME'))      
      $this->warning = $this->l('No name provided');
  }
}

Hãy bắt đầu đi vào từng dòng trong MyModule class

public function __construct()

dòng này định nghĩa ra constructor method.

$this->name = 'mymodule';
$this->tab = 'front_office_features';
$this->version = '1.0';
$this->author = 'Firstname Lastname';

Phần này gán một số thuộc tính cho module:

• thuộc tính name: định danh mà ta có thể sử dụng bên trong module. giá trị của nó phải là tên của module folder. không sử dụng kí tự đặc biệt, khoảng trắng. chỉ dùng chữ viết thường.
• thuộc tính tab : nó định nghĩa ra để biết được rằng nó sẽ nằm trong tab nào của module list in Prestashop backoffice module list. bạn có thể chọn một tên đã tồn tại hoặc tự đặt một một tên. chúng ta sẽ chọn front_office_features bởi vì module có thao tác với front office
  Dưới đây là danh sách các tab có sẵn. và tên hiển thị của chúng trong module page.

  thuộc tínhtab	hiển thị trong backoffice
  administration	Administration
  advertising_marketing	Advertising & Marketing
  analytics_stats	Analytics & Stats
  billing_invoicing	Billing & Invoices
  checkout	Checkout
  content_management	Content Management
  dashboard	Dashboard
  emailing	E-mailing
  export	Export
  front_office_features	Front Office Features
  i18n_localization	I18n & Localization
  market_place	Market Place
  merchandizing	Merchandizing
  migration_tools	Migration Tools
  mobile	Mobile
  others	Other Modules
  payments_gateways	Payments & Gateways
  payment_security	Payment Security
  pricing_promotion	Pricing & Promotion
  quick_bulk_update	Quick / Bulk update
  search_filter	Search & Filter
  seo	SEO
  shipping_logistics	Shipping & Logistics
  slideshows	Slideshows
  smart_shopping	Smart Shopping
  social_networks	Social Networks

• Thuộc tính version: số version của module. sẽ suất hiện trong module list. nó là chỗi, để bạn có thể sử dụng 0.1, 0.2 hoặc 1.0 beta...
• Thuộc tính author: Tên tác giả của module sẽ show trong module list Tiếp theo với đoạn code sau:

$this->need_instance = 0;
$this->ps_versions_compliancy = array('min' => '1.5', 'max' => 1.6); 
$this->bootstrap = true;

Phân này nó xử lí mối quan hệ với module và môi trường:
- need_instance: Cho biết rằng có load module này hay không khi đang ở module page backoffice. nếu bạn đặt là 0 thì module sẽ không được load ở trang module và ngược lại
- ps_versions_compliancy: Cho biết rằng module bạn đang viết hoạt động được trên nhưng phiên bản nào của Prestashop. Trên ví dụ trên thì module sẽ hoạt động trên phiên bản nhỏ nhất là 1.5.x.x và lớn nhất là 1.6.x.x
- bootstrap: cho biết rằng các template của module đã được xây dựng bởi Prestashop 1.6 bootstrap.

Tiếp theo, chúng ta gọi constructor method từ class cha: parent::__construct();. và bạn phải sử dụng nó sau $this->name và trước khi $this->l()

Phần tiếp theo này chủ yếu liên quan tới phương thức dịch(l()) trong Prestashop 1.6

$this->displayName = $this->l('My module');
$this->description = $this->l('Description of my module.');
 
$this->confirmUninstall = $this->l('Are you sure you want to uninstall?');
 
if (!Configuration::get('MYMODULE_NAME'))  
    $this->warning = $this->l('No name provided.'); 

• displayName tên của module sẽ show trong module list
• description mô tả của module sẽ show trong module list
• confirmUninstall một messager bắn ra trước khi bạn muốn xác nhận gỡ bỏ module
• cuối cùng một cảnh báo rằng module chưa có trong DB

Phương thức constructor bây giờ là ok. Bạn có thể thêm nhiều hơn nếu cần thiết thêm biến để sử dụng. nhưng như này là đủ cho một module cơ bản.
Bây giờ hay vào backoffice để nhận được thành quả nào:
Bạn có thể click install nhưng chưa có tác dụng gì cả bởi chúng ta chưa viết code cho install method.

Mình xin tạm dừng bài viết ở đây vì đã quá dài, ở bài tiếp theo mình sẽ giới thiệu về install và uninstall trong module. đón chờ nhé...
Nguồn bài viết: http://doc.prestashop.com/pages/viewpage.action?pageId=51184607