本記事では、Symfony7をより深く理解し、日々の開発業務を効率化するための便利な技を厳選してご紹介します。これらのテクニックを活用することで、コードの可読性、保守性、そして開発速度を飛躍的に向上させることができるでしょう。

Attribute（属性）の活用でアノテーションから脱却！

PHP8から導入されたAttribute（属性）は、Symfonyでも積極的に採用されています。コントローラーのルーティング定義やバリデーション、サービス定義など、これまでアノテーションで行っていた設定を、より直感的で可読性の高いAttributeで記述できます。

例：ルーティング定義

// アノテーションの場合 (Symfony 5/6)
/**
 * @Route("/users/{id}", name="user_show", methods={"GET"})
 */
public function show(User $user): Response
{
    // ...
}

// Attributeの場合 (Symfony 7)
#[Route('/users/{id}', name: 'user_show', methods: ['GET'])]
public function show(User $user): Response
{
    // ...
}

Attributeを使用することで、クラス定義と設定がより近くに配置され、コードの意図が明確になります。

型付きプロパティとコンストラクタープロモーションでボイラープレートを削減

PHP7.4で導入された型付きプロパティと、PHP8.0のコンストラクタープロモーションを活用することで、クラスのプロパティ定義とコンストラクターの引数への代入処理を簡潔に記述できます。

例：サービスオブジェクト

// 従来の書き方
class UserService
{
    private UserRepository $userRepository;
    private LoggerInterface $logger;

    public function __construct(UserRepository $userRepository, LoggerInterface $logger)
    {
        $this->userRepository = $userRepository;
        $this->logger = $logger;
    }

    // ...
}

// コンストラクタープロモーションを使った書き方 (Symfony 7)
class UserService
{
    public function __construct(
        private UserRepository $userRepository,
        private LoggerInterface $logger
    ) {
    }

    // ...
}

これにより、冗長なプロパティ定義と代入処理が不要になり、より重要なロジックに集中できます。

Enumerable（列挙型）をエンティティで活用する

PHP8.1で導入されたEnumerable（列挙型）は、エンティティの状態管理や定数管理をより安全かつ型安全に行うために役立ちます。Symfony Doctrine Bridgeとの連携もスムーズです。

例：ユーザーのステータス管理

// PHP 8.1 Enumerable
enum UserStatus: string
{
    case PENDING = 'pending';
    case ACTIVE = 'active';
    case INACTIVE = 'inactive';
}

// エンティティでの利用
#[ORM\Entity]
class User
{
    // ...

    #[ORM\Column(type: 'string', enumType: UserStatus::class)]
    private UserStatus $status = UserStatus::PENDING;

    public function getStatus(): UserStatus
    {
        return $this->status;
    }

    public function setStatus(UserStatus $status): self
    {
        $this->status = $status;
        return $this;
    }
}

Enumerableを使用することで、マジックナンバーや文字列による比較を防ぎ、コードの可読性と保守性を向上させます。

Messengerコンポーネントで非同期処理をスマートに

SymfonyのMessengerコンポーネントは、メッセージキューイングシステムと連携し、時間のかかる処理をバックグラウンドで非同期的に実行するための強力なツールです。メール送信、画像処理、API連携などを非同期化することで、ユーザー体験を向上させることができます。

基本的な流れ

1. メッセージクラスの作成
   実行したい処理の内容を表すシンプルなPHPクラスを作成します。
2. メッセージハンドラーの作成
   メッセージを受け取り、実際の処理を実行するクラスを作成します。
3. メッセージのディスパッチ
   コントローラーやサービスからメッセージをMessengerに送信します。
4. ワーカーの起動
   バックグラウンドでメッセージキューを監視し、処理を実行するワーカーを起動します。

Messengerを活用することで、アプリケーションの応答性を高め、より複雑な処理を効率的に管理できます。

HttpClientコンポーネントで外部API連携を簡単に

SymfonyのHttpClientコンポーネントは、外部APIとの連携をシンプルかつ強力にサポートします。HTTPリクエストの送信、レスポンスの処理、認証、タイムアウト設定などを柔軟に行うことができます。

基本的な使い方

use Symfony\Contracts\HttpClient\HttpClientInterface;

class ApiService
{
    private HttpClientInterface $client;

    public function __construct(HttpClientInterface $client)
    {
        $this->client = $client;
    }

    public function fetchUserData(int $userId): array
    {
        $response = $this->client->request(
            'GET',
            'https://api.example.com/users/' . $userId,
            [
                'headers' => [
                    'Authorization' => 'Bearer YOUR_API_KEY',
                ],
            ]
        );

        return $response->toArray();
    }
}

HttpClientを使用することで、様々な外部サービスとの連携をスムーズに行うことができます。

Serializerコンポーネントでデータ変換を自由自在に

SymfonyのSerializerコンポーネントは、PHPオブジェクトと様々なデータ形式（JSON、XML、YAMLなど）との相互変換を簡単に行うことができます。API開発やデータインポート/エクスポート処理などで非常に役立ちます。

基本的な使い方

use Symfony\Component\Serializer\SerializerInterface;

class DataConverter
{
    private SerializerInterface $serializer;

    public function __construct(SerializerInterface $serializer)
    {
        $this->serializer = $serializer;
    }

    public function serializeToJson(object $data): string
    {
        return $this->serializer->serialize($data, 'json');
    }

    public function deserializeJson(string $jsonData, string $type): object
    {
        return $this->serializer->deserialize($jsonData, $type, 'json');
    }
}

Serializerを活用することで、データ形式に依存しない柔軟なアプリケーション開発が可能になります。

Formコンポーネントの進化とカスタマイズ

SymfonyのFormコンポーネントは、ユーザーからの入力を安全かつ効率的に処理するための強力なツールです。Symfony7では、より柔軟なフォームの定義やカスタマイズが可能になっています。

• Attributeベースのフォーム定義
  フォームタイプクラス内でもAttributeを利用してフィールドを定義できます。
• 型付きのフォーム
  フォームデータに型ヒントを設定することで、より安全なデータ処理を実現できます。
• イベントリスナーとデータトランスフォーマー
  複雑なフォームのロジックやデータ変換を柔軟に実装できます。

Formコンポーネントを深く理解することで、複雑な入力フォームも効率的に開発できます。

Securityコンポーネントの強力な認証・認可機能

SymfonyのSecurityコンポーネントは、アプリケーションのセキュリティを強固にするための認証（ユーザーの識別）と認可（ユーザーのアクセス権限の管理）機能を提供します。

• ガード認証
  より柔軟な認証フローを実装できます。
• Attributeベースのアクセス制御
  コントローラーやメソッドレベルでアクセス制御をAttributeで定義できます。
• Role階層
  複雑な権限管理を効率的に行えます。

Securityコンポーネントを適切に設定することで、アプリケーションを様々な脅威から守ることができます。

Cacheコンポーネントによるパフォーマンス向上

SymfonyのCacheコンポーネントは、アプリケーションのパフォーマンスを向上させるための様々なキャッシュ機構を提供します。HTTPキャッシュ、アプリケーションレベルのキャッシュなど、用途に応じたキャッシュ戦略を簡単に実装できます。

• PSR-6/PSR-16準拠
  標準化されたインターフェースで様々なキャッシュバックエンドを利用できます。
• タグ付きキャッシュ
  関連するキャッシュアイテムをまとめて削除できます。
• HTTPキャッシュの活用
  ブラウザやプロキシによるキャッシュを効率的に利用できます。

Cacheコンポーネントを活用することで、アプリケーションの応答速度を大幅に改善できます。

Profilerとデバッグツールの活用

SymfonyのProfilerは、リクエストの処理過程で発生した様々な情報を収集し、開発者がアプリケーションの動作を詳細に分析するための強力なツールです。データベースクエリ、HTTPリクエスト、イベント、ログなどを視覚的に確認できます。

また、dump()関数やdd()関数などのデバッグツールを活用することで、変数の内容やプログラムの流れを簡単に確認できます。

これらのツールを使いこなすことで、問題の特定やパフォーマンスのボトルネックの発見が容易になります。

まとめ

Symfony7には、開発者の生産性を向上させ、より堅牢で保守性の高いアプリケーションを構築するための多くの便利な機能が搭載されています。今回ご紹介した技はほんの一部ですが、これらを活用することで、Symfony7での開発がより快適になるはずです。

ぜひ、これらのテクニックを日々の開発に取り入れて、Symfony7のパワーを最大限に引き出してください。

１．必要な環境の準備

Linuxサーバの前提

• OS
  Ubuntu、CentOS、Debianなど
• PHP
  Symfony4はPHP 7.1以上が必要です
  ※ php -v コマンドでバージョンを確認してください
• Composer
  PHPパッケージ管理ツール
• Webサーバ
  ApacheまたはNginx（ここではApacheの例を示します

ドメイン設定

• DNSで「www.example.com」が対象サーバのIPを指していることを確認してください
  

２．Apacheによるドメイン設定

ApacheでのVirtualHost設定例（/etc/apache2/sites-available/example.com.conf）

<VirtualHost *:80>
    ServerName www.example.com
    DocumentRoot /var/www/example.com/public

    <Directory /var/www/example.com/public>
        AllowOverride All
        Require all granted
    </Directory>

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

設定後、以下のコマンドで有効化と再起動を行います

sudo a2ensite example.com
sudo a2enmod rewrite
sudo systemctl reload apache2

３．Symfony4プロジェクトの作成と配置

１．プロジェクトディレクトリの作成

Webサーバのドキュメントルート（例：/var/www/example.com）に移動し、ディレクトリを作成

sudo mkdir -p /var/www/example.com
cd /var/www/example.com
sudo chown $(whoami):$(whoami) .

２．Symfony4プロジェクトのインストール

Composerを使ってSymfony4プロジェクトを作成します。今回はDoctrineやセキュリティ機能が含まれるスターターキットを利用

composer create-project symfony/website-skeleton board_project

※ プロジェクトディレクトリ（例：board_project）内にpublicフォルダが作成されます。
※ ApacheのDocumentRootは、このpublicフォルダを指定してください（もしくはVirtualHost設定でパスを調整）。

４．データベース設定とエンティティ作成

掲示板の情報（ユーザ情報、投稿内容など）をデータベースに保存します。ここではMySQLを例にしています。

4.1. データベース接続情報の設定

プロジェクトルートの .env ファイルを編集し、DATABASE_URL を設定してください。

DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name

4.2. ユーザエンティティの作成

Symfony MakerBundleを利用してユーザエンティティを作成します。

php bin/console make:user

プロンプトに従い、エンティティ名（例：User）や識別子（メールアドレスまたはユーザ名）、パスワードフィールド、既定のロール（通常ユーザには ROLE_USER、管理者には ROLE_ADMIN）を設定します。

4.3. 掲示板投稿（Post）エンティティの作成

投稿情報を保存するためのエンティティを作成します。

php bin/console make:entity Post

以下のフィールドを追加すると良いでしょう：

• title : string
• content : text
• createdAt : datetime
• user : ManyToOne（Userエンティティとの関連付け、投稿者情報）

4.4. マイグレーションの実行

エンティティ作成後、マイグレーションを作成してデータベースに反映させます

php bin/console make:migration
php bin/console doctrine:migrations:migrate

５．ユーザ認証と管理者機能の実装

Symfonyのセキュリティコンポーネントを利用して、ログイン・登録機能、アクセス制限を実装します。

5.1. ログイン・登録フォームの作成

Symfony MakerBundleを使用して、ログインフォーム認証を生成します

php bin/console make:auth

また、ユーザ登録フォームも作成する場合は

php bin/console make:registration-form

生成されたコントローラーやフォームクラスを適宜編集し、パスワードエンコーディングやCSRF保護の設定を確認してください。

5.2. security.yaml の設定

プロジェクトの config/packages/security.yaml を以下のように設定します。必要に応じてプロバイダやファイアウォールの設定を調整してください。

security:
    encoders:
        App\Entity\User:
            algorithm: bcrypt

    providers:
        app_user_provider:
            entity:
                class: App\Entity\User
                property: email

    firewalls:
        dev:
            pattern: ^/(_(profiler|wdt)|css|images|js)/
            security: false
        main:
            anonymous: true
            lazy: true
            provider: app_user_provider
            form_login:
                login_path: login
                check_path: login
                default_target_path: /
            logout:
                path: logout

    access_control:
        # 管理者エリアへのアクセスはROLE_ADMINに制限
        - { path: ^/admin, roles: ROLE_ADMIN }
        # 投稿作成・編集はログインユーザに制限
        - { path: ^/post/new, roles: ROLE_USER }
        - { path: ^/post/edit, roles: ROLE_USER }

5.3. 管理者権限の付与

ユーザ登録時や管理画面で、管理者ユーザには ROLE_ADMIN を割り当てます。管理エリア用のコントローラー（例：AdminDashboardController）はルートを /admin で始め、上記の access_control により管理者以外はアクセスできないようにします。

６．掲示板機能（BBS）の実装

掲示板の基本機能として、投稿の一覧表示、投稿詳細、投稿作成、編集、削除などの機能を実装します。

6.1. コントローラー作成

例として、BoardController を作成し、以下のようなアクションを実装します。

<?php
// src/Controller/BoardController.php
namespace App\Controller;

use App\Entity\Post;
use App\Repository\PostRepository;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class BoardController extends AbstractController
{
    /**
     * @Route("/", name="board_index")
     */
    public function index(PostRepository $postRepository): Response
    {
        $posts = $postRepository->findBy([], ['createdAt' => 'DESC']);
        return $this->render('board/index.html.twig', [
            'posts' => $posts,
        ]);
    }

    /**
     * @Route("/post/{id}", name="board_view", requirements={"id"="\d+"})
     */
    public function view(Post $post): Response
    {
        return $this->render('board/view.html.twig', [
            'post' => $post,
        ]);
    }

    /**
     * @Route("/post/new", name="board_new")
     */
    public function new(Request $request): Response
    {
        // ログインユーザのみ投稿可能
        $this->denyAccessUnlessGranted('ROLE_USER');

        $post = new Post();
        // フォーム作成、リクエストのハンドリング（例：Symfony Formコンポーネントを利用）
        // ※ ここでは簡易例として、フォーム処理の詳細は省略

        // 保存処理
        // $entityManager = $this->getDoctrine()->getManager();
        // $post->setCreatedAt(new \DateTime());
        // $post->setUser($this->getUser());
        // $entityManager->persist($post);
        // $entityManager->flush();

        return $this->render('board/new.html.twig', [
            'post' => $post,
            // 'form' => $form->createView(),
        ]);
    }

    // 編集・削除アクションも必要に応じて実装
}

6.2. Twigテンプレート作成

templates/board/ 配下に各ビュー用テンプレートを作成します。

例：index.html.twig（投稿一覧表示）

{% extends 'base.html.twig' %}

{% block title %}掲示板{% endblock %}

{% block body %}
    <h1>掲示板投稿一覧</h1>
    {% for post in posts %}
        <div class="post">
            <h2><a href="{{ path('board_view', {id: post.id}) }}">{{ post.title }}</a></h2>
            <p>{{ post.content|raw }}</p>
            <small>投稿者: {{ post.user.email }} ・ 投稿日: {{ post.createdAt|date('Y-m-d H:i') }}</small>
        </div>
        <hr>
    {% else %}
        <p>まだ投稿がありません。</p>
    {% endfor %}
    {% if is_granted('ROLE_USER') %}
        <a href="{{ path('board_new') }}">新規投稿</a>
    {% else %}
        <p><a href="{{ path('login') }}">ログイン</a>して投稿しましょう。</p>
    {% endif %}
{% endblock %}

※ 各テンプレートは必要に応じてデザインやレイアウトを調整してください。

７．アクセス制限とセキュリティ対策

アクセス制限

• /admin 以下のルートは ROLE_ADMIN のみアクセス可能とし、security.yaml の access_control で管理
• 投稿作成編集はログインユーザ（ROLE_USER）に限定するため、コントローラー内で denyAccessUnlessGranted() を利用

セキュリティ対策

• フォームにCSRF保護を設定
• ユーザ入力のバリデーションとサニタイズを実施
• パスワードはエンコーダー（例：bcrypt）で暗号化

８．パーミッション設定と本番環境向け最適化

8.1. ディレクトリのパーミッション設定

Symfonyはキャッシュやログを書き込むため、Apache（例：ユーザ www-data）が書き込めるようACLを設定します。

sudo setfacl -R -m u:www-data:rwX -m u:$(whoami):rwX var
sudo setfacl -dR -m u:www-data:rwX -m u:$(whoami):rwX var

8.2. 本番環境向け設定の調整

.env で環境変数を設定（例：APP_ENV=prod, APP_DEBUG=0）

キャッシュのウォームアップ

php bin/console cache:warmup --env=prod

９．テストと動作確認

ローカルでの動作確認

ビルトインサーバを使ってローカルテスト

php bin/console server:run

ブラウザで http://127.0.0.1:8000 にアクセスし、投稿一覧やログイン・登録、投稿作成など各機能を確認してください。

本番サーバでの確認

DNS設定が完了していることを確認した上で、http://www.example.com へアクセスし、各機能が正しく動作するかテストします。

トラブルシューティング

エラーが発生した場合は、var/log/ 内のログファイル（例：prod.log や dev.log）を確認し、エラーメッセージに基づいて対処してください。

１０．まとめ

今回のマニュアルでは、Symfony4を用いた掲示板アプリケーションの作成手順を、以下の要素を中心に解説しました

• ユーザ認証・登録
  ログインフォームの生成とユーザエンティティ作成
• 管理者権限
  ROLE_ADMIN による管理エリアの制限
• アクセス制限
  各アクションへのアクセスをセキュリティコンポーネントで制御
• データベース連携
  Doctrineを利用したユーザ・投稿エンティティの管理
• 掲示板機能
  投稿の一覧表示、詳細表示、投稿作成・編集機能の実装

PHP5時代と比べ、Symfony4は構造化された設計や豊富なコンポーネントにより、拡張性・保守性に優れたアプリケーション開発が可能です。まずは本マニュアルの手順に沿って基本機能を実装し、そこからさらにカスタマイズや機能追加に挑戦してみてください。

このページではバリテーションで使用する可能性が高いユニーク値である事を検証する方法を説明します。

ここでは一般的に使用する既にログイン認証の設定が完了したユーザー（User）の定義を例にします。

ログイン認証までの設定方法が不明な場合は以下を参照してください。

symfony4でログイン認証を簡単に実装する

Symfonyにはコンソールコマンドにて簡単にログイン認証を実装する事ができます。 この記事ではSymfonyのインストールが完了しているのを前提に説明しています。 前提条件 以下のcomposerコマンドにてインストールした事を前提としま

blog.takeho.com

/src/Entity/User.php　は以下のようになっています。

<?php

namespace App\Entity;

use App\Repository\UserRepository;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ORM\Entity(repositoryClass=UserRepository::class)
 */
class User implements UserInterface
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=180, unique=true)

     * @Assert\Email()
     */
    private $email;

設定方法

メールアドレスに設定する場合、以下のように設定します。

<?php

namespace App\Entity;

use App\Repository\UserRepository;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * @ORM\Entity(repositoryClass=UserRepository::class)
 * @UniqueEntity("email")
 */
class User implements UserInterface
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=180, unique=true)
     * @Assert\Email()
     */
    private $email;

以上で完了です。

クラスのアノテーションに設定する理由について

バリテーションの設定は各カラムの変数の宣言箇所のアノテーションに記述しますが、ユニークの設定に関しては、そのテーブルの何のカラムにユニークの設定をしているのかクラスの宣言部分のアノテーションに記載する事で管理しやすくなっているものと解釈すれば納得できるかと思います。

ここではSymgony1.0.17をベースにデータベースを参照したページネーション機能とデータベースへの参照問合せで頻繁に使用する演算子の使用例について紹介します。

ページネーション

アクションクラスへメソッドの追加

アクションクラスへ次のメソッドを追加します。

  // 省略  

  public function executeList()
  {
    $c = new Criteria();
    $c->add(ProductPeer::＜カラム名＞, ＜値＞, ＜演算子(クラスメゾット)＞);
    $c->addDescendingOrderByColumn(ProductPeer::NAME);

    $pager = new sfPropelPager('Product', ＜表示させる件数＞);
    $pager->setCriteria($c);
    $pager->setPage($this->getRequestParameter('page', 0));
    $pager->init();

    $this->pager = $pager;
  }

改ページリンクの作成

次にページャーリンクの関数を用意します。

アプリケーションディレクトリ内のlibディレクトリ内にhelperディレクトリを作成し次のファイルを作成します。

作成ファイル：PagerHelper.php

<?php

function pager_navigation($pager, $uri, $num = 8, $attach= '')
{
  $navigation = '';

  if ($pager->haveToPaginate())
  {
    $uri .= (preg_match('/\?/', $uri) ? '&' : '?');
    $uri .= 'page=';

    if($num + 1 < $pager->getPage()){
      $navigation .= '<li>'.link_to('<<', $uri.'1').'</li>';
    }
    if ($pager->getPage() > 1){
      $navigation .= '<li>'.link_to('<', $uri.$pager->getPreviousPage()).'</li>';
    }

    $stcnt = ($pager->getPage() <= $num) ? 1 : $pager->getPage() - $num;
    $encnt = ($pager->getPage() > ($pager->getLastPage() - 3)) ? $pager->getLastPage() : $pager->getPage() + $num;
    if($encnt > $pager->getLastPage()){
      $encnt = $pager->getLastPage();
    }

    for($i = $stcnt; $i <= $encnt; $i++)
    {
      if ($i == $pager->getPage()) {
        // if ($page == $pager->getPage()) {
        $navigation .= '<li class="active"><a href="#">'.$i.'</a></li>';
      }else {
        $navigation .= '<li>'.link_to($i, $uri.$i).'</li>';
      }
    }


    if($pager->getPage() <  $pager->getLastPage()){
      $navigation .= '<li>'.link_to('>', $uri.$pager->getNextPage()).'</li>';
    }
    if($pager->getPage() + $num <  $pager->getLastPage()){
      $navigation .= '<li>'.link_to('>>', $uri.$pager->getLastPage()).'</li>';
    }
  }

  return '<ul class="pagination '.$attach.'">'.$navigation.'</ul>';
}

ページ情報（プロパティ）の作成

先程作成したPageHelper.phpに表示しているページが全何件中、何処から何処まで表示しているか表示する機能を追加します。

function pager_infomation($pager, $format = '{total}件中 （{from}～{to}件表示）', $emp = 'Not found.')
{
  $infomation = '';
  if ($pager->getNbResults() > 0 ) {
    $total = $pager->getNbResults();
    if ($total > 0) {
      $from = $pager->getMaxPerPage() * ($pager->getPage()  - 1) + 1;
    }else {
      $from = $pager->getMaxPerPage() * ($pager->getPage()  - 1);
    }
    $to = $pager->getMaxPerPage() * ($pager->getPage()  - 1) + count($pager->getResults());
    $infomation = str_replace('{total}', $total, $format);
    $infomation = str_replace('{from}', $from, $infomation);
    $infomation = str_replace('{to}', $to, $infomation);
  }else {
    $infomation = $emp;
  }
  return $infomation;
}

ビュー（テンプレート）の作成

次はビューファイル（listSuccess.php）の内容です。

<?php use_helper('Pager') ?>
<table>
  <caption><?php echo pager_infomation($pager) ?></caption>
  <thead>
    <th>品名</th>
    <th>状態</th>
    <th>金額</th>
    <th>製造番号</th>
  </thead>
  <tbody>
    <?php foreach($pager->getResults() as $product): ?>
      <tr>
        <th><?php echo $product->getName() ?></th>
        <th><?php echo $product->getStatus() ?></th>
        <th><?php echo $product->getPrice() ?></th>
        <th><?php echo $product->getSerial() ?></th>
      </tr>
    <?php endforeach; ?>
  </tbody>
</table>
<?php echo pager_navigation($pager, '＜アクションクラス名＞/list') ?>

Propelのページネーションの例は以上です。

SQLの演算子の使用例

次の表に演算子の使用例を紹介します。

この記事ではSymfonyのインストールが完了しているのを前提に説明しています。

composer create-project symfony/website-skeleton <PROJECT_NAME> 4.*

セキュリティーバンドルのインストール

以下のコマンドを実行してセキュリティーバンドルをインストールします。

composer require symfony/security-bundle

ユーザークラスを作成する

ユーザ認証に使用するためのクラスを作成します。

php bin/console make:user

The name of the security user class (e.g. User) [User]:
>

Do you want to store user data in the database (via Doctrine)? (yes/no) [yes]:
>

Enter a property name that will be the unique "display" name for the user (e.g. email, username, uuid) [email]:
>

Will this app need to hash/check user passwords? Choose No if passwords are not needed or will be checked/hashed by some other system (e.g. a single sign-on server).

Does this app need to hash/check user passwords? (yes/no) [yes]:
>

created: src/Entity/User.php
created: src/Repository/UserRepository.php
updated: src/Entity/User.php
updated: config/packages/security.yaml


 Success!


Next Steps:
  - Review your new App\Entity\User class.
  - Use make:entity to add more fields to your User entity and then run make:migration.
  - Create a way to authenticate! See https://symfony.com/doc/current/security.html

Userクラスのフィールドは任意で追加しても問題ありません。重要なのはSymfony\Component\Security\Core\User\UserInterfaceを継承することです。

クラスを作成したらデータベースを更新します。

php bin/console make:migration
php bin/console doctrine:migrations:migrate

プロバイダの設定

Userクラスに加えて、「user provider」も必要です。セッションからユーザ情報の再読み込みや、なりすまし等などいくつかのオプション機能などを支援してくれます。
しかし、make:userで作成すると、自動でuser providerも作成されます。security.yamlのproviders:を確認してみましょう。

security:
    // ...
    providers:
        # used to reload user from session & other features (e.g. switch_user)
        app_user_provider:
            entity:
                class: App\Entity\User
                property: email

パスワードエンコード

ほとんどのログイン認証には、パスワードが使われます。パスワードは、情報漏洩対策でほとんど暗号化されています。security.yamlにパスワードの暗号方式を設定します。

security:
    encoders:
        App\Entity\User:
            algorithm: auto

次のコマンドを実行すると、パスワードを手動でエンコードできます。

php bin/console security:encode-password

ログインフォーム作成

ログインフォームを作成します。

php bin/console make:auth

 What style of authentication do you want? [Empty authenticator]:
  [0] Empty authenticator
  [1] Login form authenticator
 > 1

 The class name of the authenticator to create (e.g. AppCustomAuthenticator):
 > LoginFormAuthenticator

 Choose a name for the controller class (e.g. SecurityController) [SecurityController]:
 >

 Do you want to generate a '/logout' URL? (yes/no) [yes]:
 >

 created: src/Security/LoginFormAuthenticator.php
 updated: config/packages/security.yaml
 created: src/Controller/SecurityController.php
 created: templates/security/login.html.twig


  Success!


 Next:
 - Customize your new authenticator.
 - Finish the redirect "TODO" in the App\Security\LoginFormAuthenticator::onAuthenticationSuccess() method.
 - Review & adapt the login template: templates/security/login.html.twig.

これにより、1）ログイン/ログアウトルートとコントローラー、2）ログインフォームをレンダリングするテンプレート、3） ログイン送信を処理するGuard認証クラス、4）メインのセキュリティ構成ファイルが更新されます。

１．ログインコントローラー

// src/Controller/SecurityController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;

class SecurityController extends AbstractController
{
    /**
     * @Route("/login", name="app_login")
     */
    public function login(AuthenticationUtils $authenticationUtils): Response
    {
        // if ($this->getUser()) {
        //     return $this->redirectToRoute('target_path');
        // }

        // get the login error if there is one
        $error = $authenticationUtils->getLastAuthenticationError();
        // last username entered by the user
        $lastUsername = $authenticationUtils->getLastUsername();

        return $this->render('security/login.html.twig', [
            'last_username' => $lastUsername,
            'error' => $error
        ]);
    }

    /**
     * @Route("/logout", name="app_logout")
     */
    public function logout()
    {
        throw new \LogicException('This method can be blank - it will be intercepted by the logout key on your firewall.');
    }
}

ログアウトのパスをsecurity.yamlに追加します。

２．ログインフォーム

これは、セキュリィーにはほとんど関係がなくログイン用のフォームを用意するだけです。

{% extends 'base.html.twig' %}
{% block title %}Log in!{% endblock %}
{% block body %}
<form method="post">
{% if error %}
<div class="alert alert-danger">{{ error.messageKey|trans(error.messageData, 'security') }}</div>
{% endif %}
{% if app.user %}
<div class="mb-3">
You are logged in as {{ app.user.username }}, <a href="{{ path('app_logout') }}">Logout</a>
</div>
{% endif %}
<h1 class="h3 mb-3 font-weight-normal">Please sign in</h1>
<label for="inputEmail">Email</label>
<input type="email" value="{{ last_username }}" name="email" id="inputEmail" class="form-control" required autofocus>
<label for="inputPassword">Password</label>
<input type="password" name="password" id="inputPassword" class="form-control" required>
<input type="hidden" name="_csrf_token"
value="{{ csrf_token('authenticate') }}"
>
{#
Uncomment this section and add a remember_me option below your firewall to activate remember me functionality.
See https://symfony.com/doc/current/security/remember_me.html
<div class="checkbox mb-3">
<label>
<input type="checkbox" name="_remember_me"> Remember me
</label>
</div>
#}
<button class="btn btn-lg btn-primary" type="submit">
Sign in
</button>
</form>
{% endblock %}

３．Guardオーセンティケーターがフォーム送信を処理

namespace App\Security;

use App\Entity\User;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
use Symfony\Component\Security\Core\Exception\InvalidCsrfTokenException;
use Symfony\Component\Security\Core\Security;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Csrf\CsrfToken;
use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
use Symfony\Component\Security\Guard\Authenticator\AbstractFormLoginAuthenticator;
use Symfony\Component\Security\Guard\PasswordAuthenticatedInterface;
use Symfony\Component\Security\Http\Util\TargetPathTrait;

class LoginFormAuthenticator extends AbstractFormLoginAuthenticator implements PasswordAuthenticatedInterface
{
    use TargetPathTrait;

    public const LOGIN_ROUTE = 'app_login';

    private $entityManager;
    private $urlGenerator;
    private $csrfTokenManager;
    private $passwordEncoder;

    public function __construct(EntityManagerInterface $entityManager, UrlGeneratorInterface $urlGenerator, CsrfTokenManagerInterface $csrfTokenManager, UserPasswordEncoderInterface $passwordEncoder)
    {
        $this->entityManager = $entityManager;
        $this->urlGenerator = $urlGenerator;
        $this->csrfTokenManager = $csrfTokenManager;
        $this->passwordEncoder = $passwordEncoder;
    }

    public function supports(Request $request)
    {
        return self::LOGIN_ROUTE === $request->attributes->get('_route')
            && $request->isMethod('POST');
    }

    public function getCredentials(Request $request)
    {
        $credentials = [
            'email' => $request->request->get('email'),
            'password' => $request->request->get('password'),
            'csrf_token' => $request->request->get('_csrf_token'),
        ];
        $request->getSession()->set(
            Security::LAST_USERNAME,
            $credentials['email']
        );

        return $credentials;
    }

    public function getUser($credentials, UserProviderInterface $userProvider)
    {
        $token = new CsrfToken('authenticate', $credentials['csrf_token']);
        if (!$this->csrfTokenManager->isTokenValid($token)) {
            throw new InvalidCsrfTokenException();
        }

        $user = $this->entityManager->getRepository(User::class)->findOneBy(['email' => $credentials['email']]);

        if (!$user) {
            // fail authentication with a custom error
            throw new CustomUserMessageAuthenticationException('Email could not be found.');
        }

        return $user;
    }

    public function checkCredentials($credentials, UserInterface $user)
    {
        return $this->passwordEncoder->isPasswordValid($user, $credentials['password']);
    }

    /**
     * Used to upgrade (rehash) the user's password automatically over time.
     */
    public function getPassword($credentials): ?string
    {
        return $credentials['password'];
    }

    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
    {
        if ($targetPath = $this->getTargetPath($request->getSession(), $providerKey)) {
            return new RedirectResponse($targetPath);
        }

        // For example : return new RedirectResponse($this->urlGenerator->generate('some_route'));
        throw new \Exception('TODO: provide a valid redirect inside '.__FILE__);
    }

    protected function getLoginUrl()
    {
        return $this->urlGenerator->generate(self::LOGIN_ROUTE);
    }
}

４．Guardのオーセンティケーターを有効にするためにメインのセキュリティー構成ファイルを更新

security:
    # ...

    firewalls:
        main:
            # ...
            guard:
                authenticators:
                    - App\Security\LoginFormAuthenticator

アクセスコントロール

ログインしないとシステムが使えないように、アクセス権限等を設定する必要があります。しかし、ログインはアクセスを外す必要があります。

security:
    # ...
    access_control:
        - { path: '^/login$', roles: IS_AUTHENTICATED_ANONYMOUSLY }
        # require ROLE_ADMIN for /admin*
        - { path: '^/', roles: ROLE_ADMIN }

次に、ログイン成功時にTOPページに飛ぶよう設定します。ログイン認証時の処理はLoginFormAuthenticatorを変更します。

// src/Security/LoginFormAuthenticator.php

// ...
public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
{
    // ...
    // throw new \Exception('TODO: provide a valid redirect inside '.__FILE__);
    return new RedirectResponse($this->urlGenerator->generate('app_homepage'));
}

動作確認

これで、ログイン認証処理は終わりです。では実際に動作確認をする方法を説明します。

事前準備

確認するには予めデータベースへアカウント情報を登録する必要があります。

データベースへ登録するデータはメールアドレスとパスワードの２つになりますが、パスワードは暗号化したハッシュ値を保存します。

暗号化したハッシュ値はパスワードエンコードの項目で説明した以下のコマンドで確認する事ができます。

>php bin/console security:encode-password
Symfony Password Encoder Utility
================================

 Type in your password to be encoded:
 > // パスワードを入力してEnter

 ------------------ ---------------------------------------------------------------------------------------------------
  Key                Value
 ------------------ ---------------------------------------------------------------------------------------------------
  Encoder used       Symfony\Component\Security\Core\Encoder\MigratingPasswordEncoder
  Encoded password   $argon2id$v=19$m=65536,t=4,p=1$d0E5RUNweWlFMWdyWVhubw$QfPYWiHKhw+I7S4bTWPAFj8gSiyismTWad4pHtY3/NA
 ------------------ ---------------------------------------------------------------------------------------------------

 ! [NOTE] Self-salting encoder used: the encoder generated its own built-in salt.


 [OK] Password encoding succeeded

パスワードエンコードのコマンドで出力されたEncode passwordの値をデータベースのパスワードの項目へ登録します。

確認

ブラウザから以下のURLへアクセスし、データベースへ登録したメールアドレスとパスワード（暗号化前の値）を入力して確認します。

http://localhost/login