Allows to have url with or without base url

locomotivemtl · Aug 9, 2018 · 688a81e · 688a81e
1 parent 5f1535d
commit 688a81e
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,7 @@ properties are renderable by objects. Let's take the example below:
             "footer_sitemap": {
                 "l10n": true,
                 "check_active_routes": true,
+                "relative_urls": false,
                 "objects": {
                     "boilerplate/object/section": {
                         "label": "{{title}}",
@@ -119,6 +120,26 @@ Given the settings above:
 $builder = $container['charcoal/sitemap/builder'];
 $sitemap = $builder->build('footer_sitemap'); // footer_sitemap is the ident of the settings you want.
 ```
+You can also use the `SitemapBuilderAwareTrait`, which includes the setter and getter for the sitemap builder, in order
+to use it with minimal code in every necessary class.
+
+
+### Options
+
+| Key                   | Values                | Default           | Description 
+|:---                   |:---:                  |:---:              |---          
+|`l10n`                 | true/false            | false             | Defines if the sitemap includes all the languages defined in the configurations  
+| `check_active_routes` | true/false            | false             | Checks on every object if the route is active (using isActiveRoute)
+| `relative_urls`       | true/false            | false             | Returns either the absolute URL or the relative URL
+| `locale`              | string                | Current locale    | You can choose the locale for the sitemap. (Unless l10n)
+| `objects`             | object class string   | n/a               | The objects and their configurations  
+| `objects`             |-                      |-                  |-   
+| `filters`             | Array                 | n/a               | Filters for the list  
+| `orders`              | Array                 | n/a               | Orders for the list  
+| `children`            | Array                 | n/a               | Uses the same options as `objects`
+| `url`                 | string                | {{url}}           | Renderable URL, in case the method is not `url`
+| `label`               | string                | {{title}}         | Renderable label, in case it's not `title`  
+| `data`                | Array                 | n/a               | Any order data you want in. This is recursively rendered on the object  
 
 ### Sitemap.xml
 This contrib provides a route for `sitemap.xml` that dynamically loads the `xml` config and outputs it 

diff --git a/src/Charcoal/Sitemap/ExampleInterface.php b/src/Charcoal/Sitemap/ExampleInterface.php
diff --git a/src/Charcoal/Sitemap/Mixin/SitemapBuilderAwareTrait.php b/src/Charcoal/Sitemap/Mixin/SitemapBuilderAwareTrait.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Charcoal\Sitemap\Mixin;
+
+use Charcoal\Sitemap\Service\Builder;
+
+trait SitemapBuilderAwareTrait
+{
+    /**
+     * @var Builder
+     */
+    protected $sitemapBuilder;
+
+    /**
+     * @return Builder
+     */
+    public function sitemapBuilder()
+    {
+        return $this->sitemapBuilder;
+    }
+
+    /**
+     * @param Builder $sitemapBuilder
+     * @return SitemapBuilderAwareTrait
+     */
+    public function setSitemapBuilder($sitemapBuilder)
+    {
+        $this->sitemapBuilder = $sitemapBuilder;
+        return $this;
+    }
+}
diff --git a/src/Charcoal/Sitemap/Service/Builder.php b/src/Charcoal/Sitemap/Service/Builder.php
@@ -2,25 +2,25 @@
 
 namespace Charcoal\Sitemap\Service;
 
+use Charcoal\Factory\FactoryInterface;
+use Charcoal\Loader\CollectionLoader;
+use Charcoal\Object\CategoryInterface;
+use Charcoal\Object\HierarchicalInterface;
+use Charcoal\Object\RoutableInterface;
+use Charcoal\Translator\TranslatorAwareTrait;
+use Charcoal\View\ViewableInterface;
 use InvalidArgumentException;
 use RuntimeException;
 
 // From 'charcoal-factory'
-use Charcoal\Factory\FactoryInterface;
 
 // From 'charcoal-core'
-use Charcoal\Loader\CollectionLoader;
 
 // From 'charcoal-object'
-use Charcoal\Object\CategoryInterface;
-use Charcoal\Object\HierarchicalInterface;
-use Charcoal\Object\RoutableInterface;
 
 // From 'charcoal-translator'
-use Charcoal\Translator\TranslatorAwareTrait;
 
 // From 'charcoal-view'
-use Charcoal\View\ViewableInterface;
 
 /**
  * Sitemap builder from object hierarchy
@@ -117,6 +117,7 @@ protected function defaultOptions()
             'locale'              => $this->translator()->getLocale(),
             'l10n'                => true,
             'check_active_routes' => true,
+            'relative_urls'       => true,
             'objects'             => [
                 'label'    => '{{title}}',
                 'url'      => '{{url}}',
@@ -175,6 +176,9 @@ public function build($ident = 'default')
             if (!isset($options['check_active_routes'])) {
                 $options['check_active_routes'] = $defaults['check_active_routes'];
             }
+            if (!isset($options['relative_urls'])) {
+                $options['relative_urls'] = $defaults['relative_urls'];
+            }
             $out[] = $this->buildObject($class, $options);
         }
 
@@ -198,11 +202,13 @@ protected function buildObject($class, $options, ViewableInterface $parent = nul
             }
         }
 
+        // Loadin the actual objects from the predefined settings
         $factory = $this->modelFactory();
         $obj     = $factory->create($class);
 
         $loader = $this->collectionLoader()->setModel($obj);
 
+        // From the filters
         if (isset($options['filters'])) {
             $filters = $options['filters'];
             if ($parent) {
@@ -211,6 +217,7 @@ protected function buildObject($class, $options, ViewableInterface $parent = nul
             $loader->addFilters($filters);
         }
 
+        // From the orders
         if (isset($options['orders'])) {
             $orders = $options['orders'];
             if ($parent) {
@@ -219,6 +226,7 @@ protected function buildObject($class, $options, ViewableInterface $parent = nul
             $loader->addOrders($orders);
         }
 
+        // From the category / hierarchichal property
         $category     = ($obj instanceof CategoryInterface);
         $hierarchical = ($obj instanceof HierarchicalInterface);
         if ($hierarchical || $category) {
@@ -229,21 +237,26 @@ protected function buildObject($class, $options, ViewableInterface $parent = nul
             }
         }
 
+        // Loading
         $list = $loader->load();
 
+        // Processing the objects and rendering data
         $out      = [];
         $children = isset($options['children']) ? $options['children'] : [];
         $level++;
 
+        // Options
         $l10n              = $options['l10n'];
-        $locale            = $options['locale'];
+        $defaultLocale     = $options['locale'];
         $checkActiveRoutes = $options['check_active_routes'];
+        $relativeUrls      = $options['relative_urls'];
 
-        $availableLocales = $l10n ? $this->translator()->availableLocales() : [$locale];
+        // Locales
+        $availableLocales = $l10n ? $this->translator()->availableLocales() : [$defaultLocale];
 
         foreach ($availableLocales as $locale) {
 
-            $currentLocale = $locale;
+            // Get opposite languages locales
             $oppositeLang  = [];
             foreach ($availableLocales as $l) {
                 if ($l == $locale) {
@@ -252,12 +265,15 @@ protected function buildObject($class, $options, ViewableInterface $parent = nul
                 $oppositeLang[] = $l;
             }
 
+            // Set the local to the current locale before looping the list.
             $this->translator()->setLocale($locale);
             foreach ($list as $object) {
+                // When checking active routes, do not display routes that are not active
                 if ($checkActiveRoutes && $object instanceof RoutableInterface && !$object->isActiveRoute()) {
                     continue;
                 }
 
+                // Hierarchical (children, when defined)
                 $cs = [];
                 if (!empty($children)) {
                     foreach ($children as $cname => $opts) {
@@ -266,27 +282,34 @@ protected function buildObject($class, $options, ViewableInterface $parent = nul
                     }
                 }
 
+                // Url template, relative or absolute?
+                $urlTemplate = $relativeUrls ? $options['url'] : '{{#withBaseUrl}}' . $options['url'] . '{{/withBaseUrl}}';
+
                 $tmp = [
                     'label'    => trim($this->renderData($object, $options['label'])),
-                    'url'      => trim($this->renderData($object, '{{#withBaseUrl}}' . $options['url'] . '{{/withBaseUrl}}')),
+                    'url'      => trim($this->renderData($object, $urlTemplate)),
                     'children' => $cs,
                     'data'     => $this->renderData($object, $options['data']),
                     'level'    => $level,
                     'lang'     => $locale
                 ];
 
+                // If you need a priority, fix your own rules
                 $priority = '';
                 if (isset($options['priority']) && $options['priority']) {
                     $priority = $this->renderData($object, (string)$options['priority']);
                 }
                 $tmp['priority'] = $priority;
 
+                // If you need a date of last modification, fix your own rules
                 $last = '';
                 if (isset($options['last_modified']) && $options['last_modified']) {
                     $last = $this->renderData($object, $options['last_modified']);
                 }
                 $tmp['last_modified'] = $last;
 
+                // Opposite Languages
+                // Meant to be alternate, thus the lack of data rendering
                 $alternates = [];
                 foreach ($oppositeLang as $ol) {
                     $this->translator()->setLocale($ol);
@@ -302,15 +325,15 @@ protected function buildObject($class, $options, ViewableInterface $parent = nul
 
                 $tmp['alternates'] = $alternates;
 
-                $this->translator()->setLocale($currentLocale);
+                $this->translator()->setLocale($locale);
                 $out[] = $tmp;
             }
         }
 
 
         return $out;
     }
-    
+
     /**
      * Recursive data renderer
      *