環境変数を使用する際、毎回定義があるかの確認や数値への変換、IDEのコード補完が使えないなどの面倒な点が多数あります。
そこで、事前に環境変数の型を定義することで、コードの品質向上とコーディング時の利便性を改善する方法を、当社では採用しています。

環境変数ファイル
**.env.production**
に環境変数を設定します。

```
NEXT_VAR="テスト"
EXSAMPLE_VAR_STRING="文字列"
EXSAMPLE_VAR_NUMBER=1234
```

次に
**env.d.ts**
ファイルを作成し、環境変数の型を定義します。

```typescript
export type CustomProcessEnv = {
 NEXT_VAR: string
 EXSAMPLE_VAR_STRING: string
 EXSAMPLE_VAR_NUMBER: number
}

declare namespace NodeJS {
 interface ProcessEnv extends CustomProcessEnv {}
}
```

ビルド時に
**env.d.ts**
ファイルを読み込み、環境変数と型をマッピングしたファイルを生成するためのスクリプト
**generate_env_map.js**
ファイルを作成します。
ファイルの生成はts-morphというTypescriptのコードを解析、リファクタリング、生成などの処理を行うライブラリを利用します。
また、環境変数ファイルなどを読み込みためのdotenvも利用しますので、インストールされていなければ追加してください。

```javascript
const { Project } = require('ts-morph')
const fs = require('fs')
const path = require('path')

// .envを読み込む
require('dotenv').config()

/**
 * 環境変数の型マッピングを生成します。
 */
function generateEnvMap() {
 const envDtsPath = path.resolve(__dirname, 'env.d.ts')
 const envMapPath = path.resolve(__dirname, 'env_map.ts')

 // プロジェクトの設定
 const project = new Project({
 tsConfigFilePath: path.resolve(__dirname, 'tsconfig.json'),
 })

 // 型定義ファイルを追加
 const sourceFile = project.addSourceFileAtPath(envDtsPath)

 // 型エイリアスを取得
 const typeAlias = sourceFile.getTypeAliasOrThrow('CustomProcessEnv')

 // プロパティを取得
 const properties = typeAlias.getType().getProperties()

 // 環境変数のマッピングを収集
 const envVars = properties.map((prop) => {
 const name = prop.getName()
 const declarations = prop.getDeclarations()
 if (declarations.length === 0) {
 throw new Error(`No declarations found for environment variable ${name}`)
 }
 const type = declarations[0].getType().getText()

 if (type !== 'string' && type !== 'number' && type !== 'boolean') {
 throw new Error(`Unsupported type for environment variable ${name}: ${type}`)
 }

 return { name, type }
 })

 // サーバーサイドとクライアントサイドのマッピングを分離
 const serverEnvVars = envVars
 const clientEnvVars = envVars.filter((env) => env.name.startsWith('NEXT_PUBLIC_'))

 // クライアントサイド用の値を取得
 const clientEnvValues = clientEnvVars.map((env) => {
 const value = process.env[env.name]
 if (value === undefined) {
 throw new Error(`Environment variable ${env.name} is not defined.`)
 }

 // 型に基づいて値を適切に変換
 let formattedValue
 switch (env.type) {
 case 'boolean':
 formattedValue = value === 'true'
 break
 case 'number':
 const num = Number(value)
 if (isNaN(num)) {
 throw new Error(`Environment variable ${env.name} should be a valid number.`)
 }
 formattedValue = num
 break
 case 'string':
 default:
 formattedValue = value
 }

 return { name: env.name, type: env.type, value: formattedValue }
 })

 // マッピングファイルのテンプレート
 const fileContent = `
 export const serverEnvMap: Record<string, 'string' | 'number' | 'boolean'> = {
 ${serverEnvVars.map((env) => `'${env.name}': '${env.type}',`).join('\n ')}
 };

 export const clientEnvMap: Record<string, { type: 'string' | 'number' | 'boolean'; value: string | number | boolean }> = {
 ${clientEnvValues.map((env) => `'${env.name}': { type: '${env.type}', value: ${JSON.stringify(env.value)} },`).join('\n ')}
 };
 `

 // ファイルを書き出す
 fs.writeFileSync(envMapPath, fileContent, { encoding: 'utf8' })

 console.log('env_map.ts has been generated successfully.')
}

module.exports = { generateEnvMap }

// スクリプトが直接実行された場合に関数を呼び出す
if (require.main === module) {
 generateEnvMap()
}
```

buildやstart時に
**env_map.ts**
ファイルが生成されるように、以下のように
**package.json**
を修正します。

```json
{
 "name": "Youre App",
 "version": "0.0.1",
 "license": "",
 "scripts": {
 "generate_env_map": "dotenvx run -f .env.production -- node generate_env_map.js",
 "dev": "pnpm generate_env_map && NODE_TLS_REJECT_UNAUTHORIZED=0 next dev --turbo",
 "build": "pnpm generate_env_map && next build",
 "start": "pnpm generate_env_map && next start",
 },
 ...
```

生成されたファイル
***env_map.ts***
は以下のように出力されます。

```typescript
 export const serverEnvMap: Record<string, 'string' | 'number' | 'boolean'> = {
 'NEXT_VAR': string
 'EXSAMPLE_VAR_STRING': 'string'
 'EXSAMPLE_VAR_NUMBER': 'number'
 };
 export const clientEnvMap: Record<string, { type: 'string' | 'number' | 'boolean'; value: string | number | boolean }> = {
 'NEXT_VAR': { type: 'string', value: "テスト" },
 };
```

環境変数を利用するためのユーティリティ
**EnvUtil.ts**
を作成します。

```typescript
import { CustomProcessEnv } from 'env'
import { serverEnvMap, clientEnvMap } from 'env_map'

/**
 * 環境変数を取得します。
 *
 * @param key - 環境変数のキー
 * @param options - { type?: 'string' | 'number' | 'boolean', default?: CustomProcessEnv[K] }
 * @returns 環境変数の値（存在しない場合は default）
 */
export function getEnv<K extends keyof CustomProcessEnv>(key: K, defaultValue?: CustomProcessEnv[K]): CustomProcessEnv[K] {
 if (defaultValue !== undefined) {
 return defaultValue
 }

 let type: 'string' | 'number' | 'boolean' = 'string'
 let value: string | number | boolean = ''

 // サーバーサイド
 if (typeof window === 'undefined') {
 type = serverEnvMap[key]
 if (!type) {
 throw new Error(`${key} 環境変数は定義されていません。`)
 }

 value = process.env[key] as string
 if (value === undefined) {
 throw new Error(`${key} 環境変数を定義してください。`)
 }
 } else {
 // クライアントサイド
 const env = clientEnvMap[key]
 if (!env) {
 throw new Error(`${key} 環境変数を定義してください。`)
 }
 type = env.type
 value = env.value
 }

 switch (type) {
 case 'boolean':
 return ((typeof value === 'boolean' && value) || value === 'true') as CustomProcessEnv[K]
 case 'number':
 const parsedNumber = Number(value)
 if (isNaN(parsedNumber)) {
 throw new Error(`${key} 環境変数は数値で設定してください。[VALUE] ${value}`)
 }
 return parsedNumber as CustomProcessEnv[K]
 case 'string':
 default:
 return value as CustomProcessEnv[K]
 }
}
```

以下のようにgetEnv関数を使い環境変数を使うことができます。コード補完も出来るようになりますので試してみてください。

```typescript
import { getEnv } from 'EnvUtil'

getEnv('NEXT_VAR')
```

Next.jsの環境変数にTypescriptの型を定義する方法

## EC-CUBE 4

### 管理画面で確認する

**設定 -> システム設定 -> システム情報** で確認することができます。

![EC-CUEB4のシステム情報画面](/upload/save_image/column/ec-cube/ec-cube_version_4.png)

### ファイルで確認する

**[EC-CUBEインストールディレクトリ]/src/Eccube/Common/Constant.php**
```php
namespace Eccube\Common;

class Constant
{
    /**
     * EC-CUBE VERSION.
     */
    public const VERSION = '4.3.0';
```

***

## EC-CUBE 3

### 管理画面で確認する

**設定 -> システム情報設定 -> システム情報** で確認することができます。

![EC-CUEB3システム情報画面](/upload/save_image/column/ec-cube/ec-cube_version_3.png)

### ファイルで確認する

**[EC-CUBEインストールディレクトリ]/src/Eccube/Common/Constant.php**
```php
namespace Eccube\Common;

class Constant {

    /**
     * EC-CUBE VERSION.
     */
    const VERSION = '3.0.18-p6';
```

***

## EC-CUBE 2

### ファイルで確認する

**[EC-CUBEインストールディレクトリ]/data/class/SC_Initial.php**
```php
/**
 * アプリケーションの初期設定クラス.
 *
 * @author EC-CUBE CO.,LTD.
 *
 * @version $Id$
 */
class SC_Initial
{
    /**
     * コンストラクタ.
     */
    public function __construct()
    {
        /* EC-CUBEのバージョン */
        defined('ECCUBE_VERSION') || define('ECCUBE_VERSION', '2.25.0');
    }
```

EC-CUBEバージョン確認

EC-CUBEのバージョン確認方法

[「EC-CUBE Advent Calendar 2021」](https://qiita.com/advent-calendar/2021/ec-cube)24日目の投稿です。
先日、「[画像変換・配信エンジン ImageFlux](https://www.sakura.ad.jp/information/pressreleases/2021/12/15/1968208756/)」が、小規模から利用しやすい4つの料金プランにリニューアルしました。
550円/月～と導入しやすい価格設定になったので、早速、EC-CUBE4で試してみました。

---

### ImageFluxとは

ImageFluxは、さくらインターネットとピクシブで共同で開発・提供している画像変換・配信エンジンです。 
1枚の画像をもとにデバイスに最適化された画像を簡単に生成し、高速かつ高品質で配信できます。 
リリースから5周年を迎えるサービスで、料金プランの変更により、さらに使いやすくなりました。

**参考**: [ImageFlux](https://www.sakura.ad.jp/services/imageflux/)

ImageFluxを導入すると、次のような課題が解決できます:

- よりきれいな商品画像を使用したい場合
- 商品一覧で快適に多くの商品を表示させたい場合

ImageFluxは自動で画像変換を行うため、以下のリソース削減が期待できます:

- サーバリソース（CPU、ストレージ）
- ネットワークリソース
- 開発リソース

---

### ImageFluxの申し込みと設定

ImageFluxの申し込みには、さくらインターネットのアカウントが必要です。

![申し込み画面](/upload/save_image/column/ec-cube/imageflux_001.jpg)

[申し込み画面](https://www.sakura.ad.jp/services/imageflux/)からプランを選択します。
申込内容を確認し、アクティベートを完了させます。

![申込内容確認画面](/upload/save_image/column/ec-cube/imageflux_002.jpg)

アクティベート画面が出ましたら、アクテベートしてください。
申し込みは、以上です。

引き続き、設定を行います。

### オリジンサーバの設定

![](/upload/save_image/column/ec-cube/imageflux_003.jpg)

オリジン設定では、オリジンとなるサーバの情報を入力してください。

- Type: HTTP
- Scheme: https
- Host: **EC-CUBEのドメイン名**

#### Signed URL設定

- 署名付きURLを使用する: チェック
- Signing Secret: 自動生成をクリックして生成

今回は、パスプレフィックス毎のパラメータ設定は行いませんので以上となります。
設定をクリックします。
状態が運用中に代わりましたら、設定完了となります。

![オリジン設定画面](/upload/save_image/column/ec-cube/imageflux_004.jpg)

2点情報が必要なので、控えておいてください。

- Name：*******.imageflux.jp
- Signing Secret：********

---

### EC-CUBEの設定

ImageFluxの設定が完了したら、以下を設定します:

1. `app/Customize/Twig/Extension/ImageFluxExtension.php`を追加
2. `Signing Secret`と`ImageFluxのURL`を設定

**app/Customize/Twig/Extension/ImageFluxExtension.php**

```php
protected $signing_secret = "********";
protected $image_flux_url = "https://*********.imageflux.jp";

protected $packages;
```

**app/Customize/Twig/Extension/ImageFluxExtension.php#L12**

```php
protected $signing_secret = "********";
```

**app/Customize/Twig/Extension/ImageFluxExtension.php#L13**

```php
protected $image_flux_url= "https://*********.imageflux.jp";
```
控えていたHostに変更してください。

以上で基本的な設定は完了です。

ショップ画面で表示されている画像がImageFluxのURLになっていれば、成功です。
![](/upload/save_image/column/ec-cube/imageflux_005.jpg)

### 画像を最適化について

ImageFluxの機能でリサイズを行っていきます。
「商品一覧画面 – /products/list 」の画像を要素に近い250pxで指定していきます。

**src/Eccube/Resource/template/default/Product/list.twig#152-**

```twig
 
 <img src="{{ asset(Product.main_list_image|no_image_product, 'save_image') }}">
 
```
この部分を以下のように修正します。
```twig
 
 {% set imageflux_options = {'width': 250} %}
 <img src="{{ asset(Product.main_list_image|no_image_product, 'save_image' ,imageflux_options) }}">
 
```

![](/upload/save_image/column/ec-cube/imageflux_006.jpg)

DevToolsで250pxの画像が配信されていることが確認できます。
あくまでリサイズの一例です。Retinaディスプレイ対応やサイト構成を考慮して試してみてください。

### まとめ
今回は、ImageFluxについて紹介しましたが、ImageFluxには画像変換の機能が豊富にあります。
例えばオーバーレイ機能ですが、デジタルコンテンツを配信する場合や、画像にキャプションを入れる場合に画像を直接編集する必要がなくなりますので業務の効率化が可能だと思います。
Webp変換にも対応もしており、サイトパフォーマンスも向上することができると思います。

S3や独自ドメインも利用可能で、EC-CUBEに導入しやすいサービスだと感じました。ぜひトライアル期間もあるので試してみてください。

### サンプルコード

* サンプルプログラムは、あくまで検証用途なので、動作を保証するものではありません。
* 公式が提供しているWordPress用のプラグインを、参考にさせていただいています。
* Assetで呼ばれている画像のリソースに対してImageFluxのURLを返します。

**src/Eccube/Resource/template/default/Block/new_item.twig**

```php
<?php
namespace Customize\Twig\Extension;

use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;
use Symfony\Component\Asset\Packages;


class ImageFluxExtension extends AbstractExtension
{
 protected $use_signate = true;
 protected $signing_secret = "********";
 protected $image_flux_url = "https://*********.imageflux.jp";

 protected $packages;

 public function __construct(Packages $packages)
 {
 $this->packages = $packages;
 }

 public function getFunctions()
 {
 return [
 new TwigFunction('asset', [$this, 'getAsset']),
 ];
 }

 /**
 *
 * @path type: string
 * @packageName (optional) type: string | null default: null
 * @params type: array
 * @return type: string|NULL
 * 
 */
 public function getAsset($path, $packageName = null, $params = []) {
 $filepath = pathinfo($path);
 if (in_array($filepath['extension'],['jpeg','jpg','JPEG','JPG','png','PNG','gif','GIF'])) {
 return $this->image_flux_url . $this->addSignature("/c", self::genarateParams($params), $this->packages->getPackage($packageName)->getBasePath().$path);
 }
 return $this->packages->getUrl($path, $packageName);
 }

 protected function addSignature($prefix, $params, $file_path) {
 $path = $prefix . $params . $file_path;

 if ($this->use_signate) {
 $hash = hash_hmac("sha256", $path, $this->signing_secret, true);
 $params = substr_replace($params, ",", 0,1);
 return $prefix . "/sig=1." . rtrim(strtr(base64_encode($hash), "+/", "-_"), "="). $params . $file_path;
 }
 return $path;
 }
 /**
 * オプションの変換パラメータ生成
 *
 * @return string
 */
 public static function genarateParams($params)
 {
 $params_str = "/";

 // フォーマット
 $format = isset($params['format'])? $params['format']: "webp:auto";
 $params_str .= "f=" . $format . ",";

 // クオリティ
 $quality = isset($params['quality'])? $params['quality']: 70;
 $params_str .= "q=" . $quality . ",";

 // リサイズ
 isset($params['width']) && $params_str .= "w=" . $params['width'] . ",";
 isset($params['height']) && $params_str .= "h=" . $params['height'] . ",";
 
 // アスペクト
 // 0: 入力のアスペクト比に合わせ、出力の幅、高さにおさめる(scale)
 // 1: 入力のアスペクト比を無視し、出力の幅、高さに合わせる(force-scale)
 // 2: 出力を満たすように入力を拡大・縮小し、はみだした領域を切り取る(crop)
 // 3: 入力のアスペクト比に合わせ、埋まらない部分を背景色で埋める(pad)
 isset($params['aspect']) && $params_str .= "a=" . $params['aspect'] . ",";

 // Exif
 // 1: Exif情報を削除する（デフォルト）
 // 2: Exif情報のうち、Orientation以外を削除する
 $exif = isset($params['exif'])? $params['exif']: 1;
 $params_str .= "s=" . $exif . ",";

 // 画像フォーマットによる除外
 // 指定されたフォーマットは、変換しません。
 $extension_param = "";
 $through_jpeg = isset($params['through_jpeg']) && $params['through_jpeg']==1 ? true: false;
 $through_png = isset($params['through_png']) && $params['through_png']==1 ? true: false;
 $through_gif = isset($params['through_gif']) && $params['through_gif']==1 ? true: false;

 if ($through_jpeg) {
 $extension_param .= "jpeg";
 }
 if ($through_png) {
 $extension_param !== "" && $extension_param .=":";
 $extension_param .= "png";
 }
 if ($through_gif) {
 $extension_param !== "" && $extension_param .=":";
 $extension_param .= "gif";
 }

 $extension_param !== "" && $params_str .= "through=" . $extension_param;

 // 最後の文字列のカンマの削除
 mb_substr($params_str, -1) === ',' && $params_str = mb_substr($params_str, 0, -1);
 return $params_str;
 }
}
```

EC-CUBE4でImageFluxを設定する方法

[「EC-CUBE Advent Calendar 2021」](https://qiita.com/advent-calendar/2021/ec-cube) 23日目の投稿です。
タイトル通りにはなりますが、弊社でも採用しているEC-CUBEのローカル環境構築について今回は記事を書いてみようと思います。
なお、今回はEC-CUBE.coを利用せずに自社でホスティング環境を用意し、運用していく場合の環境構築を想定しています。

今回構築する際の流れは以下のとおりです。

1. ローカルにてVirtualBox＋Vagrantを使用して仮想マシンを構築し、仮想マシンの中でEC-CUBEをGithubからクローン
2. VSCodeのRemote Developmentを使用してホストマシンから仮想マシンにssh接続
3. 仮想マシンの中で直接ファイル操作を行う

今回のポイントはVagrantのディレクトリマウントを使用せずにサーバー(仮想マシン)の中で直接ファイル操作を行うところで、この構成で構築した時のメリットは以下があげられます。

* 仮想マシン側のVSCodeに拡張プラグインを導入するだけで言語(FW)などの補完がきく
* Vagrant+VirtualBoxの構成なのでホストマシン(Mac,Windows)の環境差分を吸収できる
* boxファイルをパッケージして共有することで、メンバー間で発生しがちな環境差分を吸収できる
* 仮想マシンの構築手順をAnsible等のプロビジョニングツールで自動化することで本番環境にも適用できる

### 検証環境
* MacOS Catalina, Windows10
* VirtualBox 6.1.30
* Vagrant 2.2.19
* VSCode

## 手順解説
____
### 1. ローカルにてVirtualBox＋Vagrantを使用して仮想マシンを構築

この章では開発に使用する仮想マシン(サーバー)を構築していきます。
なお今回は下記の構成で仮想マシンを構築していきます。

* Ubuntu 20.04
* Apache 2.4
* MySQL 8.0
* PHP 7.4
* EC-CUBE 4.1
弊社は本番環境でAmazonLinuxを使用する場合はUbuntuではなくCentOSで構築していますが、今回はEC-CUBE公式の情報に合わせてUbuntuで構築していきます。


まずここから先の手順を進める前にVirutualBoxとVagrant(プラグイン含め)のインストールをしてください。
下記ハンズオン形式の記事が非常に参考になりますので一読されることをオススメします。
また、本記事では今回使用するツールやそれに関するコマンドなどの解説は割愛させていただきます。

[【ペチオブ】仮想環境ハンズオン 第3回 Vagrant編](https://qiita.com/ucan-lab/items/e14a26081229c8bef98a)

```cmd
// Vagrant(プラグイン含め)とVirtualBoxのインストールを確認
$ vagrant -v Vagrant 2.2.19
$ vagrant plugin list vagrant-share (2.0.0, global) vagrant-vbguest (0.30.0, global)
$ VBoxManage -v 6.1.30r148432
```

```cmd
// 今回使用するUbuntuのboxイメージを追加
$ vagrant box add ubuntu/focal64
$ vagrant box list ubuntu/focal64 (virtualbox, 20200326.0.0)
```

```cmd
// 任意のディレクトリに作業ディレクトリを作成
$ mkdir ec-cube

// 移動
$ cd ec-cube

// 先ほど取得したUbuntuのBoxファイルを使用してVagrantファイルの雛形を作成
$ vagrant init -m ubuntu/focal64
```

今回はUbuntuのパッケージやミドルウェア等のインストールをshellで実行します。
これを作成しておくだけでも環境構築の手順書代わりになるのでオススメです。
なお、必要なパッケージ等はEC-CUBE開発者情報と公式GithubのDockerファイル等を参考に選定しています。

* EC-CUBE4 開発者ドキュメントサイト
* EC-CUBE – Github

```cmd
// 仮想マシンを初回起動時に各種モジュール等をインストールするshellを作成
$ vim init.shell
```

**init.shell**

```bash
#!/bin/bash

# shell実行時オプション
# https://qiita.com/keitean/items/83c7d0d6221ec1b9c63c
set -eux

# パッケージの削除
rm -rf /var/lib/apt/lists/*
echo "en_US.UTF-8 UTF-8" >/etc/locale.gen
locale-gen

# PHP7.4とApache2のインストール
add-apt-repository ppa:ondrej/php
apt -y install php7.4

# MySQL用モジュール
apt -y install php7.4-mysql

# その他必要なPHPモジュールのインストール
# 参考：https://doc4.ec-cube.net/quickstart/requirement
apt -y install php7.4-curl php7.4-cli php7.4-zip php7.4-intl php7.4-xml php7.4-mbstring

# MySQLのインストール
apt -y install mysql-server mysql-client

# MySQLの文字コードと照合順序を設定ファイルとして書き出し
cat << EOS | sudo tee /etc/my.cnf
[mysqld]
character_set_server = utf8mb4
collation_server = utf8mb4_ja_0900_as_cs
EOS

# MySQLを再起動
systemctl restart mysql

# MySQLのデータディレクトリを初期化
# mysqld --initialize-insecure --user=mysql

# EC-CUBE用のdatabaseを作成
mysql -u root << EOT
CREATE DATABASE eccube_db;
CREATE USER eccube@'%' IDENTIFIED WITH mysql_native_password BY 'secret';
GRANT ALL PRIVILEGES on eccube_db.* to eccube@'%';
EOT

# /var/www/ にec-cube 4.1を設置(ドキュメントルート)
git clone -b 4.1 https://github.com/EC-CUBE/ec-cube /var/www/ec-cube

# Composerのインストール
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php -r "if (hash_file('sha384', 'composer-setup.php') === '906a84df04cea2aa72f40b5f787e49f22d4c2f19492ac310e8cba5b96ac8b64115ac402c8cd292b8a03482574915d1a8') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
php composer-setup.php
php -r "unlink('composer-setup.php');"

mv ./composer.phar $(dirname $(which php))/composer && chmod +x "$_"
composer --version

# EC-CUBEに必要なパッケージを取得
composer update -d /var/www/ec-cube

echo "インストール完了！"
```

```cmd
// 作成したshellを初回起動時に実行するようにVagrantfileを編集
$ vim Vagrantfile

# -*- mode: ruby -*-
# vi: set ft=ruby :

Vagrant.configure("2") do |config|
 config.vm.box = "ubuntu/focal64"
 config.vm.network "forwarded_port", guest: 80, host: 8000
 config.vm.provision :init, type: "shell", path: "init.sh"

 # 仮想マシンのCPUとメモリも設定しておく
 config.vm.provider "virtualbox" do |vb|
 # vb.gui = true
 vb.memory = "4096"
 vb.cpus = "2"
 end
end
```

```cmd
// 仮想マシンを起動
$ vagrant up
```

仮想マシンを起動するとshellの内容を初回のみ実行して各種パッケージをインストールします。 無事起動が完了したら仮想マシンにsshで入ります。

```cmd
// 仮想マシンにsshで入る
$ vagrant ssh
```

### 2. VSCodeのRemote Developmentを使用してホストマシンから仮想マシンにssh接続

この章では前の章で作成した仮想マシンにVSCodeの拡張プラグインを導入したホストマシンからssh接続を行います。

```cmd
// 1度仮想マシンから出る
$ exit
```

* VSCodeを起動する
* 画面左側の拡張機能タブを選択し、検索窓に「remote develop」と入力
* 検索結果からRemote Developmentを選択し、プラグインをインストール
* 左下の緑アイコンからリモートウィンドウを開く
* メニューからOpen SSH Configuration File...を選択
* /Users/ユーザー名/.ssh/config を選択し、ファイルを開く
* 仮想マシンを起動しているコンソールに切り替えて下記コマンドを実行

```cmd
// 仮想マシンが起動している状態で
$ vagrant ssh-config

// 下記情報をコピー
Host default
 HostName 127.0.0.1
 User vagrant
 Port 2222
 UserKnownHostsFile /dev/null
 StrictHostKeyChecking no
 PasswordAuthentication no
 IdentityFile /Users/ユーザー名/vagrant/ec-cube/.vagrant/machines/default/virtualbox/private_key
 IdentitiesOnly yes
 LogLevel FATAL
```

* コピーした内容を/Users/ユーザー名/.ssh/config に貼り付け and 上書き保存
 * 捕捉: Host defaultのdefault部分は自分がわかりやすい名前に変更すると良い
 * 今回はeccube-defaultに設定
* 再度左下の緑アイコンからリモートウィンドウを開く
* メニューからConnect To Host...を選択
* eccube-defaultを選択し、仮想マシンにssh接続(別ウィンドウでVSCodeが開きます)

ここまでの手順で無事仮想環境にssh接続したVSCodeが開ければ一旦OKです。
次にEC-CUBEを初期状態で動かせるようにしていきます。

**コンソールから起動中の仮想マシンにsshで入る**
```cmd
$ vagrant ssh
```

**Apacheのドキュメントルートをec-cubeに変更する**
```text
// 設定ファイルを開く
$ sudo vim /etc/apache2/sites-available/000-default.conf

// INSERTモードに切り替えてから下記の修正をして上書き保存
# DocumentRoot /var/www/html
DocumentRoot /var/www/ec-cube
RewriteEngine On

# 鍵かっこは表示上の都合で全角にしていますが、本来半角なので注意してください!!
＜Directory "/var/www/ec-cube"＞
	AllowOverride All
＜/Directory＞
```

**Apache2のmod_rewriteを有効にする**
```cmd
$ sudo a2enmod rewrite
```

**Apacheを再起動する**
```cmd
$ sudo systemctl restart apache2
```

**ec-cubeインストールコマンドを実行**
```cmd

$ cd /var/www/ec-cube

$ sudo bin/console e:i
// プロビジョニング用のshellで登録した内容を入力(コピペでOKです)
Database Url
> mysql://eccube:secret@127.0.0.1/eccube_db

// Mailer Urlは今回設定しないのでエンター
// Auth Magicはそのままでエンター
```

ここまでの手順が終わったらブラウザで http://localhost:8000 へアクセスしてみましょう。
EC-CUBEデフォルトTOPページが表示されればOKです
管理画面はデフォルトだと http://localhost:8000/admin です。
id: admin
pass: password

ここからがやや面倒なのですが、VSCodeのRemote Developmentは接続する仮想マシンごとにVSCodeのプラグインをインストールしなければいけません。
そのため、今回紹介するのは必要最低限ではありますが、下記プラグインをeccube-defaultに接続しているVSCodeでもインストールしておきましょう。
※プラグインによってはローカルでインストールしているものが既に仮想マシンでも有効化されている場合もあります。

* Japanese Language Pack for Visual Studio Code
* zenkaku
* indent-railbow
* Bracket Pair Colorizer
* Symfony extensions pack

※その他必要に応じてPHP DebugやPHP DocBlocker、php cs fixerなど...

### 仮想マシンの中で直接ファイル操作を行う
この章では仮想マシンの中でファイル編集などの操作ができるようにしていきます。
ポイントはRemote Developmentでssh接続して仮想マシンをVSCodeで操作しているユーザーがvagrantユーザーという点です。
なのでまずはVSCode側で直接ファイルを編集できるようにファイル/ディレクトリの権限を変更する必要があります。

```cmd
$ sudo chown -R vagrant:www-data /var/www/
```
これでVSCode側でファイル内容を変更やファイルの追加・削除ができるようになります。

まずはssh接続先にあるec-cubeディレクトリを開きます。

![](/upload/save_image/column/ec-cube/eccube-local-development_1.png)
![](/upload/save_image/column/ec-cube/eccube-local-development_2.png)

さっそくVSCode側.envファイルを修正してみましょう。
とりあえず、モードを開発用に切り替えてみます。

![](/upload/save_image/column/ec-cube/eccube-local-development_3.png)

Ctrl+sでファイルの上書き保存をしてから、TOPページを更新してみると...。

![](/upload/save_image/column/ec-cube/eccube-local-development_4.png)

はい、画面下部にSymfonyのデバッグバーが表示されるようになりました。

次は独自プラグインのひな型生成コマンドを実行してみます。

```cmd
$ cd /var/www/ec-cube

$ sudo bin/console eccube:plugin:generate
// 全てそのままエンターで進む
```

コンソールにOK表示を確認したらVSCode側で app/Plugin の中を見てみましょう。

![](/upload/save_image/column/ec-cube/eccube-local-development_5.png)

先ほど生成したSampleという名前のプラグインが確認できます。
ここからがこの構築方法の本領発揮です。

試しに app/Plugin/Sample/Controller/Admin/ConfigController.php を開いて、indexアクションにカーソルをのせてみます。
すると、きちんとPHPDocに書かれている内容が表示されます。

![](/upload/save_image/column/ec-cube/eccube-local-development_6.png)

また、EC-CUBE本体側にあるクラスを選択して
「定義へ移動」を押すと...

![](/upload/save_image/column/ec-cube/eccube-local-development_7.png)

本体側のソースもこのように開くことができます。

![](/upload/save_image/column/ec-cube/eccube-local-development_8.png)

ちろんメソッドや変数もこのように候補が表示されます。

![](/upload/save_image/column/ec-cube/eccube-local-development_9.png)


### まとめ
全体的に簡単な説明にはなってしまいましたが、弊社でも採用している開発環境の構築を紹介させていただきました。
あとはお好みでVSCodeの拡張プラグインを追加してみたり、使いやすいようにカスタマイズしてみてください。

### 参考
- [【ペチオブ】仮想環境ハンズオン 第3回 Vagrant編](https://qiita.com/ucan-lab/items/e14a26081229c8bef98a)
- [Ubuntu 最低限抑えておきたい初期設定](https://qiita.com/kotarella1110/items/f638822d64a43824dfa4)
- [VagrantでVScodeのRemote Developmentを使おう！](https://qiita.com/hppRC/items/9a46fdb4af792a454921)
- [EC-CUBE4 開発者ドキュメントサイト](https://doc4.ec-cube.net)
- [コマンドラインからインストールする](https://doc4.ec-cube.net/quickstart/command_install)
- [EC-CUBE - Github](https://github.com/EC-CUBE/ec-cube)
- [Ubuntu 20.04にApache Webサーバーをインストールする方法](https://www.digitalocean.com/community/tutorials/how-to-install-the-apache-web-server-on-ubuntu-20-04-ja)
- [Ubuntu+Apache2の設定ファイルの場所とか構成とかメモ](https://penpen-dev.com/blog/ubuntuapache2/)
- [Ubuntu版Apache2でmod_rewriteを有効にする](https://qiita.com/u-akihiro/items/c7a5bb38c34858d00c2a)

VagrantとVirtualBoxで構築するEC-CUBE4のローカル開発環境

今回は弊社のデザイナーが使用している無料テキストエディタ「ATOM」と社内でファイルを管理しているツール「Git」との連携方法を説明していこうと思います。 「ATOM」のダウンロードまずはATOMの公式webサイトからダウンロードしてください。<a href="https://atom.io/" target="_blank">https://atom.io/</a> <img src="/upload/save_image/column/atom/download.png"> ダウンロードしたAtomSetup-x〇〇.exeというファイルをクリックするとATOMのインストーラーが立ち上がりインストールを開始します。 しばらくするとATOMが立ち上がります。<img src="/upload/save_image/column/atom/01.jpg"> ATOMの日本語化このままだと英語表記でわかりずらいと思うので日本語化パッケージをいれていきます。 メニューバー「Help」から「WelCome Guide」を選択「Install a Package」の項目で「Open Installer」をクリックsearch packagesと書かれているフォームに「japanese-menu」と入力し「Packages」をクリック一番上に出てきた「japanese-menu」をインストール <img src="/upload/save_image/column/atom/02.jpg"> ATOMの日本語化が完了しました。 <img src="/upload/save_image/column/atom/03.jpg"> GitHub でリポジトリを作成するGithubの公式webサイトにログインし,Your Repositoriesのページで緑色のNEWボタンをクリックgithub Your Repositoriesのページ <img src="/upload/save_image/column/atom/04.jpg"> 「Create a new Repository」のページが開くので「Repository name」の欄に新しいRepositoryにつける任意の名前を（ここではatom_git_testにしました）入力し、下部の「create Repository」をクリックすればRepository作成完了です。 <img src="/upload/save_image/column/atom/05.jpg"> 出来たレポジトリ画面の緑のcodeボタンにカーソルを合わせるとプルダウンが開きます。その中のアドレスを後程使うので、控えておきます。 <img src="/upload/save_image/column/atom/06.jpg"> ATOMでリポジトリを取得する作ったレポジトリのクローンを入れる空のフォルダをPCの任意の場所に新規で作成します。ATOM上部のパッケージの欄からコマンドパレットを開き「github:clone」と入力。clone fromに先ほど控えてたアドレスをペースト。To directoryには作った空のフォルダのディレクトリパスを入力 <img src="/upload/save_image/column/atom/07.jpg"> リポジトリの取得完了 <img src="/upload/save_image/column/atom/08.jpg"> AtomからGitHubのリポジトリにPushする（アップロード）データの変更があるとGitタブのUnstaged Chagesに変更があったファイル名が表示されます(ここではtest.htmlというファイルを新規作成しました。) <img src="/upload/save_image/column/atom/09.jpg"> stage Allをクリック <img src="/upload/save_image/column/atom/10.jpg"> すると変更のあったファイルがStaged Changesの欄に降りてくるので、Commit　messageに作業内容等を入力して青いバーをクリック 最下部の「push」の欄の横に数字が表示されているのを確認出来たらクリック <img src="/upload/save_image/column/atom/11.jpg"> Githubのページでpushしたファイル名が確認できたら完了 <img src="/upload/save_image/column/atom/12.jpg"> <img src="https://manage.spreadworks.co.jp/upload/save_image/column/atom/13.jpg"> AtomでGitHubのリポジトリからpullする（ダウンロード）Gitで共有しているファイルを他の人が編集した場合のATOMを使ったPull（自分のファイルと同期させる）の方法を説明します。 ATOMのGitタブの最下部にある「Fetch」をクリックして、ファイルの更新があったかを確認します。 <img src="/upload/save_image/column/atom/14.jpg"> 更新があった場合、「Fetch」の部分が「Pull」と数字の表記に代わると、更新データがあるということなので「Pull」をクリックします。 <img src="/upload/save_image/column/atom/15.jpg"> Githubのページでpullしたファイル名が確認できたら完了（今回はREADME.mdという新しいファイルが確認できました） <img src="/upload/save_image/column/atom/16.jpg">

テキストエディタ「ATOM」でGithubと連携させる方法

トップページに特定のカテゴリ一に属する商品を表示するカスタマイズの方法を説明します。

![](/upload/save_image/column/ec-cube/top-new-stock-for-ec-cube4_1.png)

トップページに「新入荷のカテゴリ」に属する商品を表示

## 手順

1. カテゴリIDを確認する
2. Blockファイルを編集し、moreボタンのリンクに変更とテキストの修正
3. TwigExtentionを修正し、「新入荷」商品情報を取得

### 1. カテゴリIDを確認する

管理画面にログインし、商品管理->カテゴリ管理を選択してください。
新入荷のカテゴリIDは「2」であることを確認します。
※今回は、新入荷のカテゴリIDの「2」を利用しますが、「2」以外が設定されている場合や他のカテゴリの商品を表示させる場合は、該当のカテゴリIDをご利用ください。

![](/upload/save_image/column/ec-cube/top-new-stock-for-ec-cube4_2.png)

### 2.moreボタンのリンクに変更とテキストの修正

**app/template/default/Block/new_item.twig**ファイルを修正。

```twig
<div class="ec-newItemRole__listItemHeading ec-secHeading--tandem">
{{ 'front.block.new_item.title__en'|trans }}

{{ 'front.block.new_item.title__ja'|trans }}
<a class="ec-inlineBtn--top" href="{{ url('product_list') }}">{{ 'front.block.new_item.more'|trans }}</a>
</div>
```

この部分を以下のように修正。

```twig
<div class="ec-newItemRole__listItemHeading ec-secHeading--tandem">
NEW STOCK

新入荷商品
<a class="ec-inlineBtn--top" href="{{ url('product_list') }}?category_id=2">{{ 'front.block.new_item.more'|trans }}</a>
</div>
```

### 3.TwigExtentionを修正し、「新入荷」商品情報を取得

**app/Customize/Twig/Extension/TwigExtension.php**ファイルに以下のメソッドを定義します。

```php
 public function getFunctions()
 {
 return array(
 new \Twig_SimpleFunction('CustomizeNewProduct', array($this, 'getCustomizeNewProduct')),
 );
 }

 // 省略...

 /**
 * 新着商品3件返す
 * @return Products|null
 */
 public function getCustomizeNewProduct()
 {
 try {
 // 検索条件の新着順を定義
 $searchData = array();
 $qb = $this->entityManager->createQueryBuilder();
 $query = $qb->select("plob")
 ->from("Eccube\\Entity\\Master\\ProductListOrderBy", "plob")
 ->where('plob.id = :id')
 ->setParameter('id', $this->eccubeConfig['eccube_product_order_newer'])
 ->getQuery();
 $searchData['orderby'] = $query->getOneOrNullResult();

 // 新入荷商品を表示
 $new_stock_id = 2;
 $qb = $this->entityManager->createQueryBuilder();
 $query = $qb->select("ctg")
 ->from("Eccube\\Entity\\Category", "ctg")
 ->where('ctg.id = :id')
 ->setParameter('id', $new_stock_id)
 ->getQuery();
 $searchData['category_id'] = $query->getOneOrNullResult();

 // 商品情報3件取得
 $qb = $this->productRepository->getQueryBuilderBySearchData($searchData);
 $query = $qb->setMaxResults(3)->getQuery();
 $products = $query->getResult();
 return $products;
 } catch (\Exception $e) {
 return null;
 }
 return null;
 }
```

トップページ以外にも、商品一覧、商品詳細、購入完了画面などの画面で表示することで、商品の訴求ができるようになります。
ぜひ、お試しください。

EC-CUBE4のトップページに特定のカテゴリ一に属する商品を表示する方法

# EC-CUBEの勉強会レポート

**日時：** 2019年2月7日 19:00から **場所：** Connecting The Dots YOYOGI / B1

初めて、EC-CUBEの勉強会に参加しました。勉強会の内容と所感を交えて、レポートを残します。今回のテーマは注文明細に値引きを追加や、送料計算のカスタマイズなどをすることができるPurchaseFlowの仕組みを理解する勉強で、設計されたEC-CUBEエバンジェリストの足立さんから、ご説明いただきました。内容はサンプルコードの提示と処理内容が表などにまとめられいて、とても理解しやすかったです。

## スライド

[https://www.slideshare.net/chihiroadachi3/201927-eccubeugpurchaseflow-130874190?fbclid=IwAR1VAYGVyPoFh8tTsTKbLt-p7zIIRrh2YeoB0TtyztygFf13cVPmzpMgG4s](https://www.slideshare.net/chihiroadachi3/201927-eccubeugpurchaseflow-130874190?fbclid=IwAR1VAYGVyPoFh8tTsTKbLt-p7zIIRrh2YeoB0TtyztygFf13cVPmzpMgG4s)

## 参考資料

### サンプルコード

[https://github.com/chihiro-adachi/ec-cube/compare/ad03d2d0078f8347c0a8fae9acc1ced74bf6e967...demo-tokyo?fbclid=IwAR3CTDTc6U-Rvobd4hsXn_fK-3etcBtWf6_U6tGgNZSBWqHEt66ADr19XlI](https://github.com/chihiro-adachi/ec-cube/compare/ad03d2d0078f8347c0a8fae9acc1ced74bf6e967...demo-tokyo?fbclid=IwAR3CTDTc6U-Rvobd4hsXn_fK-3etcBtWf6_U6tGgNZSBWqHEt66ADr19XlI)

### PurchaseFlowの仕様ドキュメント

[http://doc4.ec-cube.net/customize_service](http://doc4.ec-cube.net/customize_service)

**ドキュメントに誤りがあり(2019年2月8日現在)**

> 独自に作成した Processor を有効にするには、 app/config/eccube/packages/purchaseflow.yaml の定義を修正します。

とありますが、Processorクラスにアノテーションを指定し、所定のディレクトリに設置すると、自動でロードされ実行されてる仕組みになっています。

```text
use Eccube\Annotation\ShoppingFlow;
use Eccube\Service\PurchaseFlow\DiscountProcessor;

/**
 * @ShoppingFlow
 */
class NebikiProcessor implements DiscountProcessor {
```

アノテーションには、他に「@CartFlow」「@OrderFlow」が指定できます。
インターフェイスには、他に「ItemValidator」「ItemHolderValidator」などが指定できます。
詳細はスライドやドキュメントを確認してください。

### Github Issue

[https://github.com/EC-CUBE/ec-cube/pull/2424](https://github.com/EC-CUBE/ec-cube/pull/2424)

## 質疑応答

(勉強会のあとTwitterなどで収集した情報を編集して記載しています。)

**Q. カスタマイズしたファイルはどこにおけばよいの？**

A. app/CustomizeかApp/Plugin配下に設置すればどこでも読まれるようになっている。

ロードされるパスなどの設定は以下のファイルで行っている：
- app/config/eccube/services.yaml
- src/Eccube/DepenjencyInjection/*
- src/Eccube/Kernel::build()

**Q. 既存のProcessorを消したり、処理の順番は入れ替えられるの？**

A. 可能。ただし、本体の設定ファイルを編集する必要がある。

```yaml
app/config/eccube/packages/purchaseflow.yaml

     45     # Purchase Flow for Shopping
     46     eccube.purchase.flow.shopping:
     47         class: Eccube\Service\PurchaseFlow\PurchaseFlow
     48         calls:
     49             - [setFlowType, ['shopping']]
     50             - [setItemValidators, ['@eccube.purchase.flow.shopping.item_validators']]
     51             - [setItemHolderValidators, ['@eccube.purchase.flow.shopping.holder_validators']]
     52             - [setItemHolderPreprocessors, ['@eccube.purchase.flow.shopping.holder_preprocessors']]
     53             - [setDiscountProcessors, ['@eccube.purchase.flow.shopping.discount_processors']]
     54             - [setItemHolderPostValidators, ['@eccube.purchase.flow.shopping.holder_post_validators']]
     55             - [setPurchaseProcessors, ['@eccube.purchase.flow.shopping.purchase']]
```

**Q. Processorの実行途中で、次のProcessorに行かないような処理はできるの？**

A. 止められない。

**Q. Processorの実行状況、結果をロギングする仕組みはあるのか？**

A. 実装していない。

**Q. Processorの中で例外エラーが発生した時はどう取り扱う？**

A. Processor処理内容、エラー内容で適宜判断。

**Q. Symfonyのworkflowは使っているのか？**

A. 使用していない、独自実装。workflowバンドルば別のところで使用している。

Workflow の参考リンク:
- [Symfony Workflow](https://symfony.com/doc/3.4/components/workflow.html)
- [EC-CUBE4のキャンセルステータス](https://a-zumi.net/eccube4-cancel-status/)
- [Github Pull Request](https://github.com/EC-CUBE/ec-cube/pull/3325)

**Q. PurchaseFlowで実装できなかったカスタマイズはあるか？**

A. 通常便、クール便を含んだ注文の場合、配送種別毎にシステム側で配送先データを生成する必要があった。PurchaseFlowの仕組みでは、要求が実現できず、本体のソースコードを編集して実現した。

## 最後に

皆さん何かしらの目的をもって参加されていて、大半の方がエンジニア、フリーランスのクリエイター、店舗オーナー、決済会社の方達で、知り合いだけで固まっているような感じはなく、はじめての方でも、気負うことなく参加できる勉強会だと思いました。登壇者の方以外にも、参加者の皆さんから色々なお話を聞けて、とめもためになりました。
勉強会の題材のドキュメントやソースコードは事前にもっと確認しておけば、より身についたなーと。次回に活かそうと思います。

EC-CUBE 東京UG 勉強会 / 2019-02-07 レポート

EC-CUBE4になってTOPページのデザインも、より魅力的なものになりました。
しかし、トップページにある新着商品は、自動で更新されるものになっていません。
そこで今回は、商品を追加したときに自動で更新するようにカスタマイズしていきます。

また、カスタマイズ方法ですが、EC-CUBE3ではできなかった本体のソースコードを変更しない方法で実装していきます。

![](/upload/save_image/column/ec-cube/top-new-products-for-ec-cube4_1.jpg)

※ 商品を追加したときに、自動で更新するようにしていきます。

### 手順

1. 修正ファイルを設置
2. Blockファイルのmoreボタンを適切なリンクに変更
3. TwigExtentionを利用し、新着商品を取得
4. 新着商品をTwigテンプレート反映

### 1.修正ファイルを設置

今回必要なファイルは、2ファイルになります。

```text
/app
 Ltemplate
　Ldefault
　 LBlock
 Lnew_item.twig
 LCustomize
　LTwig
　 LExtension
 LTwigExtension.php
```

まず、新着商品のTwigファイルをコピーします。

**コピー元**
```text
src/Eccube/Resource/template/default/Block/new_item.twig
```
**コピー先**
```text
app/template/default/Block/new_item.twig
```

次にTwigExtention用のファイルを作成します。

```text
app/Customize/Twig/Extension/TwigExtension.php
```

### 2. Blockファイルのmoreボタンを適切なリンクに変更

moreボタンを見るとリンク先が商品一覧になっています。
リンク先の商品一覧のソート順を新着順となるように「app/template/default/Block/new_item.twig」のリンクを修正します。
```twig
href="{{ url('product_list') }}"
```
この記述を以下のように修正。
```twig
href="{{ url('product_list') }}?orderby={{eccube_config.eccube_product_order_newer}}"
```

### 3.TwigExtentionを利用し、新着商品を取得

Twig側で「CustomizeNewProduct()」を実行したときに、新着商品3件返す仕様にします。

**app/Customize/Twig/Extension/TwigExtension.php**ファイルにメソッドを定義します。

```php
public function getFunctions()
 {
 return array(
 new \Twig_SimpleFunction('CustomizeNewProduct', array($this, 'getCustomizeNewProduct')),
 );
 }

 // 省略...

 /**
 * 新着商品3件返す
 * @return Products|null
 */
 public function getCustomizeNewProduct()
 {
 try {
 // productRepository->getQueryBuilderBySearchData()の引数に商品の出力順番を指定できるので新着順を定義
 $searchData = array();
 $qb = $this->entityManager->createQueryBuilder();
 $query = $qb->select("plob")
 ->from("Eccube\\Entity\\Master\\ProductListOrderBy", "plob")
 ->where('plob.id = :id')
 ->setParameter('id', $this->eccubeConfig['eccube_product_order_newer'])
 ->getQuery();
 $searchData['orderby'] = $query->getOneOrNullResult();

 // 商品情報の取得する
 $qb = $this->productRepository->getQueryBuilderBySearchData($searchData);

 // 新着順の商品情報3件取得
 $query = $qb->setMaxResults(3)->getQuery();
 $products = $query->getResult();
 return $products;

 } catch (\Exception $e) {
 return null;
 }
 return null;
 }
```


### 4.新着商品をTwigテンプレート反映

**app/template/default/Block/new_item.twig**ファイルを編集。

```php
{% set Products = CustomizeNewProduct() %}
{% if Products|length > 0 %}
<div class="ec-role">
 <div class="ec-newItemRole">
 <div class="ec-newItemRole__list">
 <div class="ec-newItemRole__listItem">
 <div class="ec-newItemRole__listItemHeading ec-secHeading--tandem">
 {{ 'front.block.new_item.title__en'|trans }}
 
 {{ 'front.block.new_item.title__ja'|trans }}
 <a class="ec-inlineBtn--top" href="{{ url('product_list') }}?orderby={{eccube_config.eccube_product_order_newer}}">{{ 'front.block.new_item.more'|trans }}</a>
 </div>
 </div>
 {% for Product in Products %}
 <div class="ec-newItemRole__listItem">
 <a href="{{ url('product_detail', {'id': Product.id}) }}">
 <img src="{{ asset(Product.main_list_image|no_image_product, 'save_image') }}">
 {{ Product.name }}
 
 {% if Product.hasProductClass %}
 {% if Product.getPrice02Min == Product.getPrice02Max %}
 {{ Product.getPrice02IncTaxMin|price }}
 {% else %}
 {{ Product.getPrice02IncTaxMin|price }} ～ {{ Product.getPrice02IncTaxMax|price }}
 {% endif %}
 {% else %}
 {{ Product.getPrice02IncTaxMin|price }}
 {% endif %}
 
 </a>
 </div>
 {% endfor %}
 </div>
 </div>
</div>
{% endif %}
```

EC-CUBE4のトップページに新着商品を自動で表示する方法

EC-CUBE4になってから、Symfonyで用意している機構へ簡単にアクセスできるようになりました。今回は Symfony の EventListener を使用した例をご紹介します。 
出力するHTMLをminify(圧縮)するには、いくつか方法がありますが、ここではTwigがレンダリングした後のHTMLを変換する方法を説明します。本体のソースコードを直接編集することなく、プラグインで実装することが可能です。 


## 1. プラグインを作成します。
---------------

[プラグインの仕様はこちらを参照してください。](http://doc4.ec-cube.net/plugin_spec)


プラグインコードは**[HtmlMinify]**とします。 


### 1-1. プラグインフォルダを作成します。

```text
[EC-CUBEインストールディレクトリ]/app/Plugin/HtmlMinify
```


### 1-2. プラグインの設定ファイルを設置します。

```text
[EC-CUBEインストールディレクトリ]/app/Plugin/HtmlMinify/composer.json
```

**ファイル内容**

```yaml
{
 "name" : "ec-cube/HtmlMinify",
 "version" : "1.0.0",
 "description" : "HTML Minify プラグイン",
 "type" : "eccube-plugin",
 "require" : {
 "ec-cube/plugin-installer" : "~0.0.3"
 },
 "extra" : {
 "code" : "HtmlMinify"
 }
}

```


### 1-3. プラグインをインストールします。

EC-CUBEインストールディレクトリに移動後、以下のコマンドを実行し、プラグインのインストールと有効化を行います。

```cmd
php bin/console eccube:plugin:install --code=HtmlMinify
php bin/console eccube:plugin:enable --code=HtmlMinify
```


2. EventListener を作成します。
------------------------

### 2-1. EventListener を登録する設定ファイルを編集します。

```
[EC-CUBEインストールディレクトリ]/app/Plugin/HtmlMinify/Resource/config/services.yaml
```

**ファイル内容**

```yaml
services:
 htmlminify_listener: # 1
 class: Plugin\HtmlMinify\EventListener\HtmlMinifyListener # 2
 arguments: ['@service_container'] # 3
 tags: # 4
 - {
 name: kernel.event_listener,
 event: kernel.response,
 method: onKernelResponse,
 priority: -10000
 }

```


#### # 1

システム上で一意となる名前を設定します。

#### # 2

実行するEventListenerクラスを指定します。

#### # 3

実行するクラスのコンストラクタに渡す、オブジェクトを指定します。 
指定できるオブジェクトは以下のコマンドで確認することが出来ます。 

```text
php bin/console debug:container
```


#### # 4

実行時のオプションを指定します。 
name: kernel.event\_listener・・・実行する時のイベントリスナーの種類を指定します。 
event: kernel.response・・・イベントの種類を指定します。他にkernel.requestなどのイベントがあります。 
<https://symfony.com/doc/3.4/components/http_kernel.html> 
method: onKernelResponse・・・実行するメソッド名を指定します。 
priority: -10000・・・実行する順番を指定します。数字が低い方が後に実行されます。 


### 2-2. HTMLを変換するクラスを作成します。

```text
[EC-CUBEインストールディレクトリ]/app/Plugin/HtmlMinify/EventListener/HtmlMinifyListener.php
```

**ファイル内容**

```php
<?php
namespace Plugin\HtmlMinify\EventListener;

use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;

class HtmlMinifyListener
{
 /**
 * @var ContainerInterface
 */
 private $container;

 /**
 * コンストラクタ。
 *
 * @param ContainerInterface $container
 */
 public function __construct(ContainerInterface $container)
 {
 $this->container = $container;
 }

 /**
 * HTMLタグを圧縮します。
 *
 * @param FilterResponseEvent $event
 * @param string $eventName
 */
 public function onKernelResponse(FilterResponseEvent $event,$eventName)
 {
 if (
 ($response = $event->getResponse())
 && ($response instanceof \Symfony\Component\HttpFoundation\Response)
 && ($content = $response->getContent())
 ) {
 $content = preg_replace('#(?ix)(?>[^\S ]\s*|\s{2,})(?=(?:(?:[^<]++|<(?!/?(?:script|textarea|pre)))*+)(?:<(
?>script|textarea|pre)|\z))#','',$content);
 $response->setContent($content);
 }
 }
}

```

EC-CUBE4のHTML最適化：プラグインで実現するSymfonyのEventListener活用

EC-CUBE4がリリースされ1ヵ月が経ちました。
「[EC-CUBE 開発コミュニティ](https://xoops.ec-cube.net/)」でもEC-CUBE4の質問が多くなってきました。
今回はコミュニティで回答させていただいた商品一覧ページのソート順のカスタマイズについて詳しく説明しようと思います。

「更新順」のソートを実装していきます。手順は以下のようになります。

1. 画面に「更新順」を追加
2. 「更新順」の処理を追加

### 1. 画面に「更新順」を追加

商品一覧画面を見るとセレクトボックスで「価格が低い順」「価格が高い順」「新着順」の3つがあります。

![](/upload/save_image/column/ec-cube/product-list-sort-order-change-for-ec-cube4_1.jpg)

管理画面のマスター管理を利用し、「更新順」を追加していきます。
管理画面->設定->システム設定->マスターデータ管理を選択。
マスターデータ管理画面にある「mtb\_product\_list\_order\_by」を選択します、

マスターデータの入力欄に「価格が低い順」「価格が高い順」「新着順」が確認できます。
最終行に、IDを4、NAMEを更新順と入力し保存してください。※1

![](/upload/save_image/column/ec-cube/product-list-sort-order-change-for-ec-cube4_2.jpg)

ショップ画面で確認し、更新順が追加されていることを確認してください。

![](/upload/save_image/column/ec-cube/product-list-sort-order-change-for-ec-cube4_3.jpg)

### 2. 追加したソート順の処理を追加

更新順にソートするif文を追加していきます。

 [GitHub 該当コード](https://github.com/EC-CUBE/ec-cube/blob/1e33a4e41192d64cdac4c8c91ed9a55fcc91f8ff/src/Eccube/Repository/ProductRepository.php#L167-L204)

新着順のコードを参考に更新順のifを追加し2点を修正してください。

1. ifの条件を更新順IDの4にする
2. orderByを「update\_date」に変更する

```text
/src/Eccube/Repository/ProductRepository.php#L167-L204
```

```php
        // 新着順
        } elseif (

        ～省略～

        // 更新順
        } elseif (!empty($searchData['orderby']) && $searchData['orderby']->getId() == 4) {
            // 在庫切れ商品非表示の設定が有効時対応
            // @see https://github.com/EC-CUBE/ec-cube/issues/1998
            if ($this->getEntityManager()->getFilters()->isEnabled('option_nostock_hidden') == true) {
                $qb->innerJoin('p.ProductClasses', 'pc');
                $qb->andWhere('pc.visible = true');
            }
            $qb->orderBy('p.update_date', 'DESC');
            $qb->addOrderBy('p.id', 'DESC');
        } else {

```

以上となります。

今回は、EC-CUBE4の本体カスタマイズになりましたが、バージョン3と同様にカスタマイズも簡単にできるようになっています。
次回は、EC-CUBE4で追加されたカスタマイズフォルダを利用し、本体をカスタマイズせずに 商品一覧ページのソート順の追加をしていきます。

**参考**

> **商品一覧を更新順で表示させたい** | EC-CUBE 開発コミュニティ
>
> https://xoops.ec-cube.net/modules/newbb/viewtopic.php?viewmode=flat&topic\_id=21013&forum=11

※1 EC-CUBE4 ver4.0.0では、IDの入力欄が2つある状態になっています。左側がIDになるので4を入力。
右側がNAMEになるので更新順と入力してください。

EC-CUBE4で商品一覧を「更新順」にカスタマイズする方法：画面設定から処理追加まで

フォームの種類を変えたい場合は、src/Eccube/Form/Type/* のソースコードを直接編集するか、[FormExtension](http://doc4.ec-cube.net/customize_formtype)でカスタマイズする方法があります。これらの方法だとFormを使用する全ての画面の修正を一括で行えますが、特定の画面だけ変更したい場合は対応が難しくなります。Twigでフォームの表示方法を変更する方法があるので、ご紹介します。 

今回は会員登録画面の性別のラジオボタンをセレクトボックスに変更する方法を例に説明します。

### 1. フォームテーマを指定する。
```text
[EC-CUBEインストールディレクトリ]/src/Eccube/Resource/template/default/Entry/index.twig 
```
または 
```text
[EC-CUBEインストールディレクトリ]/app/template/default/Entry/index.twig 
```
に、あるファイルを編集します。

```twig
{% form_theme form 'Form/form_div_layout.twig' %}
```
この記述から以下の記述に変更します。
```twig
{% form_theme form 'Form/form_div_layout.twig' 'Entry/index.twig' %}
```

15行名あたりに記述されている form\_theme に、自身のファイル名 **Entry/index.twig** を追加します。 

{% form\_theme form ‘XXX’ %} このタグはフォームテーマを指定する記述です。フォームテーマファイルはSymfonyにいつくか用意されており、Bootstrap4用のテーマファイルもあります。 

> 参考：[How to Customize Form Rendering](https://symfony.com/doc/3.4/form/form_customization.html) 

このドキュメントでは、自身のファイルを示す特別な値 \_self を指定していますが、EC-CUBE側の設定の影響により、\_self は使用できません。

### 2. フォームの表示を上書きします。

```twig
{% block _entry_sex_widget %}
 {% spaceless %}
 <select name="entry[sex]">
 <option value="">選択してください</option>
 {% for choice in choices %}
 <option value="{{ choice.value }}" id="entry_sex_{{ loop.index }}"{% if choice is selectedchoice(value) %} selected="selected"{% endif %}>
 {{ choice.label }}
 </option≶
 {% endfor %}
 </select>
 {% endspaceless %}
{% endblock _entry_sex_widget %}
```

フォームを上書きするblockを記述します。block名にはルールがあり 
```text
\_ + フォーム名 + 項目名 + \_widget 
```
とする必要があります。

Twigで性別ラジオボタンをセレクトボックスに変更する方法

テーマフォルダのみgitに登録する.gitignoreの書き方です。

```text
wp-admin
wp-includes
wp-*.php
**/wp-content/languages
**/wp-content/uploads
**/wp-content/upgrade
**/wp-content/plugins
**/wp-content/themes
!**/wp-content/themes/**
!**/wp-content/themes/*/index.php
```
普段は他のもろもろのファイルを取り除くために以下を使用しています。

```text
*~
*.bak
.DS_Store
.buildpath
.project
.settings
*.tmproj
build
.idea
nbproject/

Thumbs.db
desktop.ini

*.log

index.php
xmlrpc.php
.htaccess
license.txt
readme.html
sitemap.xml
sitemap.xml.gz

wp-admin
wp-includes
wp-*.php
**/wp-content/languages
**/wp-content/uploads
**/wp-content/upgrade
**/wp-content/plugins
**/wp-content/themes
!**/wp-content/themes/**
!**/wp-content/themes/*/index.php

!*/.htaccess
!*/index.php
```

[WordPress] テーマファイルのみgitに登録する

WordPressでウェブサイトを構築すると、固定ページにHTMLをゴリゴリ書いた内容を登録することが多くなります。登録した内容をビジュアルエディタで編集すると表示が崩れるので、ビジュアルエディタの使用不可にしたいことがありますが、その方法です。

**functions.phpに以下のコードを挿入します。**

```php
function disable_visual_editor() {
	global $typenow;
	if ($typenow == 'page') {
		add_filter('user_can_richedit', 'disable_visual_editor_filter');
	}
}
function disable_visual_editor_filter() {
	return false;
}
add_action('load-post.php', 'disable_visual_editor');
add_action('load-post-new.php', 'disable_visual_editor');
```

グローバル変数「$typenow」には登録タイプ名が入っています。3行目の page の部分を post にすると、投稿ページのビジュアルエディタを消すことができます。

[WordPress] 固定ページのビジュアルエディタを使用不可にする

当社の人事評価制度を設計するにあたり、資格が人事評価にどのように組み込めるか、どの程度仕事に役に立つものなのか判断するために、ウェブ制作系唯一の国家資格資格である「ウェブデザイン技能検定」について調べました。 <a href="https://www.webdesign.gr.jp/" target="_blank">ウェブデザイン技能検定</a> 1級から3級までの過去問題を一通り目を通しましたが、HTML5、CSS3、PHP、JQuery、サーバーサイド技術の出題があるので、ウェブサイトを作る知識・能力があるかの判断には使えると思いました。ただ、デザインに関わるコンセプト設計、黄金比などデザインテクニック、色彩に関する出題はないので、デザイン自体を組み上げる力、センスの判断には使えなさそうです。また、以下のようなデザインの仕事には直接関係なさそうな問題もあるので、試験に受かるための勉強をしないといけません。 <blockquote style="background-color: rgb(254, 254, 254);">3次元空間上の点の座標を(x,y,z)としたとき、原点 O(0,0,0)から点 Pまでの距離OPは、次のJavaScriptの計算で求められる。 <blockquote>Math.sqrt(x * x + y * y + z * z)</blockquote></blockquote>答えは「YES」(括弧内を選択) <blockquote>GIF形式は、ISO/IRC 15948 として国際標準化されている。</blockquote>答えは「YES」(括弧内を選択) 私は十数年ウェブ制作にたずさわっているので、3級はスキップして2級の受験をしてみました。過去問題の内容や受験時の感想も含めて各級の評価をまとめました。「難易度」は主観です。「役に立つ度」はウチの仕事内容と照らし合わせてるので、他所では使えない評価軸かもしれません。「人事評価」は保持していることで対外的な信用アップ、仕事の広がり(官公庁などのウェブサイト構築案件の入札条件に2級以上の保持者を指定されることがあるようです。)とスキルアップ意欲を考慮してます。 <h2 style="background-color: rgb(254, 254, 254);">3級</h2> 難易度：★☆☆☆☆ 役に立つ度：★☆☆☆☆ 人事評価：★★☆☆☆ 過去問題を見るとウェブデザインの専門学校で2年学んだか、1年程実務をこなした人であれば、無勉強でも合格できそうな内容です。ただし、ウェブ制作を生業にしていない人でも、試験を受かるための勉強、対策だけで合格できそうですので、3級を保持していたとしても、実力を測るのは慎重にした方が良いと感じました。 <img src="/upload/save_image/news/webdesign_test_3.png" alt="" width="100％" style="max-width: 480px"> 合格率平均：約50% <h2>2級</h2> 難易度：★★☆☆☆　役に立つ度：★★★☆☆　人事評価：★★★☆☆ 受検資格は3級合格者か2年以上の実務経験者であることなど、ある程度の実力がある人を対象としています。試験内容はウェブ制作に関わる広い範囲の知識が必要な筆記テスト、実践的な実技テストを行いますので、2級保持者は最低限の仕事は出来る実力があると判断しても良さそうです。実技試験の内容は数年変わっていないので、作業内容を覚えて練習すれば簡単に合格できそうですが、私が受検した時は途中退出する人はあまりいなく、試験中になんでだろう、わかんないなと独り言(本当は私語厳禁)を言っている人もいたので、簡単なテストではないのだと思います。 <img src="/upload/save_image/news/webdesign_test_3.png" alt="" width="100％" style="max-width: 480px"> 合格率平均：約13% <h3>2級を受検した感想</h3> 試験勉強は過去問題を解いて、わからなかったところをネットで調べて知識を増やしていきました。あとはHTML5になって追加されたタグはheader,footer,nav,sectionぐらいし使っていなかったこともあり、HTML5のタグの種類、意味に関して重点的に勉強しました。今回の勉強でより適切にマークアップすることにつながったので受検をして良かったと思います。過去問題集は以下のテキストを利用しましたが、答えの解説が不要な人は公式サイトから過去問をダウンロードできるので、それを利用すると良いと思います。 試験はパソコンスクールで行われました。受検者は10名ぐらいで男性7:女性3ぐらいの割合、年齢層は30歳から40歳前半ぐらいの方が多く、いかにもデザイナーっぽい人はいませんでした。(私の中のデザイナーのイメージはアゴ髭を蓄えたひと、能町みね子のような個性的なひと。)資格取得の目的は就職時のアピールだったりしますので「ウェブ業界への転職希望者」か「自分の実力確認の為」「資格手当、報奨金の目当て」などの人達が受験してるのではと思います。実務試験のパソコンはWindows7、Adobe CS6で、動作もモッサリしており普段の環境と違うので戸惑うことがありました。事前に作業の時間配分を考えておいた方が良いと思います。合格発表は1カ月後とのことですが、試験翌日の正午ぐらいに学科試験の速報がでていたので自己採点したところ、5つ間違っていました。40門中70%の正解で合格ですので、マークの付け間違いなどの大ポカをやらかして無ければ、合格したと思います。落ちていたら、2級は難しい試験だと評価しようかなと(笑) <img src="/upload/save_image/news/webdesigingoukaku.png" alt="" width="100%" style="max-width: 480px"> 追記：10/6 よかった・・・2級合格していました。次は1級を受検しようと思います。 <img src="/upload/save_image/news/1st_grade_Certified_Skilled_Worker_of_Web_Design.jpg" alt="" width="100%" style="max-width: 480px"> 追記：3/23 1級に合格しました。難しかった・・・筆記の試験会場に70人ぐらいいたけど、2人しか受からないかったからなー。

ウェブデザイン技能検定が仕事に役に立つか調べてみた

WEBサイトを公開する前の制作段階ではBasic認証で保護しておくことがありますが、その状態でページに設置した「いいね」や「シェア」をすると、以下のような 401 authorization required の表示がタイムライン上に表示されてしまいます。 <img src="/upload/save_image/news/fb_error.png" alt="" width="100%" style="max-width:480px"> 一度このようになると、Basic認証を外した後に、再度「いいね」しても 401 authorization required の表示は変わりません。 この対処方法は Facebook developers サイトの Open Graph Object Debugger ツールで行います。 Open Graph Object Debugger ツール エラーが発生しているページのURLを入力し、[Fetch new scrape information]をクリックするとOGPの情報が再読み込みされ、エラーが解消できます。

ナレッジ/コラム