Config::getAsArray() - Code Metrics - Inspection of "Update Core.php" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — deprecated-options ( 54735f...d50a2b )

by Arnaud

created 2025-03-25 15:38 UTC

Config::getAsArray() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?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\Util\Platform;
use Dflydev\DotAccessData\Data;

/**
 * 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
        $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();
    }

    /**
     * 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) === false) {
            return false;
        }
        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 = null): self
    {
        if ($sourceDir === null) {
            $sourceDir = getcwd();
        }
        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
    {
        return $this->sourceDir;
    }

    /**
     * Set the destination directory.
     *
     * @throws \InvalidArgumentException
     */
    public function setDestinationDir(?string $destinationDir = null): self
    {
        if ($destinationDir === null) {
            $destinationDir = $this->sourceDir;
        }
        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
    {
        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 Util\File::getRealPath('../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
    {
        if (Util\Platform::isPhar()) {
            return Util::joinPath(Platform::getPharPath(), (string) $this->get('resources/translations'));
        }

        return realpath(Util::joinPath(__DIR__, '..', (string) $this->get('resources/translations')));
    }

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

    /**
     * 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 (array) $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 (array) $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;
    }

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

Cecilapp / Cecil

Push — deprecated-options ( 54735f...d50a2b )

Config::getAsArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like