Skip to content

Commit 950fbd7

Browse files
GinoPaneBen Thomson
GinoPane
authored and
Ben Thomson
committed
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.
1 parent 2a3d4ae commit 950fbd7

File tree

7 files changed

+167
-42
lines changed

7 files changed

+167
-42
lines changed

‎classes/ComponentAbstract.php

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<?php namespace RainLab\Blog\Classes;
2+
3+
use Cms\Classes\Page;
4+
use Cms\Classes\Theme;
5+
use Cms\Classes\ComponentBase;
6+
7+
abstract class ComponentAbstract extends ComponentBase
8+
{
9+
/**
10+
* Reference to the page name for linking to posts
11+
*
12+
* @var string
13+
*/
14+
public $postPage;
15+
16+
/**
17+
* Reference to the page name for linking to categories
18+
*
19+
* @var string
20+
*/
21+
public $categoryPage;
22+
23+
/**
24+
* @param string $componentName
25+
* @param string $page
26+
* @return ComponentBase|null
27+
*/
28+
protected function getComponent(string $componentName, string $page)
29+
{
30+
$component = null;
31+
32+
$page = Page::load(Theme::getActiveTheme(), $page);
33+
34+
if (!is_null($page)) {
35+
$component = $page->getComponent($componentName);
36+
}
37+
38+
return $component;
39+
}
40+
41+
/**
42+
* A helper function to get the real URL parameter name. For example, slug for posts
43+
* can be injected as :post into URL. Real argument is necessary if you want to generate
44+
* valid URLs for such pages
45+
*
46+
* @param ComponentBase|null $component
47+
* @param string $name
48+
*
49+
* @return string|null
50+
*/
51+
protected function urlProperty(ComponentBase $component = null, string $name = '')
52+
{
53+
$property = null;
54+
55+
if ($component !== null && ($property = $component->property($name))) {
56+
preg_match('/{{ :([^ ]+) }}/', $property, $matches);
57+
58+
if (isset($matches[1])) {
59+
$property = $matches[1];
60+
}
61+
} else {
62+
$property = $name;
63+
}
64+
65+
return $property;
66+
}
67+
}

‎components/Categories.php

+12-4
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
use Db;
44
use Carbon\Carbon;
55
use Cms\Classes\Page;
6-
use Cms\Classes\ComponentBase;
6+
use RainLab\Blog\Classes\ComponentAbstract;
77
use RainLab\Blog\Models\Category as BlogCategory;
88

9-
class Categories extends ComponentBase
9+
class Categories extends ComponentAbstract
1010
{
1111
/**
1212
* @var Collection A collection of categories to display
@@ -98,8 +98,16 @@ protected function loadCategories()
9898

9999
protected function linkCategories($categories)
100100
{
101-
return $categories->each(function ($category) {
102-
$category->setUrl($this->categoryPage, $this->controller);
101+
$blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
102+
103+
return $categories->each(function ($category) use ($blogPostsComponent) {
104+
$category->setUrl(
105+
$this->categoryPage,
106+
$this->controller,
107+
[
108+
'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
109+
]
110+
);
103111

104112
if ($category->children) {
105113
$this->linkCategories($category->children);

‎components/Post.php

+22-11
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
use Event;
44
use BackendAuth;
55
use Cms\Classes\Page;
6-
use Cms\Classes\ComponentBase;
76
use RainLab\Blog\Models\Post as BlogPost;
7+
use RainLab\Blog\Classes\ComponentAbstract;
88
use Illuminate\Database\Eloquent\ModelNotFoundException;
99

10-
class Post extends ComponentBase
10+
class Post extends ComponentAbstract
1111
{
1212
/**
13-
* @var RainLab\Blog\Models\Post The post model used for display.
13+
* @var BlogPost The post model used for display.
1414
*/
1515
public $post;
1616

@@ -102,14 +102,18 @@ protected function loadPost()
102102
}
103103

104104
/*
105-
* Add a "url" helper attribute for linking to each category
106-
*/
105+
* Add a "url" helper attribute for linking to each category
106+
*/
107107
if ($post && $post->categories->count()) {
108-
$post->categories->each(function($category) {
109-
$category->setUrl($this->categoryPage, $this->controller);
108+
$blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
109+
110+
$post->categories->each(function ($category) use ($blogPostsComponent) {
111+
$category->setUrl($this->categoryPage, $this->controller, [
112+
'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
113+
]);
110114
});
111115
}
112-
116+
113117
return $post;
114118
}
115119

@@ -137,10 +141,17 @@ protected function getPostSibling($direction = 1)
137141

138142
$postPage = $this->getPage()->getBaseFileName();
139143

140-
$post->setUrl($postPage, $this->controller);
144+
$blogPostComponent = $this->getComponent('blogPost', $postPage);
145+
$blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
146+
147+
$post->setUrl($postPage, $this->controller, [
148+
'slug' => $this->urlProperty($blogPostComponent, 'slug')
149+
]);
141150

142-
$post->categories->each(function($category) {
143-
$category->setUrl($this->categoryPage, $this->controller);
151+
$post->categories->each(function ($category) use ($blogPostsComponent) {
152+
$category->setUrl($this->categoryPage, $this->controller, [
153+
'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
154+
]);
144155
});
145156

146157
return $post;

‎components/Posts.php

+36-12
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,60 @@
44
use Redirect;
55
use BackendAuth;
66
use Cms\Classes\Page;
7-
use Cms\Classes\ComponentBase;
7+
use October\Rain\Database\Model;
8+
use October\Rain\Database\Collection;
89
use RainLab\Blog\Models\Post as BlogPost;
10+
use RainLab\Blog\Classes\ComponentAbstract;
911
use RainLab\Blog\Models\Category as BlogCategory;
1012
use RainLab\Blog\Models\Settings as BlogSettings;
1113

12-
class Posts extends ComponentBase
14+
class Posts extends ComponentAbstract
1315
{
1416
/**
1517
* A collection of posts to display
18+
*
1619
* @var Collection
1720
*/
1821
public $posts;
1922

2023
/**
2124
* Parameter to use for the page number
25+
*
2226
* @var string
2327
*/
2428
public $pageParam;
2529

2630
/**
27-
* If the post list should be filtered by a category, the model to use.
31+
* If the post list should be filtered by a category, the model to use
32+
*
2833
* @var Model
2934
*/
3035
public $category;
3136

3237
/**
33-
* Message to display when there are no messages.
38+
* Message to display when there are no messages
39+
*
3440
* @var string
3541
*/
3642
public $noPostsMessage;
3743

3844
/**
39-
* Reference to the page name for linking to posts.
45+
* Reference to the page name for linking to posts
46+
*
4047
* @var string
4148
*/
4249
public $postPage;
4350

4451
/**
45-
* Reference to the page name for linking to categories.
52+
* Reference to the page name for linking to categories
53+
*
4654
* @var string
4755
*/
4856
public $categoryPage;
4957

5058
/**
51-
* If the post list should be ordered by another attribute.
59+
* If the post list should be ordered by another attribute
60+
*
5261
* @var string
5362
*/
5463
public $sortOrder;
@@ -210,11 +219,26 @@ protected function listPosts()
210219
/*
211220
* Add a "url" helper attribute for linking to each post and category
212221
*/
213-
$posts->each(function($post) {
214-
$post->setUrl($this->postPage, $this->controller);
215-
216-
$post->categories->each(function($category) {
217-
$category->setUrl($this->categoryPage, $this->controller);
222+
$blogPostComponent = $this->getComponent('blogPost', $this->postPage);
223+
$blogPostsComponent = $this->getComponent('blogPosts', $this->categoryPage);
224+
225+
$posts->each(function ($post) use ($blogPostComponent, $blogPostsComponent) {
226+
$post->setUrl(
227+
$this->postPage,
228+
$this->controller,
229+
[
230+
'slug' => $this->urlProperty($blogPostComponent, 'slug')
231+
]
232+
);
233+
234+
$post->categories->each(function ($category) use ($blogPostsComponent) {
235+
$category->setUrl(
236+
$this->categoryPage,
237+
$this->controller,
238+
[
239+
'slug' => $this->urlProperty($blogPostsComponent, 'categoryFilter')
240+
]
241+
);
218242
});
219243
});
220244

‎components/RssFeed.php

+8-4
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
use Lang;
44
use Response;
55
use Cms\Classes\Page;
6-
use Cms\Classes\ComponentBase;
76
use RainLab\Blog\Models\Post as BlogPost;
7+
use RainLab\Blog\Classes\ComponentAbstract;
88
use RainLab\Blog\Models\Category as BlogCategory;
99

10-
class RssFeed extends ComponentBase
10+
class RssFeed extends ComponentAbstract
1111
{
1212
/**
1313
* A collection of posts to display
@@ -137,8 +137,12 @@ protected function listPosts()
137137
/*
138138
* Add a "url" helper attribute for linking to each post and category
139139
*/
140-
$posts->each(function($post) {
141-
$post->setUrl($this->postPage, $this->controller);
140+
$blogPostComponent = $this->getComponent('blogPost', $this->postPage);
141+
142+
$posts->each(function ($post) use ($blogPostComponent) {
143+
$post->setUrl($this->postPage, $this->controller, [
144+
'slug' => $this->urlProperty($blogPostComponent, 'slug')
145+
]);
142146
});
143147

144148
return $posts;

‎models/Category.php

+7-3
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,18 @@ public function getNestedPostCount()
8080

8181
/**
8282
* Sets the "url" attribute with a URL to this object
83+
*
8384
* @param string $pageName
8485
* @param Cms\Classes\Controller $controller
86+
* @param array $urlParams A mapping of overrides for default URL parameter names
87+
*
88+
* @return string
8589
*/
86-
public function setUrl($pageName, $controller)
90+
public function setUrl($pageName, $controller, array $urlParams = array())
8791
{
8892
$params = [
89-
'id' => $this->id,
90-
'slug' => $this->slug
93+
array_get($urlParams, 'id', 'id') => $this->id,
94+
array_get($urlParams, 'slug', 'slug') => $this->slug,
9195
];
9296

9397
return $this->url = $controller->pageUrl($pageName, $params, false);

‎models/Post.php

+15-8
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@
1010
use Markdown;
1111
use BackendAuth;
1212
use ValidationException;
13-
use RainLab\Blog\Classes\TagProcessor;
1413
use Backend\Models\User;
1514
use Carbon\Carbon;
1615
use Cms\Classes\Page as CmsPage;
1716
use Cms\Classes\Theme;
17+
use Cms\Classes\Controller;
18+
use RainLab\Blog\Classes\TagProcessor;
1819

20+
/**
21+
* Class Post
22+
*/
1923
class Post extends Model
2024
{
2125
use \October\Rain\Database\Traits\Validation;
@@ -141,22 +145,25 @@ public function beforeSave()
141145
/**
142146
* Sets the "url" attribute with a URL to this object.
143147
* @param string $pageName
144-
* @param Cms\Classes\Controller $controller
148+
* @param Controller $controller
149+
* @param array $urlParams A mapping of possible overrides of default URL parameter names
150+
*
151+
* @return string
145152
*/
146-
public function setUrl($pageName, $controller)
153+
public function setUrl($pageName, $controller, array $urlParams = array())
147154
{
148155
$params = [
149-
'id' => $this->id,
150-
'slug' => $this->slug
156+
array_get($urlParams, 'id', 'id') => $this->id,
157+
array_get($urlParams, 'slug', 'slug') => $this->slug,
151158
];
152159

153160
$params['category'] = $this->categories->count() ? $this->categories->first()->slug : null;
154161

155162
// Expose published year, month and day as URL parameters.
156163
if ($this->published) {
157-
$params['year'] = $this->published_at->format('Y');
158-
$params['month'] = $this->published_at->format('m');
159-
$params['day'] = $this->published_at->format('d');
164+
$params[array_get($urlParams, 'year', 'year')] = $this->published_at->format('Y');
165+
$params[array_get($urlParams, 'month', 'month')] = $this->published_at->format('m');
166+
$params[array_get($urlParams, 'day', 'day')] = $this->published_at->format('d');
160167
}
161168

162169
return $this->url = $controller->pageUrl($pageName, $params);

0 commit comments

Comments
 (0)