120512 phpカンファレンス用資料

1

EC-CUBEプラグイン機能について

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

自己紹介

吉本啓顕（よしもとひろあき）

勤務先

株式会社ロックオン

EC-CUBE プロジェクト担当

主な仕事

プロジェクト管理

開発

運用・サポート


運営会社紹介

株式会社ロックオン

• 2001年6月4日設立

• 従業員：54名

（平均：約30歳）

• 本社：大阪(梅田)

• 支社：東京(銀座)、シリコンバレー

ベトナム（オフショア拠点）

• 経営理念：Impact On The World


ロックオン製品紹介

つくる

はかる

運用する

分析する


今日のテーマ


Agenda


EC-CUBEとは？


EC-CUBEとは？

EC構築オープンソースとして

国内No.1シェア


EC-CUBEとは？

1万7000店舗以上


EC-CUBEとは？


EC-CUBEとは？

demonstration


Agenda


ソフトウェア要件

IIS


EC-CUBEの構造

controller

model view

request response

Pageクラス

SCクラス Viewクラス

Smarty


EC-CUBEの構造

controller

model view

request response

Pageクラス


Smarty


Agenda


プラグインで出来る事

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

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



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

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

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



なんでも出来る。



・ボタンを追加する。

・フォームを追加する。

・テーブルを消す。



controller

model view

request response

Pageクラス


Smarty


Agenda


プラグインの作り方

何を作るのか？



カテゴリ・コンテンツ。



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

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

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



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







config.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(プラグインメインクラス)



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(プラグイン情報)

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 {













}

実行する関数



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

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

設定ファイルに定義


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

テンプレートファイル

コンパイルファイル

解析

plugin

SC_Helper_Plugin

pre filter



コンパイルファイル

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

<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>





SC_Helper_Transform

plugin

SC_Helper_Plugin




$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;

}


}

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



テンプレートで

変更した要素を指定

要素に対する操作



カテゴリ・コンテンツ。


Agenda


おまけ

120512 phpカンファレンス用資料

Entertainment & Humor