Page::getOutputFilePath() - Code Metrics - Inspection of "feat: path prefix for default language" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — language-path ( 87e460 )

by Arnaud

created 2023-10-20 13:41 UTC

Page::getOutputFilePath() B

↳ Parent: Page

Complexity

Conditions	10
Paths	32

Size

Total Lines	30
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	17
c	0
b	0
f	0
nc	32
nop	2
dl	0
loc	30
rs	7.6666

How to fix Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Renderer;

use Cecil\Collection\Page\Page as PageItem;
use Cecil\Config;

/**
 * Class Renderer\Page.
 */
class Page
{
    /** @var Config */
    protected $config;

    public function __construct(Config $config)
    {
        $this->config = $config;
    }

    /**
     * Returns the path of the rendered file, based on the output format properties.
     *
     * Use cases:
     *   - default: path + filename + extension (e.g.: 'blog/post-1/index.html')
     *   - with subpath: path + subpath + filename + extension (e.g.: 'blog/post-1/amp/index.html')
     *   - ugly URL: path + extension (e.g.: '404.html', 'sitemap.xml', 'robots.txt')
     *   - path only (e.g.: '_redirects')
     *   - i18n: language code + default (e.g.: 'fr/blog/page/index.html')
     *
     * @param PageItem $page
     * @param string   $format Output format (ie: 'html', 'amp', 'json', etc.)
     */
    public function getOutputFilePath(PageItem $page, string $format): string
    {
        $path = $page->getPath();
        $subpath = (string) $this->config->getOutputFormatProperty($format, 'subpath');
        $filename = (string) $this->config->getOutputFormatProperty($format, 'filename');
        $extension = (string) $this->config->getOutputFormatProperty($format, 'extension');
        $uglyurl = (bool) $page->getVariable('uglyurl');
        $language = $page->getVariable('language');
        // is ugly URL?
        if ($uglyurl) {
            $filename = '';
        }
        // add extension if exists
        if ($extension) {
            $extension = sprintf('.%s', $extension);
        }
        // homepage special case (need "index")
        if (empty($path) && empty($filename)) {
            $path = 'index';
        }
        // do not prefix path with language code for the default language
        if ($language === null || ($language == $this->config->getLanguageDefault() && !$this->config->get('language.prefix'))) {
            $language = '';
        }
        // do not prefix path of the home page with language code for the default language
        if ($language == $this->config->getLanguageDefault() && $page->getType() == 'homepage') {
            $language = '';
        }

        return \Cecil\Util::joinPath($language, $path, $subpath, $filename) . $extension;
    }

    /**
     * Returns the public URL.
     *
     * @param PageItem $page
     * @param string   $format Output format (ie: 'html', 'amp', 'json', etc.), 'html' by default
     */
    public function getUrl(PageItem $page, string $format = 'html'): string
    {
        $output = $this->getOutputFilePath($page, $format);

        // remove "index.html" if not uglyurl
        if (!($page->getVariable('uglyurl') ?? false)) {
            $output = str_replace('index.html', '', $output);
        }

        return $output;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of Cecil.
7			*
8			* Copyright (c) Arnaud Ligny <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Cecil\Renderer;
15
16			use Cecil\Collection\Page\Page as PageItem;
17			use Cecil\Config;
18
19			/**
20			* Class Renderer\Page.
21			*/
22			class Page
23			{
24			/** @var Config */
25			protected $config;
26
27			public function __construct(Config $config)
28			{
29			$this->config = $config;
30			}
31
32			/**
33			* Returns the path of the rendered file, based on the output format properties.
34			*
35			* Use cases:
36			* - default: path + filename + extension (e.g.: 'blog/post-1/index.html')
37			* - with subpath: path + subpath + filename + extension (e.g.: 'blog/post-1/amp/index.html')
38			* - ugly URL: path + extension (e.g.: '404.html', 'sitemap.xml', 'robots.txt')
39			* - path only (e.g.: '_redirects')
40			* - i18n: language code + default (e.g.: 'fr/blog/page/index.html')
41			*
42			* @param PageItem $page
43			* @param string $format Output format (ie: 'html', 'amp', 'json', etc.)
44			*/
45			public function getOutputFilePath(PageItem $page, string $format): string
46			{
47			$path = $page->getPath();
48			$subpath = (string) $this->config->getOutputFormatProperty($format, 'subpath');
49			$filename = (string) $this->config->getOutputFormatProperty($format, 'filename');
50			$extension = (string) $this->config->getOutputFormatProperty($format, 'extension');
51			$uglyurl = (bool) $page->getVariable('uglyurl');
52			$language = $page->getVariable('language');
53			// is ugly URL?
54			if ($uglyurl) {
55			$filename = '';
56			}
57			// add extension if exists
58			if ($extension) {
59			$extension = sprintf('.%s', $extension);
60			}
61			// homepage special case (need "index")
62			if (empty($path) && empty($filename)) {
63			$path = 'index';
64			}
65			// do not prefix path with language code for the default language
66			if ($language === null \|\| ($language == $this->config->getLanguageDefault() && !$this->config->get('language.prefix'))) {
67			$language = '';
68			}
69			// do not prefix path of the home page with language code for the default language
70			if ($language == $this->config->getLanguageDefault() && $page->getType() == 'homepage') {
71			$language = '';
72			}
73
74			return \Cecil\Util::joinPath($language, $path, $subpath, $filename) . $extension;
75			}
76
77			/**
78			* Returns the public URL.
79			*
80			* @param PageItem $page
81			* @param string $format Output format (ie: 'html', 'amp', 'json', etc.), 'html' by default
82			*/
83			public function getUrl(PageItem $page, string $format = 'html'): string
84			{
85			$output = $this->getOutputFilePath($page, $format);
86
87			// remove "index.html" if not uglyurl
88			if (!($page->getVariable('uglyurl') ?? false)) {
89			$output = str_replace('index.html', '', $output);
90			}
91
92			return $output;
93			}
94			}
95

Cecilapp / Cecil

Push — language-path ( 87e460 )

Page::getOutputFilePath() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like