szykra / resource-naming-strategy
Resource Naming Strategy for Doctrine ORM
Installs: 20 264
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- doctrine/orm: ~2.3
- icanboogie/inflector: ~1.3.0|~2.0.0
Requires (Dev)
- phpspec/phpspec: ~2.0
README
Resource Naming Strategy for Doctrine ORM
Why Resource?
This naming strategy following the natural way of thinking about entities and resources. Imagine that you have one Flower. It's single entity. You want to store some data about flowers e.g. in your database. It's resource.
Simple? I know resource named flower sounds easier but sometimes it's more confusing. In the end, you have a lot of flowers, not one.
This strategy is similar to the Laravel naming convention (See mapping section).
Requirements
This package uses icanboogie/inflector
and it requires a mbstring php extension.
Instalation
Install via composer
Add dependecy to your composer.json
file and run composer update
.
"require": { "szykra/resource-naming-strategy": "~0.1" }
Usage
Usage with Doctrine
$namingStrategy = new \Szykra\NamingStrategy\ResourceNamingStrategy(); $configuration()->setNamingStrategy($namingStrategy);
Usage with Symfony
You have a two ways to use this naming strategy
Register bundle in AppKernel.php
Just open your AppKernel.php
file and register new symfony bundle which contains a service definition.
$bundles = array( ... new Szykra\NamingStrategy\ResourceNamingBundle\ResourceNamingBundle() );
Now you can configure Doctrine in config.yml
to use new naming strategy.
doctrine: orm: naming_strategy: szykra.naming_strategy.resource_naming_strategy
Define your own service
If you don't want to register additional bundles you can create own service definiton in services.yml
:
services: app.naming_strategy.resource: class: Szykra\NamingStrategy\ResourceNamingStrategy
And don't forget to configure Doctrine to use this service.
Mapping
Entity to table name
Lowercase and plural
Property to column name
Lowercase letters and words separated by the underscore
Embedded field to column name
Lowercase letters and words separated by the underscore
Join column name
Lowercase letters and words separated by the underscore with _id suffix
Join table name
Two singular lowercase entity names in ascending order with words separated by the underscore
License
The MIT License. Copyright © 2015 - 2020 Szymon Krajewski.