EC-CUBEプラグイン開発その６，好きな場所に”hello, world”と表示してみる。

admin

11年前

EC-CUBEの画面関連は、Smartyで書かれています。
具体的なファイルは、以下のパスに格納されています。
eccube/data/Smarty/templetes/admin (管理画面)
eccube/data/Smarty/templetes/default(PC画面)
eccube/data/Smarty/templetes/mobile (ガラケー画面)
eccube/data/Smarty/templetes/sphone (スマホ画面)

例えば、管理画面->オーナーズストア->ログ管理の画面ファイルは、以下のパスにあります。
eccube\data\Smarty\templates\admin\ownersstore/log.tpl
基本的には、URLと対応しているので見比べてみて下さい。
http://localhost/eccube/html/kanri/ownersstore/log.php

文字列を挿入する場所の目印として、HTMLタグのidやclassを使います。
例えば、ログテーブルの前に”hello, world”と表示したい時は
SC_Helper_Transform.select()メソッドを使います。

管理画面->オーナーズストア->ログ管理の画面ファイル(Smarty)

&lt;form name=&quot;form1&quot; id=&quot;form1&quot; method=&quot;post&quot; action=&quot;?&quot;&gt;
    &lt;input type=&quot;hidden&quot; name=&quot;&lt;!--{$smarty.const.TRANSACTION_ID_NAME}--&gt;&quot; value=&quot;&lt;!--{$transactionid}--&gt;&quot; /&gt;
    &lt;input type=&quot;hidden&quot; name=&quot;mode&quot; value=&quot;register&quot; /&gt;

    &lt;div id=&quot;ownersstore&quot; class=&quot;contents-main&quot;&gt;

        &lt;table class=&quot;list center&quot;&gt;
            &lt;tr&gt;
                &lt;th&gt;モジュール名&lt;/th&gt;
                &lt;th&gt;ステータス&lt;/th&gt;
                &lt;th&gt;日時&lt;/th&gt;
                &lt;th&gt;詳細&lt;/th&gt;
                &lt;!--{*&lt;th&gt;復元&lt;/th&gt;*}--&gt;
            &lt;/tr&gt;
            &lt;!--{foreach from=$arrInstallLogs item=log name=log_loop}--&gt;
                &lt;tr&gt;
                    &lt;td class=&quot;left&quot;&gt;&lt;!--{$log.module_name|h}--&gt;&lt;/td&gt;
                    &lt;td&gt;&lt;!--{if $log.error_flg}--&gt;失敗&lt;!--{else}--&gt;成功&lt;!--{/if}--&gt;&lt;/td&gt;
                    &lt;td class=&quot;left&quot;&gt;&lt;!--{$log.update_date|sfDispDBDate|h}--&gt;&lt;/td&gt;
                    &lt;td&gt;
                            &lt;a href=&quot;&lt;!--{$smarty.const.ROOT_URLPATH}--&gt;&lt;!--{$smarty.const.ADMIN_DIR}--&gt;ownersstore/log.php?mode=detail&amp;amp;log_id=&lt;!--{$log.log_id}--&gt;&quot;&gt;
                            詳細&lt;/a&gt;
                    &lt;/td&gt;
                    &lt;!--{*&lt;td&gt;&lt;!--{$log.log_id}--&gt;&lt;/td&gt;*}--&gt;
                &lt;/tr&gt;
            &lt;!--{/foreach}--&gt;
        &lt;/table&gt;
    &lt;/div&gt;
&lt;/form&gt;

<input type="hidden" name="" value="" />

<tr>

<th>モジュール名</th>

<th>ステータス</th>

</tr>

<tr>

<td>

<a href="ownersstore/log.php?mode=detail&amp;log_id=">

詳細</a>

</td>

</td>*}-->

</tr>

</table>

</div>

</form>

指定方法は、タグ名→ID名→クラス名で指定します。
HTMLタグ名はそのまま
id名の前には#を付ける
クラス名の前には.(ドット)を付ける

    static function prefilterTransform(&amp;$source, LC_Page_Ex $objPage, $filename) {
        $objTransform = new SC_Helper_Transform($source);
        
        //特定のSmartyファイルの特定の場所の文字列を置換する。
        if (strpos($filename, 'ownersstore/log.tpl') !== false) {
            $objTransform-&gt;select('div#ownersstore')-&gt;insertBefore(&quot;hello, world&quot;);
       
        }
        // 変更を実行します
        $source = $objTransform-&gt;getHTML();        
    }

static function prefilterTransform(&$source, LC_Page_Ex $objPage, $filename) {

$objTransform = new SC_Helper_Transform($source);

//特定のSmartyファイルの特定の場所の文字列を置換する。

if (strpos($filename, 'ownersstore/log.tpl') !== false) {

$objTransform->select('div#ownersstore')->insertBefore("hello, world");

}

// 変更を実行します

$source = $objTransform->getHTML();

}

他にも、指定したエレメントに対して、以下の様な操作するメソッドが用意されています。
insertBefore=要素の前にHTMLを挿入
insertAfter=要素の後にHTMLを挿入
appendFirst=要素の先頭にHTMLを挿入
appendChild=要素の末尾にHTMLを挿入
replaceElement=要素を指定したHTMLに置換
removeElement=要素を削除する

ちなみに最後の

// 変更を実行します
$source = $objTransform-&gt;getHTML();

1 2	// 変更を実行します $source = $objTransform->getHTML();

をつけ忘れないよう注意して下さい。筆者はつけ忘れて延々と悩んでいました(^_^;)

関連記事