Config::getOutputFormatProperty() - Code Metrics - Inspection of "feat: force path prefix for the main language" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1822)

by Arnaud

created 2023-10-21 23:16 UTC

Config::getOutputFormatProperty() A

↳ Parent: Config

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes

Metric	Value
cc	2
eloc	4
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	9
ccs	4
cts	5
cp	0.8
crap	2.032
rs	10

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

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

    /** @var array Configuration. */
    protected $siteConfig;

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

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

    /** @var array Languages. */
    protected $languages = null;

    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)
    {
        // load default configuration
        $defaultConfig = realpath(Util::joinFile(__DIR__, '..', 'config/default.php'));
        if (Plateform::isPhar()) {
            $defaultConfig = Util::joinPath(Plateform::getPharPath(), 'config/default.php');
        }
        $this->data = new Data(include $defaultConfig);

        // import site config
        $this->siteConfig = $config;
        $this->importSiteConfig();
    }

    /**
     * Imports site configuration.
     */
    private function importSiteConfig(): void
    {
        $this->data->import($this->siteConfig);

        /**
         * Overrides configuration with environment variables.
         */
        $data = $this->getData();
        $applyEnv = function ($array) use ($data) {
            $iterator = new \RecursiveIteratorIterator(
                new \RecursiveArrayIterator($array),
                \RecursiveIteratorIterator::SELF_FIRST
            );
            $iterator->rewind();
            while ($iterator->valid()) {
                $path = [];
                foreach (range(0, $iterator->getDepth()) as $depth) {
                    $path[] = $iterator->getSubIterator($depth)->key();
                }
                $sPath = implode('_', $path);
                if ($getEnv = getenv('CECIL_' . strtoupper($sPath))) {
                    $data->set(str_replace('_', '.', strtolower($sPath)), $this->castSetValue($getEnv));
                }
                $iterator->next();
            }
        };
        $applyEnv($data->export());
    }

    /**
     * Casts boolean value given to set() as string.
     *
     * @param mixed $value
     *
     * @return bool|mixed
     */
    private function castSetValue($value)
    {
        if (\is_string($value)) {
            switch ($value) {
                case 'true':
                    return true;
                case 'false':
                    return false;
                default:
                    return $value;
            }
        }

        return $value;
    }

    /**
     * Imports (theme) configuration.
     */
    public function import(array $config): void
    {
        $this->data->import($config);

        // re-import site config
        $this->importSiteConfig();
    }

    /**
     * Set a Data object as configuration.
     */
    protected function setData(Data $data): self
    {
        if ($this->data !== $data) {
            $this->data = $data;
        }

        return $this;
    }

    /**
     * Get configuration as a Data object.
     */
    protected function getData(): Data
    {
        return $this->data;
    }

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

    /**
     * Is configuration's key exists?
     */
    public function has(string $key): bool
    {
        return $this->data->has($key);
    }

    /**
     * Get the value of a configuration's key.
     *
     * @param string $key      Configuration key
     * @param string $language Language code (optionnal)
     * @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)
    {
        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 null;
            }
        }
        if ($this->data->has($key)) {
            return $this->data->get($key);
        }

        return null;
    }

    /**
     * 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
    {
        $path = Util::joinFile($this->getSourceDir(), (string) $this->get('pages.dir'));

        // legacy support
        if (!is_dir($path)) {
            $path = Util::joinFile($this->getSourceDir(), 'content');
        }

        return $path;
    }

    /**
     * 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 themes directory.
     */
    public function getThemesPath(): string
    {
        return Util::joinFile($this->getSourceDir(), (string) $this->get('themes.dir'));
    }

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

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

    /**
     * Returns the path of internal translations directory.
     */
    public function getInternalTranslationsPath(): string
    {
        if (Util\Plateform::isPhar()) {
            return Util::joinPath(Plateform::getPharPath(), (string) $this->get('translations.internal.dir'));
        }

        return realpath(Util::joinPath(__DIR__, '..', (string) $this->get('translations.internal.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 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 asset image widths.
     */
    public function getAssetsImagesWidths(): array
    {
        return \count((array) $this->get('assets.images.responsive.widths')) > 0 ? (array) $this->get('assets.images.responsive.widths') : [480, 640, 768, 1024, 1366, 1600, 1920];
    }

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

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

    /**
     * Returns cache path.
     *
     * @throws RuntimeException
     */
    public function getCachePath(): string
    {
        if (empty((string) $this->get('cache.dir'))) {
            throw new RuntimeException(sprintf('The cache directory ("%s") is not defined in configuration.', '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(), (string) $this->get('cache.templates.dir'));
    }

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

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

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

    /**
     * Returns the property value of an output format.
     *
     * @throws RuntimeException
     *
     * @return string|array|null
     */
    public function getOutputFormatProperty(string $name, string $property)
    {
        $properties = array_column((array) $this->get('output.formats'), $property, 'name');

        if (empty($properties)) {
            throw new RuntimeException(sprintf('Property "%s" is not defined for format "%s".', $property, $name));
        }

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

    /**
     * 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 RuntimeException
     */
    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 RuntimeException(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 RuntimeException
     */
    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 RuntimeException(sprintf('The default language "%s" is not listed in "languages" key configuration.', $this->getLanguageDefault()));
        }

        $this->languages = $languages;

        return $this->languages;
    }

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

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

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

    /**
     * Returns a language code index.
     *
     * @throws RuntimeException
     */
    public function getLanguageIndex(string $code): int
    {
        $array = array_column($this->getLanguages(), 'code');

        if (false === $index = array_search($code, $array)) {
            throw new RuntimeException(sprintf('The language code "%s" is not defined.', $code));
        }

        return $index;
    }

    /**
     * Returns the property value of a (specified or the default) language.
     *
     * @throws RuntimeException
     */
    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 RuntimeException(sprintf('Property "%s" is not defined for language "%s".', $property, $code));
        }

        return $properties[$code];
    }
}


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

Cecilapp / Cecil

Pull Request — master (#1822)

Config::getOutputFormatProperty() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like