SimpleUrlGenerator::getUrlPattern()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Platine Pagination
5
 *
6
 * Platine Pagination is a lightweight PHP paginator, for generating pagination controls
7
 *
8
 * This content is released under the MIT License (MIT)
9
 *
10
 * Copyright (c) 2020 Platine Pagination
11
 * Copyright (c) 2014 Jason Grimes
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 SimpleUrlGenerator.php
34
 *
35
 *  The pagination simple URL generator class
36
 *
37
 *  @package    Platine\Pagination
38
 *  @author Platine Developers Team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   https://www.platine-php.com
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Pagination\UrlGenerator;
49
50
use Platine\Pagination\UrlGeneratorInterface;
51
52
/**
53
 * @class SimpleUrlGenerator
54
 * @package Platine\Pagination\UrlGenerator
55
 */
56
class SimpleUrlGenerator implements UrlGeneratorInterface
57
{
58
    /**
59
     * The URL pattern to use with placeholder (num)
60
     * @var string
61
     */
62
    protected string $urlPattern;
63
64
    /**
65
     * Create new instance
66
     * @param string $urlPattern
67
     */
68
    public function __construct(string $urlPattern = '/?page=(num)')
69
    {
70
        $this->urlPattern = $urlPattern;
71
    }
72
73
    /**
74
     * {@inheritdoc}
75
     */
76
    public function generatePageUrl(int $page): string
77
    {
78
        return str_replace('(num)', (string) $page, $this->urlPattern);
79
    }
80
81
    /**
82
     * {@inheritdoc}
83
     */
84
    public function getUrlPattern(): string
85
    {
86
        return $this->urlPattern;
87
    }
88
}
89