README.md, コメント追加

EC-CUBE · Apr 7, 2022 · aa39e80 · aa39e80
1 parent 8a8df7a
commit aa39e80
Show file tree

Hide file tree

Showing 11 changed files with 62 additions and 1 deletion.
diff --git a/data/__default.php b/data/__default.php
@@ -1,6 +1,5 @@
 <?php
 exit; // Don't rewrite. This line is rewritten by EC-CUBE.
-require_once CLASS_EX_REALDIR . 'page_extends/LC_Page_Ex.php';
 
 /**
  * ユーザーカスタマイズ用のページクラス

diff --git a/data/class_extends/README.md b/data/class_extends/README.md
@@ -0,0 +1,38 @@
+# 拡張カスタマイズ用クラス用ディレクトリ
+
+本ディレクトリ以下に `<クラス名>_Ex.php` を作成することにより、 [data/class](../class/) 以下のクラスを拡張カスタマイズできます。
+
+## 使用方法
+
+### SC_Product クラスをカスタマイズする場合
+
+以下の内容で、 SC_Product_Ex.php を作成します。
+
+```php
+<?php
+// path/to/ec-cube2/data/class_extends/SC_Product_Ex.php
+class SC_Product_Ex extends SC_Product
+{
+    public function customizeMethod()
+    {
+        // ....
+    }
+}
+```
+
+## 作成済みの `*_Ex.php` ファイル
+
+EC-CUBE2.17.2 までは、 [data/class](../class/) 以下すべてのクラスの拡張カスタマイズ用クラスが作成されていました。
+[カスタマイズ時の利便性向上のため](https://github.com/EC-CUBE/ec-cube2/pull/526)、これらのファイルは削除されましたが、以下のファイルは下位互換性維持のため削除せずに残してあります。
+
+### [app_initial.php](../app_initial.php) の spl_autoload_register を登録する前に必要なクラス
+
+- [data/class_extends/SC_ClassAutoloader_Ex.php](SC_ClassAutoloader_Ex.php)
+- [data/class_extends/helper_extends/SC_Helper_Plugin_Ex.php](helper_extends/SC_Helper_Plugin_Ex.php)
+- [data/class_extends/SC_Query_Ex.php](SC_Query_Ex.php)
+
+### 決済モジュールやプラグイン、 user_data 以下の PHP で `require` されているクラス
+
+- [data/class_extends/page_extends/mypage/LC_Page_AbstractMypage_Ex.php](page_extends/mypage/LC_Page_AbstractMypage_Ex.php)
+- [data/class_extends/page_extends/LC_Page_Ex.php](page_extends/LC_Page_Ex.php)
+- [data/class_extends/page_extends/admin/LC_Page_Admin_Ex.php](page_extends/admin/LC_Page_Admin_Ex.php)
diff --git a/data/class_extends/SC_ClassAutoloader_Ex.php b/data/class_extends/SC_ClassAutoloader_Ex.php
@@ -23,6 +23,10 @@
 
 require_once CLASS_REALDIR . 'SC_ClassAutoloader.php';
 
+/*
+ * app_initial.php の spl_autoload_register を登録する前に必要なクラスですので、削除しないでください
+ */
+
 class SC_ClassAutoloader_Ex extends SC_ClassAutoloader
 {
 }
diff --git a/data/class_extends/SC_Query_Ex.php b/data/class_extends/SC_Query_Ex.php
@@ -23,6 +23,10 @@
 
 require_once CLASS_REALDIR . 'SC_Query.php';
 
+/*
+ * app_initial.php の spl_autoload_register を登録する前に必要なクラスですので、削除しないでください
+ */
+
 class SC_Query_Ex extends SC_Query
 {
 }
diff --git a/data/class_extends/helper_extends/SC_Helper_Plugin_Ex.php b/data/class_extends/helper_extends/SC_Helper_Plugin_Ex.php
@@ -23,6 +23,10 @@
 
 require_once CLASS_REALDIR . 'helper/SC_Helper_Plugin.php';
 
+/*
+ * app_initial.php の spl_autoload_register を登録する前に必要なクラスですので、削除しないでください
+ */
+
 /**
  * プラグイン関連のヘルパークラス(拡張).
  *

diff --git a/data/class_extends/page_extends/LC_Page_Ex.php b/data/class_extends/page_extends/LC_Page_Ex.php
@@ -23,6 +23,10 @@
 
 require_once CLASS_REALDIR . 'pages/LC_Page.php';
 
+/*
+ * 決済モジュールやプラグイン、 user_data 以下の PHP で require されているため削除しないでください
+ */
+
 class LC_Page_Ex extends LC_Page
 {
 }
diff --git a/data/class_extends/page_extends/admin/LC_Page_Admin_Ex.php b/data/class_extends/page_extends/admin/LC_Page_Admin_Ex.php
@@ -23,6 +23,10 @@
 
 require_once CLASS_REALDIR . 'pages/admin/LC_Page_Admin.php';
 
+/*
+ * 決済モジュールやプラグイン、 user_data 以下の PHP で require されているため削除しないでください
+ */
+
 class LC_Page_Admin_Ex extends LC_Page_Admin
 {
 }
diff --git a/data/class_extends/page_extends/mypage/LC_Page_AbstractMypage_Ex.php b/data/class_extends/page_extends/mypage/LC_Page_AbstractMypage_Ex.php
@@ -23,6 +23,10 @@
 
 require_once CLASS_REALDIR . 'pages/mypage/LC_Page_AbstractMypage.php';
 
+/*
+ * 決済モジュールやプラグイン、 user_data 以下の PHP で require されているため削除しないでください
+ */
+
 /**
  * Mypage のページクラス(拡張).
  *

diff --git a/data/class_extends/plugin_extends/.gitkeep b/data/class_extends/plugin_extends/.gitkeep
diff --git a/data/class_extends/sessionfactory_extends/.gitkeep b/data/class_extends/sessionfactory_extends/.gitkeep
diff --git a/data/class_extends/util_extends/.gitkeep b/data/class_extends/util_extends/.gitkeep