13724522058

Committed 07 Mar 2025 04:04PM UTC coverage: 8.175% (-0.3%) from 8.518%

Build # 13724522058

Build Type

Pull #7005

github

Committed by

web-flow

Commit Message

Merge 322407532 into 1e0bc9dc8

Pull Request Pull Request #7005: fix(validation): deprecate string message for ValidationException con…

Run Details

4 of 6 new or added lines in 1 file covered. (66.67%)

159 existing lines in 24 files now uncovered.

12839 of 157045 relevant lines covered (8.18%)

13.55 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/docs/guides/delete-operation-with-validation.php

<?php
// ---
// slug: delete-operation-with-validation
// name: Delete operation with validation
// position: 20
// tags: validation, expert
// executable: true
// ---

// Let's add a [custom Constraint](https://symfony.com/doc/current/validation/custom_constraint.html).

namespace App\Validator {
    use Symfony\Component\Validator\Constraint;

    #[\Attribute]
    class AssertCanDelete extends Constraint
    {
        public string $message = 'For whatever reason we denied removal of this data.';
        public string $mode = 'strict';

        public function getTargets(): string
        {
            return self::CLASS_CONSTRAINT;
        }
    }
}

// And a custom validator following Symfony's naming conventions.

namespace App\Validator {
    use Symfony\Component\Validator\Constraint;
    use Symfony\Component\Validator\ConstraintValidator;

    class AssertCanDeleteValidator extends ConstraintValidator
    {
        public function validate(mixed $value, Constraint $constraint): void
        {
            $this->context->buildViolation($constraint->message)->addViolation();
        }
    }
}

namespace App\Entity {
    use ApiPlatform\Metadata\Delete;
    use ApiPlatform\Validator\Exception\ValidationException;
    use App\Validator\AssertCanDelete;
    use Doctrine\ORM\Mapping as ORM;

    #[ORM\Entity]
    #[Delete(
        // By default, validation is not triggered on a DELETE operation, let's activate it.
        validate: true,
        // Just as with serialization we can add [validation groups](/docs/core/validation/#using-validation-groups).
        validationContext: ['groups' => ['deleteValidation']],
        exceptionToStatus: [ValidationException::class => 403]
    )]
    // Here we use the previously created constraint on the class directly.
    #[AssertCanDelete(groups: ['deleteValidation'])]
    class Book
    {
        #[ORM\Id, ORM\Column, ORM\GeneratedValue]
        private ?int $id = null;

        #[ORM\Column]
        public string $title = '';

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

namespace App\Playground {
    use Symfony\Component\HttpFoundation\Request;

    function request(): Request
    {
        return Request::create(uri: '/books/1', method: 'DELETE', server: ['CONTENT_TYPE' => 'application/ld+json']);
    }
}

namespace App\Fixtures {
    use App\Entity\Book;
    use Doctrine\Bundle\FixturesBundle\Fixture;
    use Doctrine\Persistence\ObjectManager;

    use function Zenstruck\Foundry\anonymous;
    use function Zenstruck\Foundry\faker;
    use function Zenstruck\Foundry\repository;

    final class BookFixtures extends Fixture
    {
        public function load(ObjectManager $manager): void
        {
            $bookFactory = anonymous(Book::class);
            if (repository(Book::class)->count()) {
                return;
            }

            $bookFactory->many(10)->create(
                fn () => [
                    'title' => faker()->name(),
                ]
            );
        }
    }
}

namespace DoctrineMigrations {
    use Doctrine\DBAL\Schema\Schema;
    use Doctrine\Migrations\AbstractMigration;

    final class Migration extends AbstractMigration
    {
        public function up(Schema $schema): void
        {
            $this->addSql('CREATE TABLE book (id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, title VARCHAR(255) NOT NULL)');
        }
    }
}

1	<?php
2	// ---
3	// slug: delete-operation-with-validation
4	// name: Delete operation with validation
5	// position: 20
6	// tags: validation, expert
7	// executable: true
8	// ---
9
10	// Let's add a [custom Constraint](https://symfony.com/doc/current/validation/custom_constraint.html).
11
12	namespace App\Validator {
13	use Symfony\Component\Validator\Constraint;
14
15	#[\Attribute]
16	class AssertCanDelete extends Constraint
17	{
18	public string $message = 'For whatever reason we denied removal of this data.';
19	public string $mode = 'strict';
20
21	public function getTargets(): string
22	{
23	return self::CLASS_CONSTRAINT;	×
24	}
25	}
26	}
27
28	// And a custom validator following Symfony's naming conventions.
29
30	namespace App\Validator {
31	use Symfony\Component\Validator\Constraint;
32	use Symfony\Component\Validator\ConstraintValidator;
33
34	class AssertCanDeleteValidator extends ConstraintValidator
35	{
36	public function validate(mixed $value, Constraint $constraint): void
37	{
38	$this->context->buildViolation($constraint->message)->addViolation();	×
39	}
40	}
41	}
42
43	namespace App\Entity {
44	use ApiPlatform\Metadata\Delete;
45	use ApiPlatform\Validator\Exception\ValidationException;
46	use App\Validator\AssertCanDelete;
47	use Doctrine\ORM\Mapping as ORM;
48
49	#[ORM\Entity]
50	#[Delete(
51	// By default, validation is not triggered on a DELETE operation, let's activate it.
52	validate: true,	×
53	// Just as with serialization we can add [validation groups](/docs/core/validation/#using-validation-groups).
54	validationContext: ['groups' => ['deleteValidation']],	×
55	exceptionToStatus: [ValidationException::class => 403]	×
56	)]	×
57	// Here we use the previously created constraint on the class directly.
58	#[AssertCanDelete(groups: ['deleteValidation'])]
59	class Book
60	{
61	#[ORM\Id, ORM\Column, ORM\GeneratedValue]
62	private ?int $id = null;
63
64	#[ORM\Column]
65	public string $title = '';
66
67	public function getId()
68	{
69	return $this->id;	×
70	}
71	}
72	}
73
74	namespace App\Playground {
75	use Symfony\Component\HttpFoundation\Request;
76
77	function request(): Request
78	{
79	return Request::create(uri: '/books/1', method: 'DELETE', server: ['CONTENT_TYPE' => 'application/ld+json']);	×
80	}
81	}
82
83	namespace App\Fixtures {
84	use App\Entity\Book;
85	use Doctrine\Bundle\FixturesBundle\Fixture;
86	use Doctrine\Persistence\ObjectManager;
87
88	use function Zenstruck\Foundry\anonymous;
89	use function Zenstruck\Foundry\faker;
90	use function Zenstruck\Foundry\repository;
91
92	final class BookFixtures extends Fixture
93	{
94	public function load(ObjectManager $manager): void
95	{
96	$bookFactory = anonymous(Book::class);	×
97	if (repository(Book::class)->count()) {	×
98	return;	×
99	}
100
101	$bookFactory->many(10)->create(	×
102	fn () => [	×
103	'title' => faker()->name(),	×
104	]	×
105	);	×
106	}
107	}
108	}
109
110	namespace DoctrineMigrations {
111	use Doctrine\DBAL\Schema\Schema;
112	use Doctrine\Migrations\AbstractMigration;
113
114	final class Migration extends AbstractMigration
115	{
116	public function up(Schema $schema): void
117	{
118	$this->addSql('CREATE TABLE book (id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, title VARCHAR(255) NOT NULL)');	×
119	}
120	}
121	}

api-platform / core / 13724522058

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous