github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2024-11-25 09:41:49 +08:00
Code Issues Actions 46 Packages Projects Releases Wiki Activity

Centralize pagination/canonical meta URL generation in Document (#3077)

Browse Source 
* Centralize pagination/canonical meta URL generation in Document

* Apply fixes from StyleCI

[ci skip] [skip ci]

* Use translations for title template

* Apply fixes from StyleCI

[ci skip] [skip ci]

* Dont add translator to title driver interface

It's an implementation detail, and can be made available on specific implementations as needed.

Co-authored-by: Alexander Skvortsov <askvortsov1@users.noreply.github.com>
This commit is contained in:
Alexander Skvortsov 2021-12-03 13:31:50 -05:00 committed by GitHub
parent 118e28b27a
commit 60c3e2fe77
5 changed files with 99 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
framework/core/locale/core.yml
View File

@ -628,6 +628,11 @@ core:
submit_button: => core.ref.save_changes
title: => core.ref.reset_your_password
# Translations in this namespace are used to format page meta titles.
meta_titles:
with_page_title: "{pageNumber, plural, =1 {{pageTitle} - {forumName}} other {{pageTitle}: Page # - {forumName}}}"
without_page_title: "{pageNumber, plural, =1 {{forumName}} other {Page # - {forumName}}}"
# Translations in this namespace are used in messages output by the API.
api:
invalid_username_message: "The username may only contain letters, numbers, and dashes."

5
framework/core/src/Forum/Content/Discussion.php
View File

@ -97,10 +97,13 @@ class Discussion
$hasNextPage = $page < 1 + intval($apiDocument->data->attributes->commentCount / 20);
$document->title = $apiDocument->data->attributes->title;
$document->canonicalUrl = $url(['page' => $page]);
$document->content = $this->view->make('flarum.forum::frontend.content.discussion', compact('apiDocument', 'page', 'hasPrevPage', 'hasNextPage', 'getResource', 'posts', 'url'));
$document->payload['apiDocument'] = $apiDocument;
$document->canonicalUrl = $url([]);
$document->page = $page;
$document->hasNextPage = $hasNextPage;
return $document;
}

3
framework/core/src/Forum/Content/Index.php
View File

@ -88,7 +88,10 @@ class Index
$document->title = $this->translator->trans('core.forum.index.meta_title_text');
$document->content = $this->view->make('flarum.forum::frontend.content.index', compact('apiDocument', 'page'));
$document->payload['apiDocument'] = $apiDocument;
$document->canonicalUrl = $this->url->to('forum')->base().($defaultRoute === '/all' ? '' : $request->getUri()->getPath());
$document->page = $page;
$document->hasNextPage = isset($apiDocument->links->next);
return $document;
}

68
framework/core/src/Frontend/Document.php
View File

@ -95,6 +95,24 @@ class Document implements Renderable
*/
public $canonicalUrl;
/**
* Which page of content are we on?
*
* This is used to build prev/next meta links for SEO.
*
* @var null|int
*/
public $page;
/**
* Is there a next page?
*
* This is used with $page to build next meta links for SEO.
*
* @var null|bool
*/
public $hasNextPage;
/**
* An array of strings to append to the page's <head>.
*
@ -243,8 +261,17 @@ class Document implements Renderable
return '<link rel="stylesheet" href="'.e($url).'">';
}, $this->css);
if ($this->page) {
if ($this->page > 1) {
$head[] = '<link rel="prev" href="'.e(self::setPageParam($this->canonicalUrl, $this->page - 1)).'">';
}
if ($this->hasNextPage) {
$head[] = '<link rel="next" href="'.e(self::setPageParam($this->canonicalUrl, $this->page + 1)).'">';
}
}
if ($this->canonicalUrl) {
$head[] = '<link rel="canonical" href="'.e($this->canonicalUrl).'">';
$head[] = '<link rel="canonical" href="'.e(self::setPageParam($this->canonicalUrl, $this->page)).'">';
}
$head = array_merge($head, $this->makePreloads());
@ -289,4 +316,43 @@ class Document implements Renderable
{
$this->forumApiDocument = $forumApiDocument;
}
public static function setPageParam(string $url, ?int $page)
{
if (! $page || $page === 1) {
return self::setQueryParam($url, 'page', null);
}
return self::setQueryParam($url, 'page', (string) $page);
}
/**
* Set or override a query param on a string URL to a particular value.
*/
protected static function setQueryParam(string $url, string $key, ?string $value)
{
if (filter_var($url, FILTER_VALIDATE_URL)) {
$urlParts = parse_url($url);
if (isset($urlParts['query'])) {
parse_str($urlParts['query'], $urlQueryArgs);
if ($value === null) {
unset($urlQueryArgs[$key]);
} else {
$urlQueryArgs[$key] = $value;
}
$urlParts['query'] = http_build_query($urlQueryArgs);
$newUrl = $urlParts['scheme'].'://'.$urlParts['host'].$urlParts['path'].'?'.$urlParts['query'];
} elseif ($value !== null) {
$newUrl = $url.'?'.http_build_query([$key => $value]);
} else {
return $url;
}
return $newUrl;
} else {
return $url;
}
}
}

21
framework/core/src/Frontend/Driver/BasicTitleDriver.php
View File

@ -12,13 +12,32 @@ namespace Flarum\Frontend\Driver;
use Flarum\Frontend\Document;
use Illuminate\Support\Arr;
use Psr\Http\Message\ServerRequestInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
class BasicTitleDriver implements TitleDriverInterface
{
/**
* @var TranslatorInterface
*/
protected $translator;
public function __construct(TranslatorInterface $translator)
{
$this->translator = $translator;
}
public function makeTitle(Document $document, ServerRequestInterface $request, array $forumApiDocument): string
{
$onHomePage = rtrim($request->getUri()->getPath(), '/') === '';
return ($document->title && ! $onHomePage ? $document->title.' - ' : '').Arr::get($forumApiDocument, 'data.attributes.title');
$params = [
'pageTitle' => $document->title ?? '',
'forumName' => Arr::get($forumApiDocument, 'data.attributes.title'),
'pageNumber' => $document->page ?? 1,
];
return $onHomePage || ! $document->title
? $this->translator->trans('core.views.meta_titles.without_page_title', $params)
: $this->translator->trans('core.views.meta_titles.with_page_title', $params);
}
}