Passed
Push — develop ( e3a9b8...5130a6 )
by nguereza
02:51
created

ServerRequestUrlGenerator::generatePageUrl()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 1
dl 0
loc 3
rs 10
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file ServerRequestUrlGenerator.php
34
 *
35
 *  The Pagination URL Generator using ServerRequestInteface
36
 *
37
 *  @package    Platine\Framework\Pagination
38
 *  @author Platine Developers team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   http://www.iacademy.cf
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Framework\Pagination;
49
50
use Platine\Http\ServerRequestInterface;
51
use Platine\Pagination\UrlGeneratorInterface;
52
53
/**
54
 * @class ServerRequestUrlGenerator
55
 * @package Platine\Framework\Pagination
56
 */
57
class ServerRequestUrlGenerator implements UrlGeneratorInterface
58
{
59
60
    /**
61
     * The server request instance
62
     * @var ServerRequestInterface
63
     */
64
    protected ServerRequestInterface $request;
65
66
    /**
67
     * The name of variable or key to use
68
     * @var string
69
     */
70
    protected string $queryVarName = 'page';
71
72
    /**
73
     * The current pagination URL pattern
74
     * @var string
75
     */
76
    protected string $url = '';
77
78
    /**
79
     * Create new instance
80
     * @param ServerRequestInterface $request
81
     * @param string $queryName
82
     */
83
    public function __construct(ServerRequestInterface $request, string $queryName)
84
    {
85
        $this->request = $request;
86
        $this->queryVarName = $queryName;
87
88
        $this->determineUri();
89
    }
90
91
    /**
92
     * {@inheritdoc}
93
     */
94
    public function generatePageUrl(int $page): string
95
    {
96
        return str_replace('{num}', (string) $page, $this->url);
97
    }
98
99
    /**
100
     * {@inheritdoc}
101
     */
102
    public function getUrlPattern(): string
103
    {
104
        return $this->url;
105
    }
106
107
    /**
108
     * Determine the pagination URL
109
     * @return void
110
     */
111
    protected function determineUri(): void
112
    {
113
        $uri = $this->request->getUri();
114
        $queryString = $uri->getQuery();
115
        $page = $this->queryVarName;
116
117
        $query = '';
118
        if (empty($queryString)) {
119
            $query = sprintf('?%s={num}', $page);
120
        } else {
121
            $parts = explode($page . '=', $queryString);
122
            $count = count($parts);
123
124
            if ($count === 1) {
125
                $query = sprintf('?%s&%s={num}', $queryString, $page);
126
            } else {
127
                if (empty($parts[0])) {
128
                    $query = sprintf('?%s={num}', $page);
129
                } else {
130
                    $query = sprintf('?%s%s={num}', $parts[0], $page);
131
                }
132
            }
133
        }
134
135
        $currentUrl = (string) $uri;
136
        $parts = explode('?', $currentUrl);
137
        $query = $parts[0] . $query;
138
        $this->url = $query;
139
    }
140
}
141