ec-cube / ec-cube.github.io Goto Github PK

View Code? Open in Web Editor NEW

23.0 26.0 54.0 19.73 MB

EC-CUBE 3系開発ドキュメント

Home Page: https://doc.ec-cube.net/

HTML 99.95% CSS 0.04% PHP 0.01% JavaScript 0.01% Shell 0.01% Hack 0.01% Ruby 0.01% Twig 0.01%

ec-cube.github.io's Introduction

EC-CUBE 3開発ドキュメント

github page of the http://ec-cube.github.io/

EC-CUBE 3 の仕様や手順、開発Tipsに関するドキュメントを掲載しています。修正や追記、新規ドキュメントの作成をいただく場合、本レポジトリへPullRequestをお送りください。

開発協力に関して

コードの提供・追加、修正・変更その他「EC-CUBE」への開発の御協力（Issue投稿、PullRequest投稿など、GitHub上での活動）を行っていただく場合には、 EC-CUBEのコピーライトポリシーをご理解いただき、ご了承いただく必要がございます。 PullRequestを送信する際は、EC-CUBEのコピーライトポリシーに同意したものとみなします。

本ドキュメントサイトの構成について

github pageはJekyll Documentation themeを使っています。

windows環境の方は以下のURLを参考に環境を作成してください。 http://qiita.com/chihiro-adachi/items/99a82c902b4c8467aa4c

Build the site to see the instructions for using it. Or just go here: http://idratherbewriting.com/documentation-theme-jekyll/

ローカル開発環境の構築

EC-CUBE 3開発ドキュメントはローカル開発環境を構築することにより、ドキュメントを修正した場合にローカルPCで確認することができます。 Windows、Macの環境で動作確認済みです。

前提条件

ローカル環境にruby(バージョン：2.4.0以上)がインストールされている必要があります。
Windows環境の場合、Git Bash等のターミナルを利用して下さい。
ご自身のGithubアカウントが必要になります。

※ Rubyのバージョン確認方法

$ ruby -v
ruby 2.4.5p335 (2018-10-18 revision 65137) [x64-mingw32]

開発環境構築手順

ec-cube.github.ioをForkする

ec-cube.github.ioのリポジトリをご自身のGithubリポジトリにForkします。

任意のディレクトリにクローンする

Forkしたご自身のリポジトリからソースを、git clone でローカルにコピーします。

$ git clone https://github.com/[ご自身のアカウント名]/ec-cube.github.io.git

リモートリポジトリに本家のリポジトリを登録する

本家のリポジトリの名前をupstream（任意）で登録します。

$ cd ec-cube.github.io/
$ git remote add upstream https://github.com/EC-CUBE/ec-cube.github.io.git

gem（rubyのライブラリ）のインストールを行う

bundle installにより、gemfile.lockを元にgemのインストールを行います。

$ bundle install

※ Windows環境では、gemfile.lockが更新されてしまいますが、git管理から無視するように下さい。（コミット対象から除外する）

eventmachine (1.2.7-x64-mingw32)

ローカルサーバーでサイトを立ち上げる

以下のコマンドでサイトが立ち上がります。

$ bundle exec jekyll serve
（省略）
Server address: http://127.0.0.1:4005
Server running... press ctrl-c to stop.

http://127.0.0.1:4005 にブラウザのURLでアクセスすると、 EC-CUBE 3開発ドキュメントのページが表示されます。

ec-cube.github.io's People

Contributors

Stargazers

Watchers

ec-cube.github.io's Issues

URL 404 :Not found http://doc.ec-cube.net/plugin-table

in URL http://doc.ec-cube.net/customize_policy
データベースの拡張について
新たな項目が必要な場合、テーブルの追加を参考に

4系ドキュメントへのリンクを張っておきたい

3系ドキュメントと、4系ドキュメントについて、
どっちが4なのかわからないという声があったので、混乱しないためにどうすべきか検討をしたいです。

3系：http://doc4.ec-cube.net
4系：http://doc4.ec-cube.net

Herokuボタン利用時の注意事項

herokuボタンでEC-CUBEを立ち上げる際に、プラグインのインストーラでは以下の制約がある

プラグインインストール時に、メモリ上限に引っかかる可能性がある
タイムアウトの制限に引っかかる可能性がある

目次ページの作成

#46 (comment)

の目次ページを作成する

プラグイン機構を利用した開発手法

プラグイン機構を利用した開発手法
- ジェネレータの利用方法
- ページの追加
- 利用しないページの削除
- フォームの追加
- フォームの変更
- テーブルの追加
  - dcm.ymlの作成
  - エンティティの作成
  - レポジトリの作成
  - データベースへ反映する

self-update？

venderの更新について

composer.jsonに変更がない場合vendor/の上書きは不要です
composerが利用可能な環境の場合vendorの上書きではなく以下でも可能です

> php composer.phar self-update

self-updateってcomposer自体を最新にアップデートするコマンドのような気が？

チュートリアルのエラー

http://xoops.ec-cube.net/modules/newbb/viewtopic.php?topic_id=17820&forum=2&post_id=77263#forumpost77263

use Eccube\Entity\PageLayout;が抜けており、エラーが発生している模様

プラグインでのマイグレーション方法について

プラグインのマイグレーションの作成方法について記載する

createSchemaを使ったテーブルの生成
データ投入の方法について
- ormを利用する場合
- dbalを利用する場合
  - queryBuilderでのinsert/update

参考：EC-CUBE/ec-cube#1328

$app['config']['root_urlpath']の利用についての注意記載をする

$app['config']['root_urlpath']は、環境によって異なる。

通常、サブディレクトリにインストールした場合は、

/eccube/html

となるが、URLからhtmlを取り除いた環境では

/eccube/

となる。

そのため、html配下へのパス(/html/plugin/xxx など)を取得するために$app['config']['root_urlpath']を使用していた場合、正常に取得できない可能性があるので、使用すべきではない。

参考：
EC-CUBE本体コードでは、$app['config']['root_urlpath']はCookieのパスとして使用しているだけ。

FormTypeのカスタマイズページファイル名修正漏れ

対象ページ
FormTypeのカスタマイズ
http://doc4.ec-cube.net/customize_formtype

誤

サンプル
会員登録ページのフォームを拡張して、会社名を入力必須項目に変更するサンプルです。
./app/Customize/Form/Extension/EntryTypeBirthdayExtension.php

正

サンプル
会員登録ページのフォームを拡張して、会社名を入力必須項目に変更するサンプルです。
./app/Customize/Form/Extension/CompanyNameRequiredExtension.php

ナビゲーションが見切れる

ナビゲーションバーの プラグインカスタマイズ > ベストプラクティス を押下するとメニューが画面外にまで及び、クリックできないリンクがある。

テスト

flushの作法について記載して欲しい

Doctrineのflash関数を引数無しで利用すると、意図しないものまでflashされる可能性がある。
明示的に引数にEntityを渡すよことを推奨して欲しい。

【重複】プラグイン開発の手順をまとめる

プラグイン開発にあたって、DBのテーブル作成など、一連の流れがわかるドキュメントを作成する
例えばテーブル作成であれば、Symfony標準の方法も合わせて様々な手法があるため、初学者にとって迷いやすいと思われる。

プラグインのインストールページの管理画面を利用してインストールするについて

プラグインのインストールページの管理画面を利用してインストールするについてですが、

http://doc4.ec-cube.net/plugin_install

正式版がリリースされましたので、下記の文言を削除して頂けたらと思います。
「EC-CUBE 4.0 開発中のため利用することが出来ません。」

あとREADMEの表記（EC-CUBE 4.0.0-rc）もご対応頂けると助かります。

アップデート時の.htaccessへの注意を追記

EC-CUBEのバージョンアップ手順で、htmlをそのまま上書きすると.htaccessを上書きしてしまう可能性がある。
.htaccessをカスタマイズしている場合のバックアップについても明記すべきかも。

参考） https://twitter.com/ykatombn/status/996992869104693249

createSchema関数を利用したテーブルの生成の方法

createSchema関数を利用したテーブルの生成の方法について記載して欲しい。
ガイドラインorプラグイン仕様書かはおまかせします。

設定可能な環境変数の一覧を記載

.envなど環境変数を利用して設定を変えるものがあるが実際に何が利用できるのかわかりづらい

参考：https://twitter.com/aWebprogrammer/status/1051559201120518145

バージョンアップ時のプロキシ削除コマンドの修正

http://doc4.ec-cube.net/quickstart_update#7-プロキシの再生成

こちらのプロキシファイル削除コマンドは下記が正しくはありませんか？
rm -f app/proxy/entity/src/Eccube/Entity/*.php

Processorの追加方法を更新する

プロセッサの追加方法について以下のように記載されているが、内容が古い。

http://doc3n.ec-cube.net/customize_service

独自に作成した Processor を有効にするには、 app/config/eccube/packages/purchaseflow.yaml の定義を修正します。

EC-CUBE/ec-cube#3289

でアノテーションでの追加が可能になっているため、上記の内容に更新する

PluginException例外について記載して欲しい

プラグインのインストールなどで失敗したときに発生させるPluginExceptionについて、説明を記載して欲しい。

EC-CUBE本体のソースコードを変更する

EC-CUBE本体のソースコードを変更する
- バージョン管理
  - バージョン管理対象
- アップデート方法
  - gitを利用したマージ
  - マイグレーション
  - composerの更新
- 本体の変更を追随するためのコーディング方法
- セキュリティFIXについて

EC-CUBE 3.0.11 変更内容に伴うプラグインへの影響ページへのリンクが無い

トップページから下記のページにアクセスできない。
http://ec-cube.github.io/guideline/plugin-update-for3.0.11

EC-CUBE本体のバージョンアップ誤字

EC-CUBE本体のバージョンアップ
http://doc4.ec-cube.net/quickstart_update

テンプレートファイルの更新
表の 1 レコード目
誤）会員登録(入力ページ)
正）お問い合わせ

サービスのカスタマイズの内容精査

対象ページ
Service のカスタマイズ
http://doc4.ec-cube.net/customize_service#%E6%94%AF%E6%89%95%E6%96%B9%E6%B3%95%E3%81%8C%E7%95%B0%E3%81%AA%E3%82%8B%E5%95%86%E5%93%81%E3%82%92%E5%90%8C%E6%99%82%E3%81%AB%E3%82%AB%E3%83%BC%E3%83%88%E3%81%AB%E5%85%A5%E3%82%8C%E3%82%89%E3%82%8C%E3%82%8B%E3%82%88%E3%81%86%E3%81%AB%E3%81%99%E3%82%8B

支払方法が異なる商品を同時にカートに入れられるようにする の記述通りに実装をしても
反映されない。ドキュメントの内容を最新のEC-CUBEの仕様に合わせる必要があるかと思います。

暫定解決方法：
https://ec-cube.slack.com/archives/CBQ4H83J9/p1540890504003800?thread_ts=1540866486.000500&cid=CBQ4H83J9

プラグインを利用する

プラグインを利用する
- プラグインの導入方法
  - オーナーズストアからの導入
  - 独自プラグインの追加
- トラブルシューティング
  - 項目が表示されない場合の対処方法
  - プラグインの優先順位

php-cs-fixerの利用についてのTipsが欲しい

コーディング規約を守った開発を行うには有用なツール。
すでにvender/binに含まれているので、Tips的に紹介して欲しい。

デフォルトブランチを4系のものにしたい

デフォルトが3系のブランチなので4系のドキュメントがどこにあるかわかりにくい。
4系をデフォルトとするか、リポジトリを分けたい。

4系でのログの出力に関する設定

4系でログの出力先を変えたい場合の設定方法のページをつくっておきたい
内容としては以下2点が参考にできそう。

プラグイン毎のログ出力切り替え詳細な利用方法。
EC-CUBE/ec-cube#3530

.env ファイルの APP_ENV の値で設定
EC-CUBE/ec-cube#3380 (comment)

プラグイン開発ルールについて

ec-cubeのIssueから移動 EC-CUBE/ec-cube#1436

ttsuru commented on 29 Jan
プラグインの開発ルールのようなものを定められませんでしょうか。

例えば、app/Plugin 以下にはシステムから生成されるファイルを置かないなど、ルールづけできると嬉しいです。

マイグレーションガイドのリンク切れ

update.md のマイグレーションガイドのリンクが切れています。

-/development/migration.html
+/migration.html

プラグイン開発の手順をまとめる

計測タグの埋め込みについてのドキュメントが欲しい

GAなどの計測タグや購入完了ページにコンバージョンタグを埋めたいなどの要望をいただくことがあります。
公式ドキュメントに設定方法があると助かります。

記載内容の提案

全ページタグの埋め方
- default_frame.twig に直接追加する方法
- ブロック管理でタグを追加する方法
コンバージョンタグ
- 購入完了画面にコンバージョンタグを追加する例

参考

公式ドキュメント以外ではQiitaに記事があります。

https://qiita.com/okazy/items/913584e3a676bf8eb0b9
https://qiita.com/tirol_jpn/items/37ba326676f572e70dc7

カスタマイズガイドラインの作成

EC-CUBEを使ってカスタマイズを行う場合のガイドラインを作成する

以下のケースを想定

プラグインを利用する、デザインを変更する場合
項目の追加など、軽微なカスタマイズを行う場合
テーブルのスキーマ定義も含め、大きく変更を加える場合

task list

Applicationのインスタンスを取得する方法について記載して欲しい

Applicationのインスタンスを利用したい場合、
new するのではなく$app = \Eccube\Application::getInstance()とするのが適切。

※getInstance()が使用できるようになる以前のコードでnewしていることろがあるので混乱しがち。

その他

その他　
- 開発環境構築
  - パッケージ版からの構築
  - githubからの構築
- 本番反映
  - 開発環境から本番環境への反映
  - 本番稼働後の修正

デザインのカスタマイズ方法

デザインのカスタマイズ方法
- ブロックの利用
- 「テンプレートの探索順序」仕様
  - app/templateへtwigファイルを配置する
- default_flame.twig
- フォームレイアウトの変更について
  - form.layout.twig
- gulpを利用したディレクトリ構造

あと、今後バージョン別に細かくドキュメントを作らないのであれば、「バージョン4.0の場合の例」のような注記があると親切かなと思いました。

xdebug有効時、プラグインインストールに失敗する

xdebugが有効な環境の場合、プラグインインストール時に次ののエラーが発生
(画面上には表示されない。ログで確認)

Maximum function nesting level of '256' reached, aborting!

xdebugを無効にすると解消されます。
プラグイン利用時の注意事項として記載する

バージョンアップ手順の修正

バージョンアップ手順に、メンテナンス機能について追記する
データベースのバックアップについて追記
.envの記載を修正(環境変数)
http://doc4.ec-cube.net/quickstart_update

パッケージダウンロード先の修正

パッケージダウンロード先を最新版に変更する。

ページ

http://doc4.ec-cube.net/quickstart_install

箇所
EC-CUBE 4のパッケージ
リンク先
.../eccube-4.0.0-rc.zip