M structure navigation

Author: vvval

source/NavigationBuilder/Builders/StructureBuilder.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Spiral\NavigationBuilder\Builders;
+
+use Spiral\NavigationBuilder\Services\LinkWrapper;
+
+class StructureBuilder extends TreeBuilder
+{
+    /**
+     * @param array $data
+     * @return array
+     */
+    protected function packRow(array $data): array
+    {
+        return parent::packRow($data) + [
+            'depth'      => $data['depth'],
+            'text'       => $data['link']['text'],
+            'href'       => $data['link']['href'],
+            'attributes' => LinkWrapper::unpackAttributes($data['link']['attributes']),
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @return array
+     */
+    protected function packLink(array $data): array
+    {
+        return parent::packLink($data) + [
+            'depth'      => $data['depth'],
+            'text'       => $data['text'],
+            'href'       => $data['href'],
+            'attributes' => $data['attributes'],
+        ];
+    }
+
+    /**
+     * @param string $domain
+     * @return array
+     */
+    protected function getTree(string $domain): array
+    {
+        return $this->source->findDomainTree($domain)->orderBy('order', 'ASC')->fetchData();
+    }
+}

source/NavigationBuilder/Navigation.php

@@ -3,6 +3,7 @@
 namespace Spiral\NavigationBuilder;
 
 use Spiral\NavigationBuilder\Builders\HtmlBuilder;
+use Spiral\NavigationBuilder\Builders\StructureBuilder;
 use Spiral\NavigationBuilder\Builders\TreeBuilder;
 
 /**
@@ -23,6 +24,9 @@ class Navigation
     /** @var HtmlBuilder */
     private $htmlBuilder;
 
+    /** @var StructureBuilder */
+    private $structureBuilder;
+
     /** @var RendererInterface */
     private $renderer;
 
@@ -34,29 +38,36 @@ class Navigation
      *
      * @param TreeBuilder       $treeBuilder
      * @param HtmlBuilder       $htmlBuilder
+     * @param StructureBuilder  $structureBuilder
      * @param RendererInterface $renderer
      * @param Storage           $storage
      */
     public function __construct(
         TreeBuilder $treeBuilder,
         HtmlBuilder $htmlBuilder,
+        StructureBuilder $structureBuilder,
         RendererInterface $renderer,
         Storage $storage
     ) {
         $this->treeBuilder = $treeBuilder;
         $this->htmlBuilder = $htmlBuilder;
+        $this->structureBuilder = $structureBuilder;
         $this->storage = $storage;
 
         $this->setRenderer($renderer);
     }
 
     /**
      * @param RendererInterface $renderer
+     * @return Navigation
      */
-    public function setRenderer(RendererInterface $renderer)
+    public function setRenderer(RendererInterface $renderer): Navigation
     {
-        $this->renderer = $renderer;
-        $this->htmlBuilder->setRenderer($renderer);
+        $navigation = clone $this;
+        $navigation->renderer = $renderer;
+        $navigation->htmlBuilder->setRenderer($renderer);
+
+        return $navigation;
     }
 
     /**
@@ -108,6 +119,25 @@ public function getTree(string $domain, bool $cache = true): array
         return $tree;
     }
 
+    /**
+     * @param string $domain
+     * @param bool   $cache
+     * @return array
+     */
+    public function getStructure(string $domain, bool $cache = true): array
+    {
+        if (empty($cache)) {
+            return $this->structureBuilder->build($domain);
+        }
+
+        $structure = $this->storage->getStructureCache($domain);
+        if (empty($structure)) {
+            $structure = $this->buildAndCacheTree($domain);
+        }
+
+        return $structure;
+    }
+
     /**
      * @param string $domain
      * @return array
@@ -120,6 +150,18 @@ protected function buildAndCacheTree(string $domain): array
         return $tree;
     }
 
+    /**
+     * @param string $domain
+     * @return array
+     */
+    protected function buildAndCacheStructure(string $domain): array
+    {
+        $structure = $this->structureBuilder->build($domain);
+        $this->storage->setStructureCache($domain, $structure);
+
+        return $structure;
+    }
+
     /**
      * @param string $domain
      * @return string

source/NavigationBuilder/Storage.php

@@ -11,9 +11,10 @@
  */
 class Storage
 {
-    const TREE_CACHE = 'navigation::tree';
-    const HTML_CACHE = 'navigation::html';
-    const LIFETIME   = 86400 * 365 * 10; // 10 years is enough
+    const TREE_CACHE      = 'navigation::tree';
+    const STRUCTURE_CACHE = 'navigation::structure';
+    const HTML_CACHE      = 'navigation::html';
+    const LIFETIME        = 86400 * 365 * 10; // 10 years is enough
 
     /** @var CacheInterface */
     private $cache;
@@ -62,6 +63,28 @@ public function setTreeCache(string $domain, array $data)
         $this->cache->set($this->treeCache($domain), $data, self::LIFETIME);
     }
 
+    /**
+     * Get domain structure cache. Supposed to be array.
+     *
+     * @param string $domain
+     * @return mixed
+     */
+    public function getStructureCache(string $domain)
+    {
+        return $this->cache->get($this->structureCache($domain), []);
+    }
+
+    /**
+     * Set domain structure cache.
+     *
+     * @param string $domain
+     * @param array  $data
+     */
+    public function setStructureCache(string $domain, array $data)
+    {
+        $this->cache->set($this->structureCache($domain), $data, self::LIFETIME);
+    }
+
     /**
      * Get domain html cache. Supposed to be string.
      *
@@ -97,6 +120,17 @@ protected function treeCache(string $domain): string
         return self::TREE_CACHE . '::' . $domain;
     }
 
+    /**
+     * Tree cache name.
+     *
+     * @param string $domain
+     * @return string
+     */
+    protected function structureCache(string $domain): string
+    {
+        return self::STRUCTURE_CACHE . '::' . $domain;
+    }
+
     /**
      * HTML cache name (used renderer).
      *