Symfonyで簡単なCRUDを作る

mkdir sandbox && cd sandbox

git clone https://github.com/shimabox/devenv.git # shimaboxのところは自身のアカウント名に変えてください

cd devenv

make up

docker ps

CONTAINER ID   IMAGE        COMMAND                  CREATED         STATUS         PORTS                               NAMES
be0409416857   devenv-web   "docker-php-entrypoi…"   9 seconds ago   Up 8 seconds   0.0.0.0:8080->80/tcp                web
a41cbfc9c9da   mysql:8.0    "docker-entrypoint.s…"   10 days ago     Up 10 days     0.0.0.0:3306->3306/tcp, 33060/tcp   db

make php-cli

root@be0409416857:/var/www/html#

ls

chapter02  chapter09  chapter12  composer.json  composer.lock  phpunit.xml

which composer

/usr/bin/composer

composer create-project symfony/skeleton symfony-sample

cd symfony-sample

ls

bin  composer.json  composer.lock  config  public  src  symfony.lock  var  vendor

composer require webapp

ls

assets  bin  composer.json  composer.lock  config  importmap.php  migrations  phpunit.xml.dist  public  src  symfony.lock  templates  tests  translations  var  vendor

root@be0409416857:/var/www/html/symfony-sample# exit # exitで抜ける
exit
~/shimabox/sandbox/devenv (main)
%

symfony server:start --dir=app/symfony-sample/public

〜

 [OK] Web server listening
      The Web server is using PHP CGI 8.3.9
      http://127.0.0.1:8000

git add .
git commit -m "feat: Symfonyの起動まで"

cd sandbox/devenv

docker compose exec db /bin/bash

mysql --version

mysql  Ver 8.0.37 for Linux on aarch64 (MySQL Community Server - GPL)

mysql -h 127.0.0.1 -u myuser -p sample
Enter password: 

mysql> show tables;
Empty set (0.01 sec)

make php-cli
cd symfony-sample/

touch .env.local

vim .env.local

DATABASE_HOST="127.0.0.1"
DATABASE_URL="mysql://myuser:mypassword@${DATABASE_HOST}:3306/sample?serverVersion=8.0.37"

php bin/console debug:container --env-vars

Symfony Container Environment Variables
=======================================

 ------------------------- ------------------ -----------------------------------------------------------------
  Name                      Default value      Real value
 ------------------------- ------------------ -----------------------------------------------------------------
  APP_SECRET                n/a                "5abb6e6abc1a0ac00fe0b74d3a6767fe"
  DATABASE_URL              n/a                "mysql://myuser:[email protected]:3306/sample?serverVersion=8.0.37"
  MAILER_DSN                n/a                "null://null"
  MESSENGER_TRANSPORT_DSN   n/a                "doctrine://default?auto_setup=0"
  VAR_DUMPER_SERVER         "127.0.0.1:9912"   n/a
 ------------------------- ------------------ -----------------------------------------------------------------

 // Note real values might be different between web and CLI.

DATABASE_HOST="db" php Bin/console debug:container --env-vars

Symfony Container Environment Variables
=======================================

 ------------------------- ------------------ -----------------------------------------------------------------
  Name                      Default value      Real value
 ------------------------- ------------------ -----------------------------------------------------------------
  APP_SECRET                n/a                "5abb6e6abc1a0ac00fe0b74d3a6767fe"
  DATABASE_URL              n/a                "mysql://myuser:mypassword@db:3306/sample?serverVersion=8.0.37"
  MAILER_DSN                n/a                "null://null"
  MESSENGER_TRANSPORT_DSN   n/a                "doctrine://default?auto_setup=0"
  VAR_DUMPER_SERVER         "127.0.0.1:9912"   n/a
 ------------------------- ------------------ -----------------------------------------------------------------

 // Note real values might be different between web and CLI.

php bin/console make:entity Task

created: src/Entity/Task.php
created: src/Repository/TaskRepository.php

Entity generated! Now let's add some fields!
You can always add more fields later manually or by re-running this command.

<?php

namespace App\Entity;

use App\Repository\TaskRepository;
use Doctrine\DBAL\Types\Types;
use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity(repositoryClass: TaskRepository::class)]
class Task
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\Column(length: 255)]
    private ?string $title = null;

    #[ORM\Column(type: Types::TEXT, nullable: true)]
    private ?string $description = null;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function setTitle(string $title): static
    {
        $this->title = $title;

        return $this;
    }

    public function getDescription(): ?string
    {
        return $this->description;
    }

    public function setDescription(?string $description): static
    {
        $this->description = $description;

        return $this;
    }
}

git add src/Entity/Task.php src/Repository/TaskRepository.php
git commit -m "feat: エンティティ(リポジトリ)の作成"

DATABASE_HOST="db" php bin/console make:migration

created: migrations/Version20241229070020.php

  Success!

Review the new migration then run it with php bin/console doctrine:migrations:migrate
See https://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html

DATABASE_HOST="db" php bin/console doctrine:migrations:migrate

 WARNING! You are about to execute a migration in database "sample" that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
 > yes

[notice] Migrating up to DoctrineMigrations\Version20241229070020
[notice] finished in 25.3ms, used 24M memory, 1 migrations executed, 2 sql queries

 [OK] Successfully migrated to version: DoctrineMigrations\Version20241229070020

docker compose exec db /bin/bash

mysql -h 127.0.0.1 -u myuser -p sample

mysql> desc task;
+-------------+--------------+------+-----+---------+----------------+
| Field       | Type         | Null | Key | Default | Extra          |
+-------------+--------------+------+-----+---------+----------------+
| id          | int          | NO   | PRI | NULL    | auto_increment |
| title       | varchar(255) | NO   |     | NULL    |                |
| description | longtext     | YES  |     | NULL    |                |
+-------------+--------------+------+-----+---------+----------------+
3 rows in set (0.01 sec)

git add migrations/.
git commit -m "feat: マイグレーションファイルの生成" 

git diff

diff --git a/app/symfony-sample/src/Entity/Task.php b/app/symfony-sample/src/Entity/Task.php
index 4c802d1..e330414 100644
--- a/app/symfony-sample/src/Entity/Task.php
+++ b/app/symfony-sample/src/Entity/Task.php
@@ -12,20 +12,20 @@ class Task
     #[ORM\Id]
     #[ORM\GeneratedValue]
     #[ORM\Column]
-    private ?int $id = null;
+    private int $id;

     #[ORM\Column(length: 255)]
-    private ?string $title = null;
+    private string $title;

     #[ORM\Column(type: Types::TEXT, nullable: true)]
     private ?string $description = null;

-    public function getId(): ?int
+    public function getId(): int
     {
         return $this->id;
     }

-    public function getTitle(): ?string
+    public function getTitle(): string
     {
         return $this->title;
     }

git add src/Entity/Task.php
git commit -m "feat: nullableをやめる"

<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class TaskController extends AbstractController
{
}

<?php

namespace App\Controller;

use App\Entity\Task;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class TaskController extends AbstractController
{
    #[Route('/task', name: 'task_index', methods: ['GET'])]
    public function index(EntityManagerInterface $em): Response
    {
        $tasks = $em->getRepository(Task::class)->findAll();
        return $this->render('task/index.html.twig', ['tasks' => $tasks]);
    }
}

controllers:
    resource:
        path: ../src/Controller/
        namespace: App\Controller
    type: attribute

{# templates/task/index.html.twig #}

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

{% block title %}タスク一覧{% endblock %}

{% block body %}
    <h1>タスク一覧</h1>
    <ul>
        {% for task in tasks %}
            <li>
                {{ task.title }}
            </li>
        {% else %}
            <li>タスクがありません。</li>
        {% endfor %}
    </ul>
{% endblock %}

docker compose exec db /bin/bash

mysql -h 127.0.0.1 -u myuser -p sample
Enter password: 

mysql> INSERT INTO task (title, description) VALUES ('Task 1', 'This is task1.'), ('Task 2', 'This is task2.'), ('Task 3', 'This is task3.');
Query OK, 3 rows affected (0.00 sec)
Records: 3  Duplicates: 0  Warnings: 0

mysql> select * from task;
+----+--------+----------------+
| id | title  | description    |
+----+--------+----------------+
|  1 | Task 1 | This is task1. |
|  2 | Task 2 | This is task2. |
|  3 | Task 3 | This is task3. |
+----+--------+----------------+
3 rows in set (0.00 sec)

git add app/symfony-sample/src/Controller/TaskController.php app/symfony-sample/templates/task/
git commit -m "feat: Readの作成まで"

<?php

namespace App\Controller;

use App\Entity\Task;
use App\Form\TaskType;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class TaskController extends AbstractController
{
    // 〜

    #[Route('/task/new', name: 'task_new', methods: ['GET', 'POST'])]
    public function new(Request $request, EntityManagerInterface $em): Response
    {
        $task = new Task();
        $form = $this->createForm(TaskType::class, $task);

        $form->handleRequest($request);
        if ($form->isSubmitted() && $form->isValid()) {
            $em->persist($task);
            $em->flush();

            return $this->redirectToRoute('task_index');
        }

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

<?php

namespace App\Form;

use App\Entity\Task;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class TaskType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('title', TextType::class, [
                'label' => 'Title',
            ])
            ->add('description', TextareaType::class, [
                'label' => 'Description',
                'required' => false,
            ]);
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'data_class' => Task::class,
        ]);
    }
}

{# templates/task/new.html.twig #}

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

{% block title %}新しいタスクを作成{% endblock %}

{% block body %}
    <h1>新しいタスクを作成</h1>

    {{ form_start(form) }}
    {{ form_widget(form) }}
    <button type="submit">作成</button>
    {{ form_end(form) }}

    <a href="{{ path('task_index') }}">戻る</a>
{% endblock %}

{# templates/task/index.html.twig #}

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

{% block title %}タスク一覧{% endblock %}

{% block body %}
    <h1>タスク一覧</h1>

    <a href="{{ path('task_new') }}">新しいタスクを作成</a>

    <ul>
        {% for task in tasks %}
            <li>
                {{ task.title }}
            </li>
        {% else %}
            <li>タスクがありません。</li>
        {% endfor %}
    </ul>
{% endblock %}

git add app/symfony-sample/src/Controller/TaskController.php app/symfony-sample/templates/task/ app/symfony-sample/src/Form/
git commit -m "feat: Createの作成まで"

<?php

namespace App\Controller;

use App\Entity\Task;
use App\Form\TaskType;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class TaskController extends AbstractController
{
    // 〜

    #[Route('/task/{id}/edit', name: 'task_edit', methods: ['GET', 'PUT'])]
    public function edit(Task $task, Request $request, EntityManagerInterface $em): Response
    {
        $form = $this->createForm(TaskType::class, $task, [
            'method' => 'PUT',
        ]);
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            $em->flush();

            return $this->redirectToRoute('task_index');
        }

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

{# templates/task/edit.html.twig #}

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

{% block title %}タスクを編集{% endblock %}

{% block body %}
    <h1>タスクを編集</h1>

    {{ form_start(form, {
        'method': 'PUT',
        'action': path('task_edit', {'id': task.id})
    }) }}
    {{ form_widget(form) }}
    <button type="submit">更新</button>
    {{ form_end(form) }}

    <a href="{{ path('task_index') }}">戻る</a>
{% endblock %}

{# templates/task/index.html.twig #}

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

{% block title %}タスク一覧{% endblock %}

{% block body %}
    <h1>タスク一覧</h1>

    <a href="{{ path('task_new') }}">新しいタスクを作成</a>

    <ul>
        {% for task in tasks %}
            <li>
                <a href="{{ path('task_edit', {'id': task.id}) }}">{{ task.title }}</a>
            </li>
        {% else %}
            <li>タスクがありません。</li>
        {% endfor %}
    </ul>
{% endblock %}

# see https://symfony.com/doc/current/reference/configuration/framework.html
framework:
    secret: '%env(APP_SECRET)%'

    # Note that the session will be started ONLY if you read or write from it.
    session: true

    #esi: true
    #fragments: true
    
    http_method_override: true

when@test:
    framework:
        test: true
        session:
            storage_factory_id: session.storage.factory.mock_file

git add app/symfony-sample/config/packages/framework.yaml app/symfony-sample/src/Controller/TaskController.php app/symfony-sample/templates/task/
git commit -m "feat: Updateの作成まで"

<?php

namespace App\Controller;

use App\Entity\Task;
use App\Form\TaskType;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class TaskController extends AbstractController
{
    // 〜

    #[Route('/task/{id}/delete', name: 'task_delete', methods: ['DELETE'])]
    public function delete(Task $task, Request $request, EntityManagerInterface $em): Response
    {
        if ($this->isCsrfTokenValid('delete'.$task->getId(), $request->request->get('_token'))) {
            $em->remove($task);
            $em->flush();
        }

        return $this->redirectToRoute('task_index');
    }
}

{# templates/task/index.html.twig #}

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

{% block title %}タスク一覧{% endblock %}

{% block body %}
    <h1>タスク一覧</h1>

    <a href="{{ path('task_new') }}">新しいタスクを作成</a>

    <ul>
        {% for task in tasks %}
            <li>
                <a href="{{ path('task_edit', {'id': task.id}) }}">{{ task.title }}</a>
                <form action="{{ path('task_delete', {'id': task.id}) }}" method="post" style="display:inline">
                    <input type="hidden" name="_method" value="DELETE">
                    <input type="hidden" name="_token" value="{{ csrf_token('delete' ~ task.id) }}">
                    <button type="submit">削除</button>
                </form>
            </li>
        {% else %}
            <li>タスクがありません。</li>
        {% endfor %}
    </ul>
{% endblock %}

git add app/symfony-sample/src/Controller/TaskController.php app/symfony-sample/templates/task/index.html.twig
git commit -m "feat: Deleteの作成まで。CRUD、Done！"