add-model

Add a Model

Ask the user for the ModelName if not provided, the list of fields with their types, and any relations to other resources.

Where to place the files

Group by domain like Sylius-Standard (src/Entity/Product/, src/Entity/Customer/):

• Name starts with an existing resource ({Parent}Image, {Parent}Translation, …) → src/Entity/{Parent}/
• Otherwise → own folder src/Entity/{ModelName}/

1. Create the interface

src/Entity/{ModelName}/{ModelName}Interface.php:

<?php

declare(strict_types=1);

namespace App\Entity\{ModelName};

use Sylius\Resource\Model\ResourceInterface;

interface {ModelName}Interface extends ResourceInterface
{
    public function getId(): ?int;
    // declare the getter (and setter if mutable) for every field and relation added in step 2
}

2. Create the entity

src/Entity/{ModelName}/{ModelName}.php:

<?php

declare(strict_types=1);

namespace App\Entity\{ModelName};

use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
#[ORM\Table(name: 'app_{model_snake}')]
class {ModelName} implements {ModelName}Interface
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    protected ?int $id = null;

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

    // add your fields here
}

For fields that require validation, add Symfony constraints directly on the property:

use Symfony\Component\Validator\Constraints as Assert;

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

For relations to another resource in your app, always use the target's interface as targetEntity — Sylius's ResolveTargetEntityListener resolves it at runtime from the interface: key in the resource config. In forms, EntityType does not go through this listener — pass the concrete class or use /sylius-app:add-autocomplete.

ManyToOne — {ModelName} belongs to one {RelatedModel}:

#[ORM\ManyToOne(targetEntity: {RelatedModel}Interface::class)]
private ?{RelatedModel}Interface ${related_model} = null;