bundles section updated for 2.5

Author: petk

bundles/DoctrineFixturesBundle/index.rst

@@ -20,15 +20,15 @@ Standard edition. Add the following to your ``composer.json`` file:
 
     {
         "require": {
-            "doctrine/doctrine-fixtures-bundle": "dev-master"
+            "doctrine/doctrine-fixtures-bundle": "2.2.*"
         }
     }
 
 Update the vendor libraries:
 
 .. code-block:: bash
 
-    $ php composer.phar update
+    $ php composer.phar update doctrine/doctrine-fixtures-bundle
 
 If everything worked, the ``DoctrineFixturesBundle`` can now be found
 at ``vendor/doctrine/doctrine-fixtures-bundle``.

bundles/DoctrineMigrationsBundle/index.rst

@@ -23,6 +23,7 @@ Standard edition. Add the following to your ``composer.json`` file:
 
     {
         "require": {
+            "doctrine/migrations": "dev-master",
             "doctrine/doctrine-migrations-bundle": "dev-master"
         }
     }
@@ -55,6 +56,20 @@ following:
             new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle(),
         );
     }
+    
+Configuration
+-------------
+
+You can configure the path, namespace, table_name and name in your `config.yml`. The examples below are the default values.
+
+.. code-block:: yaml
+
+    // app/config/config.yml
+    doctrine_migrations:
+        dir_name: %kernel.root_dir%/DoctrineMigrations
+        namespace: Application\Migrations
+        table_name: migration_versions
+        name: Application Migrations   
 
 Usage
 -----
@@ -126,7 +141,7 @@ migration to execute:
 
 .. code-block:: bash
 
-    php app/console doctrine:migrations:status
+    php app/console doctrine:migrations:status --show-versions
 
      == Configuration
 
@@ -150,7 +165,7 @@ finally migrate when you're ready:
 
 .. code-block:: bash
 
-    php app/console doctrine:migrations:migrate
+    php app/console doctrine:migrations:migrate 20100621140655
 
 For more information on how to write the migrations themselves (i.e. how to
 fill in the ``up()`` and ``down()`` methods), see the official Doctrine Migrations
@@ -287,7 +302,9 @@ to get full access to the container.
 .. code-block:: php
 
     // ...
-    
+    use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+    use Symfony\Component\DependencyInjection\ContainerInterface;
+
     class Version20130326212938 extends AbstractMigration implements ContainerAwareInterface
     {
     

bundles/DoctrineMongoDBBundle/config.rst

@@ -101,7 +101,7 @@ Explicit definition of all the mapped documents is the only necessary
 configuration for the ODM and there are several configuration options that you
 can control. The following configuration options exist for a mapping:
 
-- ``type`` One of ``annotations``, ``xml``, ``yml``, ``php`` or ``staticphp``.
+- ``type`` One of ``annotation``, ``xml``, ``yml``, ``php`` or ``staticphp``.
   This specifies which type of metadata type your mapping uses.
 
 - ``dir`` Path to the mapping or entity files (depending on the driver). If
@@ -164,23 +164,65 @@ The following configuration shows a bunch of mapping examples:
 Filters
 ~~~~~~~
 
-You can easily add filters to a document manager by using the
-following syntax:
+Filter classes may be used in order to add criteria to ODM queries, regardless
+of where those queries are created within your application. Typically, filters
+will limit themselves to operating on a particular class or interface. Filters
+may also take parameters, which can be used to customize the injected query
+criteria.
 
-.. code-block:: yaml
+Filters may be registered with a document manager by using the following syntax:
 
-    doctrine_mongodb:
-        document_managers:
-            default:
-                filters:
-                    filter-one:
-                        class: Class\ExampleOne\Filter\ODM\ExampleFilter
-                        enabled: true
-                    filter-two:
-                        class: Class\ExampleTwo\Filter\ODM\ExampleFilter
-                        enabled: false
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        doctrine_mongodb:
+            document_managers:
+                default:
+                    filters:
+                        basic_filter:
+                            class: Vendor\Filter\BasicFilter
+                            enabled: true
+                        complex_filter:
+                            class: Vendor\Filter\ComplexFilter
+                            enabled: false
+                            parameters:
+                                author: bob
+                                comments: { $gte: 10 }
+                                tags: { $in: [ 'foo', 'bar' ] }
+
+    .. code-block:: xml
+
+        <?xml version="1.0" ?>
+
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xmlns:doctrine="http://symfony.com/schema/dic/doctrine/odm/mongodb"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                                http://symfony.com/schema/dic/doctrine/odm/mongodb http://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">
+
+            <doctrine:mongodb>
+                <doctrine:connection id="default" server="mongodb://localhost:27017" />
+
+                <doctrine:document-manager id="default" connection="default">
+                    <doctrine:filter name="basic_filter" enabled="true" class="Vendor\Filter\BasicFilter" />
+                    <doctrine:filter name="complex_filter" enabled="true" class="Vendor\Filter\ComplexFilter">
+                        <doctrine:parameter name="author">bob</doctrine:parameter>
+                        <doctrine:parameter name="comments">{ "$gte": 10 }</doctrine:parameter>
+                        <doctrine:parameter name="tags">{ "$in": [ "foo", "bar" ] }</doctrine:parameter>
+                    </doctrine:filter>
+                </doctrine:document-manager>
+            </doctrine:mongodb>
+        </container>
+
+.. note::
 
-Filters are used to append conditions to the queryBuilder regardless of where the query is generated.
+    Unlike ORM, query parameters in MongoDB ODM may be non-scalar values. Since
+    such values are difficult to express in XML, the bundle allows JSON strings
+    to be used in ``parameter`` tags. While processing the configuration, the
+    bundle will run the tag contents through ``json_decode()`` if the string is
+    wrapped in square brackets or curly braces for arrays and objects,
+    respectively.
 
 Multiple Connections
 ~~~~~~~~~~~~~~~~~~~~
@@ -335,6 +377,7 @@ Full Default Configuration
                         replicaSet:           ~
                         username:             ~
                         password:             ~
+                        db:                   ~
             proxy_namespace:      MongoDBODMProxies
             proxy_dir:            %kernel.cache_dir%/doctrine/odm/mongodb/Proxies
             auto_generate_proxy_classes:  false

bundles/DoctrineMongoDBBundle/form.rst

@@ -89,12 +89,12 @@ Next, create the form for the ``User`` model::
 
     use Symfony\Component\Form\AbstractType;
     use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
-    use Symfony\Component\Form\FormBuilder;
+    use Symfony\Component\Form\FormBuilderInterface;
     use Symfony\Component\OptionsResolver\OptionsResolverInterface;
 
     class UserType extends AbstractType
     {
-        public function buildForm(FormBuilder $builder, array $options)
+        public function buildForm(FormBuilderInterface $builder, array $options)
         {
             $builder->add('email', 'email');
             $builder->add('password', 'repeated', array(
@@ -185,11 +185,11 @@ Next, create the form for this ``Registration`` model::
 
     use Symfony\Component\Form\AbstractType;
     use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
-    use Symfony\Component\Form\FormBuilder;
+    use Symfony\Component\Form\FormBuilderInterface;
 
     class RegistrationType extends AbstractType
     {
-        public function buildForm(FormBuilder $builder, array $options)
+        public function buildForm(FormBuilderInterface $builder, array $options)
         {
             $builder->add('user', new UserType());
             $builder->add('terms', 'checkbox', array('property_path' => 'termsAccepted'));

bundles/DoctrineMongoDBBundle/index.rst

@@ -50,12 +50,12 @@ The ``@dev`` definition is necessary until non-beta versions of the bundle and
 ODM are available. Depending on your project needs, other version strings may
 be used, which are discussed in Composer's `schema documentation`_.
 
-You can now can install the new dependencies by running Composer's ``update``
+You can now install the new dependencies by running Composer's ``update``
 command from the directory where your ``composer.json`` file is located:
 
 .. code-block :: bash
 
-    php composer.phar update
+    php composer.phar update doctrine/mongodb-odm doctrine/mongodb-odm-bundle
 
 Now, Composer will automatically download all required files, and install them
 for you.
@@ -389,7 +389,7 @@ to easily fetch objects based on multiple conditions::
     // query for one product matching be name and price
     $product = $repository->findOneBy(array('name' => 'foo', 'price' => 19.99));
 
-    // query for all prdocuts matching the name, ordered by price
+    // query for all products matching the name, ordered by price
     $product = $repository->findBy(
         array('name' => 'foo'),
         array('price', 'ASC')
@@ -689,7 +689,7 @@ and then :ref:`tagging<book-service-container-tags>` it with a specific tag.
             <service id="my_doctrine_listener" class="Acme\HelloBundle\Listener\MyDoctrineListener">
                 <!-- ... -->
                 <tag name="doctrine_mongodb.odm.event_listener" event="postPersist" />
-            </service>.
+            </service>
 
         .. code-block:: php
 
@@ -738,6 +738,17 @@ same than the `entity` provider described in :doc:`the cookbook</cookbook/securi
             </provider>
         </config>
 
+Validation
+----------
+
+This bundle provides a ``Unique`` constraint, which extends the `UniqueEntity`_
+constraint provided by Symfony's Doctrine bridge. This constraint allows you to
+validate the uniqueness of an document field against the database.
+
+The ``Unique`` constraint shares the same options as `UniqueEntity`_, which
+means that the ``em`` option should be used if you wish to specify the document
+manager explicitly instead of having it be inferred from the document class.
+
 Using the Abstraction Layer
 ---------------------------
 
@@ -785,10 +796,11 @@ Learn more from the Cookbook
 .. _`documentation`:    http://docs.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/
 .. _`schema documentation`: http://getcomposer.org/doc/04-schema.md#minimum-stability
 .. _`Quick Start`:      http://www.mongodb.org/display/DOCS/Quickstart
-.. _`Basic Mapping Documentation`: http://www.doctrine-project.org/docs/mongodb_odm/1.0/en/reference/basic-mapping.html
+.. _`Basic Mapping Documentation`: http://docs.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/reference/basic-mapping.html
 .. _`MongoDB type`: http://us.php.net/manual/en/mongo.types.php
 .. _`Mapping Types Documentation`: http://docs.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/reference/basic-mapping.html#doctrine-mapping-types
 .. _`Query Builder`: http://www.doctrine-project.org/docs/mongodb_odm/1.0/en/reference/query-builder-api.html
 .. _`Conditional Operators`: http://www.doctrine-project.org/docs/mongodb_odm/1.0/en/reference/query-builder-api.html#conditional-operators
 .. _`Event Documentation`: http://www.doctrine-project.org/docs/mongodb_odm/1.0/en/reference/events.html
 .. _`PHP Documentation`: http://www.php.net/manual/en/mongo.tutorial.php
+.. _`UniqueEntity`: http://symfony.com/doc/current/reference/constraints/UniqueEntity.html

bundles/SensioFrameworkExtraBundle/annotations/cache.rst

@@ -1,24 +1,28 @@
 @Cache
 ======
 
-Usage
------
+The ``@Cache`` annotation makes it easy to define HTTP caching headers for
+expiration and validation.
+
+HTTP Expiration Strategies
+--------------------------
 
 The ``@Cache`` annotation makes it easy to define HTTP caching::
 
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
 
     /**
-     * @Cache(expires="tomorrow", public="true")
+     * @Cache(expires="tomorrow", public=true)
      */
     public function indexAction()
     {
     }
 
-You can also use the annotation on a class to define caching for all methods::
+You can also use the annotation on a class to define caching for all actions
+of a controller::
 
     /**
-     * @Cache(expires="tomorrow", public="true")
+     * @Cache(expires="tomorrow", public=true)
      */
     class BlogController extends Controller
     {
@@ -40,22 +44,63 @@ configuration, the latter overrides the former::
         }
     }
 
-Attributes
-----------
+.. note::
 
-Here is a list of accepted attributes and their HTTP header equivalent:
+   The ``expires`` attribute takes any valid date understood by the PHP
+   ``strtotime()`` function.
+
+HTTP Validation Strategies
+--------------------------
+
+The ``lastModified`` and ``ETag`` attributes manages the HTTP validation cache
+headers. ``lastModified`` adds a ``Last-Modified`` header to Responses and
+``ETag`` adds an ``ETag`` header.
+
+Both automatically trigger the logic to return a 304 response when the
+response is not modified (in this case, the controller is **not** called)::
+
+    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
+
+    /**
+     * @Cache(lastModified="post.getUpdatedAt()", ETag="'Post' ~ post.getId() ~ post.getUpdatedAt()")
+     */
+    public function indexAction(Post $post)
+    {
+        // your code
+        // won't be called in case of a 304
+    }
+
+It's roughly doing the same as the following code::
+
+    public function myAction(Request $request, Post $post)
+    {
+        $response = new Response();
+        $response->setLastModified($post->getUpdatedAt());
+        if ($response->isNotModified($request)) {
+            return $response;
+        }
 
-============================== ===============
-Annotation                     Response Method
-============================== ===============
-``@Cache(expires="tomorrow")`` ``$response->setExpires()``
-``@Cache(smaxage="15")``       ``$response->setSharedMaxAge()``
-``@Cache(maxage="15")``        ``$response->setMaxAge()``
-``@Cache(vary=["Cookie"])``    ``$response->setVary()``
-``@Cache(public="true")``      ``$response->setPublic()``
-============================== ===============
+        // your code
+    }
 
 .. note::
 
-   The ``expires`` attribute takes any valid date understood by the PHP
-   ``strtotime()`` function.
+    The ETag HTTP header value is the result of the expression hashed with the
+    ``sha256`` algorithm.
+
+Attributes
+----------
+
+Here is a list of accepted attributes and their HTTP header equivalent:
+
+===================================================== ================================
+Annotation                                            Response Method
+===================================================== ================================
+``@Cache(expires="tomorrow")``                        ``$response->setExpires()``
+``@Cache(smaxage="15")``                              ``$response->setSharedMaxAge()``
+``@Cache(maxage="15")``                               ``$response->setMaxAge()``
+``@Cache(vary={"Cookie"})``                           ``$response->setVary()``
+``@Cache(public=true)``                               ``$response->setPublic()``
+``@Cache(lastModified="post.getUpdatedAt()")``        ``$response->setLastModified()``
+``@Cache(ETag="post.getId() ~ post.getUpdatedAt()")`` ``$response->setETag()``
+===================================================== ================================