Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fix README

  • Loading branch information...
commit 01b37d7308a2e7c5fa2165d3306544b3d1f0e48c 1 parent 6f543a7
@golovanov authored
Showing with 63 additions and 3 deletions.
  1. +63 −3 README.md
View
66 README.md
@@ -5,8 +5,68 @@ Doctrine OXM is a PHP 5.3 project for PHP object to XML mapping that provides su
## Instaliation
-### Register annotations.
+To use the OXM, you'll need OXM library provided by Doctrine and one bundle that integrates them into Symfony.
+If you're using the Symfony Standard Distribution, add the following to the deps file at the root of your project:
-```php
-AnnotationRegistry::registerFile(__DIR__.'/../vendor/doctrine-oxm/lib/Doctrine/OXM/Mapping/Driver/DoctrineAnnotations.php');
+```
+[doctrine-oxm]
+ git=http://github.com/doctrine/oxm.git
+ target=/doctrine-oxm
+
+[DoctrineOXMBundle]
+ git=http://github.com/golovanov/DoctrineOXMBundle.git
+ target=/bundles/Doctrine/Bundle/OXMBundle
+
+```
+
+Now, update the vendor libraries by running:
+
+```
+$ php bin/vendors install
+```
+
+Next, add the Doctrine\OXM and Doctrine\Bundle\OXMBundle namespaces to the app/autoload.php file so that these libraries can be autoloaded.
+Be sure to add them anywhere above the Doctrine namespace (shown here):
+
+```
+// app/autoload.php
+$loader->registerNamespaces(array(
+ // ...
+ 'Doctrine\\OXM' => __DIR__.'/../vendor/doctrine-oxm/lib',
+ 'Doctrine\\Bundle' => __DIR__.'/../vendor/bundles',
+ // ...
+));
+```
+
+Finally, enable the new bundle in the kernel:
+
+```
+// app/AppKernel.php
+public function registerBundles()
+{
+ $bundles = array(
+ // ...
+ new Doctrine\Bundle\OXMBundle\DoctrineOXMBundle(),
+ );
+
+ // ...
+}
+```
+Congratulations! You're ready to get to work.
+
+## Configuration
+
+To get started, you'll need some basic configuration that sets up the document manager.
+The easiest way is to enable auto_mapping, which will activate the OXM across your application:
+
+```
+# app/config/config.yml
+doctrine_oxm:
+ storages:
+ default:
+ path: "%kernel.root_dir%/doctrine-oxm-storage"
+
+ xml_entity_managers:
+ default:
+ auto_mapping: true
```
Please sign in to comment.
Something went wrong with that request. Please try again.