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

VirtualPages::generate() C
last analyzed 2025-10-27 12:25 UTC

↳ Parent: VirtualPages

Complexity

Conditions	12
Paths	15

Size

Total Lines	36
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
eloc	24
nc	15
nop	0
dl	0
loc	36
rs	6.9666
c	0
b	0
f	0

How to fix Complexity

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

use Cecil\Collection\Page\Page;
use Cecil\Collection\Page\Type;
use Cecil\Exception\RuntimeException;

/**
 * VirtualPages class.
 *
 * This class is responsible for generating virtual pages based on the configuration provided.
 * It extends the AbstractGenerator and implements the GeneratorInterface.
 * It collects pages from the configuration under the 'pages.virtual' key and creates Page objects
 * for each virtual page defined in the configuration.
 * Each page can have its own frontmatter, and the generator ensures that the pages are created
 * with the correct path and language settings.
 * If a page is marked as unpublished or does not have a path defined, it will be skipped.
 * If a page already exists with the same ID, it will also be skipped.
 * The generated pages are added to the collection of generated pages for further processing.
 */
class VirtualPages extends AbstractGenerator implements GeneratorInterface
{
    protected $configKey = 'pages.virtual';

    /**
     * {@inheritdoc}
     */
    public function generate(): void
    {
        $pagesConfig = $this->collectPagesFromConfig($this->configKey);

        if (!$pagesConfig) {
            return;
        }

        foreach ($pagesConfig as $frontmatter) {
            if (isset($frontmatter['published']) && $frontmatter['published'] === false) {
                continue;
            }
            if (!isset($frontmatter['path'])) {
                throw new RuntimeException(\sprintf('Each pages in "%s" config\'s section must have a "path".', $this->configKey));
            }
            $path = Page::slugify($frontmatter['path']);
            foreach ($this->config->getLanguages() as $language) {
                $pageId = !empty($path) ? $path : 'index';
                if ($language['code'] !== $this->config->getLanguageDefault()) {
                    $pageId = \sprintf('%s/%s', $language['code'], $pageId);
                    // disable multilingual support
                    if (isset($frontmatter['multilingual']) && $frontmatter['multilingual'] === false) {
                        continue;
                    }
                }
                // abord if the page id already exists
                if ($this->builder->getPages()->has($pageId)) {
                    continue;
                }
                $page = (new Page($pageId))
                    ->setPath($path)
                    ->setType(Type::PAGE->value)
                    ->setVariable('language', $language['code'])
                    ->setVariable('langref', $path);
                $page->setVariables($frontmatter);
                $this->generatedPages->add($page);
            }
        }
    }

    /**
     * Collects virtual pages configuration.
     */
    private function collectPagesFromConfig(string $configKey): ?array
    {
        return $this->config->get($configKey);
    }
}


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\Generator;
15
16			use Cecil\Collection\Page\Page;
17			use Cecil\Collection\Page\Type;
18			use Cecil\Exception\RuntimeException;
19
20			/**
21			* VirtualPages class.
22			*
23			* This class is responsible for generating virtual pages based on the configuration provided.
24			* It extends the AbstractGenerator and implements the GeneratorInterface.
25			* It collects pages from the configuration under the 'pages.virtual' key and creates Page objects
26			* for each virtual page defined in the configuration.
27			* Each page can have its own frontmatter, and the generator ensures that the pages are created
28			* with the correct path and language settings.
29			* If a page is marked as unpublished or does not have a path defined, it will be skipped.
30			* If a page already exists with the same ID, it will also be skipped.
31			* The generated pages are added to the collection of generated pages for further processing.
32			*/
33			class VirtualPages extends AbstractGenerator implements GeneratorInterface
34			{
35			protected $configKey = 'pages.virtual';
36
37			/**
38			* {@inheritdoc}
39			*/
40			public function generate(): void
41			{
42			$pagesConfig = $this->collectPagesFromConfig($this->configKey);
43
44			if (!$pagesConfig) {
45			return;
46			}
47
48			foreach ($pagesConfig as $frontmatter) {
49			if (isset($frontmatter['published']) && $frontmatter['published'] === false) {
50			continue;
51			}
52			if (!isset($frontmatter['path'])) {
53			throw new RuntimeException(\sprintf('Each pages in "%s" config\'s section must have a "path".', $this->configKey));
54			}
55			$path = Page::slugify($frontmatter['path']);
56			foreach ($this->config->getLanguages() as $language) {
57			$pageId = !empty($path) ? $path : 'index';
58			if ($language['code'] !== $this->config->getLanguageDefault()) {
59			$pageId = \sprintf('%s/%s', $language['code'], $pageId);
60			// disable multilingual support
61			if (isset($frontmatter['multilingual']) && $frontmatter['multilingual'] === false) {
62			continue;
63			}
64			}
65			// abord if the page id already exists
66			if ($this->builder->getPages()->has($pageId)) {
67			continue;
68			}
69			$page = (new Page($pageId))
70			->setPath($path)
71			->setType(Type::PAGE->value)
72			->setVariable('language', $language['code'])
73			->setVariable('langref', $path);
74			$page->setVariables($frontmatter);
75			$this->generatedPages->add($page);
76			}
77			}
78			}
79
80			/**
81			* Collects virtual pages configuration.
82			*/
83			private function collectPagesFromConfig(string $configKey): ?array
84			{
85			return $this->config->get($configKey);
86			}
87			}
88

Cecilapp / Cecil

VirtualPages::generate() C last analyzed 2025-10-27 12:25 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

VirtualPages::generate() C
last analyzed 2025-10-27 12:25 UTC