PHPackages cds-uwb/nette-model-generator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. cds-uwb/nette-model-generator ActiveLibrary[Database & ORM](/categories/database) cds-uwb/nette-model-generator ============================= Database model generator for the Nette framework. v0.6.1(3w ago)0297↓82.7%[1 issues](https://github.com/CDS-UWB/nette-model-generator/issues)MITPHPPHP ^8.2 || ^8.3 || ^8.4CI passing Since Mar 11Pushed 3w agoCompare [ Source](https://github.com/CDS-UWB/nette-model-generator)[ Packagist](https://packagist.org/packages/cds-uwb/nette-model-generator)[ RSS](/packages/cds-uwb-nette-model-generator/feed)WikiDiscussions main Synced 3w ago READMEChangelog (10)Dependencies (32)Versions (21)Used By (0) [ ![](https://camo.githubusercontent.com/b004a33a75fe2a27a8432648d719202a59b2510855507e591e47f9d842158582/68747470733a2f2f6364732e7a63752e637a2f696d616765732f6c6f676f2e737667)](https://cds.zcu.cz) Nette Model Generator ===================== [](#nette-model-generator) [![Tests](https://github.com/CDS-UWB/nette-model-generator/actions/workflows/tests.yml/badge.svg)](https://github.com/CDS-UWB/nette-model-generator/actions/workflows/tests.yml) This project is a database model generator for the Nette Framework. It provides utilities to generate PHP classes for database tables, columns, and enums, following the PSR-4 standard. Features -------- [](#features) - Generate PHP classes for database tables, columns, and enums. - Follows PSR-4 autoloading standard. - Customizable namespace and root directory. Installation ------------ [](#installation) ``` composer require --dev cds-uwb/nette-model-generator ``` Usage ----- [](#usage) ### Generating models [](#generating-models) Use provided `bin/cds-model-generator` script to generate models from your database schema. ``` Usage: model-generator -d -H -D -U -P [optional options] Options: Required: -d, --driver Database driver (e.g., mysql, pgsql). -H, --host Database host. -D, --dbname Database name. -U, --user Database user. -P, --password Database password. -r, --root-dir Root directory for generated files. Optional: -p, --port Database port. -s, --schemas [pgsql only] Comma-separated list of schemas to include (optional). -i, --include-schema [pgsql only] Include schema name in generated class names and paths (optional). -e, --namespace Namespace for generated classes (default: App\\Model). -o, --omit-namespace-root Namespace part ignored when generating PSR-4 structure for model (optional). -v, --php-version Target PHP version for generated code (default: 84). Allowed values are: 82, 83, 84. -h, --help Display this help message.\n ``` Use `--php-version` when you need the generator to produce code compatible with an older runtime. Supported values are `82`, `83`, and `84`; the generator emits property hooks and constant types only when the target version supports them, otherwise it falls back to `@property-read` annotations. #### Generated Structure [](#generated-structure) The generator creates the following directory structure: ``` app/ ├── Model/ │ ├── Generated/ │ │ ├── Columns/ │ │ │ └── {TableName}.php │ │ ├── Rows/ │ │ │ └── {TableName}ActiveRowBase.php │ │ ├── Enums/ │ │ │ └── {EnumName}.php │ │ ├── Managers/ │ │ │ └── {TableName}ManagerBase.php │ │ ├── DatabaseConventions.php │ │ ├── Explorer.php │ │ └── Manager.php │ │ │ ├── Managers/ │ │ ├── ManagerBase.php (user file, all user managers extend this class) │ │ └── {TableName}Manager.php (user file) │ └── Rows/ │ └── {TableName}ActiveRow.php (user file) ``` #### Generated and User Files [](#generated-and-user-files) The generator distinguishes between two types of files: - **Generated files** (in `Generated/` directory): These are fully regenerated on each run and may be overwritten. - **User files** (in `Model/` directory): These are created **only if they don't already exist**. Once created, they won't be overwritten by subsequent generator runs, allowing you to customize them with your own logic. ### Nette DI configuration [](#nette-di-configuration) Register the Explorer and Managers to the DI container in Nette configuration: ``` services: database.default.explorer: App\Model\Generated\Explorer search: - in: %appDir%/Model classes: - *Manager database: # Not necessary, but this can prevent fails when fetching data from views without primary keys # that has not been cached yet. conventions: App\Model\Generated\DatabaseConventions ``` ### Usage in code [](#usage-in-code) #### Managers [](#managers) Managers provide methods for common database operations such as fetching, inserting, updating, and deleting records. See the table below for available methods: MethodDescription`query(string $sql, mixed ...$params): ResultSet`Executes a raw SQL query and returns the result set.`getTable(): Selection`Returns the table selection.`getAll(): Selection`Returns selection with all rows from the table.`find(mixed $primary): Selection`Returns selection for row by primary key value.`findWhere(string|array $where, mixed ...$params): Selection`Returns a selection of rows that match the given conditions.`get(mixed $primary): ?ActiveRow`Fetches a single row by primary key value.`getStrict(mixed $primary): ActiveRow`Fetches a single row by primary key value, throws exception if not found.`getWhere(string|array $where, mixed ...$params): ?ActiveRow`Fetches a single row that matches the given conditions.`getWhereStrict(string|array $where, mixed ...$params): ActiveRow`Fetches a single row that matches the given conditions, throws exception if not found.`exists(array|int|string $primary): bool`Checks if any row exists.`existsWhere(array $where): bool`Checks if any row exists that matches the given conditions.`getUnique(string $column, array $where = []): array`Fetches a list of unique values of a column from the table.`insert(array $data): ActiveRow|array|int`Inserts a single row into the table and returns the record.`insertMultiple(iterable $data): ActiveRow|array|int`Inserts multiple rows into the table and returns the first ActiveRow if table has primary key, or original input data if table doesn't have primary key.`update(mixed $primary, array $data): int`Updates a single row by primary key value.`updateWhere(string|array $where, iterable $data, mixed ...$params): int`Updates rows that match the given conditions.`updateAll(iterable $data): int`Updates all rows in the table.`delete(mixed $primary): int`Deletes a single row by primary key value.`deleteWhere(string|array $where, mixed ...$params): int`Deletes rows that match the given conditions.`deleteAll(): int`Deletes all rows in the table.`fetchPairs(string|\Closure|int|null $key = null, string|int|null $value = null): array`Fetches pairs of key and value from the table.`transaction(callable $function): mixed`Executes function in a transaction.`beginTransaction(): void`Begins a transaction.`commit(): void`Commits a transaction.`rollBack(): void`Rolls back a transaction.`getColumnNames(): array`Returns an array of column names in the table.``` use App\Model\Manager\YourTableManager; class YourService { public function __construct(protected YourTableManager $yourTableManager) { } public function doSomething(): void { $records = $this->yourTableManager->get(); // ... } } ``` ### Custom types [](#custom-types) Use `Cds\NetteModelGenerator\Data\CustomType` to override how database column types are mapped to generated properties. Pass your custom types through the reflection constructor when you build a `GeneratorContext` in your build script. `CustomType::phpType` supports PHPStan-compatible generic signatures (e.g. `ArrayObject`). The generator keeps the base type (without generics) for the getter and emits a `@var` annotation so static analyzers still see the full signature. ``` use ArrayObject; use DateTimeImmutable; use Cds\NetteModelGenerator\Data\CustomType; use Cds\NetteModelGenerator\Generators\ModelGenerator; use Cds\NetteModelGenerator\GeneratorContext; use Cds\NetteModelGenerator\Reflections\MySqlReflection; use Cds\NetteModelGenerator\Psr4FileManager; use Cds\NetteModelGenerator\FileWriter; use Nette\PhpGenerator\PsrPrinter; $customTypes = [ new CustomType( dbType: 'date', phpType: '\\' . ArrayObject::class . '', annotations: [ "custom comment\n", '@phpstan-ignore property.unusedType', ], castValueCallback: static fn (string $columnName): string => "\$data['" . $columnName . "'] !== null ? new \\ArrayObject([new \\DateTimeImmutable(\$data['" . $columnName . "']])) : null", ), ]; $context = new GeneratorContext( reflection: new MySqlReflection(connection: $connection, dbName: $dbName, customTypes: $customTypes), fileManager: new Psr4FileManager(rootDir: $rootDir, namespace: ['App', 'Model']), fileWriter: new FileWriter(), printer: new PsrPrinter(), ); (new ModelGenerator())->runDefault($context); // The generated base row keeps the getter signature and performs casting via constructor hooks: abstract class YourTableActiveRowBase extends ActiveRow { /** * custom comment * * @phpstan-ignore property.unusedType * @var \ArrayObject */ public \ArrayObject $yourColumnName { get => $this['your_column_name']; } /** * @param array $data */ public function __construct(array $data, Selection $selection) { $data = $this->castValues($data); parent::__construct($data, $selection); } /** * @param array $data */ private function castValues(array $data): array { $data['your_column_name'] = $data['your_column_name'] !== null ? new \ArrayObject([new \DateTimeImmutable($data['your_column_name'])]) : null; return $data; } } ``` ### Custom Explorer, Manager, and DatabaseConventions base classes [](#custom-explorer-manager-and-databaseconventions-base-classes) You can make generated classes extend existing base implementations by setting `managerClass`, `explorerClass`, `dbConventionsClass` in `GeneratorContext`. This is useful i.e. when you have a base library that provides common functionality with model generated using this tool and you need your application to extend it. - `managerClass`: generated `Manager` extends this class and skips generating CRUD methods. - `explorerClass`: generated `Explorer` extends this class. - `dbConventionsClass`: generated `DatabaseConventions` extends this class. ### Health Score 45 — FairBetter than 91% of packages Maintenance95 Actively maintained with recent releases Popularity15 Limited adoption so far Community8 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 98% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~4 days Recently: every ~15 days Total 20 Last Release 24d ago PHP version history (2 changes)v0.1.0PHP ^8.4 v0.5.0PHP ^8.2 || ^8.3 || ^8.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/4ff9ecec714558288e706225720ad1015776936ccbb8d85e1ab814e37e36e1f6?d=identicon)[cds](/maintainers/cds) --- Top Contributors [![fifal](https://avatars.githubusercontent.com/u/54062667?v=4)](https://github.com/fifal "fifal (48 commits)")[![NTSFka](https://avatars.githubusercontent.com/u/6008678?v=4)](https://github.com/NTSFka "NTSFka (1 commits)") ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/cds-uwb-nette-model-generator/health.svg) ``` [![Health](https://phpackages.com/badges/cds-uwb-nette-model-generator/health.svg)](https://phpackages.com/packages/cds-uwb-nette-model-generator) ``` ### Alternatives [tempest/framework The PHP framework that gets out of your way. 2.2k31.1k12](/packages/tempest-framework)[api-platform/schema-generator Various tools to generate a data model based on Schema.org vocables 4734.4M7](/packages/api-platform-schema-generator)[filament/support Core helper methods and foundation code for all Filament packages. 2328.3M217](/packages/filament-support)[contributte/nextras-orm-generator Nextras ORM Generator 20727.3k](/packages/contributte-nextras-orm-generator)[modul-is/orm Lightweight hybrid ORM/Explorer 1118.7k](/packages/modul-is-orm) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)