Allow custom slug name for Posts and Post component (#394)

Fixes an issue that prevents the use of anything but "slug" as the post slug property. This merge also contains abstraction of some URL helper methods for all blog components. Credit to @GinoPane. Fixes #392.
rainlab · May 19, 2019 · 950fbd7 · 950fbd7
1 parent 2a3d4ae
commit 950fbd7
Show file tree

Hide file tree

Showing 7 changed files with 167 additions and 42 deletions.
diff --git a/classes/ComponentAbstract.php b/classes/ComponentAbstract.php
@@ -0,0 +1,67 @@
+<?php namespace RainLab\Blog\Classes;
+
+use Cms\Classes\Page;
+use Cms\Classes\Theme;
+use Cms\Classes\ComponentBase;
+
+abstract class ComponentAbstract extends ComponentBase
+{
+    /**
+     * Reference to the page name for linking to posts
+     *
+     * @var string
+     */
+    public $postPage;
+
+    /**
+     * Reference to the page name for linking to categories
+     *
+     * @var string
+     */
+    public $categoryPage;
+
+    /**
+     * @param string $componentName
+     * @param string $page
+     * @return ComponentBase|null
+     */
+    protected function getComponent(string $componentName, string $page)
+    {
+        $component = null;
+
+        $page = Page::load(Theme::getActiveTheme(), $page);
+
+        if (!is_null($page)) {
+            $component = $page->getComponent($componentName);
+        }
+
+        return $component;
+    }
+
+    /**
+     * A helper function to get the real URL parameter name. For example, slug for posts
+     * can be injected as :post into URL. Real argument is necessary if you want to generate
+     * valid URLs for such pages
+     *
+     * @param ComponentBase|null $component
+     * @param string $name
+     *
+     * @return string|null
+     */
+    protected function urlProperty(ComponentBase $component = null, string $name = '')
+    {
+        $property = null;
+
+        if ($component !== null && ($property = $component->property($name))) {
+            preg_match('/{{ :([^ ]+) }}/', $property, $matches);
+
+            if (isset($matches[1])) {
+                $property = $matches[1];
+            }
+        } else {
+            $property = $name;
+        }
+
+        return $property;
+    }
+}
diff --git a/components/Categories.php b/components/Categories.php
@@ -3,10 +3,10 @@
 use Db;
 use Carbon\Carbon;
 use Cms\Classes\Page;
-use Cms\Classes\ComponentBase;
+use RainLab\Blog\Classes\ComponentAbstract;
 use RainLab\Blog\Models\Category as BlogCategory;
 
-class Categories extends ComponentBase
+class Categories extends ComponentAbstract
 {
     /**
      * @var Collection A collection of categories to display
@@ -98,8 +98,16 @@ protected function loadCategories()
 
     protected function linkCategories($categories)
     {
-        return $categories->each(function ($category) {
-            $category->setUrl($this->categoryPage, $this->controller);
+        $blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
+
+        return $categories->each(function ($category) use ($blogPostsComponent) {
+            $category->setUrl(
+                $this->categoryPage,
+                $this->controller,
+                [
+                    'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
+                ]
+            );
 
             if ($category->children) {
                 $this->linkCategories($category->children);

diff --git a/components/Post.php b/components/Post.php
@@ -3,14 +3,14 @@
 use Event;
 use BackendAuth;
 use Cms\Classes\Page;
-use Cms\Classes\ComponentBase;
 use RainLab\Blog\Models\Post as BlogPost;
+use RainLab\Blog\Classes\ComponentAbstract;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 
-class Post extends ComponentBase
+class Post extends ComponentAbstract
 {
     /**
-     * @var RainLab\Blog\Models\Post The post model used for display.
+     * @var BlogPost The post model used for display.
      */
     public $post;
 
@@ -102,14 +102,18 @@ protected function loadPost()
         }
 
         /*
-        * Add a "url" helper attribute for linking to each category
-        */
+         * Add a "url" helper attribute for linking to each category
+         */
         if ($post && $post->categories->count()) {
-            $post->categories->each(function($category) {
-                $category->setUrl($this->categoryPage, $this->controller);
+            $blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
+
+            $post->categories->each(function ($category) use ($blogPostsComponent) {
+                $category->setUrl($this->categoryPage, $this->controller, [
+                    'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
+                ]);
             });
         }
-        
+
         return $post;
     }
 
@@ -137,10 +141,17 @@ protected function getPostSibling($direction = 1)
 
         $postPage = $this->getPage()->getBaseFileName();
 
-        $post->setUrl($postPage, $this->controller);
+        $blogPostComponent = $this->getComponent('blogPost', $postPage);
+        $blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
+
+        $post->setUrl($postPage, $this->controller, [
+            'slug' => $this->urlProperty($blogPostComponent, 'slug')
+        ]);
 
-        $post->categories->each(function($category) {
-            $category->setUrl($this->categoryPage, $this->controller);
+        $post->categories->each(function ($category) use ($blogPostsComponent) {
+            $category->setUrl($this->categoryPage, $this->controller, [
+                'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
+            ]);
         });
 
         return $post;

diff --git a/components/Posts.php b/components/Posts.php
@@ -4,51 +4,60 @@
 use Redirect;
 use BackendAuth;
 use Cms\Classes\Page;
-use Cms\Classes\ComponentBase;
+use October\Rain\Database\Model;
+use October\Rain\Database\Collection;
 use RainLab\Blog\Models\Post as BlogPost;
+use RainLab\Blog\Classes\ComponentAbstract;
 use RainLab\Blog\Models\Category as BlogCategory;
 use RainLab\Blog\Models\Settings as BlogSettings;
 
-class Posts extends ComponentBase
+class Posts extends ComponentAbstract
 {
     /**
      * A collection of posts to display
+     *
      * @var Collection
      */
     public $posts;
 
     /**
      * Parameter to use for the page number
+     *
      * @var string
      */
     public $pageParam;
 
     /**
-     * If the post list should be filtered by a category, the model to use.
+     * If the post list should be filtered by a category, the model to use
+     *
      * @var Model
      */
     public $category;
 
     /**
-     * Message to display when there are no messages.
+     * Message to display when there are no messages
+     *
      * @var string
      */
     public $noPostsMessage;
 
     /**
-     * Reference to the page name for linking to posts.
+     * Reference to the page name for linking to posts
+     *
      * @var string
      */
     public $postPage;
 
     /**
-     * Reference to the page name for linking to categories.
+     * Reference to the page name for linking to categories
+     *
      * @var string
      */
     public $categoryPage;
 
     /**
-     * If the post list should be ordered by another attribute.
+     * If the post list should be ordered by another attribute
+     *
      * @var string
      */
     public $sortOrder;
@@ -210,11 +219,26 @@ protected function listPosts()
         /*
          * Add a "url" helper attribute for linking to each post and category
          */
-        $posts->each(function($post) {
-            $post->setUrl($this->postPage, $this->controller);
-
-            $post->categories->each(function($category) {
-                $category->setUrl($this->categoryPage, $this->controller);
+        $blogPostComponent = $this->getComponent('blogPost', $this->postPage);
+        $blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
+
+        $posts->each(function ($post) use ($blogPostComponent, $blogPostsComponent) {
+            $post->setUrl(
+                $this->postPage,
+                $this->controller,
+                [
+                    'slug' => $this->urlProperty($blogPostComponent, 'slug')
+                ]
+            );
+
+            $post->categories->each(function ($category) use ($blogPostsComponent) {
+                $category->setUrl(
+                    $this->categoryPage,
+                    $this->controller,
+                    [
+                        'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
+                    ]
+                );
             });
         });
 

diff --git a/components/RssFeed.php b/components/RssFeed.php
@@ -3,11 +3,11 @@
 use Lang;
 use Response;
 use Cms\Classes\Page;
-use Cms\Classes\ComponentBase;
 use RainLab\Blog\Models\Post as BlogPost;
+use RainLab\Blog\Classes\ComponentAbstract;
 use RainLab\Blog\Models\Category as BlogCategory;
 
-class RssFeed extends ComponentBase
+class RssFeed extends ComponentAbstract
 {
     /**
      * A collection of posts to display
@@ -137,8 +137,12 @@ protected function listPosts()
         /*
          * Add a "url" helper attribute for linking to each post and category
          */
-        $posts->each(function($post) {
-            $post->setUrl($this->postPage, $this->controller);
+        $blogPostComponent = $this->getComponent('blogPost', $this->postPage);
+
+        $posts->each(function ($post) use ($blogPostComponent) {
+            $post->setUrl($this->postPage, $this->controller, [
+                'slug' => $this->urlProperty($blogPostComponent, 'slug')
+            ]);
         });
 
         return $posts;

diff --git a/models/Category.php b/models/Category.php
@@ -80,14 +80,18 @@ public function getNestedPostCount()
 
     /**
      * Sets the "url" attribute with a URL to this object
+     *
      * @param string $pageName
      * @param Cms\Classes\Controller $controller
+     * @param array $urlParams A mapping of overrides for default URL parameter names
+     *
+     * @return string
      */
-    public function setUrl($pageName, $controller)
+    public function setUrl($pageName, $controller, array $urlParams = array())
     {
         $params = [
-            'id'   => $this->id,
-            'slug' => $this->slug
+            array_get($urlParams, 'id', 'id')   => $this->id,
+            array_get($urlParams, 'slug', 'slug')  => $this->slug,
         ];
 
         return $this->url = $controller->pageUrl($pageName, $params, false);

diff --git a/models/Post.php b/models/Post.php
@@ -10,12 +10,16 @@
 use Markdown;
 use BackendAuth;
 use ValidationException;
-use RainLab\Blog\Classes\TagProcessor;
 use Backend\Models\User;
 use Carbon\Carbon;
 use Cms\Classes\Page as CmsPage;
 use Cms\Classes\Theme;
+use Cms\Classes\Controller;
+use RainLab\Blog\Classes\TagProcessor;
 
+/**
+ * Class Post
+ */
 class Post extends Model
 {
     use \October\Rain\Database\Traits\Validation;
@@ -141,22 +145,25 @@ public function beforeSave()
     /**
      * Sets the "url" attribute with a URL to this object.
      * @param string $pageName
-     * @param Cms\Classes\Controller $controller
+     * @param Controller $controller
+     * @param array $urlParams A mapping of possible overrides of default URL parameter names
+     *
+     * @return string
      */
-    public function setUrl($pageName, $controller)
+    public function setUrl($pageName, $controller, array $urlParams = array())
     {
         $params = [
-            'id'   => $this->id,
-            'slug' => $this->slug
+            array_get($urlParams, 'id', 'id')   => $this->id,
+            array_get($urlParams, 'slug', 'slug') => $this->slug,
         ];
 
         $params['category'] = $this->categories->count() ? $this->categories->first()->slug : null;
 
         // Expose published year, month and day as URL parameters.
         if ($this->published) {
-            $params['year']  = $this->published_at->format('Y');
-            $params['month'] = $this->published_at->format('m');
-            $params['day']   = $this->published_at->format('d');
+            $params[array_get($urlParams, 'year', 'year')] = $this->published_at->format('Y');
+            $params[array_get($urlParams, 'month', 'month')] = $this->published_at->format('m');
+            $params[array_get($urlParams, 'day', 'day')] = $this->published_at->format('d');
         }
 
         return $this->url = $controller->pageUrl($pageName, $params);