EC-CUBE4をMAMPにインストールする方法とインストール画面の設定方法
EC-CUBE Advent Calendar 201 4日目の記事です。
2018年10月11日に待望のEC-CUBE4がリリースされました。
その後、2018年12月3日に早速EC-CUBE 4.0.1がリリースされました。
そろそろEC-CUBE4を利用しているという話も聞きますので、 4日目はMacの方限定になりますがMAMPに対してEC-CUBE4をインストールする方法を書きます。 WindowsにもMAMPは用意されていますので、読み替えたら利用できると思います。
MAMPのダウンロード、インストール
MAMPはダウンロードしてインストールするだけですので説明は省きます。
(記事の時点でMAMP PRO5.2を利用しています。)
MAMPをダウンロード後、インストールすると/ApplicationディレクトリにMAMPディレクトリが作成されます。 MAMP PROというディレクトリも作成されますが今回は普通のMAMPを使います。
php.iniの設定
ダウンロードしたらphp.iniのtimezoneの変更をしてください。
EC-CUBE4ではPHP7.1.3以上が推奨されていますので、
MAMPに入っているPHP 7.2.10を使います。
/Applications/MAMP/bin/php/php7.2.10/conf/php.ini
のphp.iniにあるtimezoneを
date.timezone = Asia/Tokyo
に変更してください。
EC-CUBE4のダウンロード
本来の目的であるEC-CUBE4をインストールしてみましょう。 本日時点でEC-CUBE4.0.1が最新なのでそれを想定して説明します。
早速下記URLよりVersion 4.0.1をダウンロードしてください。zipでもtarでもどちらでも構いません。
EC-CUBEダウンロード | ECサイト構築・リニューアルは「ECオープンプラットフォームEC-CUBE」
データベースの作成
事前にデータベースが必要なのでMAMPを実行し、phpMyAdminへアクセスします。
http://localhost:8888/phpMyAdmin
「データベース」タブを選択し、 以下のデータベースの内容を作成してください。
データベース名:eccube4 照合順序:utf8_general_ci
今回はEC-CUBE4のインストールのみなのでMAMPのデフォルトで設定されているrootユーザのままインストールします。
EC-CUBE4のインストール
ダウンロードしたEC-CUBE4を先ほどインストールしたMAMPのhtdocsにコピーします。
(解凍したEC-CUBEのディレクトリ名をeccube-4.0.1からeccubeに変更します。)
/Applications/MAMP/htdocs/eccube
コピー終了後、ブラウザより
へアクセスしてください。
そうするとEC-CUBE4のインストール画面が表示されますので、「次へ進む」ボタンを押します。
「送信を承諾する」はチェックしてもしなくてもどちらでも構いません。
権限チェックがされますので、問題がなければ「次へ進む」を押します。
サイトの設定画面が表示されます。こちらはサイト名や管理者用メールアドレス等の情報を入力します。
それぞれの項目の説明は以下の通りです。
- あなたの店名 : サイト名
- メールアドレス : 管理者用のメールアドレス
- 管理画面ログインID : 管理画面にログインするID
- 管理画面パスワード : 管理画面にログインするパスワード
- 管理画面のディレクトリ名 : 管理画面のURL(4.0.1からはadminが利用できなくなりました。)
- サイトへのアクセスSSL : httpsで接続させるかどうかのチェック
- 管理画面のIP制限 : 設定すると決まったIPアドレスまたはドメインからしか接続不可能
- メールの設定 : 4からはSMTPの設定しかできませんので環境に合わせて設定
下記は実際に入力した内容となります。
入力が完了すると次はデータベースの設定となります。
今回はmysqlを利用するのでmysqlを選択し、以下のように入力します。
設定が完了すればデータベースの初期化を行います。
完了しました画面が表示されれば、インストールは無事に完了です。
「管理画面を表示」ボタンを押すと管理画面が表示されます。 こちらの画面では、先ほど設定したログインID、パスワードを入力し「ログイン」ボタンを押します。
無事にログインできれば管理画面のトップページが表示されます。
また、
へアクセスするとトップページが表示されます。
3系から管理画面、フロント画面ともにイメージが変わっていますが、3系を利用されている方であればすぐに慣れると思います。
以上でEC-CUBE4でのインストール作業は完了です。
なお、EC-CUBE4はMAMPなどを用意しなくてもローカルで動作させる方法はあるのですが、 ドキュメントが見当たらないので見つけたらリンクをはっておきます。
EC-CUBE3で帳票プラグインを利用してフロントでも出力できるようにする方法
EC-CUBE3では帳票出力はプラグインとして提供されています。
管理画面からはプラグインをインストールするだけですぐに利用できますが、フロントからでも帳票を出力したいとう要望が時々あります。 帳票の内容が同じでよければ以下のように対応するだけで実現可能です。
前提として、帳票プラグインを有効にしておく必要がありますのでご注意ください。 対象バージョンはEC-CUBE3.0.15となりますが、他のバージョンでも動作すると思います。
- src/Eccube/Resource/template/default/Mypage/index.twig の修正
マイページの購入一覧画面で帳票出力リンクを表示したい場合、以下のソースをデザインに合わせて適当な場所へ追加します。
{% if Order.OrderStatus.id == app.config.order_deliv %} <p><a href="{{ url('mypage_history_print', {'id': Order.id}) }}" target="print">帳票出力</a></p> {% endif %}
if文を使っているのは、ステータスが発送済みの時だけ出力できるようにしています。
- src/Eccube/Resource/template/default/Mypage/history.twig の修正
同様に購入履歴の詳細画面でも帳票出力リンクを用意します。
{% if Order.OrderStatus.id == app.config.order_deliv %} <p><a href="{{ url('mypage_history_print', {'id': Order.id}) }}" target="print">帳票出力</a></p> {% endif %}
記述する内容は上記と同じです。
- src/Eccube/ControllerProvider/FrontControllerProvider.php へURLを定義
帳票を出力すためのURL定義を行います。記述する場所はどこでも構いません。
$c->match('/mypage/history_print/{id}', '\Eccube\Controller\Mypage\MypageController::historyPrint')->bind('mypage_history_print');
ここの部分はプロジェクトに合わせて変更しても構いません。
- src/Eccube/Controller/Mypage/MypageController.php へ帳票出力関数を追加
実際に帳票を出力するための関数を記述します。本来であればプラグインのものを再利用できれば良いのですが、色々と考慮する必要があるため新たに作成しています。
<?php /** * 印刷画面を表示 * * @param Application $app * @param Request $request * @param $id * @return \Symfony\Component\HttpFoundation\Response * @throws \Doctrine\ORM\OptimisticLockException */ public function historyPrint(Application $app, Request $request, $id) { /* @var $softDeleteFilter \Eccube\Doctrine\Filter\SoftDeleteFilter */ $softDeleteFilter = $app['orm.em']->getFilters()->getFilter('soft_delete'); $softDeleteFilter->setExcludes(array( 'Eccube\Entity\ProductClass', )); $app['orm.em']->getFilters()->enable('incomplete_order_status_hidden'); /* @var $Order \Eccube\Entity\Order */ $Order = $app['eccube.repository.order']->findOneBy(array( 'id' => $id, 'Customer' => $app->user(), )); if (!$Order) { throw new NotFoundHttpException(); } // 発送済みしか表示させない if ($Order->getOrderStatus()->getId() != $app['config']['order_deliv']) { throw new AccessDeniedHttpException(); } // 購入情報からPDFを作成する $arrData = array( 'issue_date' => new \DateTime(), 'ids' => $Order->getId(), 'title' => 'XXXXX明細書', 'message1' => 'このたびはお買上げいただきありがとうございます。', 'message2' => '下記の内容にて納品させていただきます。', 'message3' => 'ご確認くださいますよう、お願いいたします。', 'note1' => '', 'note2' => '', 'note3' => '', ); $status = $app['orderpdf.service.order_pdf']->makePdf($arrData); // 異常終了した場合の処理 if (!$status) { throw new AccessDeniedHttpException(); } // ダウンロードする $response = new Response( $app['orderpdf.service.order_pdf']->outputPdf(), 200, array('content-type' => 'application/pdf') ); // レスポンスヘッダーにContent-Dispositionをセットし、ファイル名を指定 $response->headers->set('Content-Disposition', 'inline; filename="'.$app['orderpdf.service.order_pdf']->getPdfFileName().'"'); // $response->headers->set('Content-Disposition', 'attachment; filename="'.$app['orderpdf.service.order_pdf']->getPdfFileName().'"'); return $response; }
上記を記述すると管理画面と同じ帳票が出力できるようになります。
下記の部分ですが、PDFをブラウザ上に表示させるか、ダウンロードさせたいかの違いだけですので、用途に合わせてコメントアウトを変更してください。
$response->headers->set('Content-Disposition', 'inline; filename="'.$app['orderpdf.service.order_pdf']->getPdfFileName().'"'); // $response->headers->set('Content-Disposition', 'attachment; filename="'.$app['orderpdf.service.order_pdf']->getPdfFileName().'"');
以上でフロントからでも帳票出力が可能となりますので、もしフロントでも帳票出力させたいという方は参考にしてください。
EC-CUBE2からEC-CUBE3へバージョンアップ後のmod_rewrite設定について
EC-CUBE Advent Calendar 2017 22日目の記事です。
EC-CUBE2系からEC-CUBE3系へバージョンアップされたという方も中にはいるかもしれませんが、EC-CUBE2系から3系は内部構造もそうですがURLも変更されています。
URLが変更になるということは、長い間運用されていた方にとってはSEOとしては致命的なものとなりますし、別サイト等からリンクされていたら全て404になってしまいます。それを防ぐためにmod_rewriteを使ってリダイレクトさせる方法を以下に書きます。
EC-CUBE3.0.15を利用しています。
一番大事なページはやはり商品詳細ページとなります。
ECCUBEROOT/html/.htacccess
に以下を記述してください。
記述する場所は、 <IfModule mod_rewrite.c>
に囲まれている箇所となります。
RewriteCond %{REQUEST_URI} products/detail.php RewriteCond %{QUERY_STRING} ^product_id=([0-9]+) RewriteRule ^(.*)$ /products/detail/%1? [R=301,L]
詳しい説明は省きますがこちらを記述することで今まで2系で利用されていたURLが3系の商品詳細画面へリダイレクトされます。 また、商品一覧は以下の通りです。
RewriteRule ^products/list.php(.*)$ /products/list$1 [R=301,L]
こちらは比較的簡単ですね。
その他のページについては一つずつ2系のurlを3系に合わせて変更していくだけです。
RewriteRule ^guide/privacy.php /help/privacy [R=301,L]
と一つずつ設定してください。 また独自にページを作成されていた時でも独自ページのURLを記述するだけで対応可能です。
また、URLを変更したいという時でも、
RewriteRule ^brand /guide/brand [R=301,L]
というように変更後のURLへリダイレクト設定を記述するだけです。
以上がmod_rewrite設定になります。広告を出稿していてURL変更が大変だという方などはこちらの設定を記述しておけば特に変更する必要はありません。もし動作しないなどがありましたらコメントをください。
EC-CUBE2.4、2.11、2.13からEC-CUBE3.0.1xへのデータ移行ツール公開
EC-CUBE Advent Calendar 2017 15日目の記事です。
15日目はEC-CUBE2系からEC-CUBE3.0.1x系へ移行するためのツールを公開します。このツールはエンジニアの方を対象にしています。
元々は、1つのツールで2.4、2.11、2.13の対応をしようと思っていましたが、意外とめんどくさいことが判明しましたのでそれぞれのバージョンにあったものをお使いください。
プログラムの説明
既存DBから情報を読み取り、3系のデータ構造に合わせてinsert文を作成するというものです。
移行対象テーブルは商品、受注、会員に関連するもののみとなりますのでそれ以外のテーブルは別途作成してみてください。
読み出し元DBはMySQL、PostgreSQL両方対応していますが、作成されるinsert文はMySQL専用となっていますので、PostgreSQLが必要な方はカスタマイズしてお使いください。
PHP5.3から動きます。
また、移行先がレンタルサーバ等の場合、一度に大量のデータを流すとエラーになるレンタルサーバもあります。そのため、受注データ関連のみのinsert文のみですがファイルを分割して作成するようにしています。商品データ等も同じように修正すれば対応可能です。
忘れてはいけないこと
2系から3系に移行した後、必ずAUTH_MAGICは2系で使用されていたものをお使いください。これがないと会員、管理者ともにログインできなくなります。
- AUTH_MAGICのそれぞれの場所
これらを3系の
app/config/eccube/config.yml
にあるauth_magicに設定してください。
以下、利用する前に以下の注意点を必ずお読みください。
※注意点
- カスタマイズされているデータベースには対応していません。ソースを見ればわかるように簡単なコードですので、適宜カスタマイズしてお使いください。
- こちらは必ず動作保証されているものではありません。また、データ構成によっては全て移行されない時がありますので、必ず検証をお願いします。
- こちらの移行ツールを使ったあとは必ずテストをしてください。
- マスタ系(mtb_xxx)は移行していませんが、必要であれば同じように作成すれば対応可能です。
- 3系から新たに用意されたカラムに対しての考慮まではしていません。
- プラグインとして提供されるようになったテーブルは対象外としています。
→2.11からの移行としてdtb_makerの移行だけサンプルとして用意しています。
なお、使用するEC-CUBE3ですが、本日時点のソースをcloneしたものを使います。 https://github.com/EC-CUBE/ec-cube
EC-CUBE2.4系からの移行
EC-CUBE2.4は3系とデータ構造は似ていますが、足りていない項目などがありますがそこは無視しています。
商品タグについては作成されたsql文に対して一部手動で変更する必要があります。
EC-CUBE2.11系からの移行
EC-CUBE2.11は商品規格のデータ構造が異なります。3系に変換時はそれぞれのテーブルを結合して対応していますが、もしかしたら漏れがあるかもしれません。
それ以外は2.4からの移行とほぼ同じです。商品タグについては作成されたsql文に対して一部手動で変更する必要があります。
EC-CUBE2.13系からの移行
3系はEC-CUBE2.13のデータ構造をベースとして作成されていますので、ほぼ同じです。ただし、複数配送時などの配送データが一部手直しする必要があります。
メルマガプラグインを利用している方も多いと思いますので、メルマガプラグインへの移行データも一応入っています。不要な方はその箇所を削除してください。
実行方法
それぞれのリポジトリにconfig.php
が入っていますので、環境に合わせてお使いください。
実行方法は、
./migration.sh
とターミナルから実行すれば使えます。
insert.sh
ファイルは、データをインポートするときにファイル数が多ければお使いください。seq 10
の箇所を作成されたファイル数と合わせるだけです。
以上がツールの注意点となります。基本的には他のテーブルも同じように作成すれば問題ありません。
データによっては潜在的なバグが含まれている可能性がありますので、十分気をつけてください。
本当はPostgreSQL版も用意したかったのですが、私がMySQLを利用することが多いため作成する時間がありませんでした。
不具合があったり、PostgreSQL版を用意したという方がいればpull requestを随時お待ちしております。
EC-CUBE3の商品一覧画面にカートボタンを追加させる方法
EC-CUBE Advent Calendar 2017 4日目の記事です。
4日目はEC-CUBE3の商品一覧画面にカートボタンを追加する内容を書きます。
EC-CUBE2系では商品一覧からカートに追加するボタンが存在していたのですが3系からは無くなっています。
3系からこの機能が無くなったのかというと実はソースを眺めてみると実装されており、少しカスタマイズをするだけで実現可能です。
というわけで3系の商品一覧画面でもカートボタンを表示するカスタマイズを紹介します。
使用するEC-CUBE3ですが、本日時点のソースをcloneしたものを使います。 https://github.com/EC-CUBE/ec-cube
デフォルトだと商品一覧画面は以下のようになります。(商品を一つ追加しています。)
この一覧画面に規格選択およびカートボタンを表示させます。今回デザインは全く気にしていません。
- src/Eccube/Resource/template/default/Product/list.twig
137行目から以下を追加します。
{% if Product.stock_find %} <!--▼買い物かご--> {% set form = forms[Product.id] %} <form name="form{{ Product.id }}" id="productForm{{ Product.id }}" action="{{ url('product_detail', {'id': Product.id}) }}" method="post"> <dl> {% if form.classcategory_id1 is defined %} {# 規格1 #} <dt> {{ form_label(form.classcategory_id1) }}: </dt> <dd> {{ form_widget(form.classcategory_id1) }} {{ form_errors(form.classcategory_id1) }} </dd> {# 規格2 #} {% if form.classcategory_id2 is defined %} <dt> {{ form_label(form.classcategory_id2) }}: </dt> <dd> {{ form_widget(form.classcategory_id2) }} {{ form_errors(form.classcategory_id2) }} </dd> {% endif %} {% endif %} <dt>個数:</dt> <dd> {{ form_widget(form.quantity) }} {{ form_errors(form.quantity) }} </dd> {{ form_rest(form) }} </dl> <div> <button type="submit" class="add-cart btn btn-primary btn-block prevention-btn prevention-mask" data-cartid="{{ Product.id }}">カートに入れる</button> </div> </form> <!--▲買い物かご--> {% else %} <div>ただいま品切れ中です</div> {% endif %}
これだけで規格がある商品は規格の選択、およびカートボタンが表示されるようになりました。
だたし、表示されるだけでカートボタンは正常に動作しません。 動作させるためにはJavaScriptの処理を追加させます。
45行目以降のscriptの中に以下を追加します。
eccube.productsClassCategories = { {% for Product in pagination %} "{{ Product.id|escape('js') }}": {{ Product.class_categories|json_encode|raw }}{% if loop.last == false %}, {% endif %} {% endfor %} }; $('.add-cart').click(function() { var data = $(this).data(); $('input[name="mode"]').val('add_cart'); $('#productForm' + data.cartid).submit() });
これを追加することでパーコレーターの規格1を選択すると、規格2が選択されるようになりました。
$('.add-cart').click(function() { var data = $(this).data(); $('input[name="mode"]').val('add_cart'); $('#productForm' + data.cartid).submit() return false; });
の処理でカートを追加するボタンを押すとカート画面へ遷移するようにしています。 [2018/06/25 追記] 最後にreturn false; を記述してください。
規格が複数あったとしても問題なく動作します。
これで商品一覧画面からカートへ追加する実装が可能となりました。EC-CUBE3では少しカスタマイズするだけで実現させたい機能が簡単に可能です。
動作しない、エラーが発生したという方はコメントしてくれれば確認します。
EC-CUBE3でページ管理から画面作成時にURLからuser_dataを無くす方法
EC-CUBE3にあるページ管理より新しいページを作成した場合、URLには必ずuser_data
が含まれます。
http://hogehoge/user_data/hoge
というようになります。
user_dataは別にあっても問題はありませんが、中には無くしてしまいたいという方もいると思います。以下のカスタマイズを行うことで実現可能となります。
EC-CUBE3.0.14を対象に説明します。
まず、FrontControllerProviderにあるuser_dataを定義しているルーティングの箇所をコメントアウトします。
// user定義 // $c->match('/'.$app['config']['user_data_route'].'/{route}', '\Eccube\Controller\UserDataController::index')->assert('route', '([0-9a-zA-Z_\-]+\/?)+(?<!\/)')->bind('user_data');
ページ作成時にuser_dataの定義がなくても動作するように、PageControllerとPageLayoutRepositoryを修正します。
- src/Eccube/Controller/Admin/Content/PageController.php
・120行目 // ファイル生成・更新 $templatePath = $app['eccube.repository.page_layout']->getWriteTemplatePath($editable); ↓ $templatePath = $app['eccube.repository.page_layout']->getWriteTemplatePath(false); ・156行目 $templatePath = $app['eccube.repository.page_layout']->getWriteTemplatePath($editable); ↓ $templatePath = $app['eccube.repository.page_layout']->getWriteTemplatePath(false); ・187行目 $templatePath = $app['eccube.repository.page_layout']->getWriteTemplatePath(true); ↓ $templatePath = $app['eccube.repository.page_layout']->getWriteTemplatePath(false);
というようにそれぞれ$app['eccube.repository.page_layout']->getWriteTemplatePath(false);
と変更します。
- src/Eccube/Repository/PageLayoutRepository.php
public function getReadTemplateFile($fileName, $isUser = false) { if ($isUser) { $readPaths = array( $this->app['config']['user_data_realdir'], ); } else { $readPaths = array( $this->app['config']['template_realdir'], $this->app['config']['template_default_realdir'], ); } ・ ・ ・
と記述されている箇所を
public function getReadTemplateFile($fileName, $isUser = false) { if ($isUser) { $readPaths = array( $this->app['config']['template_realdir'], $this->app['config']['user_data_realdir'], ); } else { $readPaths = array( $this->app['config']['template_realdir'], $this->app['config']['template_default_realdir'], ); } ・ ・ ・
と$this->app['config']['template_realdir'],
を263行目に追加します。
また、管理画面でのURL表記を変更するため、page_edit.twigも修正します。
- app/template/admin/Content/page_edit.twig
・59行目 {{ url('top') }}{{ app.config.user_data_route }}/{{ form_widget(form.url) }} ↓ {{ url('homepage') }}{{ form_widget(form.url) }}
こちらはuser_dataを表示上からなくしているだけです。
ここまで対応すればほぼ完了なのですが、FrontControllerProviderからuser_dataへルーティング定義を削除してしまったため、新たに定義してあげる必要があります。どこに定義するのかというと、index.phpで定義してあげます。
- html/index.php
// インストールされてなければインストーラにリダイレクト if (isset($app['config']['eccube_install']) && $app['config']['eccube_install']) { $app->initialize(); $app->initializePlugin(); if ($app['config']['http_cache']['enabled']) { $app['http_cache']->run(); } else { $app->run(); } } else { ・ ・ ・
と記載されている箇所を
// インストールされてなければインストーラにリダイレクト if (isset($app['config']['eccube_install']) && $app['config']['eccube_install']) { $app->initialize(); $app->initializePlugin(); // ページレイアウトのカスタマイズに伴う修正 $front = $app['controllers_factory']; // 強制SSL if ($app['config']['force_ssl'] == \Eccube\Common\Constant::ENABLED) { $front->requireHttps(); } $front->match('/{route}', '\Eccube\Controller\UserDataController::index')->assert('route', '([0-9a-zA-Z_\-]+\/?)+(?<!\/)')->bind('user_data'); $app->mount('', $front); if ($app['config']['http_cache']['enabled']) { $app['http_cache']->run(); } else { $app->run(); } } else { ・ ・ ・
というように新たにuser_data用のルーティング定義を行います。
以上の作業を行うことで、ページ管理から新たなページを作成した場合、URLにはuser_data
はなくなります。
必要な方には必要なカスタマイズだと思いますので、user_dataをURLから無くしてしまいたい!という方は是非ご利用ください。
EC-CUBE3でログイン成功時に直前まで見ていた画面へ戻る方法
EC-CUBE3ではログインする場合、EC-CUBE2とは違いログイン画面を経由させる必要があります。
また、ログイン成功後は必ずサイトのトップページへ戻ってしまいます。
サイトの作りにもよりますが、例えばログイン後は前に見ていた画面を表示して欲しいという要望があった場合、 以下のカスタマイズを行うことで実現可能となります。
EC-CUBE3.0.14を対象に説明します。
まず、MypageControllerにあるlogin関数を修正します。
- src/Eccube/Controller/Mypage/MypageController.php
/** * ログイン画面. * * @param Application $app * @param Request $request * @return \Symfony\Component\HttpFoundation\RedirectResponse|\Symfony\Component\HttpFoundation\Response */ public function login(Application $app, Request $request) { if ($app->isGranted('IS_AUTHENTICATED_FULLY')) { log_info('認証済のためログイン処理をスキップ'); return $app->redirect($app->url('mypage')); } /* @var $form \Symfony\Component\Form\FormInterface */ $builder = $app['form.factory'] ->createNamedBuilder('', 'customer_login'); if ($app->isGranted('IS_AUTHENTICATED_REMEMBERED')) { $Customer = $app->user(); if ($Customer) { $builder->get('login_email')->setData($Customer->getEmail()); } } $event = new EventArgs( array( 'builder' => $builder, ), $request ); $app['eccube.event.dispatcher']->dispatch(EccubeEvents::FRONT_MYPAGE_MYPAGE_LOGIN_INITIALIZE, $event); $form = $builder->getForm(); // ログイン前の画面へ戻す $error = $app['security.last_error']($request); if (!$error) { // ログインエラーがなければ戻り先をセット $referer = $request->headers->get('referer'); if ($referer) { // refererチェック $referers = parse_url($referer); if ($referers['host'] == $request->getHost()) { // ホストが同一であればrefererをセット $requestStackUri = $app['request_stack']->getMasterRequest()->getUri(); if ($request->getUri() == $requestStackUri) { // ログイン画面遷移直前のuriをセット $app->setLoginTargetPath($referer); } else { // ログイン必須画面のuriをセット $app->setLoginTargetPath($requestStackUri); } } } } return $app->render('Mypage/login.twig', array( 'error' => $error, 'form' => $form->createView(), )); }
修正箇所は、
// ログイン前の画面へ戻す $error = $app['security.last_error']($request); if (!$error) { // ログインエラーがなければ戻り先をセット $referer = $request->headers->get('referer'); if ($referer) { // refererチェック $referers = parse_url($referer); if ($referers['host'] == $request->getHost()) { // ホストが同一であればrefererをセット $requestStackUri = $app['request_stack']->getMasterRequest()->getUri(); if ($request->getUri() == $requestStackUri) { // ログイン画面遷移直前のuriをセット $app->setLoginTargetPath($referer); } else { // ログイン必須画面のuriをセット $app->setLoginTargetPath($requestStackUri); } } } } return $app->render('Mypage/login.twig', array( 'error' => $error, 'form' => $form->createView(), ));
になります。ログイン前のrefererを取得し、ログイン成功時に直前まで見ていた画面へ戻すようにしています。ただし、ログインが必要な画面を直接指定された場合、refererを取得するとログインに成功してもrefererで指定した画面に遷移してしまうため、
$app['request_stack']->getMasterRequest()->getUri()
と本来指定されているURLを取得し、比較する事でログイン成功後の遷移先を変更するようにセットしています。
refererが取得できない環境は諦めてください。
あと、login.twigも変更する必要があります。以下抜粋です。
- src/Eccube/Resource/template/default/Mypage/login.twig
{% if app.session.flashBag.has('eccube.login.target.path') %} {% for targetPath in app.session.flashBag.peek('eccube.login.target.path') %} <input type="hidden" name="_target_path" value="{{ targetPath }}" /> {% endfor %} {% endif %}
こちらの変更箇所ですが、
{% for targetPath in app.session.flashBag.peek('eccube.login.target.path') %}
の部分となり、get
からpeek
へと変更しています。なぜpeek
に変更しているかというと、ログインエラー時にセットされていたtargepathの値が削除されてしまいますので、peek
に変更しています。
以上の対応でログイン成功後は、直前まで見ていた画面へ遷移するようになります。
必要な方には必要なカスタマイズだと思います。特にスマホだとログイン後にトップページへ遷移してしまうと離脱されてしまう可能性が高くなりますのでこちらを是非活用してください。