{"id":876,"date":"2015-11-28T22:52:59","date_gmt":"2015-11-29T03:52:59","guid":{"rendered":"http:\/\/xfloyd.net\/blog\/?p=876"},"modified":"2015-11-29T00:36:43","modified_gmt":"2015-11-29T05:36:43","slug":"orm-cheatsheet","status":"publish","type":"post","link":"http:\/\/xfloyd.net\/blog\/?p=876","title":{"rendered":"ORM Cheatsheet"},"content":{"rendered":"
\n
\n
\n
\n
Entity<\/a><\/dd>\n
Id<\/a><\/dd>\n
Field<\/a><\/dd>\n
Indexes<\/a><\/dd>\n
Association<\/a><\/dd>\n
Many to Many<\/a><\/dd>\n
Inheritance<\/a><\/dd>\n
Doctrine extensions<\/a><\/dd>\n
Behaviors<\/a><\/dd>\n
Skipper<\/a><\/dd>\n
Links<\/a><\/dd>\n<\/dl>\n<\/div>\n<\/div>\n<\/div>\n

<\/p>\n

\n
\n

Doctrine2 Installation<\/h2>\n

<\/p>\n

Define the following requirement in your composer.json<\/code> file:<\/p>\n

{\r\n    \"require\"<\/span>: {\r\n        \"doctrine\/orm\"<\/span>: \"*\"<\/span>\r\n    }\r\n}\r\n<\/code><\/pre>\n
Doctrine2 configuration<\/h2>\n
Class loading<\/h3>\n
<\/p>\n
Autoloading is taken care of by Composer. You just have to include the composer autoload file in your project:<\/p>\n
<<\/span>?php\r\n\/\/ bootstrap.php<\/span>\r\n\/\/ Include Composer Autoload (relative to project root).<\/span>\r\nrequire_once \"vendor\/autoload.php\"<\/span>;\r\n<\/code><\/pre>\n
Entity Manager<\/h3>\n
<\/p>\n
Once you have prepared the class loading, you acquire an EntityManager instance. The EntityManager class is the primary access point to ORM functionality provided by Doctrine.<\/p>\n
<\/p>\n
<\/p>\n
<\/p>\n
\n
\n
\n
Annotations<\/a><\/dd>\n
XML<\/a><\/dd>\n
YML<\/a><\/dd>\n
More info<\/a><\/dd>\n
Links<\/a><\/dd>\n<\/dl>\n
\n
\n
<<\/span>?php\r\n\/\/ bootstrap.php<\/span>\r\nrequire_once \"vendor\/autoload.php\"<\/span>;\r\n\r\nuse Doctrine\\ORM\\Tools\\Setup;\r\nuse Doctrine\\ORM\\EntityManager;\r\n\r\n$paths =<\/span> array<\/span>(\"\/path\/to\/entity-files\"<\/span>);\r\n$isDevMode =<\/span> false<\/span>;\r\n\r\n\/\/ the connection configuration<\/span>\r\n$dbParams =<\/span> array<\/span>(\r\n    'driver'<\/span>   =<\/span>><\/span> 'pdo_mysql'<\/span>,\r\n    'user'<\/span>     =<\/span>><\/span> 'root'<\/span>,\r\n    'password'<\/span> =<\/span>><\/span> ''<\/span>,\r\n    'dbname'<\/span>   =<\/span>><\/span> 'foo'<\/span>,\r\n);\r\n\r\n$config =<\/span> Setup::createAnnotationMetadataConfiguration<\/span>($paths, $isDevMode);\r\n$entityManager =<\/span> EntityManager::create<\/span>($dbParams, $config);\r\n<\/code><\/pre>\n<\/div>\n
\n
<<\/span>?php\r\n$paths =<\/span> array<\/span>(\"\/path\/to\/xml-mappings\"<\/span>);\r\n$config =<\/span> Setup::createXMLMetadataConfiguration<\/span>($paths, $isDevMode);\r\n$entityManager =<\/span> EntityManager::create<\/span>($dbParams, $config);\r\n<\/code><\/pre>\n<\/div>\n
\n
<<\/span>?php\r\n$paths =<\/span> array<\/span>(\"\/path\/to\/yml-mappings\"<\/span>);\r\n$config =<\/span> Setup::createYAMLMetadataConfiguration<\/span>($paths, $isDevMode);\r\n$entityManager =<\/span> EntityManager::create<\/span>($dbParams, $config);\r\n<\/code><\/pre>\n<\/div>\n
\n
Inside the Setup<\/code> methods several assumptions are made:<\/p>\n
If $isDevMode<\/code> is true caching is done in memory with the ArrayCache. Proxy objects are recreated on every request.<\/p>\n
If $isDevMode<\/code> is false, check for Caches in the order APC, Xcache, Memcache (127.0.0.1:11211), Redis (127.0.0.1:6379) unless $cache<\/code> is passed as fourth argument.<\/p>\n
If $isDevMode<\/code> is false, set then proxy classes have to be explicitly created through the command line.<\/p>\n
If third argument $proxyDir<\/code> is not set, use the systems temporary directory.<\/p>\n<\/div>\n
\n
Doctrine2 documentation<\/a><\/p>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\"Doctrine<\/a><\/p>\n
Generated by Skipper<\/a><\/p>\n<\/div>\n<\/div>\n<\/div>\n
Command line tool<\/h3>\n
You need to register your applications EntityManager to the console tool to make use of the tasks by creating a cli-config.php<\/code> file with the following content:<\/p>\n
\n
\n
\n
version 2.4 and newer<\/a><\/dd>\n
version 2.3 and older<\/a><\/dd>\n<\/dl>\n
\n
\n
<<\/span>?php\r\nuse Doctrine\\ORM\\Tools\\Console\\ConsoleRunner;\r\n\r\n\/\/ replace with file to your own project bootstrap<\/span>\r\nrequire_once 'bootstrap.php'<\/span>;\r\n\r\n\/\/ replace with mechanism to retrieve EntityManager in your app<\/span>\r\n$entityManager =<\/span> GetEntityManager<\/span>();\r\n\r\nreturn<\/span> ConsoleRunner::createHelperSet<\/span>($entityManager);\r\n<\/code><\/pre>\n<\/div>\n
\n
<<\/span>?php\r\n\/\/ cli-config.php<\/span>\r\nrequire_once 'my_bootstrap.php'<\/span>;\r\n\r\n\/\/ Any way to access the EntityManager from  your application<\/span>\r\n$em =<\/span> GetMyEntityManager<\/span>();\r\n\r\n$helperSet =<\/span> new<\/span> \\Symfony\\Component\\Console\\Helper\\HelperSet<\/span>(array<\/span>(\r\n    'db'<\/span> =<\/span>><\/span> new<\/span> \\Doctrine\\DBAL\\Tools\\Console\\Helper\\ConnectionHelper<\/span>($em-<\/span>><\/span>getConnection<\/span>()),\r\n    'em'<\/span> =<\/span>><\/span> new<\/span> \\Doctrine\\ORM\\Tools\\Console\\Helper\\EntityManagerHelper<\/span>($em)\r\n));\r\n<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
Doctrine2 basic use<\/h2>\n
Generating Doctrine2 model from database<\/h3>\n
<\/p>\n
$ php doctrine orm:convert-mapping --from-database yml \/path\/to\/mapping-path-converted-to-yml\r\n<\/code><\/pre>\n
For more details check the documentation<\/a>.<\/p>\n
Creating database tables from Doctrine2 model<\/h3>\n
<\/p>\n
Generate the database schema:<\/p>\n
$ php doctrine orm:schema-tool:create\r\n\r\n<\/code><\/pre>\n
Update the database schema:<\/p>\n
$ php doctrine orm:schema-tool:update\r\n<\/code><\/pre>\n
For more details check the documentation<\/a>.<\/p>\n
Using Doctrine2 with Symfony2<\/h2>\n
Installation<\/h3>\n
<\/p>\n
Add required bundles to composer.json<\/code>:<\/p>\n
    \"require\"<\/span>: {\r\n        ....\r\n        ....\r\n        \"doctrine\/orm\"<\/span>: \"*\"<\/span>,\r\n        \"doctrine\/doctrine-bundle\"<\/span>: \"*\"<\/span>,\r\n    },\r\n<\/code><\/pre>\n
And enable the bundles in the Kernel:<\/p>\n
class<\/span> AppKernel extends<\/span> Kernel\r\n{\r\n    public<\/span> function<\/span> registerBundles<\/span>()\r\n    {\r\n        $bundles =<\/span> array<\/span>(\r\n            .......\r\n            new<\/span> Doctrine\\Bundle\\DoctrineBundle\\DoctrineBundle<\/span>(),\r\n        );\r\n\r\n        .....\r\n\r\n        return<\/span> $bundles;\r\n    }\r\n}\r\n<\/code><\/pre>\n
Configuration<\/h3>\n
<\/p>\n
Configure app\/config\/config.yml<\/code> and add Doctrine section:<\/p>\n
doctrine:\r\n    dbal:\r\n        driver:   %database_driver%\r\n        host:     %database_host%\r\n        port:     %database_port%\r\n        dbname:   %database_name%\r\n        user:     %database_user%\r\n        password: %database_password%\r\n        charset:  UTF8\r\n\r\n    orm:\r\n        auto_generate_proxy_classes: %kernel.debug%\r\n        auto_mapping: true<\/span>\r\n<\/code><\/pre>\n
Configure app\/config\/parameters.yml<\/code> and set database connection parameters:<\/p>\n
parameters:\r\n    database_driver:   pdo_mysql\r\n    database_host:     127.0<\/span>.0.1<\/span>\r\n    database_port:     ~\r\n    database_name:     symfony\r\n    database_user:     UsernameHere\r\n    database_password: PasswordHere\r\n<\/code><\/pre>\n
Configure your schema<\/h3>\n
<\/p>\n
You can use annotations for schema definition. Entities can be stored at src\\Acme\\SampleBundle\\Entity\\User.php<\/code>:<\/p>\n
<<\/span>?php\r\nnamespace Acme\\SampleBundle\\Entity;\r\nuse Doctrine\\ORM\\Mapping AS<\/span> ORM;\r\n\r\n\/** \r\n * @ORM\\Entity\r\n * @ORM\\Table(name=\"acme_user\")\r\n *\/<\/span>\r\nclass<\/span> Event\r\n{\r\n    \/** \r\n     * @ORM\\Id\r\n     * @ORM\\Column(type=\"integer\")\r\n     * @ORM\\GeneratedValue(strategy=\"AUTO\")\r\n     *\/<\/span>\r\n    private<\/span> $id;\r\n\r\n    \/** \r\n     * @ORM\\Column(type=\"string\", unique=true, length=64, nullable=false)\r\n     *\/<\/span>\r\n    private<\/span> $name;\r\n}\r\n<\/code><\/pre>\n
Getters and setters can be generated simply by running:<\/p>\n
php app\/console doctrine:generate:entities Acme\r\n<\/code><\/pre>\n
Using Doctrine2 with Symfony1.4<\/h2>\n
Installation<\/h3>\n
<\/p>\n
First we need to install the plugin from SVN with the following command from the root of your project:<\/p>\n
$ svn co http:\/\/svn.symfony-project.org\/plugins\/sfDoctrinePlugin\/branches\/1.3-2.0\/ plugins\/sfDoctrine2Plugin\r\n<\/code><\/pre>\n
Now you just need to enable the plugin:<\/p>\n
class<\/span> ProjectConfiguration extends<\/span> sfProjectConfiguration\r\n{\r\n  public<\/span> function<\/span> setup<\/span>()\r\n  {\r\n    $this<\/span>-<\/span>><\/span>enablePlugins<\/span>('sfDoctrine2Plugin'<\/span>);\r\n  }\r\n}\r\n<\/code><\/pre>\n
Configuration<\/h3>\n
<\/p>\n
Configure config\/databases.yml<\/code> for database connection:<\/p>\n
all:\r\n  doctrine:\r\n    class<\/span>: sfDoctrineDatabase\r\n    param:\r\n      options:\r\n        driver: pdo_mysql\r\n        user: root\r\n        password:\r\n        dbname: doctrine\r\n<\/code><\/pre>\n
Configure Your Schema<\/h4>\n
Below is an example of a simple User entity:<\/p>\n
# config\/doctrine\/schema.yml<\/span>\r\n \r\nModels\\User:\r\n  type: entity\r\n  table: user\r\n  id:\r\n    id:\r\n      type: integer<\/span>\r\n      generator:\r\n        strategy: AUTO\r\n  fields:\r\n    username:\r\n      type: string<\/span>\r\n      length: 255<\/span>\r\n    password:\r\n      type: string<\/span>\r\n      length: 255<\/span>\r\n<\/code><\/pre>\n
Basic use<\/h3>\n
<\/p>\n
Writing Data Fixtures<\/h4>\n
The times of using YAML for data fixtures is no longer. Instead, you are only required to use plain PHP for loading your data fixtures.<\/p>\n
\/\/ data\/fixtures\/fixtures.php\r\n \r\n$em = $this->getEntityManager();\r\n \r\n$admin = new \\Models\\User();\r\n$admin->username = 'admin';\r\n$admin->password = 'changeme';\r\n<\/code><\/pre>\n
Building Doctrine<\/h4>\n
Now you\u2019re ready to build everything. The following command will build models, forms, filters, database and load data fixtures.<\/p>\n
$ php symfony doctrine:build --all --and-load\r\n<\/code><\/pre>\n
Updating Schema<\/h4>\n
If you change your schema mapping information and want to update the database you can easily do so by running the following command after changing your mapping information.<\/p>\n
$ php symfony doctrine:build --all-classes --and-update-schema\r\n<\/code><\/pre>\n
Using Doctrine2 with Zend Framework 2<\/h2>\n
Installation<\/h3>\n
<\/p>\n
php composer.phar require doctrine\/doctrine-orm-module:0.7.*\r\n<\/code><\/pre>\n
php composer.phar require zendframework\/zend-developer-tools:dev-master\r\n<\/code><\/pre>\n
cp vendor\/zendframework\/zend-developer-tools\/config\/zenddevelopertools.local.php.dist config\/autoload\/zdt.local.php\r\n<\/code><\/pre>\n
Enable the modules in config\/application.config.php<\/code>:<\/p>\n
return<\/span> array<\/span>(\r\n    'modules'<\/span> =<\/span>><\/span> array<\/span>(\r\n        'ZendDeveloperTools'<\/span>,\r\n        'DoctrineModule'<\/span>,\r\n        'DoctrineORMModule'<\/span>,\r\n        'Application'<\/span>,\r\n    ),\r\n    \/\/ [...]<\/span>\r\n);\r\n<\/code><\/pre>\n
Doctrine2 Model Elements<\/h1>\n
Schema file structure<\/h2>\n
<\/p>\n
Doctrine2 uses one *.dcm.xml<\/code> schema file for each entity. The file is structured like this:<\/p>\n
<\/p>\n
<\/p>\n
<\/p>\n
\n
\n
\n
Annotations<\/a><\/dd>\n
XML<\/a><\/dd>\n
YML<\/a><\/dd>\n
Links<\/a><\/dd>\n<\/dl>\n
\n
\n
<<\/span>?php\r\nuse Doctrine\\ORM\\Mapping AS<\/span> ORM;\r\n\r\n\/** \r\n * @ORM\\Entity(repositoryClass=\"Doctrine\\ORM\\EntityRepository\")\r\n * @ORM\\Table\r\n *\/<\/span>\r\nclass<\/span> itemRecord\r\n{\r\n    \/** \r\n     * @ORM\\Id\r\n     *\/<\/span>\r\n    private<\/span> $id;\r\n\r\n    \/** \r\n     * @ORM\\Column\r\n     *\/<\/span>\r\n    private<\/span> $name;\r\n<\/code><\/pre>\n<\/div>\n
\n
<<\/span>?xml version=<\/span>\"1.0\"<\/span>?><\/span>\r\n<<\/span>doctrine-<\/span>mapping \r\nxmlns=<\/span>\"http:\/\/doctrine-project.org\/schemas\/orm\/doctrine-mapping\"<\/span> \r\nxsi=<\/span>\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"<\/span> \r\nschemaLocation=<\/span>\"http:\/\/doctrine-project.org\/schemas\/orm\/doctrine-mapping.xsd\"<\/span>><\/span>\r\n\r\n  <<\/span>entity name=<\/span>\"itemRecord\"<\/span>\/><\/span>\r\n\r\n<<\/span>\/doctrine-<\/span>mapping><\/span>\r\n<\/code><\/pre>\n<\/div>\n
\n
itemRecord:\r\n  type: entity\r\n  fields:\r\n  indexes:\r\n  oneToOne:\r\n  oneToMany:\r\n  manyToOne:\r\n  manyToMany:\r\n  discriminatorColumn:\r\n  discriminatorMap:\r\n<\/code><\/pre>\n<\/div>\n
\n
For more details check the documentation<\/a>.<\/p>\n
For more details check the documentation<\/a>.<\/p>\n
Then call composer install<\/code> from your command line. For more details consult Doctrine2 documentation<\/a> or Composer documentation<\/a>.<\/p>\n