Wallogit.com
2017 © Pedro Peláez
Symfony 4 bundle for Atlas 3
This package makes the Atlas ORM and command-line tooling available as a bundle for Symfony 4 projects., (*1)
(Atlas is a data mapper for your persistence layer, not your domain layer.), (*2)
In your Symfony 4 project, enable contributor recipes:, (*3)
composer config extra.symfony.allow-contrib true
Require the atlas/symfony package; this will activate a Symfony Flex recipe
as part of the installation:, (*4)
composer require atlas/symfony ~1.0
Edit these new .env variables to define your database connection:, (*5)
ATLAS_PDO_DSN=mysql:host=myhost;dbname=mydatabase ATLAS_PDO_USERNAME=myusername ATLAS_PDO_PASSWORD=mypassword
Note:, (*6)
If you are using PHPStorm, you may wish to copy the IDE meta file to your project to get full autocompletion on Atlas classes:, (*7)
cp ./vendor/atlas/orm/resources/phpstorm.meta.php ./.phpstorm.meta.php
In the atlas.yaml config file, these settings are notable:, (*8)
atlas.orm.atlas.log_queries: set this to true to enable the web profiler
data collector for query logging., (*9)
atlas.orm.atlas.transaction_class: set this to one of the Atlas transaction
strategy classes, such as Atlas\\Orm\\Transaction\\AutoTransact. For more
information, see the
transactions documentation., (*10)
The options section under any connection configuration can be used to set
PDO attributes through the PDO constructor.
For example:, (*11)
dsn: '%env(resolve:ATLAS_PDO_DSN)%'
username: '%env(resolve:ATLAS_PDO_USERNAME)%'
password: '%env(resolve:ATLAS_PDO_PASSWORD)%'
options:
!php/const PDO::EMULATE_PREPARES: false
!php/const PDO::ATTR_CASE: !php/const PDO::CASE_NATURAL
Use the command-line tooling to create the skeleton files for all your database tables:, (*12)
mkdir src/DataSource php bin/console atlas:skeleton
The config/packages/atlas.yaml file specifies App\DataSource\ as the
namespace, and src/DataSource/ as the directory. To change them, modify the
atlas.cli.config.input values for directory and namespace as you see fit., (*13)
The database table names will be converted to singular for their relevant
type names in PHP. If you want a different type names for certain tables,
modify the atlas.cli.transform values in the atlas.yaml file to map a
from table name to a type name., (*14)
As you make changes to the database, re-run the skeleton generator, and the relevant table files will be regenerated., (*15)
For more information, see http://atlasphp.io/cassini/skeleton/., (*16)
Now that there are mappers for all the database tables, you can use the Symfony dependency injection system to autowire Atlas into your classes for you., (*17)
namespace App;
use Atlas\Orm\Atlas;
use App\DataSource\Thread\Thread
use App\DataSource\Thread\ThreadRecord;
class ApplicationService
{
public function __construct(Atlas $atlas)
{
$this->atlas = $atlas;
}
public function fetchThreadById($thread_id) : ThreadRecord
{
return $this->atlas->fetchRecord(Thread::class, $thread_id);
}
}
Full documentation for using Atlas is at http://atlasphp.io/cassini/orm/:, (*18)
Working with Records and RecordSets, (*21)
Managing transactions, (*22)
Adding behaviors, (*23)
Handling events, (*24)
Direct lower-level queries, (*25)
Other topics such as custom mapper methods, single table inheritance, many-to-many relationships, and automated validation, (*26)
Enjoy!, (*27)
Symfony 4 bundle for Atlas 3
MIT
Symfony 4 bundle for Atlas 3
MIT