Mark repository managers private (#1662)

* Mark repository managers private

* Type hint against interface

* Update PersistenceRepositoryTest

* Fixed typo

* Update changelog

Author: XWB

CHANGELOG-6.0.md

@@ -43,3 +43,4 @@ in 6.0 versions.
     - `POST_PERSIST` => `FOS\ElasticaBundle\Persister\Event\PostPersistEvent`
     - `PRE_FETCH_OBJECTS` => `FOS\ElasticaBundle\Persister\Event\PreFetchObjectsEvent`
 * **[BC break]** Renamed `FOS\ElasticaBundle\Persister\Event\OnExceptionEvent::setIgnore()` to `FOS\ElasticaBundle\Persister\Event\OnExceptionEvent::setIgnored()`.
+* **[BC break]** Marked all `fos_elastica.manager` services as private.

doc/usage.md

@@ -115,15 +115,41 @@ fos_elastica:
 
 An example for using a repository:
 
+```yaml
+# config/services.yaml
+services:
+    # ...
+
+    App\Controller\UserController:
+        tags: ['controller.service_arguments']
+        public: true
+        arguments:
+            - '@fos_elastica.manager'
+```
+
 ```php
-/** var FOS\ElasticaBundle\Manager\RepositoryManager */
-$repositoryManager = $this->container->get('fos_elastica.manager');
+namespace App\Controller;
+
+use FOS\ElasticaBundle\Manager\RepositoryManagerInterface;
+
+class UserController extends Controller
+{
+    /** @var RepositoryManagerInterface */
+    private $repositoryManager;
+
+    public function __construct(RepositoryManagerInterface $repositoryManager)
+    {
+        $this->repositoryManager = $repositoryManager;
+    }
 
-/** var FOS\ElasticaBundle\Repository */
-$repository = $repositoryManager->getRepository('UserBundle:User');
+    public function userAction()
+    {
+        $repository = $this->repositoryManager->getRepository('UserBundle:User');
 
-/** var array of Acme\UserBundle\Entity\User */
-$users = $repository->find('bob');
+        /** var array of App\UserBundle\Entity\User */
+        $users = $repository->find('bob');
+    }
+}
 ```
 
 For more information about customising repositories, see the cookbook entry
@@ -160,10 +186,10 @@ class UserRepository extends EntityRepository
     public function createSearchQueryBuilder($entityAlias)
     {
         $qb = $this->createQueryBuilder($entityAlias);
-        
+
         $qb->select($entityAlias, 'g')
             ->innerJoin($entityAlias.'.groups', 'g');
-            
+
         return $qb;
     }
 }

src/DependencyInjection/FOSElasticaExtension.php

@@ -723,9 +723,7 @@ private function createDefaultManagerAlias(string $defaultManager, ContainerBuil
         }
 
         $container->setAlias('fos_elastica.manager', sprintf('fos_elastica.manager.%s', $defaultManagerService));
-        $container->getAlias('fos_elastica.manager')->setPublic(true);
         $container->setAlias(RepositoryManagerInterface::class, 'fos_elastica.manager');
-        $container->getAlias(RepositoryManagerInterface::class)->setPublic(false);
     }
 
     /**

src/Resources/config/mongodb.xml

@@ -32,7 +32,7 @@
             </call>
         </service>
 
-        <service id="fos_elastica.manager.mongodb" class="FOS\ElasticaBundle\Doctrine\RepositoryManager" public="true">
+        <service id="fos_elastica.manager.mongodb" class="FOS\ElasticaBundle\Doctrine\RepositoryManager">
             <argument type="service" id="doctrine_mongodb"/>
             <argument type="service" id="fos_elastica.repository_manager"/>
         </service>

src/Resources/config/orm.xml

@@ -32,7 +32,7 @@
             </call>
         </service>
 
-        <service id="fos_elastica.manager.orm" class="FOS\ElasticaBundle\Doctrine\RepositoryManager" public="true">
+        <service id="fos_elastica.manager.orm" class="FOS\ElasticaBundle\Doctrine\RepositoryManager">
             <argument type="service" id="doctrine" />
             <argument type="service" id="fos_elastica.repository_manager" />
         </service>

src/Resources/config/phpcr.xml

@@ -32,7 +32,7 @@
             </call>
         </service>
 
-        <service id="fos_elastica.manager.phpcr" class="FOS\ElasticaBundle\Doctrine\RepositoryManager" public="true">
+        <service id="fos_elastica.manager.phpcr" class="FOS\ElasticaBundle\Doctrine\RepositoryManager">
             <argument type="service" id="doctrine_phpcr" />
             <argument type="service" id="fos_elastica.repository_manager" />
         </service>

tests/Functional/PersistenceRepositoryTest.php

@@ -15,9 +15,15 @@ class PersistenceRepositoryTest extends WebTestCase
 {
     public function testRepositoryShouldBeSetCorrectly()
     {
-        static::bootKernel(['test_case' => 'ORM']);
+        self::bootKernel(['test_case' => 'ORM']);
 
-        $repository = static::$kernel->getContainer()->get('fos_elastica.manager.orm')
+        // returns the real and unchanged service container
+        $container = self::$kernel->getContainer();
+
+        // gets the special container that allows fetching private services
+        $container = self::$container;
+
+        $repository = self::$container->get('test_alias.fos_elastica.manager.orm')
             ->getRepository(TypeObject::class);
 
         $this->assertInstanceOf(TypeObjectRepository::class, $repository);

tests/Functional/app/ORM/config.yml

@@ -10,12 +10,14 @@ doctrine:
         auto_mapping: false
 
 services:
+    _defaults:
+        public: true
     test_alias.fos_elastica.indexable:
         alias: fos_elastica.indexable
-        public: true
     indexable_service:
         class: FOS\ElasticaBundle\Tests\Functional\app\ORM\IndexableService
-        public: false
+    test_alias.fos_elastica.manager.orm:
+        alias: fos_elastica.manager.orm
 
 fos_elastica:
     clients:

tests/Functional/app/config/config.yml

@@ -1,4 +1,5 @@
 framework:
+    test: true
     secret: secret
 
 services: