# magendoo/module-declarative-enum-support

> Lets Magento 2 declarative schema (setup:upgrade) read past MySQL ENUM/SET columns in third-party database tables instead of failing with 'Cannot process definition to array for type enum'.

`composer require magendoo/module-declarative-enum-support`

Canonical URL: https://packagento.com/magendoo/module-declarative-enum-support

## At a glance

- **Vendor**: magendoo (https://packagento.com/magendoo.md)
- **Latest version**: v1.0.0 — released 2026-07-18
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/magendoo/module-declarative-enum-support and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require magendoo/module-declarative-enum-support:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Lets Magento 2 declarative schema (setup:upgrade) read past MySQL ENUM/SET columns in third-party database tables instead of failing with 'Cannot process definition to array for type enum'.

## README

Lets `bin/magento setup:upgrade` succeed when the Magento database contains
third-party tables with MySQL `ENUM` or `SET` columns.

### The problem

Magento's declarative schema reads **every table in the database** — not just
the tables declared in `db_schema.xml` files. If any table contains an `ENUM`
or `SET` column, `setup:upgrade` aborts:

```
Upgrade failed: Cannot process definition to array for type enum
```

and, once past that, a second failure in the DTO layer:

```
Types enum is not declared
```

This bites any installation whose database is shared with other applications
(microservices, ETL pipelines, reporting tools) or contains tables left behind
by legacy extensions — Magento itself never creates `ENUM`/`SET` columns, but
it refuses to *read past* anyone else's.

### What this module does

It registers handlers for the `enum` and `set` column types in the two
declarative-schema registries that lack them:

| Registry | Class | Handler |
|---|---|---|
| `definitionProcessors` | `Magento\Framework\Setup\Declaration\Schema\Db\DefinitionAggregator` | Pass-through processor (`Model/EnumDefinition.php`) |
| `typeFactories` | `Magento\Framework\Setup\Declaration\Schema\Dto\ElementFactory` | Stock `Blob` DTO factory |

Tables that are not declared in any `db_schema.xml` are never diffed, so
declarative schema only needs to *parse* their columns without crashing — it
never generates DDL for them. Your third-party tables are read, ignored, and
left untouched.

Declaring an `ENUM` column **in** a `db_schema.xml` remains unsupported: the
pass-through processor throws a `LogicException` if declarative schema ever
tries to render one, so misuse fails loudly instead of producing broken DDL.

### Installation

#### Via composer (VCS repository)

```bash
composer config repositories.magendoo-declarative-enum-support vcs https://github.com/magendooro/magento2-declarative-enum-support
composer require magendoo/module-declarative-enum-support
bin/magento module:enable Magendoo_DeclarativeEnumSupport
bin/magento setup:upgrade
```

#### Via app/code

```bash
mkdir -p app/code/Magendoo
git clone https://github.com/magendooro/magento2-declarative-enum-support app/code/Magendoo/DeclarativeEnumSupport
bin/magento module:enable Magendoo_DeclarativeEnumSupport
bin/magento setup:upgrade
```

### Compatibility

- Magento Open Source / Adobe Commerce 2.4.x (tested on 2.4.9)
- PHP 8.1+

### Maintenance note (important)

A module's `di.xml` argument **replaces** — it does not merge with — the same
argument declared in the primary config `app/etc/di.xml`; primary and module
configs are combined per-argument, not per-array-item. This module therefore
ships **full copies** of the `typeFactories` and `definitionProcessors`
registries with `enum`/`set` appended.

After upgrading Magento, diff this module's `etc/di.xml` against your
`app/etc/di.xml`: if a new core release adds column types to either registry,
they must be re-synced here, otherwise the new types would be masked.

### License

[MIT](LICENSE)

## Recent Versions

| Version | Released |
|---|---|
| v1.0.0 | 2026-07-18 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=103.0.0 |
| php | >=8.1 |

## Quality

Latest release (v1.0.0) passes the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 |  |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["magendoo/module-declarative-enum-support"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

magendoo is a Magento 2 vendor on Packagento. See https://packagento.com/magendoo.md for their full catalogue.