PHP – igreks開発日記

【ECCUBE2】スパム対策としてお問合せフォームにreCaptchaを導入

定期的に中国から来る迷惑なお問合せフォームを利用したスパム。

スパムの一例↓

　　：
この度のお問い合せ誠にありがとうございます。

以下の内容で承りました。

回答を要するもので、万一、ご回答メールが届かない場合は、
受信トラブルの可能性もありますので
大変お手数ではございますがもう一度お問い合わせいただくか、
お電話にてお問い合わせください。

今後ともご愛顧賜りますようよろしくお願い申し上げます。


■会社団体名　: 城特邀，彩�牡首拵送э0%【】网址:[www.clf30.com]
■フリガナ　　: 未登録
■お名前　　　: 来了就送 城特邀，彩�牡首拵送э0%【】网址:[www.clf30.com] 様
■フリガナ　　: カタカ カタカ 様
■電話番号　　　：--
■メールアドレス：henson77777@qq.com

■お問い合わせの内容
城特邀，彩�牡首拵送э0%【】网址:[www.clf30.com]
　　：

　　：

この度のお問い合せ誠にありがとうございます。

以下の内容で承りました。

回答を要するもので、万一、ご回答メールが届かない場合は、

受信トラブルの可能性もありますので

大変お手数ではございますがもう一度お問い合わせいただくか、

お電話にてお問い合わせください。

今後ともご愛顧賜りますようよろしくお願い申し上げます。

■会社団体名　: 城特邀，彩�牡首拵送э0%【】网址:[www.clf30.com]

■フリガナ　　: 未登録

■お名前　　　: 来了就送城特邀，彩�牡首拵送э0%【】网址:[www.clf30.com] 様

■フリガナ　　: カタカカタカ様

■電話番号　　　：--

■メールアドレス：henson77777@qq.com

■お問い合わせの内容

城特邀，彩�牡首拵送э0%【】网址:[www.clf30.com]

　　：

このように、メールアドレス欄に不特定多数のメールアドレスを指定し、自動返信機能を利用してメールを送り付けている。

今までは接続元IPを特定して、apacheの設定ファイルなり.htaccessで個別にアクセスを拒否するなど、対症療法をしていましたが、業務の負担になりつつあるので、導入することにしました。

結果として効果はかなりあったようで、対策後およそ1か月、未だスパムによる被害は1回もうけていません。

reCaptchaをECCUBE2のお問合せフォームに導入する手順は以下の通りです。

サイトキーとシークレットキーの取得

reCaptchaにアクセスし「Admin console」を開きます。Googleアカウントが必要になります。
必要事項を入力し、サイトキーとシークレットキーを取得します。（今回は「」を採用します。）

テンプレートを修正

ECCUBE2のお問合せフォーム(確認画面)のテンプレートファイルを修正します。

  :
<form name="form1" id="form1" method="post" action="?">
     :
  <!-- <form>～</form>の任意の場所に以下を追記 ------------------>
  <!-- reCAPTCHA v3 -->
  <input type="hidden" name="recaptchaResponse" id="recaptchaResponse" />
  <!------------------------------------------------------------->
     :
</form>
  :

<!-- 任意の場所に以下のjsコードを追記 ----------------->
<!-- reCAPTCHA v3 Start -->
<script src="https://www.google.com/recaptcha/api.js?render=サイトキー"></script>
<script>
	grecaptcha.ready(function () {
    	grecaptcha.execute('サイトキー', {action: 'homepage'}).then(function(token) {
    	    var recaptchaResponse = document.getElementById('recaptchaResponse');
    	    recaptchaResponse.value = token;
    	});
	});
</script>
<!-- reCAPTCHA v3 End   -->

</form>

grecaptcha.ready(function () {

grecaptcha.execute('サイトキー', {action: 'homepage'}).then(function(token) {

var recaptchaResponse = document.getElementById('recaptchaResponse');

recaptchaResponse.value = token;

});

</script>

スマホページも運用している場合はそちらのテンプレート(data/Smarty/templates/sphone/contact/confirm.tpl)も同様に修正します。

PHPファイルの修正

お問い合わせの受付・自動返信メール送信処理を行うPHPファイルを修正します。

          :
        case 'complete':

            //reCAPTCHA v3の処理を追加 /////////////////////////////////
            if(isset($_POST['recaptchaResponse']) && !empty($_POST['recaptchaResponse'])){
                $secret = 'シークレットキー';
                $verifyResponse = file_get_contents('https://www.google.com/recaptcha/api/siteverify?secret='.$secret.'&response='.$_POST['recaptchaResponse']);
                $reCAPTCHA = json_decode($verifyResponse);
                if (!$reCAPTCHA->success){
                    SC_Utils_Ex::sfDispSiteError(
                        FREE_ERROR_MSG,
                        '',
                        false,
                        "スパム対策機能により送信がブロックされました。お手数ですがブラウザの戻るボタンを押して、再度ご送信お願いします。
                    ");
                    exit;
                }
            }else{
                SC_Utils_Ex::sfDispSiteError(
                    FREE_ERROR_MSG,
                    '',
                    false,
                    "スパム対策機能により送信がブロックされました。お手数ですがブラウザの戻るボタンを押して、再度ご送信お願いします。
                ");
                exit;
            }
            ///////////////////////////////////////////////////////////////

            $this->lfInitParam($objFormParam);
            $objFormParam->setParam($_POST);
            $this->arrErr = $objFormParam->checkError();
            $this->arrForm = $objFormParam->getFormParamList();
            if (SC_Utils_Ex::isBlank($this->arrErr)) {
                $this->lfSendMail($this);
                // 完了ページへ移動する
                SC_Response_Ex::sendRedirect('complete.php');
                exit;
            } else {
                SC_Utils_Ex::sfDispSiteError(CUSTOMER_ERROR);
                exit;
            }
            break;
              :

case 'complete':

//reCAPTCHA v3の処理を追加 /////////////////////////////////

if(isset($_POST['recaptchaResponse']) && !empty($_POST['recaptchaResponse'])){

$secret = 'シークレットキー';

$verifyResponse = file_get_contents('https://www.google.com/recaptcha/api/siteverify?secret='.$secret.'&response='.$_POST['recaptchaResponse']);

$reCAPTCHA = json_decode($verifyResponse);

if (!$reCAPTCHA->success){

SC_Utils_Ex::sfDispSiteError(

FREE_ERROR_MSG,

'',

false,

"スパム対策機能により送信がブロックされました。お手数ですがブラウザの戻るボタンを押して、再度ご送信お願いします。

");

exit;

}

}else{

SC_Utils_Ex::sfDispSiteError(

FREE_ERROR_MSG,

'',

false,

"スパム対策機能により送信がブロックされました。お手数ですがブラウザの戻るボタンを押して、再度ご送信お願いします。

");

exit;

}

///////////////////////////////////////////////////////////////

$this->lfInitParam($objFormParam);

$objFormParam->setParam($_POST);

$this->arrErr = $objFormParam->checkError();

$this->arrForm = $objFormParam->getFormParamList();

if (SC_Utils_Ex::isBlank($this->arrErr)) {

$this->lfSendMail($this);

// 完了ページへ移動する

SC_Response_Ex::sendRedirect('complete.php');

exit;

} else {

SC_Utils_Ex::sfDispSiteError(CUSTOMER_ERROR);

exit;

}

break;

確認

確認画面の右下に、以下のようなreCAPTCHAアイコンが表示されていれば、適用完了です。

参考サイト）

【ECCUBE2】外部からのPOSTでセッションが切れる件の対応

2020年4月に入ったあたりから、ECCUBE2を使用している内部サービスで、決済代行会社の決済画面から戻った際になぜかセッションが無効となり、ページ遷移エラーもしくは自動ログアウトしてしまう現象が発生。

原因は結果的に、chrome80からのCSRF(クロスサイトリクエストフォージェリ)対策として、Cookieセット時にSameSite属性が適切に指定されていない場合、外部からそのサイトにPOSTなどでアクセスされた際に発行されたサイトのCookieが強制的に無効になるという仕様によるものでした。（エンジニアが気づいた）

※なお、多くの混乱を招いたようで、直後のChromeアップデートで当仕様は取り急ぎロールバックされた模様。

Googleからのアナウンスは、2019年11月には出ていた模様で、4月に入ったあたりから徐々にクライアントのChromeが80に強制アップデートされたようです。

現実に多くのショッピングサイトでは、決済時に決済代行会社の決済画面（特にリンクタイプ）で決済を行った後、処理結果受け取りのために決済完了画面からPOSTで戻って、パラメタを処理しています。

ECCUBE2のなどのカートシステムなどを利用している場合、大抵はページ遷移チェックがかかるため、この時決済画面に行く前のCookie情報が削除されていることから、セッション情報が判定できず、ログイン状態が無効となりセッションエラーもしくはログアウトという結果になります。

こういったサイトでは、対策として、

Cookie発行時に「SameSite=None; Secure」をセットする
httpsを利用する

ことで対応できます。

こちらに詳しくまとめていただいている方がいるので、適宜参照していただければと思います。

ECCUBE2のついては、すでにパッチが配布されていますで、ECCUBE2のサイト管理者は至急対応されることをおススメします。

なおこの配布パッチを充てると、具体的には、

Cookieセット時に「SameSite=None;」を併せてセットする。この時、httpsなら「 Secure」を追加する
SameSite=Noneが未対応のブラウザ用に、あらかじめ互換用のCookieを発行しておく。
ECSESSIDが現Cookieと対応しない場合は ECSESSID の Cookie が拒否されたと見なす
3の場合はあらかじめ発行しておいた互換用 cookie からセッションデータを読み込む

といった動作を行うようになります。

今回のアップデートについて、告知はされていたものの、もう少し具体的に影響を受ける対象事業者に対して大々的に告知してほしかったというのが正直なところ。

さらに言えば、決済代行会社も情報を早めに得て、影響を受ける顧客に周知するべきだったと思います。（リンクタイプを使っているクライアントはかなりいると思うし、、、）

うちが使っている決済代行会社は、通常結構この辺はきっちりしていて、こういう件が発生するときはかなり早めに連絡がくるのですが、今回に限ってはまったくもってノーマークだったように思います。念のため問い合わせたときに「特に障害情報は出ていません。どのような不具合でしょうか？」のような対応でしたからねー。

ECCUBE3でフォームの入力制限文字数を変更する

例えば、管理画面の何かしらのメニューでURL情報を入力するとき、stext_len(50文字)だと足りない時があるので、mtext_len(200文字)に変更する。

  :
$builder
  ->add('url', 'text', array(
    'required' => true,
    'label' => 'URL',
    'constraints' => array(
      // stext_len(50文字)だと足りないのでmtext_len(200文字)に変更
      //new Assert\Length(array('max' => $config['stext_len'])),
      new Assert\Length(array('max' => $config['mtext_len'])),
    ),
));
  :

$builder

->add('url', 'text', array(

'required' => true,

'label' => 'URL',

'constraints' => array(

// stext_len(50文字)だと足りないのでmtext_len(200文字)に変更

//new Assert\Length(array('max' => $config['stext_len'])),

new Assert\Length(array('max' => $config['mtext_len'])),

));

これらの値（$config[‘***’]）は”/src/Eccube/Resource/config/constant.yml.dist”で定義されている。

ちなみに以下、文字数制限の主要なデフォルト値。

amount_len: 6
credit_no_len: 4
file_name_len: 10
id_max_len: 50
id_min_len: 4
int_len: 9
lltext_len: 99999
ltext_len: 3000
mltext_len: 1000
mtext_len: 200
password_max_len: 32
password_min_len: 8
percentage_len: 3
price_len: 8
search_category_len: 18
sltext_len: 500
smtext_len: 100
stext_len: 50
tel_len: 5
tel_len_min: 1
tel_item_len: 12
url_len: 1024
zip01_len: 3
zip02_len: 4
name_len: 16
kana_len: 25
address1_len: 32
address2_len: 32

amount_len: 6

credit_no_len: 4

file_name_len: 10

id_max_len: 50

id_min_len: 4

int_len: 9

lltext_len: 99999

ltext_len: 3000

mltext_len: 1000

mtext_len: 200

password_max_len: 32

password_min_len: 8

percentage_len: 3

price_len: 8

search_category_len: 18

sltext_len: 500

smtext_len: 100

stext_len: 50

tel_len: 5

tel_len_min: 1

tel_item_len: 12

url_len: 1024

zip01_len: 3

zip02_len: 4

name_len: 16

kana_len: 25

address1_len: 32

address2_len: 32

ECCUBE3 独自パラメタで検索→リスト表示の時にサブタイトルにパラメタ名を反映させる

前提条件いろいろ割愛しますが、DBに当該データが入っていて、Doctrineファイルにパラメタと名前が定義してあり、Formビルダー各パラメタが構築されてるのが前提です。

以下ファイルを修正。

/src/Eccube/Controller/ProductController.php

		：
    /**
     * ページタイトルの設定
     *
     * @param  null|array $searchData
     * @return str
     */
    private function getPageTitle($searchData)
    {
        if (isset($searchData['name']) && !empty($searchData['name'])) {
            return '検索結果';
        } elseif (isset($searchData['category_id']) && $searchData['category_id']) {
            return $searchData['category_id']->getName();
        // *********************************************** //
        // 検索キー(パラメタ名->getName())をサブタイトルに反映：
        // 地方(東北地方とかの)
        } elseif (isset($searchData['district']) && $searchData['district']) {
        	// この情報はymlに登録してない（DBと連携してない）ので、定義してあるクラスから引っ張ってきた
            return Constant::DISTRICTS[$searchData['district']]['name'] ? Constant::DISTRICTS[$searchData['district']]['name']: null;
        // 都道府県
        } elseif (isset($searchData['pref']) && $searchData['pref']) {
            return $searchData['pref']->getName();
        // 市区町村
        } elseif (isset($searchData['city']) && $searchData['city']) {
            return $searchData['city']->getName();
        } elseif (isset($searchData['brewery']) && $searchData['brewery']) {
            return $searchData['brewery']->getName();
        } elseif (isset($searchData['brand']) && $searchData['brand']) {
            return $searchData['brand']->getName();
        // *********************************************** //
        } else {
            return '全商品';
        }
    }
    	:

：

/**

* ページタイトルの設定

* @param null|array $searchData

* @return str

private function getPageTitle($searchData)

{

if (isset($searchData['name']) && !empty($searchData['name'])) {

return '検索結果';

} elseif (isset($searchData['category_id']) && $searchData['category_id']) {

return $searchData['category_id']->getName();

// *********************************************** //

// 検索キー(パラメタ名->getName())をサブタイトルに反映：

// 地方(東北地方とかの)

} elseif (isset($searchData['district']) && $searchData['district']) {

// この情報はymlに登録してない（DBと連携してない）ので、定義してあるクラスから引っ張ってきた

return Constant::DISTRICTS[$searchData['district']]['name'] ? Constant::DISTRICTS[$searchData['district']]['name']: null;

// 都道府県

} elseif (isset($searchData['pref']) && $searchData['pref']) {

return $searchData['pref']->getName();

// 市区町村

} elseif (isset($searchData['city']) && $searchData['city']) {

return $searchData['city']->getName();

} elseif (isset($searchData['brewery']) && $searchData['brewery']) {

return $searchData['brewery']->getName();

} elseif (isset($searchData['brand']) && $searchData['brand']) {

return $searchData['brand']->getName();

// *********************************************** //

} else {

return '全商品';

}

基本、$searchDataに値が入っていれば、getName->()でとれます。

Joomla1.5でdescriptionにtitleの値を設定する

Joomla1.5とかって古っ！！という意見は置いておいて、、。

主にGoogleのSEO対策です。

Joomlaでは、ページのdescriptionが明示的に指定されていないと、グローバルのdescriptionの値が出力されます。

なので、descriptionの指定が無いページは、すべてdescriptionの内容が同じになって、Google先生にサーチコンソールとかで、「HTMLの改善：descriptionの重複！」と怒られます。

Joomlaで書き溜めた何百件もある記事、これから1件1件descriptionを書き足すのはかなり大変ですので、descriptionにはtitleの内容を動的に出力させ、Google先生の警告を回避するという横着な方法です。

１．/templates/使用中のテンプレート名/index.phpを開きます。

2．以下のように修正します。

// headタグ内の<jdoc:include type="head" />の直前に追記
 :
<head>
// [Start] ***********//
<?php
  // Google対策 他のページとDescriotionが重複しないようにDescriptionには
  // タイトルの値を設定する
  $document =& JFactory::getDocument();
  $document->setDescription($document->title);
}
?>
// [End] *************// 
<jdoc:include type="head" />
 :

// headタグ内の<jdoc:include type="head" />の直前に追記

<head>

// [Start] ***********//

<?php

// Google対策他のページとDescriotionが重複しないようにDescriptionには

// タイトルの値を設定する

$document =& JFactory::getDocument();

$document->setDescription($document->title);

}

// [End] *************//

<jdoc:include type="head" />

以上です。

ECCUBE3の商品一覧の並び順に「お気に入り数順」を追加する

まず最初に、並び順テーブル(mtb_product_list_order_by)に新しく「お気に入り数順」を追加

（一例）
・id：4
・name：お気に入り数順(任意)
・rank：3

※optionの順番を前に持ってきたければrankの番号を減らす

/src/Eccube/Resource/config/constant.yml.dist に追加したorderbyパラメタの番号(4)に名前を定義する

  :
++ product_order_favorite_higher: 4
  :

++ product_order_favorite_higher: 4

参考）
https://github.com/EC-CUBE/ec-cube/issues/2703

/src/Eccube/Repository/ProductRepository.php に、SQLを定義する

// 新着順のセクションの後に以下を追加

// お気に入り数順
else if (!empty($searchData['orderby']) && $searchData['orderby']->getId() == $config['product_order_favorite_higher']) {
   $qb->addSelect('COUNT(cfp.id) as HIDDEN favorite_count');
   $qb->leftJoin('p.CustomerFavoriteProducts', 'cfp');
   $qb->groupBy('p');
   $qb->orderBy('favorite_count', 'DESC');
   $qb->addOrderBy('p.id', 'DESC');
}

// 新着順のセクションの後に以下を追加

// お気に入り数順

else if (!empty($searchData['orderby']) && $searchData['orderby']->getId() == $config['product_order_favorite_higher']) {

$qb->addSelect('COUNT(cfp.id) as HIDDEN favorite_count');

$qb->leftJoin('p.CustomerFavoriteProducts', 'cfp');

$qb->groupBy('p');

$qb->orderBy('favorite_count', 'DESC');

$qb->addOrderBy('p.id', 'DESC');

}

※クエリビルダーを使用する際、JOINするテーブル名やカラム名はdoctrineの定義に基づくので、 /src/Eccube/Resource/doctrine/Eccube.Entity.CustomerFavoriteProduct.dcm.ymlなどの中を確認して、同じ名前にする。

ちなみに、上記は、生のSQLとしては下記のような感じとなる。多分。

SELECT * , Count(cfp.product_id)        AS favorite_count
FROM       dtb_product                  AS p
LEFT JOIN dtb_customer_favorite_product AS cfp
ON         p.product_id = cfp.product_id
GROUP BY   p.product_id
ORDER BY   favorite_count DESC, p.product_id DESC

SELECT * , Count(cfp.product_id) AS favorite_count

FROM dtb_product AS p

LEFT JOIN dtb_customer_favorite_product AS cfp

ON p.product_id = cfp.product_id

GROUP BY p.product_id

ORDER BY favorite_count DESC, p.product_id DESC

参考）
https://xoops.ec-cube.net/modules/newbb/viewtopic.php?topic_id=17472&forum=10
https://ameblo.jp/withathena/entry-12173872626.html
https://umebius.com/eccube/sort_admin_product_master/
http://doctrine-orm.readthedocs.io/projects/doctrine-orm/en/latest/reference/query-builder.html
https://teratail.com/questions/30434
https://teratail.com/questions/43888
http://www.aiship.jp/knowhow/archives/25107
http://d.hatena.ne.jp/Fivestar/20100423/1272013815

以上で、商品一覧ページのドロップダウンに「お気に入り数順」が追加され、選択するとお気に入りに追加された数の多い商品順にソートされる。

twigのフィルターまとめ

随時更新中。

HTMLタグをエスケープ無しで出力(デフォルトではエスケープされる)

{{ html | raw }}

1	{{ html \| raw }}

参考サイト

ECCUBE3(Symfony)のテンプレート(Twig)内でのシステムURL出力

忘備録として随時更新中。テンプレ内をよく探せば出てくるのだが、、、。

トップページURL

{{ url('homepage') }}

1	{{ url('homepage') }}

カレントページ(現在アクセスしているページ)URL

{{ app.request.uri }}

1	{{ app.request.uri }}

商品一覧ページURL

{{# 基本形 #}}
{{ url('product_list') }}

{{# カテゴリ情報を付ける場合 #}}
{{ url('product_list') }}?category_id="カテゴリID"

{{# EntityでCategory.idが定義されている場合 #}} 
{{ url('product_list') }}?category_id={{ Category.id }}

{{ url('product_list') }}?category_id="カテゴリID"

{{ url('product_list') }}?category_id={{ Category.id }}

商品画像保存ディレクトリの絶対パス

{{# 基本形 #}}
{{ app.config.image_save_urlpath }}

{{# ファイル名を指定する場合 #}}
{{ app.config.image_save_urlpath }}/"画像ファイル名"

{{# EntityでProduct.ProductImageが定義されている場合 #}}
{{ app.config.image_save_urlpath }}/{{ Product.ProductImage."添え字"|no_image_product }}

{{ app.config.image_save_urlpath }}/"画像ファイル名"

{{ app.config.image_save_urlpath }}/{{ Product.ProductImage."添え字"|no_image_product }}

商品詳細ページURL

{{# 基本形 #}}
{{ url('product_detail', {'id': "商品ID") }}

{{# EntityでProduct.idが定義されている場合 #}}
{{ url('product_detail', {'id': Product.id}) }}

{{ url('product_detail', {'id': "商品ID") }}

{{ url('product_detail', {'id': Product.id}) }}

商品詳細ページでのメイン画像URL (Pinterestボタンに画像URLのパラメタ付けたい時とか)

{{ "Product.ProductImage"が商品画像のファイル名が入った配列 }}
{{ url('homepage') }}upload/save_image/{{ Product.ProductImage.0|no_image_product }}

1 2	{{ "Product.ProductImage"が商品画像のファイル名が入った配列 }} {{ url('homepage') }}upload/save_image/{{ Product.ProductImage.0\|no_image_product }}

参考サイト）

ECCUBE3でカテゴリに補足情報を追加する

EC-CUBE 3.0.16
MySQL 5.6.19
PHP 5.6.36

例として、あるカテゴリに「関連A」(assoc_A)という補足情報を追加する場合。

１．テーブルへのカラム追加
dtb_categoryテーブルへ”assoc_A”という名前のカラムをtinyintタイプで追加。また、NULLを許可にする。

２．エンティティファイルに、セッターゲッター追加
/src/Eccube/Entity/Category.php

以下のように追記。

    /**
     * @var integer
     */
    private $assoc_A;
 
    /**
     * @return string
     */
    public function getAssocA()
    {
        return $this->assoc_A;
    }
 
    /**
     * @param string $assoc_A
     * @return \Eccube\Entity\Category
     */
    public function setAssocA($assocA)
    {
        $this->assoc_A = $assocA;
        return $this;
    }

    /************************************
     ※メソッド名とその引数にアンダーバーを使うと
       エラーになるので、宣言した変数名にアンダーバー
       を含む場合は上記のように、アンダーバーを消して
       その次の文字を大文字(キャメルケース)にする。
    ************************************/

/**

* @var integer

private $assoc_A;

/**

* @return string

public function getAssocA()

{

return $this->assoc_A;

}

/**

* @param string $assoc_A

* @return \Eccube\Entity\Category

public function setAssocA($assocA)

{

$this->assoc_A = $assocA;

return $this;

}

/************************************

※メソッド名とその引数にアンダーバーを使うと

エラーになるので、宣言した変数名にアンダーバー

を含む場合は上記のように、アンダーバーを消して

その次の文字を大文字(キャメルケース)にする。

************************************/

３．データベース定義ファイルへカラム追加
/src/Eccube/Resource/doctrine/Eccube.Entity.Category.dcm.yml

fields一覧にassoc_Aの項目を追加。データベースとエンティティクラスを接続するのがdcm.yml(Doctrineマッピングファイル)。これにより、Categoryエンティティのassoc_Aとdtb_categoryのassoc_Aカラムが接続される。

       assoc_A:
            type: boolean
            nullable: true

assoc_A:

type: boolean

nullable: true

※データ型がint,smallint,tinyintでも、Formでcheckboxタイプを使う予定のため（論理型(値が1か0のタイプ)と認識されるので）ブーリアンタイプにしておく。

ECCUBE3で使用できるtype一覧は過去記事参照。

4．フォーム定義ファイルへの項目追加
/src/Eccube/Form/Type/Admin/CategoryType.php

下記のように、管理画面の商品登録フォームへ定義を追加。

$builder->add('assoc_A', 'checkbox', array(
                'label' => 'A',
                'required' => false,
                //valueはデフォルトで"1"らしい
          ));

$builder->add('assoc_A', 'checkbox', array(

'label' => 'A',

'required' => false,

//valueはデフォルトで"1"らしい

));

5．管理画面（カテゴリ登録画面）へフォーム表示
/app/template/admin/Product/category.twig

フォームを表示したい場所に下記のように記述。

{{ form_row(form.assoc_A) }}
{{## もしくは ##}}
{{ form_widget(form.assoc_A) }}{{ form_errors(form.assoc_A) }}

6．商品詳細ページへの表示
/app/template/default/Product/detail.twig

関連付けした情報を使って詳細ページでごにょごにょするには、多少の工夫が必要。これについては別途書く予定。

とりあえず以上。

参考URL）

http://symfony.com/doc/current/reference/forms/types/checkbox.html

ECCUBE3で商品に新しい項目を追加

EC-CUBE 3.0.16
MySQL 5.6.19
PHP 5.6.36

例として、商品名かな(name_kana)という項目を追加する場合。

１．テーブルへのカラム追加
dtb_productテーブルへ”name_kana”という名前のカラムをtextタイプ(またはvarchar)で追加。また、NULLを許可にする。

２．エンティティファイルに、セッターゲッター追加
/src/Eccube/Entity/Product.php

以下のように追記。

    /**
     * @var string
     */
    private $name_kana;
 
    /**
     * @return string
     */
    public function getNameKana()
    {
        return $this->name_kana;
    }
 
    /**
     * @param string $name_kana
     * @return \Eccube\Entity\Product
     */
    public function setNameKana($nameKana)
    {
        $this->name_kana = $nameKana;
        return $this;
    }

    /************************************
     ※メソッド名とその引数にアンダーバーを使うと
       エラーになるので、宣言した変数名にアンダーバー
       を含む場合は上記のように、アンダーバーを消して
       その次の文字を大文字(キャメルケース)にする。
    ************************************/

/**

* @var string

private $name_kana;

/**

* @return string

public function getNameKana()

{

return $this->name_kana;

}

/**

* @param string $name_kana

* @return \Eccube\Entity\Product

public function setNameKana($nameKana)

{

$this->name_kana = $nameKana;

return $this;

}

/************************************

※メソッド名とその引数にアンダーバーを使うと

エラーになるので、宣言した変数名にアンダーバー

を含む場合は上記のように、アンダーバーを消して

その次の文字を大文字(キャメルケース)にする。

************************************/

３．データベース定義ファイルへカラム追加
/src/Eccube/Resource/doctrine/Eccube.Entity.Product.dcm.yml

fields一覧にname_kanaの項目を追加。データベースとエンティティクラスを接続するのがdcm.yml(Doctrineマッピングファイル)。これにより、Productエンティティのname_kanaとdtb_productのname_kanaカラムが接続される。

       name_kana:
            type: text
            nullable: true

name_kana:

type: text

nullable: true

ちなみに、EC-CUBE３が採用しているSymfonyの標準ORM、Doctorineで設定できるフィールドタイプは以下の通り。

    const TARRAY = 'array';
    const SIMPLE_ARRAY = 'simple_array';
    const JSON_ARRAY = 'json_array';
    const BIGINT = 'bigint';
    const BOOLEAN = 'boolean';
    const DATETIME = 'datetime';
    const DATETIMETZ = 'datetimetz';
    const DATE = 'date';
    const TIME = 'time';
    const DECIMAL = 'decimal';
    const INTEGER = 'integer';
    const OBJECT = 'object';
    const SMALLINT = 'smallint';
    const STRING = 'string';
    const TEXT = 'text';
    const BINARY = 'binary';
    const BLOB = 'blob';
    const FLOAT = 'float';
    const GUID = 'guid';

const TARRAY = 'array';

const SIMPLE_ARRAY = 'simple_array';

const JSON_ARRAY = 'json_array';

const BIGINT = 'bigint';

const BOOLEAN = 'boolean';

const DATETIME = 'datetime';

const DATETIMETZ = 'datetimetz';

const DATE = 'date';

const TIME = 'time';

const DECIMAL = 'decimal';

const INTEGER = 'integer';

const OBJECT = 'object';

const SMALLINT = 'smallint';

const STRING = 'string';

const TEXT = 'text';

const BINARY = 'binary';

const BLOB = 'blob';

const FLOAT = 'float';

const GUID = 'guid';

4．フォーム定義ファイルへの項目追加
/src/Eccube/Form/Type/Admin/ProductType.php

下記のように、管理画面の商品登録フォームへ定義を追加。

$builder->add('name_kana', 'text', array(
                'label' => '商品名かな',
                'required' => true,
            ));

$builder->add('name_kana', 'text', array(

'label' => '商品名かな',

'required' => true,

));

上記の書き方で入力必須とならない場合（未入力で保存した際にエラーとならない）場合は、下記のようにする。

$builder->add('name_kana', 'text', array(
                'label' => '商品名かな',
                'required' => true,
                'constraints' => array(
                    new Assert\NotBlank(),
                ),
            ));

$builder->add('name_kana', 'text', array(

'label' => '商品名かな',

'required' => true,

'constraints' => array(

new Assert\NotBlank(),

));

なお、フォームの入力形式として整数型としたい場合は、第2引数に”integer”, 浮動小数点型としたい場合は、第2引数に”number”を指定するなどして対応。

このほかにも選択型(choice型)も指定できる。詳細は公式ドキュメントを参照。

5．管理画面（商品情報登録画面）へフォーム表示
/app/template/admin/Product/product.twig

フォームを表示したい場所に下記のように記述。

{{ form_row(form.name_kana) }}

1	{{ form_row(form.name_kana) }}

form_rowは、form_label、form_widget、form_errorsを同時に出力する関数。テキストの入力幅を小さくしたい場合などは、form_label、form_widget、form_errorsに分割するなどしてCSSで対応。

<!-- 入力幅を小さく -->
<div id="" class="form-group">
    {{ form_label(form.name_kana) }}
    <!-- col-sm-* col-lg-* の「*」値で調整すると簡単 -->
    <div class="col-sm-2 col-lg-2">
        {{ form_widget(form.name_kana) }}
        {{ form_errors(form.name_kana) }}
    </div>
</div>

</div>

6．商品詳細ページへの表示
/app/template/default/Product/detail.twig

フロント側で出力。好きな場所に下記のように記載。未登録であれば何も出力されない。

{{ Product.name_kana }}

1	{{ Product.name_kana }}

以上。

参考URL）