DisableORM Bundle

A Symfony + Doctrine bundle to allow disabling fields from being seen by DoctrineORM.

Why

This bundle will allow you to seamlessly update your application, assuming you have multiple versions running at the same time, with different database expectations.

While adding new entities is not an issue, as they're simply not present in the old application versions, this is not the case for entities being modified. You must either shut down all instances before running migrations which could cause differences in database schema expectations or... use this bundle.

With this, you're able to safely "remove" a field, so that the old version of the application can still use it before update, and the new one can ignore it.

As this modifies the ORM metadata the field is transparently removed from ORM and is not usable outside of raw SQL queries.

Install

Simply composer require dualmedia/disable-orm-bundle

Then add the bundle to your config/bundles.php file like so

return [
    Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
    // other bundles ...
    DualMedia\DisableORMBundle\DisableORMBundle::class => ['all' => true],
];

Setup

You must manually set the doctrine class metadata factory name value under your entity manager to use this bundle.

doctrine:
  orm:
    entity_managers:
      <manager_name>:
        class_metadata_factory_name: DualMedia\DisableORMBundle\Factory

Config

dm_disable_orm:
  # you can specify commands which should not be affected by DisableORM logic
  # defaults are below, you don't need to modify them unless you want to
  disable_on_commands:
    - 'doctrine:schema:validate'
    - 'doctrine:migrations:diff'

Usage

The #[DisableORM] attribute prevents doctrine from loading and creating the column from the database.

You should set a default value for the column before this, as otherwise you might get issues inserting new entities!

Use your entities as usual, when you decide you want to remove a field from it simply add #[DisableORM] on it, then update your application once.

From then, you can safely remove the field with a migration while not causing any downtime.

Example

#[ORM\Entity]
class FooEntity {
    #[ORM\Column]
    public int|null $normalField = null;

    #[DisableORM]
    #[ORM\Column(options: ['default' => false])]
    public int|null $someField = null;
    
    // ... getters and setters, etc.
}

PHPStan Rule

Simply add the following to your PHPStan config to enable a simple check for your entities (only applies if you're using PHP8 Attributes)

includes:
  - vendor/dualmedia/disable-orm-bundle/extension.neon

Git change detection

To prevent breaking your application on accident you may add the script in /scripts to your CI to automatically detect possibly incorrect removals of fields.

As when using this bundle it is expected, that a removed field WILL contain the DisableORM attribute, before being deleted, because of that, we can catch invalid field removals in the CI steps.

A Gitlab CI declaration is provided in the .gitlab-ci.job.yml file, simply include it and then extend it as required.