remove unused request object from PhpcrMenuProvider

Author: dbu

CHANGELOG.md

@@ -1,6 +1,8 @@
 Changelog
 =========
 
+* **2017-02-17**: [BC BREAK] Removed unused setRequest from PhpcrMenuProvider and changed properties to private.
+
 2.0.0-RC2
 ---------
 

src/Provider/PhpcrMenuProvider.php

@@ -14,68 +14,53 @@
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\ODM\PHPCR\DocumentManager;
 use Jackalope\Session;
-use Knp\Menu\FactoryInterface;
 use Knp\Menu\ItemInterface;
 use Knp\Menu\Loader\NodeLoader;
 use Knp\Menu\NodeInterface;
 use Knp\Menu\Provider\MenuProviderInterface;
 use PHPCR\PathNotFoundException;
 use PHPCR\RepositoryException;
 use PHPCR\Util\PathHelper;
-use Symfony\Component\HttpFoundation\Request;
 
 class PhpcrMenuProvider implements MenuProviderInterface
 {
     /**
      * @var NodeLoader
      */
-    protected $loader;
-
-    /**
-     * @var Request
-     */
-    protected $request;
+    private $loader;
 
     /**
      * base for menu ids.
      *
      * @var string
      */
-    protected $menuRoot;
+    private $menuRoot;
 
     /**
      * Depth to use to prefetch all menu nodes. Only used if > 0, otherwise
      * no prefetch is attempted.
      *
      * @var int
      */
-    protected $prefetch = 10;
-
-    /**
-     * doctrine document class name.
-     *
-     * @var string
-     */
-    protected $className;
+    private $prefetch = 10;
 
     /**
      * If this is null, the manager registry will return the default manager.
      *
      * @var string|null Name of object manager to use
      */
-    protected $managerName;
+    private $managerName;
 
     /**
      * @var ManagerRegistry
      */
-    protected $managerRegistry;
+    private $managerRegistry;
 
     /**
-     * @param FactoryInterface $factory         the menu factory to create the menu
-     *                                          item with the root document (usually ContentAwareFactory)
-     * @param ManagerRegistry  $managerRegistry manager registry service to use in conjunction
-     *                                          with the manager name to load the load menu root document
-     * @param string           $menuRoot        root id of the menu
+     * @param NodeLoader      $loader          Factory for the menu items
+     * @param ManagerRegistry $managerRegistry manager registry service to use in conjunction
+     *                                         with the manager name to load the load menu root document
+     * @param string          $menuRoot        root id of the menu
      */
     public function __construct(
         NodeLoader $loader,
@@ -127,7 +112,7 @@ public function getMenuRoot()
      */
     public function setPrefetch($depth)
     {
-        $this->prefetch = intval($depth);
+        $this->prefetch = (int) $depth;
     }
 
     /**
@@ -140,16 +125,6 @@ public function getPrefetch()
         return $this->prefetch;
     }
 
-    /**
-     * Set the request.
-     *
-     * @param Request $request
-     */
-    public function setRequest(Request $request = null)
-    {
-        $this->request = $request;
-    }
-
     /**
      * Create the menu subtree starting from name.
      *
@@ -167,10 +142,10 @@ public function setRequest(Request $request = null)
      */
     public function get($name, array $options = [])
     {
-        $menu = $this->find($name, $options, true);
+        $menu = $this->find($name, true);
 
         $menuItem = $this->loader->load($menu);
-        if (empty($menuItem)) {
+        if (!$menuItem) {
             throw new \InvalidArgumentException("Menu at '$name' is misconfigured (f.e. the route might be incorrect) and could therefore not be instanciated");
         }
 
@@ -191,25 +166,24 @@ public function get($name, array $options = [])
      */
     public function has($name, array $options = [])
     {
-        return $this->find($name, $options, false) instanceof NodeInterface;
+        return $this->find($name, false) instanceof NodeInterface;
     }
 
     /**
-     * @param string $name    Name of the menu to load
-     * @param array  $options
-     * @param bool   $throw   Whether to throw an exception if the menu is not
-     *                        found or no valid menu. Returns false if $throw is false and there
-     *                        is no menu at $name
+     * @param string $name  Name of the menu to load
+     * @param bool   $throw Whether to throw an exception if the menu is not
+     *                      found or no valid menu. Returns false if $throw is
+     *                      false and there is no menu at $name
      *
      * @return object|bool The menu root found with $name or false if $throw
      *                     is false and the menu was not found
      *
      * @throws \InvalidArgumentException Only if $throw is true throws this
      *                                   exception if the name is empty or no menu found
      */
-    protected function find($name, array $options, $throw)
+    private function find($name, $throw)
     {
-        if (empty($name)) {
+        if (!$name) {
             if ($throw) {
                 throw new \InvalidArgumentException('The menu name may not be empty');
             }
@@ -232,22 +206,24 @@ protected function find($name, array $options, $throw)
         }
 
         if ($this->getPrefetch() > 0) {
-            if (
-                    $session instanceof Session
-                    && 0 < $session->getSessionOption(Session::OPTION_FETCH_DEPTH)
-                    && 0 === strncmp($path, $this->getMenuRoot(), strlen($this->getMenuRoot()))
-                ) {
+            if ($session instanceof Session
+                && 0 < $session->getSessionOption(Session::OPTION_FETCH_DEPTH)
+                && 0 === strncmp($path, $this->getMenuRoot(), strlen($this->getMenuRoot()))
+            ) {
                 // we have jackalope with a fetch depth. prefetch all menu
-                    // nodes of all menues.
-                    try {
-                        $session->getNode($this->getMenuRoot(), $this->getPrefetch() + 1);
-                    } catch (PathNotFoundException $e) {
-                        if ($throw) {
-                            throw new \InvalidArgumentException(sprintf('The menu root "%s" does not exist.', $this->getMenuRoot()));
-                        }
-
-                        return false;
+                // nodes of all menues.
+                try {
+                    $session->getNode($this->getMenuRoot(), $this->getPrefetch() + 1);
+                } catch (PathNotFoundException $e) {
+                    if ($throw) {
+                        throw new \InvalidArgumentException(sprintf(
+                            'The menu root "%s" does not exist.',
+                            $this->getMenuRoot()
+                        ));
                     }
+
+                    return false;
+                }
             } else {
                 try {
                     $session->getNode($path, $this->getPrefetch());

src/Resources/config/persistence-phpcr.xml

@@ -13,7 +13,6 @@
             <argument>%cmf_menu.persistence.phpcr.menu_basepath%</argument>
             <call method="setManagerName"><argument>%cmf_menu.persistence.phpcr.manager_name%</argument></call>
             <call method="setPrefetch"><argument>%cmf_menu.persistence.phpcr.prefetch%</argument></call>
-            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false"/></call>
         </service>
 
         <service id="cmf_menu.initializer" class="Doctrine\Bundle\PHPCRBundle\Initializer\GenericInitializer">

tests/Unit/Provider/PhpcrMenuProviderTest.php

@@ -19,7 +19,6 @@
 use PHPCR\SessionInterface;
 use Prophecy\Argument;
 use Symfony\Cmf\Bundle\MenuBundle\Provider\PhpcrMenuProvider;
-use Symfony\Component\HttpFoundation\Request;
 
 class PhpcrMenuProviderTest extends \PHPUnit_Framework_Testcase
 {
@@ -49,7 +48,6 @@ public function testGet($menuRoot, $name, $expectedPath)
             ->willReturn($this->item->reveal());
 
         $provider = $this->createProvider($menuRoot);
-        $provider->setRequest(Request::create('/'));
         $item = $provider->get($name);
 
         $this->assertSame($this->item->reveal(), $item);