Config::isEnabled() - Code Metrics - Inspection of "refactor: configuration options and logic" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2148)

by Arnaud

created 2025-03-29 12:10 UTC

Config::isEnabled() A

↳ Parent: Config

Complexity

Conditions	5
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	5

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	5
eloc	5
c	2
b	0
f	0
nc	3
nop	3
dl	0
loc	10
ccs	6
cts	6
cp	1
crap	5
rs	9.6111

<?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;

use Cecil\Exception\ConfigException;
use Cecil\Exception\RuntimeException;
use Dflydev\DotAccessData\Data;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;

/**
 * Class Config.
 */
class Config
{
    /** Configuration is a Data object. */
    protected Data $data;

    /** Default configuration is a Data object. */
    protected Data $default;

    /** Source directory. */
    protected string $sourceDir;

    /** Destination directory. */
    protected string $destinationDir;

    /** Languages list as array. */
    protected ?array $languages = null;

    public const PRESERVE = 0;
    public const REPLACE = 1;
    public const MERGE = 2;
    public const LANG_CODE_PATTERN = '([a-z]{2}(-[A-Z]{2})?)'; // "fr" or "fr-FR"
    public const LANG_LOCALE_PATTERN = '[a-z]{2}(_[A-Z]{2})?(_[A-Z]{2})?'; // "fr" or "fr_FR" or "no_NO_NY"

    /**
     * Build the Config object with the default config + the optional given array.
     */
    public function __construct(?array $config = null)
    {
        // default configuration
        $defaultConfigFile = Util\File::getRealPath('../config/default.php');
        $this->default = new Data(include $defaultConfigFile);
        // base configuration
        $baseConfigFile = Util\File::getRealPath('../config/base.php');
        $this->data = new Data(include $baseConfigFile);
        // import config array if provided
        if ($config !== null) {
            $this->import($config);
        }
    }

    /**
     * Imports (and validate) configuration.
     * The mode can be: Config::PRESERVE, Config::REPLACE or Config::MERGE.
     */
    public function import(array $config, $mode = self::MERGE): void
    {
        $this->data->import($config, $mode);
        $this->setFromEnv(); // override configuration with environment variables
        $this->validate();   // validate configuration
    }

    /**
     * Get configuration as an array.
     */
    public function export(): array
    {
        return $this->data->export();
    }

    /**
     * Load and parse a YAML file.
     */
    public function loadFile(string $file): array
    {
        if (!Util\File::getFS()->exists($file)) {
            throw new ConfigException(\sprintf('File "%s" does not exist.', $file));
        }
        if (false === $fileContent = Util\File::fileGetContents($file)) {
            throw new ConfigException(\sprintf('Can\'t read file "%s".', $file));
        }
        try {
            return Yaml::parse($fileContent, Yaml::PARSE_DATETIME);
        } catch (ParseException $e) {
            throw new ConfigException(\sprintf('"%s" parsing error: %s', $file, $e->getMessage()));
        }
    }

    /**
     * Is configuration's key exists?
     *
     * @param string $key      Configuration key
     * @param string $language Language code (optional)
     * @param bool   $fallback Set to false to not return the value in the default language as fallback
     */
    public function has(string $key, ?string $language = null, bool $fallback = true): bool
    {
        $default = $this->default->has($key);

        if ($language !== null) {
            $langIndex = $this->getLanguageIndex($language);
            $keyLang = "languages.$langIndex.config.$key";
            if ($this->data->has($keyLang)) {
                return true;
            }
            if ($language !== $this->getLanguageDefault() && $fallback === false) {
                return $default;
            }
        }
        if ($this->data->has($key)) {
            return true;
        }

        return $default;
    }

    /**
     * Get the value of a configuration's key.
     *
     * @param string $key      Configuration key
     * @param string $language Language code (optional)
     * @param bool   $fallback Set to false to not return the value in the default language as fallback
     *
     * @return mixed|null
     */
    public function get(string $key, ?string $language = null, bool $fallback = true)
    {
        $default = $this->default->has($key) ? $this->default->get($key) : null;
        if ($language !== null) {
            $langIndex = $this->getLanguageIndex($language);
            $keyLang = "languages.$langIndex.config.$key";
            if ($this->data->has($keyLang)) {
                return $this->data->get($keyLang);
            }
            if ($language !== $this->getLanguageDefault() && $fallback === false) {
                return $default;
            }
        }
        if ($this->data->has($key)) {
            return $this->data->get($key);
        }

        return $default;
    }

    /**
     * Is an option is enabled?
     * Checks if the key is set to `false` or if subkey `enabled` is set to `false`.
     */
    public function isEnabled(string $key, ?string $language = null, bool $fallback = true): bool
    {
        if ($this->has("$key.enabled", $language, $fallback) && $this->get("$key.enabled", $language, $fallback) === true) {
            return true;
        }
        if ($this->has($key, $language, $fallback) && $this->get($key, $language, $fallback) !== false) {
            return true;
        }

        return false;
    }

    /**
     * Set the source directory.
     *
     * @throws \InvalidArgumentException
     */
    public function setSourceDir(string $sourceDir): self
    {
        if (!is_dir($sourceDir)) {
            throw new \InvalidArgumentException(\sprintf('The directory "%s" is not a valid source.', $sourceDir));
        }
        $this->sourceDir = $sourceDir;

        return $this;
    }

    /**
     * Get the source directory.
     */
    public function getSourceDir(): string
    {
        if ($this->sourceDir === null) {
            return getcwd();
        }

        return $this->sourceDir;
    }

    /**
     * Set the destination directory.
     *
     * @throws \InvalidArgumentException
     */
    public function setDestinationDir(string $destinationDir): self
    {
        if (!is_dir($destinationDir)) {
            throw new \InvalidArgumentException(\sprintf('The directory "%s" is not a valid destination.', $destinationDir));
        }
        $this->destinationDir = $destinationDir;

        return $this;
    }

    /**
     * Get the destination directory.
     */
    public function getDestinationDir(): string
    {
        if ($this->destinationDir === null) {
            return $this->getSourceDir();
        }

        return $this->destinationDir;
    }

    /*
     * Path helpers.
     */

    /**
     * Returns the path of the pages directory.
     */
    public function getPagesPath(): string
    {
        return Util::joinFile($this->getSourceDir(), (string) $this->get('pages.dir'));
    }

    /**
     * Returns the path of the output directory.
     */
    public function getOutputPath(): string
    {
        return Util::joinFile($this->getDestinationDir(), (string) $this->get('output.dir'));
    }

    /**
     * Returns the path of the data directory.
     */
    public function getDataPath(): string
    {
        return Util::joinFile($this->getSourceDir(), (string) $this->get('data.dir'));
    }

    /**
     * Returns the path of templates directory.
     */
    public function getLayoutsPath(): string
    {
        return Util::joinFile($this->getSourceDir(), (string) $this->get('layouts.dir'));
    }

    /**
     * Returns the path of internal templates directory.
     */
    public function getLayoutsInternalPath(): string
    {
        return __DIR__ . '/../resources/layouts';
    }

    /**
     * Returns the layout for a section.
     */
    public function getLayoutSection(?string $section): ?string
    {
        if ($layout = $this->get('layouts.sections')[$section] ?? null) {
            return $layout;
        }

        return $section;
    }

    /**
     * Returns the path of translations directory.
     */
    public function getTranslationsPath(): string
    {
        return Util::joinFile($this->getSourceDir(), (string) $this->get('layouts.translations.dir'));
    }

    /**
     * Returns the path of internal translations directory.
     */
    public function getTranslationsInternalPath(): string
    {
        return Util\File::getRealPath('../resources/translations');
    }

    /**
     * Returns the path of themes directory.
     */
    public function getThemesPath(): string
    {
        return Util::joinFile($this->getSourceDir(), 'themes');
    }

    /**
     * Returns the path of static files directory.
     */
    public function getStaticPath(): string
    {
        return Util::joinFile($this->getSourceDir(), (string) $this->get('static.dir'));
    }

    /**
     * Returns the path of static files directory, with a target.
     */
    public function getStaticTargetPath(): string
    {
        $path = $this->getStaticPath();
        if (!empty($this->get('static.target'))) {
            $path = substr($path, 0, -\strlen((string) $this->get('static.target')));
        }

        return $path;
    }

    /**
     * Returns the path of assets files directory.
     */
    public function getAssetsPath(): string
    {
        return Util::joinFile($this->getSourceDir(), (string) $this->get('assets.dir'));
    }

    /**
     * Returns the path of remote assets files directory (in cache).
     *
     * @return string
     */
    public function getAssetsRemotePath(): string
    {
        return Util::joinFile($this->getCacheAssetsPath(), 'remote');
    }

    /**
     * Returns cache path.
     *
     * @throws ConfigException
     */
    public function getCachePath(): string
    {
        if (empty((string) $this->get('cache.dir'))) {
            throw new ConfigException(\sprintf('The cache directory (`%s`) is not defined.', 'cache.dir'));
        }
        if ($this->isCacheDirIsAbsolute()) {
            $cacheDir = Util::joinFile((string) $this->get('cache.dir'), 'cecil');
            Util\File::getFS()->mkdir($cacheDir);

            return $cacheDir;
        }

        return Util::joinFile($this->getDestinationDir(), (string) $this->get('cache.dir'));
    }

    /**
     * Returns cache path of templates.
     */
    public function getCacheTemplatesPath(): string
    {
        return Util::joinFile($this->getCachePath(), 'templates');
    }

    /**
     * Returns cache path of translations.
     */
    public function getCacheTranslationsPath(): string
    {
        return Util::joinFile($this->getCachePath(), 'translations');
    }

    /**
     * Returns cache path of assets.
     */
    public function getCacheAssetsPath(): string
    {
        return Util::joinFile($this->getCachePath(), 'assets');
    }

    /**
     * Returns cache path of assets files.
     */
    public function getCacheAssetsFilesPath(): string
    {
        return Util::joinFile($this->getCacheAssetsPath(), 'files');
    }

    /*
     * Output helpers.
     */

    /**
     * Returns the property value of an output format.
     *
     * @throws ConfigException
     */
    public function getOutputFormatProperty(string $name, string $property): string|array|null
    {
        $properties = array_column((array) $this->get('output.formats'), $property, 'name');
        if (empty($properties)) {
            throw new ConfigException(\sprintf('Property "%s" is not defined for format "%s".', $property, $name));
        }

        return $properties[$name] ?? null;
    }

    /*
     * Assets helpers.
     */

    /**
     * Returns asset image widths.
     * Default: [480, 640, 768, 1024, 1366, 1600, 1920].
     */
    public function getAssetsImagesWidths(): array
    {
        return $this->get('assets.images.responsive.widths') ?? [480, 640, 768, 1024, 1366, 1600, 1920];
    }

    /**
     * Returns asset image sizes.
     * Default: ['default' => '100vw'].
     */
    public function getAssetsImagesSizes(): array
    {
        return $this->get('assets.images.responsive.sizes') ?? ['default' => '100vw'];
    }

    /*
     * Theme helpers.
     */

    /**
     * Returns theme(s) as an array.
     */
    public function getTheme(): ?array
    {
        if ($themes = $this->get('theme')) {
            if (\is_array($themes)) {
                return $themes;
            }

            return [$themes];
        }

        return null;
    }

    /**
     * Has a (valid) theme(s)?
     *
     * @throws ConfigException
     */
    public function hasTheme(): bool
    {
        if ($themes = $this->getTheme()) {
            foreach ($themes as $theme) {
                if (!Util\File::getFS()->exists($this->getThemeDirPath($theme, 'layouts')) && !Util\File::getFS()->exists(Util::joinFile($this->getThemesPath(), $theme, 'config.yml'))) {
                    throw new ConfigException(\sprintf('Theme "%s" not found. Did you forgot to install it?', $theme));
                }
            }

            return true;
        }

        return false;
    }

    /**
     * Returns the path of a specific theme's directory.
     * ("layouts" by default).
     */
    public function getThemeDirPath(string $theme, string $dir = 'layouts'): string
    {
        return Util::joinFile($this->getThemesPath(), $theme, $dir);
    }

    /*
     * Language helpers.
     */

    /**
     * Returns an array of available languages.
     *
     * @throws ConfigException
     */
    public function getLanguages(): array
    {
        if ($this->languages !== null) {
            return $this->languages;
        }
        $languages = array_filter((array) $this->get('languages'), function ($language) {
            return !(isset($language['enabled']) && $language['enabled'] === false);
        });
        if (!\is_int(array_search($this->getLanguageDefault(), array_column($languages, 'code')))) {
            throw new ConfigException(\sprintf('The default language "%s" is not listed in "languages".', $this->getLanguageDefault()));
        }
        $this->languages = $languages;

        return $this->languages;
    }

    /**
     * Returns the default language code (ie: "en", "fr-FR", etc.).
     *
     * @throws ConfigException
     */
    public function getLanguageDefault(): string
    {
        if (!$this->get('language')) {
            throw new ConfigException('There is no default "language" key.');
        }
        if (\is_array($this->get('language'))) {
            if (!$this->get('language.code')) {
                throw new ConfigException('There is no "language.code" key.');
            }

            return $this->get('language.code');
        }

        return $this->get('language');
    }

    /**
     * Returns a language code index.
     *
     * @throws ConfigException
     */
    public function getLanguageIndex(string $code): int
    {
        $array = array_column($this->getLanguages(), 'code');
        if (false === $index = array_search($code, $array)) {
            throw new ConfigException(\sprintf('The language code "%s" is not defined.', $code));
        }

        return $index;
    }

    /**
     * Returns the property value of a (specified or the default) language.
     *
     * @throws ConfigException
     */
    public function getLanguageProperty(string $property, ?string $code = null): string
    {
        $code = $code ?? $this->getLanguageDefault();
        $properties = array_column($this->getLanguages(), $property, 'code');
        if (empty($properties)) {
            throw new ConfigException(\sprintf('Property "%s" is not defined for language "%s".', $property, $code));
        }

        return $properties[$code];
    }

    /*
     * Cache helpers.
     */

    /**
     * Is cache dir is absolute to system files
     * or relative to project destination?
     */
    public function isCacheDirIsAbsolute(): bool
    {
        $path = (string) $this->get('cache.dir');
        if (Util::joinFile($path) == realpath(Util::joinFile($path))) {
            return true;
        }

        return false;
    }

    /*
     * Private functions.
     */

    /**
     * Set configuration from environment variables starting with "CECIL_".
     */
    private function setFromEnv(): void
    {
        foreach (getenv() as $key => $value) {
            if (str_starts_with($key, 'CECIL_')) {
                $this->data->set(str_replace(['cecil_', '_'], ['', '.'], strtolower($key)), $this->castSetValue($value));
            }
        }
    }

    /**
     * Casts boolean value given to set() as string.
     *
     * @param mixed $value
     *
     * @return bool|mixed
     */
    private function castSetValue($value)
    {
        $filteredValue = filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);

        if ($filteredValue !== null) {
            return $filteredValue;
        }

        return $value;
    }

    /**
     * Validate the configuration.
     *
     * @throws ConfigException
     */
    private function validate(): void
    {
        // default language must be valid
        if (!preg_match('/^' . Config::LANG_CODE_PATTERN . '$/', $this->getLanguageDefault())) {
            throw new ConfigException(\sprintf('Default language code "%s" is not valid (e.g.: "language: fr-FR").', $this->getLanguageDefault()));
        }
        // if language is set then the locale is required and must be valid
        foreach ((array) $this->get('languages') as $lang) {
            if (!isset($lang['locale'])) {
                throw new ConfigException('A language locale is not defined.');
            }
            if (!preg_match('/^' . Config::LANG_LOCALE_PATTERN . '$/', $lang['locale'])) {
                throw new ConfigException(\sprintf('The language locale "%s" is not valid (e.g.: "locale: fr_FR").', $lang['locale']));
            }
        }

        // check for deprecated options
        $deprecatedConfigFile = Util\File::getRealPath('../config/deprecated.php');
        $deprecatedConfig = require $deprecatedConfigFile;
        array_walk($deprecatedConfig, function ($to, $from) {
            if ($this->has($from)) {
                if (empty($to)) {
                    throw new ConfigException("Option `$from` is deprecated and must be removed.");
                }
                $path = explode(':', $to);
                $step = 0;
                $formatedPath = '';
                foreach ($path as $fragment) {
                    $step = $step + 2;
                    $formatedPath .= "$fragment:\n" . str_pad(' ', $step);
                }
                throw new ConfigException("Option `$from` must be moved to:\n```\n$formatedPath\n```");
            }
        });
    }
}


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;
15
16		use Cecil\Exception\ConfigException;
17		use Cecil\Exception\RuntimeException;
18		use Dflydev\DotAccessData\Data;
19		use Symfony\Component\Yaml\Exception\ParseException;
20		use Symfony\Component\Yaml\Yaml;
21
22		/**
23		* Class Config.
24		*/
25		class Config
26		{
27		/** Configuration is a Data object. */
28		protected Data $data;
29
30		/** Default configuration is a Data object. */
31		protected Data $default;
32
33		/** Source directory. */
34		protected string $sourceDir;
35
36		/** Destination directory. */
37		protected string $destinationDir;
38
39		/** Languages list as array. */
40		protected ?array $languages = null;
41
42		public const PRESERVE = 0;
43		public const REPLACE = 1;
44		public const MERGE = 2;
45		public const LANG_CODE_PATTERN = '([a-z]{2}(-[A-Z]{2})?)'; // "fr" or "fr-FR"
46		public const LANG_LOCALE_PATTERN = '[a-z]{2}(_[A-Z]{2})?(_[A-Z]{2})?'; // "fr" or "fr_FR" or "no_NO_NY"
47
48		/**
49		* Build the Config object with the default config + the optional given array.
50		*/
51	1	public function __construct(?array $config = null)
52		{
53		// default configuration
54	1	$defaultConfigFile = Util\File::getRealPath('../config/default.php');
55	1	$this->default = new Data(include $defaultConfigFile);
56		// base configuration
57	1	$baseConfigFile = Util\File::getRealPath('../config/base.php');
58	1	$this->data = new Data(include $baseConfigFile);
59		// import config array if provided
60	1	if ($config !== null) {
61	1	$this->import($config);
62		}
63		}
64
65		/**
66		* Imports (and validate) configuration.
67		* The mode can be: Config::PRESERVE, Config::REPLACE or Config::MERGE.
68		*/
69	1	public function import(array $config, $mode = self::MERGE): void
70		{
71	1	$this->data->import($config, $mode);
72	1	$this->setFromEnv(); // override configuration with environment variables
73	1	$this->validate(); // validate configuration
74		}
75
76		/**
77		* Get configuration as an array.
78		*/
79		public function export(): array
80		{
81		return $this->data->export();
82		}
83
84		/**
85		* Load and parse a YAML file.
86		*/
87		public function loadFile(string $file): array
88		{
89		if (!Util\File::getFS()->exists($file)) {
90		throw new ConfigException(\sprintf('File "%s" does not exist.', $file));
91		}
92		if (false === $fileContent = Util\File::fileGetContents($file)) {
93		throw new ConfigException(\sprintf('Can\'t read file "%s".', $file));
94		}
95		try {
96		return Yaml::parse($fileContent, Yaml::PARSE_DATETIME);
97		} catch (ParseException $e) {
98		throw new ConfigException(\sprintf('"%s" parsing error: %s', $file, $e->getMessage()));
99		}
100		}
101
102		/**
103		* Is configuration's key exists?
104		*
105		* @param string $key Configuration key
106		* @param string $language Language code (optional)
107		* @param bool $fallback Set to false to not return the value in the default language as fallback
108		*/
109	1	public function has(string $key, ?string $language = null, bool $fallback = true): bool
110		{
111	1	$default = $this->default->has($key);
112
113	1	if ($language !== null) {
114		$langIndex = $this->getLanguageIndex($language);
115		$keyLang = "languages.$langIndex.config.$key";
116		if ($this->data->has($keyLang)) {
117		return true;
118		}
119		if ($language !== $this->getLanguageDefault() && $fallback === false) {
120		return $default;
121		}
122		}
123	1	if ($this->data->has($key)) {
124	1	return true;
125		}
126
127	1	return $default;
128		}
129
130		/**
131		* Get the value of a configuration's key.
132		*
133		* @param string $key Configuration key
134		* @param string $language Language code (optional)
135		* @param bool $fallback Set to false to not return the value in the default language as fallback
136		*
137		* @return mixed\|null
138		*/
139	1	public function get(string $key, ?string $language = null, bool $fallback = true)
140		{
141	1	$default = $this->default->has($key) ? $this->default->get($key) : null;
142	1	if ($language !== null) {
143	1	$langIndex = $this->getLanguageIndex($language);
144	1	$keyLang = "languages.$langIndex.config.$key";
145	1	if ($this->data->has($keyLang)) {
146	1	return $this->data->get($keyLang);
147		}
148	1	if ($language !== $this->getLanguageDefault() && $fallback === false) {
149	1	return $default;
150		}
151		}
152	1	if ($this->data->has($key)) {
153	1	return $this->data->get($key);
154		}
155
156	1	return $default;
157		}
158
159		/**
160		* Is an option is enabled?
161		* Checks if the key is set to `false` or if subkey `enabled` is set to `false`.
162		*/
163	1	public function isEnabled(string $key, ?string $language = null, bool $fallback = true): bool
164		{
165	1	if ($this->has("$key.enabled", $language, $fallback) && $this->get("$key.enabled", $language, $fallback) === true) {
166	1	return true;
167		}
168	1	if ($this->has($key, $language, $fallback) && $this->get($key, $language, $fallback) !== false) {
169	1	return true;
170		}
171
172	1	return false;
173		}
174
175		/**
176		* Set the source directory.
177		*
178		* @throws \InvalidArgumentException
179		*/
180	1	public function setSourceDir(string $sourceDir): self
181		{
182	1	if (!is_dir($sourceDir)) {
183		throw new \InvalidArgumentException(\sprintf('The directory "%s" is not a valid source.', $sourceDir));
184		}
185	1	$this->sourceDir = $sourceDir;
186
187	1	return $this;
188		}
189
190		/**
191		* Get the source directory.
192		*/
193	1	public function getSourceDir(): string
194		{
195	1	if ($this->sourceDir === null) {
196		return getcwd();
197		}
198
199	1	return $this->sourceDir;
200		}
201
202		/**
203		* Set the destination directory.
204		*
205		* @throws \InvalidArgumentException
206		*/
207	1	public function setDestinationDir(string $destinationDir): self
208		{
209	1	if (!is_dir($destinationDir)) {
210		throw new \InvalidArgumentException(\sprintf('The directory "%s" is not a valid destination.', $destinationDir));
211		}
212	1	$this->destinationDir = $destinationDir;
213
214	1	return $this;
215		}
216
217		/**
218		* Get the destination directory.
219		*/
220	1	public function getDestinationDir(): string
221		{
222	1	if ($this->destinationDir === null) {
223		return $this->getSourceDir();
224		}
225
226	1	return $this->destinationDir;
227		}
228
229		/*
230		* Path helpers.
231		*/
232
233		/**
234		* Returns the path of the pages directory.
235		*/
236	1	public function getPagesPath(): string
237		{
238	1	return Util::joinFile($this->getSourceDir(), (string) $this->get('pages.dir'));
239		}
240
241		/**
242		* Returns the path of the output directory.
243		*/
244	1	public function getOutputPath(): string
245		{
246	1	return Util::joinFile($this->getDestinationDir(), (string) $this->get('output.dir'));
247		}
248
249		/**
250		* Returns the path of the data directory.
251		*/
252	1	public function getDataPath(): string
253		{
254	1	return Util::joinFile($this->getSourceDir(), (string) $this->get('data.dir'));
255		}
256
257		/**
258		* Returns the path of templates directory.
259		*/
260	1	public function getLayoutsPath(): string
261		{
262	1	return Util::joinFile($this->getSourceDir(), (string) $this->get('layouts.dir'));
263		}
264
265		/**
266		* Returns the path of internal templates directory.
267		*/
268	1	public function getLayoutsInternalPath(): string
269		{
270	1	return __DIR__ . '/../resources/layouts';
271		}
272
273		/**
274		* Returns the layout for a section.
275		*/
276	1	public function getLayoutSection(?string $section): ?string
277		{
278	1	if ($layout = $this->get('layouts.sections')[$section] ?? null) {
279		return $layout;
280		}
281
282	1	return $section;
283		}
284
285		/**
286		* Returns the path of translations directory.
287		*/
288	1	public function getTranslationsPath(): string
289		{
290	1	return Util::joinFile($this->getSourceDir(), (string) $this->get('layouts.translations.dir'));
291		}
292
293		/**
294		* Returns the path of internal translations directory.
295		*/
296	1	public function getTranslationsInternalPath(): string
297		{
298	1	return Util\File::getRealPath('../resources/translations');
299		}
300
301		/**
302		* Returns the path of themes directory.
303		*/
304	1	public function getThemesPath(): string
305		{
306	1	return Util::joinFile($this->getSourceDir(), 'themes');
307		}
308
309		/**
310		* Returns the path of static files directory.
311		*/
312	1	public function getStaticPath(): string
313		{
314	1	return Util::joinFile($this->getSourceDir(), (string) $this->get('static.dir'));
315		}
316
317		/**
318		* Returns the path of static files directory, with a target.
319		*/
320	1	public function getStaticTargetPath(): string
321		{
322	1	$path = $this->getStaticPath();
323	1	if (!empty($this->get('static.target'))) {
324		$path = substr($path, 0, -\strlen((string) $this->get('static.target')));
325		}
326
327	1	return $path;
328		}
329
330		/**
331		* Returns the path of assets files directory.
332		*/
333	1	public function getAssetsPath(): string
334		{
335	1	return Util::joinFile($this->getSourceDir(), (string) $this->get('assets.dir'));
336		}
337
338		/**
339		* Returns the path of remote assets files directory (in cache).
340		*
341		* @return string
342		*/
343	1	public function getAssetsRemotePath(): string
344		{
345	1	return Util::joinFile($this->getCacheAssetsPath(), 'remote');
346		}
347
348		/**
349		* Returns cache path.
350		*
351		* @throws ConfigException
352		*/
353	1	public function getCachePath(): string
354		{
355	1	if (empty((string) $this->get('cache.dir'))) {
356		throw new ConfigException(\sprintf('The cache directory (`%s`) is not defined.', 'cache.dir'));
357		}
358	1	if ($this->isCacheDirIsAbsolute()) {
359		$cacheDir = Util::joinFile((string) $this->get('cache.dir'), 'cecil');
360		Util\File::getFS()->mkdir($cacheDir);
361
362		return $cacheDir;
363		}
364
365	1	return Util::joinFile($this->getDestinationDir(), (string) $this->get('cache.dir'));
366		}
367
368		/**
369		* Returns cache path of templates.
370		*/
371	1	public function getCacheTemplatesPath(): string
372		{
373	1	return Util::joinFile($this->getCachePath(), 'templates');
374		}
375
376		/**
377		* Returns cache path of translations.
378		*/
379	1	public function getCacheTranslationsPath(): string
380		{
381	1	return Util::joinFile($this->getCachePath(), 'translations');
382		}
383
384		/**
385		* Returns cache path of assets.
386		*/
387	1	public function getCacheAssetsPath(): string
388		{
389	1	return Util::joinFile($this->getCachePath(), 'assets');
390		}
391
392		/**
393		* Returns cache path of assets files.
394		*/
395	1	public function getCacheAssetsFilesPath(): string
396		{
397	1	return Util::joinFile($this->getCacheAssetsPath(), 'files');
398		}
399
400		/*
401		* Output helpers.
402		*/
403
404		/**
405		* Returns the property value of an output format.
406		*
407		* @throws ConfigException
408		*/
409	1	public function getOutputFormatProperty(string $name, string $property): string\|array\|null
410		{
411	1	$properties = array_column((array) $this->get('output.formats'), $property, 'name');
412	1	if (empty($properties)) {
413		throw new ConfigException(\sprintf('Property "%s" is not defined for format "%s".', $property, $name));
414		}
415
416	1	return $properties[$name] ?? null;
417		}
418
419		/*
420		* Assets helpers.
421		*/
422
423		/**
424		* Returns asset image widths.
425		* Default: [480, 640, 768, 1024, 1366, 1600, 1920].
426		*/
427	1	public function getAssetsImagesWidths(): array
428		{
429	1	return $this->get('assets.images.responsive.widths') ?? [480, 640, 768, 1024, 1366, 1600, 1920];
430		}
431
432		/**
433		* Returns asset image sizes.
434		* Default: ['default' => '100vw'].
435		*/
436	1	public function getAssetsImagesSizes(): array
437		{
438	1	return $this->get('assets.images.responsive.sizes') ?? ['default' => '100vw'];
439		}
440
441		/*
442		* Theme helpers.
443		*/
444
445		/**
446		* Returns theme(s) as an array.
447		*/
448	1	public function getTheme(): ?array
449		{
450	1	if ($themes = $this->get('theme')) {
451	1	if (\is_array($themes)) {
452	1	return $themes;
453		}
454
455		return [$themes];
456		}
457
458		return null;
459		}
460
461		/**
462		* Has a (valid) theme(s)?
463		*
464		* @throws ConfigException
465		*/
466	1	public function hasTheme(): bool
467		{
468	1	if ($themes = $this->getTheme()) {
469	1	foreach ($themes as $theme) {
470	1	if (!Util\File::getFS()->exists($this->getThemeDirPath($theme, 'layouts')) && !Util\File::getFS()->exists(Util::joinFile($this->getThemesPath(), $theme, 'config.yml'))) {
471		throw new ConfigException(\sprintf('Theme "%s" not found. Did you forgot to install it?', $theme));
472		}
473		}
474
475	1	return true;
476		}
477
478		return false;
479		}
480
481		/**
482		* Returns the path of a specific theme's directory.
483		* ("layouts" by default).
484		*/
485	1	public function getThemeDirPath(string $theme, string $dir = 'layouts'): string
486		{
487	1	return Util::joinFile($this->getThemesPath(), $theme, $dir);
488		}
489
490		/*
491		* Language helpers.
492		*/
493
494		/**
495		* Returns an array of available languages.
496		*
497		* @throws ConfigException
498		*/
499	1	public function getLanguages(): array
500		{
501	1	if ($this->languages !== null) {
502	1	return $this->languages;
503		}
504	1	$languages = array_filter((array) $this->get('languages'), function ($language) {
505	1	return !(isset($language['enabled']) && $language['enabled'] === false);
506	1	});
507	1	if (!\is_int(array_search($this->getLanguageDefault(), array_column($languages, 'code')))) {
508		throw new ConfigException(\sprintf('The default language "%s" is not listed in "languages".', $this->getLanguageDefault()));
509		}
510	1	$this->languages = $languages;
511
512	1	return $this->languages;
513		}
514
515		/**
516		* Returns the default language code (ie: "en", "fr-FR", etc.).
517		*
518		* @throws ConfigException
519		*/
520	1	public function getLanguageDefault(): string
521		{
522	1	if (!$this->get('language')) {
523		throw new ConfigException('There is no default "language" key.');
524		}
525	1	if (\is_array($this->get('language'))) {
526		if (!$this->get('language.code')) {
527		throw new ConfigException('There is no "language.code" key.');
528		}
529
530		return $this->get('language.code');
531		}
532
533	1	return $this->get('language');
534		}
535
536		/**
537		* Returns a language code index.
538		*
539		* @throws ConfigException
540		*/
541	1	public function getLanguageIndex(string $code): int
542		{
543	1	$array = array_column($this->getLanguages(), 'code');
544	1	if (false === $index = array_search($code, $array)) {
545		throw new ConfigException(\sprintf('The language code "%s" is not defined.', $code));
546		}
547
548	1	return $index;
549		}
550
551		/**
552		* Returns the property value of a (specified or the default) language.
553		*
554		* @throws ConfigException
555		*/
556	1	public function getLanguageProperty(string $property, ?string $code = null): string
557		{
558	1	$code = $code ?? $this->getLanguageDefault();
559	1	$properties = array_column($this->getLanguages(), $property, 'code');
560	1	if (empty($properties)) {
561		throw new ConfigException(\sprintf('Property "%s" is not defined for language "%s".', $property, $code));
562		}
563
564	1	return $properties[$code];
565		}
566
567		/*
568		* Cache helpers.
569		*/
570
571		/**
572		* Is cache dir is absolute to system files
573		* or relative to project destination?
574		*/
575	1	public function isCacheDirIsAbsolute(): bool
576		{
577	1	$path = (string) $this->get('cache.dir');
578	1	if (Util::joinFile($path) == realpath(Util::joinFile($path))) {
579		return true;
580		}
581
582	1	return false;
583		}
584
585		/*
586		* Private functions.
587		*/
588
589		/**
590		* Set configuration from environment variables starting with "CECIL_".
591		*/
592	1	private function setFromEnv(): void
593		{
594	1	foreach (getenv() as $key => $value) {
595	1	if (str_starts_with($key, 'CECIL_')) {
596	1	$this->data->set(str_replace(['cecil_', '_'], ['', '.'], strtolower($key)), $this->castSetValue($value));
597		}
598		}
599		}
600
601		/**
602		* Casts boolean value given to set() as string.
603		*
604		* @param mixed $value
605		*
606		* @return bool\|mixed
607		*/
608	1	private function castSetValue($value)
609		{
610	1	$filteredValue = filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
611
612	1	if ($filteredValue !== null) {
613	1	return $filteredValue;
614		}
615
616	1	return $value;
617		}
618
619		/**
620		* Validate the configuration.
621		*
622		* @throws ConfigException
623		*/
624	1	private function validate(): void
625		{
626		// default language must be valid
627	1	if (!preg_match('/^' . Config::LANG_CODE_PATTERN . '$/', $this->getLanguageDefault())) {
628		throw new ConfigException(\sprintf('Default language code "%s" is not valid (e.g.: "language: fr-FR").', $this->getLanguageDefault()));
629		}
630		// if language is set then the locale is required and must be valid
631	1	foreach ((array) $this->get('languages') as $lang) {
632	1	if (!isset($lang['locale'])) {
633		throw new ConfigException('A language locale is not defined.');
634		}
635	1	if (!preg_match('/^' . Config::LANG_LOCALE_PATTERN . '$/', $lang['locale'])) {
636		throw new ConfigException(\sprintf('The language locale "%s" is not valid (e.g.: "locale: fr_FR").', $lang['locale']));
637		}
638		}
639
640		// check for deprecated options
641	1	$deprecatedConfigFile = Util\File::getRealPath('../config/deprecated.php');
642	1	$deprecatedConfig = require $deprecatedConfigFile;
643	1	array_walk($deprecatedConfig, function ($to, $from) {
644	1	if ($this->has($from)) {
645		if (empty($to)) {
646		throw new ConfigException("Option `$from` is deprecated and must be removed.");
647		}
648		$path = explode(':', $to);
649		$step = 0;
650		$formatedPath = '';
651		foreach ($path as $fragment) {
652		$step = $step + 2;
653		$formatedPath .= "$fragment:\n" . str_pad(' ', $step);
654		}
655		throw new ConfigException("Option `$from` must be moved to:\n```\n$formatedPath\n```");
656		}
657	1	});
658		}
659		}
660

Cecilapp / Cecil

Pull Request — master (#2148)

Config::isEnabled() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like