ログイン

最近とある用事で、初めて EC-CUBE をガリガリとカスタマイズしています。

始めに構造を理解するまではどうしても時間がかかりますが、ある程度理解してしまえば何とかなりそうな感触はつかめてきました。それなりに規模が大きいシステムなので、ソース解析には Vim + GLOBAL さまさまという感じですね。

せっかくの機会なので、よく使えそうな小ネタでもあればこちらに残していこうと思っています。

さて、ログインしている時としていない時でページの表示を切り替えたいっていう要望はどこでもありますよね。今回はそんな時に使える、ログイン状態のチェックをどのページでもできるようにする方法です。

なお、EC-CUBEは Ver 2.13.2の環境です。

カスタマイズ方法

EC-CUBE には、ログインの判定結果を tpl_login という変数にセットしているいくつかのページがデフォルトで存在します。

例えば、下記のようにソースを grep すると、tpl_login に値をセットしている箇所が見つかります。

<br />
$ grep -rn &quot;\$this\-&gt;tpl_login =&quot; *<br />
data/class/pages/products/LC_Page_Products_Detail.php:240:            $this-&gt;tpl_login = true;<br />
data/class/pages/frontparts/bloc/LC_Page_FrontParts_Bloc_Login.php:43:        $this-&gt;tpl_login = false;<br />
data/class/pages/frontparts/bloc/LC_Page_FrontParts_Bloc_Login.php:72:            $this-&gt;tpl_login = true;<br />
data/class/pages/shopping/LC_Page_Shopping_Payment.php:95:            $this-&gt;tpl_login = '1';<br />
data/class/pages/shopping/LC_Page_Shopping_Confirm.php:129:            $this-&gt;tpl_login = '1';<br />
data/class/pages/cart/LC_Page_Cart.php:200:            $this-&gt;tpl_login = true;<br />

上記は、名前からも察しがつくように、商品詳細ページ、ログインブロック、カートページ、・・・といった特定のページを表示する時に使われるクラスなのですが、これらのページでは変数 tpl_login にセットされたログインしているか(true)否か(false)の結果によって、次のようにテンプレート内の表示を切り分けることができます。

<br />
&lt;!--{if $tpl_login}--&gt;<br />
ログイン中です。<br />
&lt;!--{else}--&gt;<br />
ログインしていません。<br />
&lt;!--{/if}--&gt;<br />

さて、これを特定のページに限らずどのページからも使えるようにしてみましょう。

ページ表示する際に必ず呼び出される LC_Page という基底クラス LC_Page(data/class/pages/LC_Page.php)があります。その拡張クラスである LC_Page_Ex(data/class_extends/page_extends/LC_Page_Ex.php)に、次のようなコードを追加します。

<br />
public function init()<br />
{<br />
    parent::init();</p>
<p>    // ログイン判定<br />
    $objCustomer = new SC_Customer_Ex();<br />
    if ($objCustomer-&gt;isLoginSuccess() === true) {<br />
        $this-&gt;tpl_login = true;<br />
    }<br />
}<br />

これで、どのページからも tpl_login にログイン判定結果がセットされるようになりました。

同様に LC_Page_Ex に処理を追加することで、全ページ共通で参照したい情報をセットしておくことが可能です。知っておくと役に立つ場面がありそうですね。

photo credit: Sean MacEntee via photopin cc