Config::getAssetsImagesSizes() - Code Metrics - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Config::getAssetsImagesSizes() A
last analyzed 2025-08-01 13:36 UTC

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * This file is part of Cecil.
 *
 * (c) Arnaud Ligny <[email protected]>
 *
 * 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\Exception\ConfigException;
use Dflydev\DotAccessData\Data;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;

/**
 * Configuration class.
 *
 * This class is used to manage the configuration of the application.
 * It allows to import, export, validate and access configuration data.
 * It also provides methods to handle paths, languages, themes, and cache.
 */
class Config
{
    public const IMPORT_PRESERVE = 0;
    public const IMPORT_REPLACE = 1;
    public const IMPORT_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"

    /**
     * Configuration is a Data object.
     * This allows to use dot notation to access configuration keys.
     * For example: $config->get('key.subkey') or $config->has('key.subkey').
     * @var Data
     */
    protected Data $data;
    /**
     * Default configuration.
     */
    protected Data $default;
    /**
     * Source directory.
     * This is the directory where the source files are located.
     * It is used to resolve relative paths in the configuration.
     * If not set, it defaults to the current working directory.
     * @var string|null
     */
    protected ?string $sourceDir = null;
    /**
     * Destination directory.
     * This is the directory where the output files will be generated.
     * It is used to resolve relative paths in the configuration.
     * If not set, it defaults to the source directory.
     * @var string|null
     */
    protected ?string $destinationDir = null;
    /**
     * Languages list as array.
     * This is used to store the languages defined in the configuration.
     * It is initialized to null and will be populated when the languages are requested.
     * @var array|null
     * @see Config::getLanguages()
     * @see Config::getLanguageDefault()
     */
    protected ?array $languages = null;

    /**
     * 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::IMPORT_PRESERVE: preserves existing configuration and adds new keys.
     * - Config::IMPORT_REPLACE: replaces existing configuration with new keys.
     * - Config::IMPORT_MERGE: merges existing configuration with new keys, overriding existing keys.
     * @param array $config Configuration array to import
     * @param int   $mode   Import mode (default: Config::IMPORT_MERGE)
     */
    public function import(array $config, int $mode = self::IMPORT_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();
    }

    /**
     * Loads and parse a YAML file.
     */
    public static function loadFile(string $file, bool $ignore = false): array
    {
        if (!Util\File::getFS()->exists($file)) {
            if ($ignore) {
                return [];
            }
            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, $language, $fallback) && $this->get($key, $language, $fallback) === true) {
            return true;
        }
        if ($this->has("$key.enabled", $language, $fallback)) {
            if ($this->get("$key.enabled", $language, $fallback) === true) {
                return true;
            }
            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): 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 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');
    }

    /*
     * 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.
     */
    public function getAssetsImagesWidths(): array
    {
        return $this->get('assets.images.responsive.widths');
    }

    /**
     * Returns asset image sizes.
     */
    public function getAssetsImagesSizes(): array
    {
        return $this->get('assets.images.responsive.sizes');
    }

    /*
     * 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);
                }
                $formatedPath = trim($formatedPath);
                throw new ConfigException("Option `$from` must be moved to:\n```\n$formatedPath\n```");
            }
        });
    }
}


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

Cecilapp / Cecil

Config::getAssetsImagesSizes() A last analyzed 2025-08-01 13:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Config::getAssetsImagesSizes() A
last analyzed 2025-08-01 13:36 UTC