Sylius扩展模型字段自定义：移除原有字段并新增字段

Got it, let's walk through how to customize Sylius's Address model to remove existing fields (street, company) and add new ones (bldg no, subarea)—this is totally manageable once you understand how Sylius works with Doctrine ORM. Here's a step-by-step breakdown:

First, you need to override Sylius's default Address entity with your own. Create this file in src/Entity/Address.php:

namespace App\Entity;

use Sylius\Component\Core\Model\Address as BaseAddress;
use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
#[ORM\Table(name: 'sylius_address')]
class Address extends BaseAddress
{
    // Add your new fields first
    #[ORM\Column(name: 'bldg_no', type: 'string', length: 50, nullable: true)]
    private ?string $bldgNo = null;

    #[ORM\Column(name: 'subarea', type: 'string', length: 100, nullable: true)]
    private ?string $subarea = null;

    // Getters and setters for the new fields
    public function getBldgNo(): ?string
    {
        return $this->bldgNo;
    }

    public function setBldgNo(?string $bldgNo): void
    {
        $this->bldgNo = $bldgNo;
    }

    public function getSubarea(): ?string
    {
        return $this->subarea;
    }

    public function setSubarea(?string $subarea): void
    {
        $this->subarea = $subarea;
    }
}

Update your config/packages/sylius_addressing.yaml to point to your new Address model:

sylius_addressing:
    resources:
        address:
            classes:
                model: App\Entity\Address

You can't just delete these fields from your entity immediately—Doctrine will throw errors because it expects the database columns to exist. Follow these sub-steps safely:

Sub-step 3.1: Make the Columns Nullable (Temporary Migration) #

First, generate a blank migration to adjust the existing columns:

php bin/console make:migration

Open the generated file in src/Migrations/VersionXXXXXXXXX.php and add this line to the up() method:

public function up(Schema $schema): void
{
    // ... keep any auto-generated code, then add this
    $this->addSql('ALTER TABLE sylius_address CHANGE street street VARCHAR(255) DEFAULT NULL, CHANGE company company VARCHAR(255) DEFAULT NULL');
}

Run the migration to apply the change:

php bin/console doctrine:migrations:migrate

Sub-step 3.2: Exclude Fields from Entity Mapping #

Now, tell Doctrine not to persist the street and company fields anymore. Add these overrides to your App\Entity\Address class:

// ... existing code in Address.php

#[ORM\Transient]
protected ?string $street = null;

#[ORM\Transient]
protected ?string $company = null;

// ... rest of your code

The #[ORM\Transient] attribute tells Doctrine these properties shouldn't map to database columns.

Sub-step 3.3: Generate Migration to Drop the Columns #

Run the migration generator again to detect the removed fields:

php bin/console make:migration

Check the new migration file—it should include SQL to drop the columns:

public function up(Schema $schema): void
{
    // ...
    $this->addSql('ALTER TABLE sylius_address DROP COLUMN street, DROP COLUMN company');
}

Run the migration to finalize the removal:

php bin/console doctrine:migrations:migrate

Since you've modified the model, you need to update the form to match. Create a custom form type in src/Form/Type/AddressType.php:

namespace App\Form\Type;

use Sylius\Bundle\AddressingBundle\Form\Type\AddressType as BaseAddressType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

class AddressType extends BaseAddressType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        parent::buildForm($builder, $options);

        // Remove the old fields from the form
        $builder->remove('street');
        $builder->remove('company');

        // Add your new fields
        $builder
            ->add('bldgNo', TextType::class, [
                'label' => 'sylius.form.address.bldg_no',
                'required' => false,
            ])
            ->add('subarea', TextType::class, [
                'label' => 'sylius.form.address.subarea',
                'required' => false,
            ]);
    }

    public function getBlockPrefix(): string
    {
        return 'app_address';
    }
}

Update your sylius_addressing.yaml to use this form type:

sylius_addressing:
    resources:
        address:
            classes:
                model: App\Entity\Address
                form: App\Form\Type\AddressType

Add labels for your new fields in your translation files (e.g., translations/messages.en.yaml):

sylius:
    form:
        address:
            bldg_no: Building Number
            subarea: Subarea

Repeat this for any other locales you support.

• Always back up your database before running migrations—better safe than sorry!
• Clear your cache after making entity/configuration changes: php bin/console cache:clear
• If you're using MongoDB instead of MySQL, the migration steps will differ, but the core idea of overriding the model and adjusting mappings stays the same.

内容的提问来源于stack exchange，提问作者Naveen Kumar