16580139702

Committed 28 Jul 2025 08:57PM UTC coverage: 81.813% (-0.02%) from 81.83%

Build # 16580139702

Build Type

push

github

Committed by

ArnaudLigny

Commit Message

feat: use base path if exists

Run Details

1 of 2 new or added lines in 1 file covered. (50.0%)

3140 of 3838 relevant lines covered (81.81%)

0.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.21

/src/Url.php

<?php

/**
 * This file is part of Cecil.
 *
 * (c) Arnaud Ligny <arnaud@ligny.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cecil;

use Cecil\Assets\Asset;
use Cecil\Builder;
use Cecil\Collection\Menu\Entry as MenuEntry;
use Cecil\Collection\Page\Page;
use Cecil\Config;
use Cecil\Renderer\Page as PageRenderer;
use Cecil\Util;
use Cocur\Slugify\Slugify;

/**
 * URL class.
 *
 * Builds an URL from a Page, a Menu Entry, an Asset or a string.
 */
class Url
{
    /** @var Builder */
    protected $builder;

    /** @var Config */
    protected $config;

    /** @var string */
    protected $url;

    /** @var Page Slugifier */
    private static $slugifier;

    /**
     * Creates an URL from a Page, a Menu Entry, an Asset or a string.
     *
     * @param Builder                          $builder
     * @param Page|MenuEntry|Asset|string|null $value
     * @param array|null                       $options Rendering options, e.g.: ['canonical' => true, 'format' => 'html', 'language' => 'fr']
     */
    public function __construct(Builder $builder, $value, ?array $options = null)
    {
        $this->builder = $builder;
        $this->config = $builder->getConfig();
        if (!self::$slugifier instanceof Slugify) {
            self::$slugifier = Slugify::create(['regexp' => Page::SLUGIFY_PATTERN]);
        }

        // handles options
        $canonical = null; // if true prefix url with baseurl config
        $format = null;    // output format
        $language = null;  // force language
        extract(\is_array($options) ? $options : [], EXTR_IF_EXISTS);

        // base URL
        $base = '';
        // enable canonical URL
        if ($this->config->isEnabled('canonicalurl') || $canonical === true) {
            $base = rtrim((string) $this->config->get('baseurl'), '/');
        }
        // disable canonical URL by option
        if ($canonical === false) {
            $base = '';
        }
        // use base path if exists
        if ($base == '' && $basepath = trim(parse_url((string) $this->config->get('baseurl'), PHP_URL_PATH), '/')) {
            $base = $basepath;
        }

        // if value is empty (i.e.: `url()`) returns home URL
        if (\is_null($value) || empty($value) || $value == '/') {
            $this->url = $base . '/';

            return;
        }

        switch (true) {
            case $value instanceof Page: // $value is a Page
                /** @var Page $value */
                if (!$format) {
                    $format = $value->getVariable('output');
                    if (\is_array($value->getVariable('output'))) {
                        $default = array_search('html', $value->getVariable('output')) ?: 0;
                        $format = $value->getVariable('output')[$default];
                    }
                    if (!$format) {
                        $format = 'html';
                    }
                }
                $this->url = $base . '/' . ltrim((new PageRenderer($this->config))->getPublicFilePath($value, $format), '/');
                if ($canonical && $value->hasVariable('canonical') && $value->getVariable('canonical')['url']) { // canonical URL
                    $this->url = $value->getVariable('canonical')['url'];
                }
                break;
            case $value instanceof MenuEntry: // $value is a Menu Entry
                /** @var MenuEntry $value */
                if (Util\File::isRemote($value['url'])) {
                    $this->url = $value['url'];
                    break;
                }
                $this->url = $base . '/' . ltrim($value['url'], '/');
                break;
            case $value instanceof Asset: // $value is an Asset
                /** @var Asset $value */
                $this->url = $base . '/' . ltrim($value['path'], '/');
                if ($value->isImageInCdn()) {
                    $this->url = (string) $value;
                }
                break;
            case \is_string($value): // others cases
                /** @var string $value */
                // $value is a potential Page ID
                $pageId = self::$slugifier->slugify($value);
                // should force language?
                $lang = '';
                if ($language !== null && $language != $this->config->getLanguageDefault()) {
                    $pageId = "$language/$pageId";
                    $lang = "$language/";
                }
                switch (true) {
                    case Util\File::isRemote($value): // $value is an external URL
                        $this->url = $value;
                        break;
                    case $this->builder->getPages()->has($pageId): // $pageId exists in pages collection
                        $this->url = (string) new self($this->builder, $this->builder->getPages()->get($pageId), $options);
                        break;
                    default:
                        // remove double language prefix
                        if ($lang && Util\Str::startsWith($value, $lang)) {
                            $value = substr($value, \strlen($lang));
                        }
                        $this->url = $base . '/' . $lang . ltrim($value, '/');
                }
        }
    }

    /**
     * If called like a string returns built URL.
     */
    public function __toString(): string
    {
        return $this->getUrl();
    }

    /**
     * Returns built URL.
     */
    public function getUrl(): string
    {
        return (string) $this->url;
    }
}

1	<?php
2
3	/**
4	* This file is part of Cecil.
5	*
6	* (c) Arnaud Ligny <arnaud@ligny.fr>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace Cecil;
15
16	use Cecil\Assets\Asset;
17	use Cecil\Builder;
18	use Cecil\Collection\Menu\Entry as MenuEntry;
19	use Cecil\Collection\Page\Page;
20	use Cecil\Config;
21	use Cecil\Renderer\Page as PageRenderer;
22	use Cecil\Util;
23	use Cocur\Slugify\Slugify;
24
25	/**
26	* URL class.
27	*
28	* Builds an URL from a Page, a Menu Entry, an Asset or a string.
29	*/
30	class Url
31	{
32	/** @var Builder */
33	protected $builder;
34
35	/** @var Config */
36	protected $config;
37
38	/** @var string */
39	protected $url;
40
41	/** @var Page Slugifier */
42	private static $slugifier;
43
44	/**
45	* Creates an URL from a Page, a Menu Entry, an Asset or a string.
46	*
47	* @param Builder $builder
48	* @param Page\|MenuEntry\|Asset\|string\|null $value
49	* @param array\|null $options Rendering options, e.g.: ['canonical' => true, 'format' => 'html', 'language' => 'fr']
50	*/
51	public function __construct(Builder $builder, $value, ?array $options = null)
52	{
53	$this->builder = $builder;	1✔
54	$this->config = $builder->getConfig();	1✔
55	if (!self::$slugifier instanceof Slugify) {	1✔
56	self::$slugifier = Slugify::create(['regexp' => Page::SLUGIFY_PATTERN]);	1✔
57	}
58
59	// handles options
60	$canonical = null; // if true prefix url with baseurl config	1✔
61	$format = null; // output format	1✔
62	$language = null; // force language	1✔
63	extract(\is_array($options) ? $options : [], EXTR_IF_EXISTS);	1✔
64
65	// base URL
66	$base = '';	1✔
67	// enable canonical URL
68	if ($this->config->isEnabled('canonicalurl') \|\| $canonical === true) {	1✔
69	$base = rtrim((string) $this->config->get('baseurl'), '/');	1✔
70	}
71	// disable canonical URL by option
72	if ($canonical === false) {	1✔
73	$base = '';	1✔
74	}
75	// use base path if exists
76	if ($base == '' && $basepath = trim(parse_url((string) $this->config->get('baseurl'), PHP_URL_PATH), '/')) {	1✔
NEW 77	$base = $basepath;	×
78	}
79
80	// if value is empty (i.e.: `url()`) returns home URL
81	if (\is_null($value) \|\| empty($value) \|\| $value == '/') {	1✔
82	$this->url = $base . '/';	1✔
83
84	return;	1✔
85	}
86
87	switch (true) {
88	case $value instanceof Page: // $value is a Page	1✔
89	/** @var Page $value */
90	if (!$format) {	1✔
91	$format = $value->getVariable('output');	1✔
92	if (\is_array($value->getVariable('output'))) {	1✔
93	$default = array_search('html', $value->getVariable('output')) ?: 0;	1✔
94	$format = $value->getVariable('output')[$default];	1✔
95	}
96	if (!$format) {	1✔
97	$format = 'html';	1✔
98	}
99	}
100	$this->url = $base . '/' . ltrim((new PageRenderer($this->config))->getPublicFilePath($value, $format), '/');	1✔
101	if ($canonical && $value->hasVariable('canonical') && $value->getVariable('canonical')['url']) { // canonical URL	1✔
102	$this->url = $value->getVariable('canonical')['url'];	×
103	}
104	break;	1✔
105	case $value instanceof MenuEntry: // $value is a Menu Entry	1✔
106	/** @var MenuEntry $value */
107	if (Util\File::isRemote($value['url'])) {	×
108	$this->url = $value['url'];	×
109	break;	×
110	}
111	$this->url = $base . '/' . ltrim($value['url'], '/');	×
112	break;	×
113	case $value instanceof Asset: // $value is an Asset	1✔
114	/** @var Asset $value */
115	$this->url = $base . '/' . ltrim($value['path'], '/');	1✔
116	if ($value->isImageInCdn()) {	1✔
117	$this->url = (string) $value;	×
118	}
119	break;	1✔
120	case \is_string($value): // others cases	1✔
121	/** @var string $value */
122	// $value is a potential Page ID
123	$pageId = self::$slugifier->slugify($value);	1✔
124	// should force language?
125	$lang = '';	1✔
126	if ($language !== null && $language != $this->config->getLanguageDefault()) {	1✔
127	$pageId = "$language/$pageId";	1✔
128	$lang = "$language/";	1✔
129	}
130	switch (true) {
131	case Util\File::isRemote($value): // $value is an external URL	1✔
132	$this->url = $value;	1✔
133	break;	1✔
134	case $this->builder->getPages()->has($pageId): // $pageId exists in pages collection	1✔
135	$this->url = (string) new self($this->builder, $this->builder->getPages()->get($pageId), $options);	1✔
136	break;	1✔
137	default:
138	// remove double language prefix
139	if ($lang && Util\Str::startsWith($value, $lang)) {	1✔
140	$value = substr($value, \strlen($lang));	1✔
141	}
142	$this->url = $base . '/' . $lang . ltrim($value, '/');	1✔
143	}
144	}
145	}
146
147	/**
148	* If called like a string returns built URL.
149	*/
150	public function __toString(): string
151	{
152	return $this->getUrl();	1✔
153	}
154
155	/**
156	* Returns built URL.
157	*/
158	public function getUrl(): string
159	{
160	return (string) $this->url;	1✔
161	}
162	}

Cecilapp / Cecil / 16580139702

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous