パート 1: OpenCart 2.1.x.x でカスタムプラグインを作成する方法-htmlチュートリアル-php.cn

開発者として、どのフレームワークでもカスタムコンテンツを構築するのは常に刺激的であり、OpenCart プラグインにも同じことが当てはまります。

この 2 部構成のシリーズでは、OpenCart でのカスタムプラグインの開発について説明します。初心者開発者の観点から、OpenCart での拡張機能開発の詳細を説明します。また、OpenCart プラグイン構造のさまざまな側面を示すための小さなカスタムプラグインも作成します。

最初の部分では、ストアのフロントエンドに最新の商品を表示するためのカスタムプラグインを構築します。バックエンド自体から商品の数量を設定できるようになります。この記事の目的は、構成フォームを備えたバックエンドプラグインを開発することです。

OpenCart の最新バージョン (この記事の執筆時点では 2.1.0.2) がセットアップされていると仮定します。実際のプラグインの開発に進む前に、次のセクションで OpenCart の基本的なプラグインアーキテクチャを紹介します。

MVCL の概要

OpenCart は、最も人気のある Web 開発パターン (MVC パターン) の 1 つを使用して開発されていますが、若干の変更が加えられている、またはむしろ追加と言えるでしょう。追加されたフォームは言語コンポーネントであり、OpenCart の世界では MVCL になります。このパターンについて聞いたことがあるかもしれませんが、まず最初に、それがどのようなものかを簡単に要約します。

MVC の M はモデルを表し、ビジネスロジックの大部分が存在します。 OpenCart のコンテキストでは、データベース抽象化レイヤーと対話して、ストアの運営に必要なすべての重労働を実行するモデルです。あなたは、ほとんどの場合、この分野で開発者として働いていることに気づくでしょう。

次に、V は View の略で、アプリケーションのプレゼンテーション層を表します。名前が示すように、これは任意のページのプレゼンテーションロジックのみを処理し、ほとんどの場合、他のレイヤーから入力を受け取り、XHTML 出力を生成します。アプリケーションのビジネスロジックは、この層から離れるべきであり、どのように行われるかではなく、何が行われるかのみを考慮する必要があります。 MVC の C (コントローラー) はすべての先頭にあり、各リクエストを処理し、それに応じて処理する責任があります。この領域には、ユーザー入力の処理と検証から、ページ出力を準備するための正しいモデルとビューコンポーネントの読み込みまで、アプリケーションロジックのほとんどが含まれています。

最後に、言語を表す追加コンポーネント L があります。多言語ウェブサイトの構築が簡単になります。

これは OpenCart アーキテクチャの概要です。各コンポーネントについて詳しく説明し続けると、さらに理解できるようになります。

OpenCart プラグインのスケルトン

カスタムバックエンドプラグイン用に実装する必要があるファイルのリストを簡単に見てみましょう。

: これは、管理アプリケーション領域全体で使用される静的タグを保持するファイルです。
: これは、モジュールのアプリケーションロジックを保持するコントローラーファイルです。
: これは、XHTML コードを含むビューテンプレートファイルです。

いつものように、カスタムプラグインファイルを

module

ディレクトリに配置する必要があります。この場合、バックエンドプラグインの開発時に、admin の下のディレクトリにファイルが保存されます。もちろん、上記の OpenCart アーキテクチャによれば、ファイルは異なるディレクトリまたはコンポーネントに分散されます。バックエンドプラグイン用のファイルを作成する

このセクションでは、モジュールファイルの作成を開始します。まず、次の内容の言語ファイル

admin/ language/english/module/recent_products.php

を作成します。 OpenCart の観点から見ると、これは OpenCart がプラグインを検出するために必要なファイルであるため、重要です。 リーリーご覧のとおり、静的タグを PHP 配列に割り当てます。後で配列が PHP 変数に変換されると、ビューテンプレートファイルでこれらの変数にアクセスできるようになります。

また、ファイルは

english

ディレクトリに作成されます。これはストアのデフォルト言語であるためです。もちろん、多言語 Web サイトの場合は、他の言語用にも作成する必要があります。たとえば、同じファイルのフランス語版を admin/ language/french/module/recent_products.php に作成する必要があります。次に、最も重要なプラグインファイルの 1 つであるコントローラーファイルを作成します。次の内容で

admin/controller/module/recent_products.php

を作成しましょう。 リーリーこれは、ベースの

Controller

クラスを拡張する、カスタムプラグインの新しいクラスを定義します。慣例により、クラスの名前は、ファイルが配置されているディレクトリ構造を模倣する必要があります。したがって、キャメルケースの命名規則に従ってスラッシュ文字とアンダースコア文字を置き換えることにより、パス controller/module/recent_products.php は ControllerModuleRecentProducts に変換されます。 <p>接下来，有一个事实上的 <code class="inline">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">&times;</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 代码，最重要的是它具有开箱即用的响应能力。

所以，这就是我们后端自定义插件的文件设置。