VOOZH about

URL: https://stack.sylius.com/resource/index/validation

⇱ Validation | Sylius Stack

For the complete documentation index, see llms.txt. This page is also available as Markdown.

It uses symfony/validator to validate your data.

on HTML request

src/Entity/Book.php
namespaceApp\Entity;
use App\Form\Type\BookType;
use Sylius\Resource\Model\ResourceInterface;
use Sylius\Resource\Metadata\AsResource;
use Sylius\Resource\Metadata\Create;
use Symfony\Component\Validator\Constraintsas Assert;
#[AsResource(
formType:BookType::class,
operations:[
newCreate(),
],
)
class Book implements ResourceInterface
{
 // ...
 #[Assert\NotBlank()]
private?string$title;
}

In this example, validation will fail when adding a new book without specifying its title on the form.

on API request

In this example, validation will fail when adding a new book without specifying its title on the payload.

Disable validation

In some case, you may want to disable this validation.

For example, in a "publish" operation, you may want to apply a state machine transition without validation existing data.

Last updated

Was this helpful?

Was this helpful?

src/Entity/Book.php
namespace App\Entity;
use App\Form\Type\BookType;
use Sylius\Resource\Metadata\Api\Post;
use Sylius\Resource\Model\ResourceInterface;
use Sylius\Resource\Metadata\AsResource;
use Symfony\Component\Validator\Constraints as Assert;
#[AsResource(
 operations: [
 new Post(),
 ],
)
class Book implements ResourceInterface
{
 // ...
 #[Assert\NotBlank()]
 private ?string $title;
}
src/BoardGameBlog/Infrastructure/Sylius/Resource/BoardGameResource.php
namespace App\BoardGameBlog\Infrastructure\Sylius\Resource;
use App\BoardGameBlog\Infrastructure\Sylius\State\Http\Processor\PublishBoardGameProcessor;
use App\BoardGameBlog\Infrastructure\Sylius\State\Http\Provider\BoardGameItemProvider;
use App\BoardGameBlog\Infrastructure\Symfony\Form\Type\BoardGameType;
use Sylius\Resource\Metadata\ApplyStateMachineTransition;
use Sylius\Resource\Model\ResourceInterface;
use Sylius\Resource\Metadata\AsResource;
use Sylius\Resource\Metadata\Create;
use Symfony\Component\Validator\Constraints as Assert;
#[AsResource(
 formType: BoardGameType::class, 
 operations: [
 new Update(
 provider: BoardGameItemProvider::class, 
 processor: PublishBoardGameProcessor::class,
 validate: false, // disable resource validation 
 ),
 ],
)
class BoardGameResource implements ResourceInterface
{
}