20120824_ハンズオンセミナー資料_第1部

1

EC-CUBE Plugin

Copyright c LOCKON CO.,LTD. All Rights Reserved. 2 2

自己紹介

吉本啓顕勤務先

株式会社ロックオン

主な仕事

プロモーション・開発・運用・サポート


今回のセミナーテーマ


Agenda


Agenda

6

EC-CUBEとは？

新コンセプト EC Open Platform


プラグインで出来る事

・EC-CUBEの本体処理に介入する。

・テンプレートに変更を加える。


Agenda






本体処理に介入

・フォームからのPOST値を変更する。

・別のページに遷移させる。

・全く別の処理を実行する。



・フォームからのPOST値を変更する。

REQUEST{

‘mode’ = car t,

‘product_id’ = 1

‘quantity’ = 1

‘price’ = 100

}

REQUEST{

‘mode’ = car t,

‘product_id’ = 1

‘quantity’ = 1

‘price’ = 0

}



・別のページに遷移させるカート

配送方法選択

支払方法選択

確認

購入完了

見積り入力



・全く別の処理を実行する。初期化

商品の価格計算

配送料計算

消費税の計算新消費税の計算

合計の計算



本体処理A

本体処理B

本体処理C

プラグイン処理



controller

model view

request response

Pageクラス

SCクラス Viewクラス

Smarty



なんでも出来る。






テンプレートに変更を加える

・ボタンを追加する。

・フォームを追加する。

・テーブルを消す。


Agenda


プラグインの作り方

カテゴリ・コンテンツ。


カテゴリコンテンツ

①商品カテゴリー毎にデータを持たせる。

②該当のカテゴリが選択・表示される際に

データを持ってきて画面に表示する。


カテゴリコンテンツ

demonstration



CategoryContents.php (プラグインメインクラス) [必須]

CategoryContents.tar.gz

plugin_info.php (プラグイン情報) [必須]

plugin_update.php (アップデートクラス)

logo.png (縦65x横65ピクセル)

categorycontents_products_list_add.tpl

categorycontents_admin_basis_category_add.tpl

用意するファイル



①商品カテゴリー毎にデータを持たせる。

②該当のカテゴリが選択・表示される際に

データを持ってきて画面に表示する。


plugin

SC_Helper_Plugin（エンジンクラス）

本体処理に介入する流れ

controller

LC_Page_Products_List

view

Viewクラス

CategoryContents

LC_Page_Products_List_action_after

dtb_plugin







config.php (設定クラス)






プラグインメインクラス

CategoryContents.php (プラグインメインクラス)



CategoryContents.php (プラグインメインクラス)

フックポイント通過時に実行する

コールバック関数



function disp_contents($objPage) {

// 選択されたカテゴリーID

$category_id = $objPage->arrSearchData['category_id'];

if(!empty($category_id)){

$array_category = CategoryContents::getCategoryByCategoryId($category_id);

$objPage->plg_categoryContents_category_contents

= $array_category['plg_categorycontents_category_contents'];

}

}

CategoryContents.php(プラグインメインクラス)










}

}


カテゴリーのIDをキーに登録されたコンテンツを取得する










}

}


フックしたページクラスのインスタンス







config.php (設定クラス)





プラグイン情報

plugin_info.php (プラグイン情報)



plugin_info.php (プラグイン情報)

フックポイントと

コールバック関数を定義



plugin_info.php(プラグイン情報)

class plugin_info {

static $PLUGIN_CODE = "CategoryContents ";

static $PLUGIN_NAME = "カテゴリ・コンテンツ";

static $PLUGIN_VERSION = "0.1";

static $COMPLIANT_VERSION = "2.12.0";

static $AUTHOR = “株式会社ロックオン";

static $DESCRIPTION = “カテゴリにコンテンツを表示。";

static $PLUGIN_SITE_URL = "http://www.ec-cube.net/";

static $AUTHOR_SITE_URL = "http:// www.ec-cube.net /";

static $CLASS_NAME = "SampleClassHook";

static $HOOK_POINTS = array(

array(" LC_Page_Admin_Products_Category_action_after ", 'contents_set'),

array(" LC_Page_Products_List_action_after ", 'disp_contents'),

array("prefilterTransform", 'prefilterTransform'));

}

介入したいフックポイントとコールバック関数定義




class plugin_info {












array(" LC_Page_Products_List_action_after ", 'disp_contents'), array("prefilterTransform", 'prefilterTransform'));

}




class plugin_info {













}

介入したい場所




class plugin_info {













}

実行する関数



dtb_plugin_hookpoint

CREATE TABLE `dtb_plugin_hookpoint` (

`plugin_hookpoint_id` int(11) NOT NULL,

`plugin_id` int(11) NOT NULL,

`hook_point` text NOT NULL,

`callback` text, `create_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,

`update_date` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',

PRIMARY KEY (`plugin_hookpoint_id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8

$HOOK_POINTSで定義した定数は

インストール時に以下のテーブルにINSERTされます。


まとめ

実行したい関数をメインクラスに作成

作成した関数とフックポイントを

設定ファイルに定義


テンプレート変更の仕組み

テンプレートファイル

コンパイルファイル

解析

plugin

SC_Helper_Plugin

pre filter



コンパイルファイル

一度コンパイルファイルが生成されると次回からはコンパイルファイルが参照される

SC_Helper_Transform


実例



<h2 class="title"></h2>





<ul class="pagecond_area">

<li><strong>商品カテゴリ：</strong></li>

<li><strong>商品名：</strong></li>

</ul>







<div></div>



<h2 class="title"></h2>





<ul class="pagecond_area">

<li><strong>商品カテゴリ：</strong></li>

<li><strong>商品名：</strong></li>

</ul>







function prefilterTransform(&$source, LC_Page_Ex $objPage, $filename) {

$objTransform = new SC_Helper_Transform($source);

$template_dir = PLUGIN_UPLOAD_REALDIR . 'CategoryContents/templates/';

switch($objPage->arrPageLayout['device_type_id']){

case DEVICE_TYPE_MOBILE:

case DEVICE_TYPE_SMARTPHONE:

case DEVICE_TYPE_PC:

// 商品一覧画面

if (strpos($filename, 'products/list.tpl') !== false) { $objTransform->select('h2.title')->insertBefore(file_get_contents($template_dir . 'categorycontents_products_list_add.tpl'));

}

break;

default:

break;

}

$source = $objTransform->getHTML();

}




class plugin_info {












array(" LC_Page_Products_List_action_after ", 'disp_contents'),

array("prefilterTransform", 'prefilterTransform'));

}












}

break;

default:

break;

}


}

コールされたテンプレートのソース












}

break;

default:

break;

}


}

コール元のPageオブジェクト












}

break;

default:

break;

}


}

コールされたテンプレートのファイル名












}

break;

default:

break;

}


}




$objTransform = new SC_Helper_Transform($source); $template_dir = PLUGIN_UPLOAD_REALDIR . 'CategoryContents/templates/';






if (strpos($filename, 'products/list.tpl') !== false) {

$objTransform->select('h2.title')->insertBefore(

file_get_contents($template_dir . 'categorycontents_products_list_add.tpl')

); }

break;

default:

break;

}


}













); }

break;

default:

break;

}


}

変更を加えるソース













); }

break;

default:

break;

}


}













); }

break;

default:

break;

}


}













); }

break;

default:

break;

}


}

要素を指定













); }

break;

default:

break;

}


}

指定した要素の操作













); }

break;

default:

break;

}


}

プラグインで用意したテンプレートを指定


テンプレート変更のまとめ

テンプレートで変更したい要素をDOM形式で指定

要素に対する操作を実行


カテゴリコンテンツおさらい

controller

model view

Pageクラス

SCクラス Viewクラス

Smarty

SC_Helper_Plugin

CategoryContents

①

② ③

①インスタンス生成

②PHP処理介入

③テンプレート介入

20120824_ハンズオンセミナー資料_第1部

News & Politics