作為一名開發人員,在任何框架中構建自定義內容總是令人興奮的,對于 OpenCart 插件也是如此。
在這個由兩部分組成的系列中,我將解釋 OpenCart 中的自定義插件開發。我們將從新手開發者的角度來詳細介紹 OpenCart 中的擴展開發細節。我們還將創建一個小型自定義插件來演示 OpenCart 插件結構的各個方面。
在第一部分中,我們將構建一個自定義插件,用于在商店前端顯示最新產品,并且您將能夠從后端本身配置產品數量。這就是本文的目的——開發一個帶有配置表單的后端插件。
我假設您已經設置了最新版本的 OpenCart,在撰寫本文時為 2.1.0.2。在我們繼續開發實際的插件之前,我將在下一節中向您介紹 OpenCart 的基本插件架構。
MVCL 簡介
OpenCart 是使用最流行的 Web 開發模式之一(MVC 模式)開發的,但有一些細微的變化,或者更確切地說,我會說這是一個補充。添加的形式是語言組件,使其成為 OpenCart 世界中的 MVCL。您可能聽說過這種模式,但為了初學者,我將快速總結一下該模式的全部內容。
MVC 中的 M 代表模型,這是大部分業務邏輯所在的地方。在 OpenCart 的上下文中,它是與數據庫抽象層交互的模型,以完成運行商店所需的所有繁重工作。您會發現自己大部分時間都在這個領域擔任開發人員。
接下來,V代表View,它代表應用程序的表示層。顧名思義,它只處理任何頁面的表示邏輯,并且大多數時候它接收其他層的輸入并生成 XHTML 輸出。應用程序的業務邏輯應該遠離這一層;它應該只關心做什么而不是如何去做。
MVC 中的 C(控制器)位于所有內容的前面,負責處理每個請求并進行相應的處理。該區域包含大部分應用程序邏輯,從處理和驗證用戶輸入到加載正確的模型和視圖組件以準備頁面輸出。
最后,還有一個附加組件 L,代表語言。它使建立多語言網站變得輕而易舉。
這是 OpenCart 架構的快速視圖,當我們繼續深入解釋每個組件時,它會更有意義。
任何 OpenCart 插件的骨架
讓我們快速瀏覽一下需要為自定義后端插件實現的文件列表。
admin/language/english/module/recent_products.php
:這是一個保存在整個管理應用程序區域中使用的靜態標簽的文件。
admin/controller/module/recent_products.php
:它是一個控制器文件,保存我們模塊的應用程序邏輯。
admin/view/template/module/recent_products.tpl
:這是一個視圖模板文件,包含 XHTML 代碼。
在下一節中,我們將創建上述每個文件,并進行深入說明。
按照慣例,我們需要將自定義插件文件放置在模塊目錄下。在這種情況下,當我們開發后端插件時,admin 下的目錄將保存我們的文件。當然,根據上面所示的 OpenCart 架構,文件分布在不同的目錄或組件中。
為后端插件創建文件
在本節中,我們將開始創建模塊文件。首先,我們將創建一個語言文件 admin/language/english/module/recent_products.php
,其中包含以下內容。從 OpenCart 的角度來看,這是一個重要的文件,因為它是 OpenCart 檢測到您的插件所必需的。
<?php // admin/language/english/module/recent_products.php // Heading $_['heading_title'] = 'Recent Products'; // Text $_['text_module'] = 'Modules'; $_['text_success'] = 'Success: You have modified Recent Products module!'; $_['text_edit'] = 'Edit Recent Products Module'; // Entry $_['entry_name'] = 'Module Name'; $_['entry_limit'] = 'Limit'; $_['entry_status'] = 'Status'; // Error $_['error_permission'] = 'Warning: You do not have permission to modify Recent Products module!'; $_['error_name'] = 'Module Name must be between 3 and 64 characters!';
登錄后復制
如您所見,我們將靜態標簽分配給 PHP 數組。稍后,當數組轉換為 PHP 變量時,您將可以在視圖模板文件中訪問這些變量。
您可能還注意到,該文件是在 english 目錄下創建的,因為它是商店的默認語言。當然,對于多語言網站,您需要確保也為其他語言創建它。例如,應在 admin/language/french/module/recent_products.php
創建同一文件的法語版本。
接下來,我們將創建最重要的插件文件之一——控制器文件。讓我們繼續創建包含以下內容的 admin/controller/module/recent_products.php
。
<?php // admin/controller/module/recent_products.php class ControllerModuleRecentProducts extends Controller { private $error = array(); public function index() { $this->load->language('module/recent_products'); $this->document->setTitle($this->language->get('heading_title')); $this->load->model('extension/module'); if (($this->request->server['REQUEST_METHOD'] == 'POST') && $this->validate()) { if (!isset($this->request->get['module_id'])) { $this->model_extension_module->addModule('recent_products', $this->request->post); } else { $this->model_extension_module->editModule($this->request->get['module_id'], $this->request->post); } $this->session->data['success'] = $this->language->get('text_success'); $this->response->redirect($this->url->link('extension/module', 'token=' . $this->session->data['token'], 'SSL')); } $data['heading_title'] = $this->language->get('heading_title'); $data['text_edit'] = $this->language->get('text_edit'); $data['text_enabled'] = $this->language->get('text_enabled'); $data['text_disabled'] = $this->language->get('text_disabled'); $data['entry_name'] = $this->language->get('entry_name'); $data['entry_limit'] = $this->language->get('entry_limit'); $data['entry_status'] = $this->language->get('entry_status'); $data['button_save'] = $this->language->get('button_save'); $data['button_cancel'] = $this->language->get('button_cancel'); if (isset($this->error['warning'])) { $data['error_warning'] = $this->error['warning']; } else { $data['error_warning'] = ''; } if (isset($this->error['name'])) { $data['error_name'] = $this->error['name']; } else { $data['error_name'] = ''; } $data['breadcrumbs'] = array(); $data['breadcrumbs'][] = array( 'text' => $this->language->get('text_home'), 'href' => $this->url->link('common/dashboard', 'token=' . $this->session->data['token'], 'SSL') ); $data['breadcrumbs'][] = array( 'text' => $this->language->get('text_module'), 'href' => $this->url->link('extension/module', 'token=' . $this->session->data['token'], 'SSL') ); if (!isset($this->request->get['module_id'])) { $data['breadcrumbs'][] = array( 'text' => $this->language->get('heading_title'), 'href' => $this->url->link('module/recent_products', 'token=' . $this->session->data['token'], 'SSL') ); } else { $data['breadcrumbs'][] = array( 'text' => $this->language->get('heading_title'), 'href' => $this->url->link('module/recent_products', 'token=' . $this->session->data['token'] . '&module_id=' . $this->request->get['module_id'], 'SSL') ); } if (!isset($this->request->get['module_id'])) { $data['action'] = $this->url->link('module/recent_products', 'token=' . $this->session->data['token'], 'SSL'); } else { $data['action'] = $this->url->link('module/recent_products', 'token=' . $this->session->data['token'] . '&module_id=' . $this->request->get['module_id'], 'SSL'); } $data['cancel'] = $this->url->link('extension/module', 'token=' . $this->session->data['token'], 'SSL'); if (isset($this->request->get['module_id']) && ($this->request->server['REQUEST_METHOD'] != 'POST')) { $module_info = $this->model_extension_module->getModule($this->request->get['module_id']); } if (isset($this->request->post['name'])) { $data['name'] = $this->request->post['name']; } elseif (!empty($module_info)) { $data['name'] = $module_info['name']; } else { $data['name'] = ''; } if (isset($this->request->post['limit'])) { $data['limit'] = $this->request->post['limit']; } elseif (!empty($module_info)) { $data['limit'] = $module_info['limit']; } else { $data['limit'] = 5; } if (isset($this->request->post['status'])) { $data['status'] = $this->request->post['status']; } elseif (!empty($module_info)) { $data['status'] = $module_info['status']; } else { $data['status'] = ''; } $data['header'] = $this->load->controller('common/header'); $data['column_left'] = $this->load->controller('common/column_left'); $data['footer'] = $this->load->controller('common/footer'); $this->response->setOutput($this->load->view('module/recent_products.tpl', $data)); } protected function validate() { if (!$this->user->hasPermission('modify', 'module/recent_products')) { $this->error['warning'] = $this->language->get('error_permission'); } if ((utf8_strlen($this->request->post['name']) < 3) || (utf8_strlen($this->request->post['name']) > 64)) { $this->error['name'] = $this->language->get('error_name'); } return !$this->error; } }
登錄后復制
它為我們的自定義插件定義了新類,該類擴展了基本 Controller
類。根據約定,類的名稱應模仿文件所在的目錄結構。因此,路徑 controller/module/recent_products.php
會根據駝峰命名約定替換斜杠和下劃線字符,轉換為 ControllerModuleRecentProducts
!
接下來,有一個事實上的 index
方法,當插件加載到前端時會調用該方法。所以,它是一個索引方法,定義了插件的大部分應用邏輯。
在當前應用程序的上下文中,簡寫 $this->load->language
加載相應的語言文件。在我們的例子中,它加載前面部分中定義的語言文件。語法非常簡單,您只需傳遞前綴為 module/
的插件名稱即可。語言變量可以通過 $this->language->get
方法訪問。
接下來,它使用文檔對象的 setTitle
方法設置頁面標題。
繼續,簡寫 $this->load->model
用于加載模塊模型。它是模型類,提供實用方法來保存模塊參數等。
接下來,有一個重要的代碼片段,如下所示,用于檢查是否是 POST 數據提交,并在這種情況下保存模塊配置。
if (($this->request->server['REQUEST_METHOD'] == 'POST') && $this->validate()) { if (!isset($this->request->get['module_id'])) { $this->model_extension_module->addModule('recent_products', $this->request->post); } else { $this->model_extension_module->editModule($this->request->get['module_id'], $this->request->post); } $this->session->data['success'] = $this->language->get('text_success'); $this->response->redirect($this->url->link('extension/module', 'token=' . $this->session->data['token'], 'SSL')); }
登錄后復制
此外,我們還將 heading_title
和 text_edit
等語言標簽分配給 $data
數組,以便我們可以使用它們在視圖模板文件中。
接下來,有一個片段可以為配置頁面構建正確的面包屑鏈接。
$data['breadcrumbs'] = array(); $data['breadcrumbs'][] = array( 'text' => $this->language->get('text_home'), 'href' => $this->url->link('common/dashboard', 'token=' . $this->session->data['token'], 'SSL') ); $data['breadcrumbs'][] = array( 'text' => $this->language->get('text_module'), 'href' => $this->url->link('extension/module', 'token=' . $this->session->data['token'], 'SSL') ); if (!isset($this->request->get['module_id'])) { $data['breadcrumbs'][] = array( 'text' => $this->language->get('heading_title'), 'href' => $this->url->link('module/recent_products', 'token=' . $this->session->data['token'], 'SSL') ); } else { $data['breadcrumbs'][] = array( 'text' => $this->language->get('heading_title'), 'href' => $this->url->link('module/recent_products', 'token=' . $this->session->data['token'] . '&module_id=' . $this->request->get['module_id'], 'SSL') ); }
登錄后復制
如果模塊之前已配置并處于編輯模式,則以下代碼片段將填充默認模塊配置。
if (isset($this->request->get['module_id']) && ($this->request->server['REQUEST_METHOD'] != 'POST')) { $module_info = $this->model_extension_module->getModule($this->request->get['module_id']); }
登錄后復制
最后,我們加載常見的頁面元素,例如頁眉、頁腳和左側邊欄。另外,它是加載實際視圖文件 recent_products.tpl
并顯示配置表單的 $this->load->view
簡寫。
控制器文件中有一些重要的注釋需要記住。您會看到很多類似 $this->load->ELEMENT
的調用,其中 ELEMENT
可以是視圖、模型或語言。它加載相應的視圖、模型和語言組件。
今天文章的下一個也是最后一個文件是視圖模板文件admin/view/template/module/recent_products.tpl
。繼續創建它!
<!-- admin/view/template/module/recent_products.tpl --> <?php echo $header; ?><?php echo $column_left; ?> <div id="content"> <div class="page-header"> <div class="container-fluid"> <div class="pull-right"> <button type="submit" form="form-recent-products" data-toggle="tooltip" title="<?php echo $button_save; ?>" class="btn btn-primary"><i class="fa fa-save"></i></button> <a href="<?php echo $cancel; ?>" data-toggle="tooltip" title="<?php echo $button_cancel; ?>" class="btn btn-default"><i class="fa fa-reply"></i></a></div> <h1><?php echo $heading_title; ?></h1> <ul class="breadcrumb"> <?php foreach ($breadcrumbs as $breadcrumb) { ?> <li><a href="<?php echo $breadcrumb['href']; ?>"><?php echo $breadcrumb['text']; ?></a></li> <?php } ?> </ul> </div> </div> <div class="container-fluid"> <?php if ($error_warning) { ?> <div class="alert alert-danger"><i class="fa fa-exclamation-circle"></i> <?php echo $error_warning; ?> <button type="button" class="close" data-dismiss="alert">×</button> </div> <?php } ?> <div class="panel panel-default"> <div class="panel-heading"> <h3 class="panel-title"><i class="fa fa-pencil"></i> <?php echo $text_edit; ?></h3> </div> <div class="panel-body"> <form action="<?php echo $action; ?>" method="post" enctype="multipart/form-data" id="form-recent-products" class="form-horizontal"> <div class="form-group"> <label class="col-sm-2 control-label" for="input-name"><?php echo $entry_name; ?></label> <div class="col-sm-10"> <input type="text" name="name" value="<?php echo $name; ?>" placeholder="<?php echo $entry_name; ?>" id="input-name" class="form-control" /> <?php if ($error_name) { ?> <div class="text-danger"><?php echo $error_name; ?></div> <?php } ?> </div> </div> <div class="form-group"> <label class="col-sm-2 control-label" for="input-limit"><?php echo $entry_limit; ?></label> <div class="col-sm-10"> <input type="text" name="limit" value="<?php echo $limit; ?>" placeholder="<?php echo $entry_limit; ?>" id="input-limit" class="form-control" /> </div> </div> <div class="form-group"> <label class="col-sm-2 control-label" for="input-status"><?php echo $entry_status; ?></label> <div class="col-sm-10"> <select name="status" id="input-status" class="form-control"> <?php if ($status) { ?> <option value="1" selected="selected"><?php echo $text_enabled; ?></option> <option value="0"><?php echo $text_disabled; ?></option> <?php } else { ?> <option value="1"><?php echo $text_enabled; ?></option> <option value="0" selected="selected"><?php echo $text_disabled; ?></option> <?php } ?> </select> </div> </div> </form> </div> </div> </div> </div> <?php echo $footer; ?>
登錄后復制
眼尖的用戶已經注意到它只是顯示從控制器文件傳遞的變量。除此之外,它是顯示配置表單的簡單 XHTML 代碼,最重要的是它具有開箱即用的響應能力。
所以,這就是我們后端自定義插件的文件設置。
啟用插件
前往 OpenCart 后端并導航至擴展 > 模塊。您應該在列表中看到最近的產品。單擊+符號安裝模塊,如以下屏幕截圖所示。
安裝后,您將看到一個編輯圖標。單擊該按鈕可打開模塊配置表單。
在配置表單中,您可以設置要在前端塊中顯示的最近產品的數量。另外,不要忘記將狀態字段設置為啟用!保存模塊,它應該看起來像這樣。
模塊中有一個新條目,標題為最近的產品 > 我最近的塊插件。原因是您可以為不同的頁面多次復制它!
所以,我們快完成了!我們在 OpenCart 中制作了一個成熟的后端自定義插件。在下一部分中,我們將介紹它的前端對應部分,它在前端顯示一個漂亮的產品塊!
結論
今天,我們討論了 OpenCart 中的自定義插件開發。在這個由兩部分組成的系列的第一部分中,我們完成了后端插件開發并創建了一個提供配置表單的工作自定義插件。
如果您正在尋找可在自己的項目或自己的教育中使用的其他 OpenCart 工具、實用程序、擴展程序等,請查看我們在市場上提供的產品。
在下一部分中,我們將通過創建在前端顯示產品列表的前端部分來完成該插件。如有任何疑問和反饋,請使用下面的評論源。
以上就是第一部分:如何在 OpenCart 2.1.x.x 中創建自定義插件的詳細內容,更多請關注www.92cms.cn其它相關文章!