EC-CUBEで受注管理系プラグインを開発する場合に押さえておきたいフックポイントまとめ
EC-CUBEで注文管理データをプラグイン開発等でコントロールする場合、利用できるフックポイントとしては以下のものがあります（Ver 2.12.2を元に分析）。
フックポイント一覧
| フックポイント名 | コールされるタイミング | 引数の$objPageの型 |
|---|---|---|
| LC_Page_Admin_Order_action_before | 「受注管理」画面の構築前 | LC_Page_Admin_Order_Ex |
| LC_Page_Admin_Order_action_csv | 「受注管理」画面でCSVダウンロード時 | |
| LC_Page_Admin_Order_action_after | 「受注管理」画面の構築後 | |
| LC_Page_Admin_Order_Disp_action_before | 受注情報画面の構築前(「対応状況管理」→「注文番号」で表示) | LC_Page_Admin_Order_Disp_Ex |
| LC_Page_Admin_Order_Disp_action_after | 受注情報画面の構築後 | |
| LC_Page_Admin_Order_Edit_action_before | 受注登録編集画面の構築前 | LC_Page_Admin_Order_Edit_Ex |
| LC_Page_Admin_Order_Edit_action_after | 受注登録編集画面の構築後 | |
| LC_Page_Admin_Order_Mail_action_before | 受注関連メール送信前 | LC_Page_Admin_Order_Mail_Ex |
| LC_Page_Admin_Order_Mail_action_send | 受注関連メール送信時 | |
| LC_Page_Admin_Order_Mail_action_after | 受注関連メール送信後 | |
| LC_Page_Admin_Order_MailView_action_before | （送信済みの）受注管理メール確認画面構築前 | LC_Page_Admin_Order_MailView_Ex |
| LC_Page_Admin_Order_MailView_action_after | （送信済みの）受注管理メール確認画面構築後 | |
| LC_Page_Admin_Order_Multiple_action_before | 複数配送設定画面の構築前 | LC_Page_Admin_Order_Multiple_Ex |
| LC_Page_Admin_Order_Multiple_action_after | 複数配送設定画面の構築後 | |
| LC_Page_Admin_Order_Pdf_action_before | 帳票出力画面構築前 | LC_Page_Admin_Order_Pdf_Ex |
| LC_Page_Admin_Order_Pdf_action_confirm | 帳票出力画面構築確認（PDF表示時） | |
| LC_Page_Admin_Order_Pdf_action_after | 帳票出力画面構築後 | |
| LC_Page_Admin_Order_ProductSelect_action_before | 商品追加画面構築前 | LC_Page_Admin_Order_ProductSelect_Ex |
| LC_Page_Admin_Order_ProductSelect_action_after | 商品追加画面構築後 | |
| LC_Page_Admin_Order_Status_action_before | 対応状況管理画面構築前 | LC_Page_Admin_Order_Status_Ex |
| LC_Page_Admin_Order_Status_action_after | 対応状況管理画面構築後 |
プラグインクラスファイルでの利用例
例えば、register関数内で「LC_Page_Admin_Order_Edit_action_after」をフックして「adminOrderEditActionAfter()」という自作関数を実行させる場合は以下のようにします。
function register(SC_Helper_Plugin $objHelperPlugin,$priority) {
$objHelperPlugin->addAction('LC_Page_Admin_Order_Edit_action_after', array(&$this, 'adminOrderEditActionAfter'));
}
割りこませる関数は以下のように定義します。
/**
* 受注登録(after)
*
* @param LC_Page_Ex $objPage
*/
function adminOrderEditActionAfter(LC_Page_Ex $objPage) {
(実行させたい処理）
}
ぜひ参考にしてみてください。
2013-03-27