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

Create::createMenusFromPages() B
last analyzed 2025-10-27 12:25 UTC

↳ Parent: Create

Complexity

Conditions	11
Paths	14

Size

Total Lines	74
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	40
c	0
b	0
f	0
nc	14
nop	0
dl	0
loc	74
rs	7.3166

How to fix Long Method 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\Step\Menus;

use Cecil\Collection\Menu\Collection as MenusCollection;
use Cecil\Collection\Menu\Entry;
use Cecil\Collection\Menu\Menu;
use Cecil\Collection\Page\Page;
use Cecil\Exception\RuntimeException;
use Cecil\Logger\PrintLogger;
use Cecil\Renderer\Page as PageRenderer;
use Cecil\Step\AbstractStep;

/**
 * Create menus step.
 *
 * This step is responsible for creating menus based on the configuration
 * and the pages defined in the site. It initializes a collection of menus
 * for each language, adds a default "main" menu, and processes the configuration
 * to add, remove, or replace menu entries. It also creates menus from pages
 * that have a `menu` variable defined, allowing for dynamic menu generation
 * based on the content of the site.
 */
class Create extends AbstractStep
{
    /** @var array */
    protected $menus;

    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return 'Creating menus';
    }

    /**
     * {@inheritdoc}
     *
     * @throws RuntimeException
     */
    public function process(): void
    {
        // creates a Menu collection for each language, with a default "main" menu
        foreach ($this->config->getLanguages() as $language) {
            $this->menus[$language['code']] = new MenusCollection('menus');
            $this->menus[$language['code']]->add(new Menu('main'));
        }

        $this->createMenusFromPages();

        /**
         * Removing/adding/replacing menus entries from config.
         * ie:
         *   menus:
         *     main:
         *       # remove
         *       - id: about
         *         enabled: false
         *       # add
         *       - id: example
         *         name: "Example"
         *         url: https://example.com
         *         weight: 999
         *       # replace
         *       - id: index
         *         name: "Home page"
         */
        foreach ($this->config->getLanguages() as $language) {
            if ($menusConfig = (array) $this->config->get('menus', $language['code'], false)) {
                $totalConfig = array_sum(array_map('count', $menusConfig));
                $countConfig = 0;

                foreach ($menusConfig as $menuConfig => $entry) {
                    if (!\is_array($entry)) {
                        break;
                    }
                    // add Menu if not exists
                    if (!$this->menus[$language['code']]->has($menuConfig)) {
                        $this->menus[$language['code']]->add(new Menu($menuConfig));
                    }
                    /** @var \Cecil\Collection\Menu\Menu $menu */
                    $menu = $this->menus[$language['code']]->get($menuConfig);
                    foreach ($entry as $key => $properties) {
                        $countConfig++;
                        $updated = false;

                        // ID is required
                        if (!isset($properties['id'])) {
                            $this->builder->getLogger()->error(\sprintf('Config menu entry: key "id" is required for entry at position %s in "%s" menu', $key, $menu), ['progress' => [$countConfig, $totalConfig]]);
                            continue;
                        }
                        /** @var \Cecil\Collection\Menu\Entry $item */
                        $item = (new Entry($properties['id']))
                            ->setName($properties['name'] ?? ucfirst($properties['id']))
                            ->setUrl($properties['url'] ?? '404')
                            ->setWeight((int) ($properties['weight'] ?? 0));
                        // is entry already exists?
                        if ($menu->has($properties['id'])) {
                            // removes a not enabled entry
                            if (isset($properties['enabled']) && $properties['enabled'] === false) {
                                $menu->remove($properties['id']);

                                $message = \sprintf('Config menu entry "%s (%s) > %s" removed', (string) $menu, $language['code'], $properties['id']);
                                $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                                continue;
                            }
                            // merges properties
                            $current = $menu->get($properties['id'])->toArray();
                            $properties = array_merge($current, $properties);
                            /** @var \Cecil\Collection\Menu\Entry $item */
                            $item = clone $menu->get($properties['id']);
                            $item->setName($properties['name'])
                                ->setUrl($properties['url'])
                                ->setWeight($properties['weight']);
                            $updated = true;
                        }
                        // abord if entry is not enabled
                        if (isset($properties['enabled']) && $properties['enabled'] === false) {
                            continue;
                        }
                        // adds/replaces entry
                        $menu->add($item);

                        $message = \sprintf('Config menu entry "%s (%s) > %s" %s {name: %s, url: %s, weight: %s}', (string) $menu, $language['code'], $item->getId(), $updated ? 'updated' : 'created', $item-> getName(), $item->getUrl(), $item->getWeight());
                        $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                    }
                }
            }
        }

        $this->builder->setMenus($this->menus);
    }

    /**
     * Create menus from pages' `menu` variable.
     */
    protected function createMenusFromPages(): void
    {
        $filteredPages = $this->builder->getPages()->filter(function (Page $page) {
            return $page->hasVariable('menu')
                && $page->getVariable('published') === true
                && \in_array($page->getVariable('language', $this->config->getLanguageDefault()), array_column($this->config->getLanguages(), 'code'));
        });

        $total = \count($filteredPages);
        $count = 0;
        /** @var \Cecil\Collection\Page\Page $page */
        foreach ($filteredPages as $page) {
            $count++;
            $language = $page->getVariable('language', $this->config->getLanguageDefault());
            /**
             * Array case.
             *
             * case 1:
             *   menu: [main, navigation]
             * case 2:
             *   menu:
             *     main:
             *       weight: 999
             */
            if (\is_array($page->getVariable('menu'))) {
                foreach ($page->getVariable('menu') as $key => $value) {
                    $menuName = $key;
                    $properties = $value;
                    if (\is_int($key)) {
                        $menuName = $value;
                        $properties = null;
                    }
                    if (!\is_string($menuName)) {
                        $this->builder->getLogger()->error(\sprintf('Menu\'s name of page "%s" must be a string, not "%s"', $page->getId(), PrintLogger::format($menuName)), ['progress' => [$count, $total]]);
                        continue;
                    }
                    $item = (new Entry($page->getIdWithoutLang()))
                        ->setName($page->getVariable('title'))
                        ->setUrl((new PageRenderer($this->builder, $page))->getPath());
                    if (isset($properties['weight'])) {
                        $item->setWeight((int) $properties['weight']);
                    }
                    // add Menu if not exists
                    if (!$this->menus[$language]->has($menuName)) {
                        $this->menus[$language]->add(new Menu($menuName));
                    }
                    /** @var \Cecil\Collection\Menu\Menu $menu */
                    $menu = $this->menus[$language]->get($menuName);
                    $menu->add($item);

                    $message = \sprintf('Page menu entry "%s (%s) > %s" created {name: %s, weight: %s}', $menu->getId(), $language, $item->getId(), $item->getName(), $properties['weight'] ?? 'N/A');
                    $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
                }
                continue;
            }
            /**
             * String case.
             *
             * e.g.:
             *   menu: main
             */
            $item = (new Entry($page->getIdWithoutLang()))
                ->setName($page->getVariable('title'))
                ->setUrl((new PageRenderer($this->builder, $page))->getPath());
            // add Menu if not exists
            if (!$this->menus[$language]->has($page->getVariable('menu'))) {
                $this->menus[$language]->add(new Menu($page->getVariable('menu')));
            }
            /** @var \Cecil\Collection\Menu\Menu $menu */
            $menu = $this->menus[$language]->get($page->getVariable('menu'));
            $menu->add($item);

            $message = \sprintf('Page menu entry "%s (%s) > %s" created {name: %s}', $menu->getId(), $language, $item->getId(), $item->getName());
            $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
        }
    }
}


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\Step\Menus;
15
16			use Cecil\Collection\Menu\Collection as MenusCollection;
17			use Cecil\Collection\Menu\Entry;
18			use Cecil\Collection\Menu\Menu;
19			use Cecil\Collection\Page\Page;
20			use Cecil\Exception\RuntimeException;
21			use Cecil\Logger\PrintLogger;
22			use Cecil\Renderer\Page as PageRenderer;
23			use Cecil\Step\AbstractStep;
24
25			/**
26			* Create menus step.
27			*
28			* This step is responsible for creating menus based on the configuration
29			* and the pages defined in the site. It initializes a collection of menus
30			* for each language, adds a default "main" menu, and processes the configuration
31			* to add, remove, or replace menu entries. It also creates menus from pages
32			* that have a `menu` variable defined, allowing for dynamic menu generation
33			* based on the content of the site.
34			*/
35			class Create extends AbstractStep
36			{
37			/** @var array */
38			protected $menus;
39
40			/**
41			* {@inheritdoc}
42			*/
43			public function getName(): string
44			{
45			return 'Creating menus';
46			}
47
48			/**
49			* {@inheritdoc}
50			*
51			* @throws RuntimeException
52			*/
53			public function process(): void
54			{
55			// creates a Menu collection for each language, with a default "main" menu
56			foreach ($this->config->getLanguages() as $language) {
57			$this->menus[$language['code']] = new MenusCollection('menus');
58			$this->menus[$language['code']]->add(new Menu('main'));
59			}
60
61			$this->createMenusFromPages();
62
63			/**
64			* Removing/adding/replacing menus entries from config.
65			* ie:
66			* menus:
67			* main:
68			* # remove
69			* - id: about
70			* enabled: false
71			* # add
72			* - id: example
73			* name: "Example"
74			* url: https://example.com
75			* weight: 999
76			* # replace
77			* - id: index
78			* name: "Home page"
79			*/
80			foreach ($this->config->getLanguages() as $language) {
81			if ($menusConfig = (array) $this->config->get('menus', $language['code'], false)) {
82			$totalConfig = array_sum(array_map('count', $menusConfig));
83			$countConfig = 0;
84
85			foreach ($menusConfig as $menuConfig => $entry) {
86			if (!\is_array($entry)) {
87			break;
88			}
89			// add Menu if not exists
90			if (!$this->menus[$language['code']]->has($menuConfig)) {
91			$this->menus[$language['code']]->add(new Menu($menuConfig));
92			}
93			/** @var \Cecil\Collection\Menu\Menu $menu */
94			$menu = $this->menus[$language['code']]->get($menuConfig);
95			foreach ($entry as $key => $properties) {
96			$countConfig++;
97			$updated = false;
98
99			// ID is required
100			if (!isset($properties['id'])) {
101			$this->builder->getLogger()->error(\sprintf('Config menu entry: key "id" is required for entry at position %s in "%s" menu', $key, $menu), ['progress' => [$countConfig, $totalConfig]]);
102			continue;
103			}
104			/** @var \Cecil\Collection\Menu\Entry $item */
105			$item = (new Entry($properties['id']))
106			->setName($properties['name'] ?? ucfirst($properties['id']))
107			->setUrl($properties['url'] ?? '404')
108			->setWeight((int) ($properties['weight'] ?? 0));
109			// is entry already exists?
110			if ($menu->has($properties['id'])) {
111			// removes a not enabled entry
112			if (isset($properties['enabled']) && $properties['enabled'] === false) {
113			$menu->remove($properties['id']);
114
115			$message = \sprintf('Config menu entry "%s (%s) > %s" removed', (string) $menu, $language['code'], $properties['id']);
116			$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
117			continue;
118			}
119			// merges properties
120			$current = $menu->get($properties['id'])->toArray();
121			$properties = array_merge($current, $properties);
122			/** @var \Cecil\Collection\Menu\Entry $item */
123			$item = clone $menu->get($properties['id']);
124			$item->setName($properties['name'])
125			->setUrl($properties['url'])
126			->setWeight($properties['weight']);
127			$updated = true;
128			}
129			// abord if entry is not enabled
130			if (isset($properties['enabled']) && $properties['enabled'] === false) {
131			continue;
132			}
133			// adds/replaces entry
134			$menu->add($item);
135
136			$message = \sprintf('Config menu entry "%s (%s) > %s" %s {name: %s, url: %s, weight: %s}', (string) $menu, $language['code'], $item->getId(), $updated ? 'updated' : 'created', $item-> getName(), $item->getUrl(), $item->getWeight());
137			$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
138			}
139			}
140			}
141			}
142
143			$this->builder->setMenus($this->menus);
144			}
145
146			/**
147			* Create menus from pages' `menu` variable.
148			*/
149			protected function createMenusFromPages(): void
150			{
151			$filteredPages = $this->builder->getPages()->filter(function (Page $page) {
152			return $page->hasVariable('menu')
153			&& $page->getVariable('published') === true
154			&& \in_array($page->getVariable('language', $this->config->getLanguageDefault()), array_column($this->config->getLanguages(), 'code'));
155			});
156
157			$total = \count($filteredPages);
158			$count = 0;
159			/** @var \Cecil\Collection\Page\Page $page */
160			foreach ($filteredPages as $page) {
161			$count++;
162			$language = $page->getVariable('language', $this->config->getLanguageDefault());
163			/**
164			* Array case.
165			*
166			* case 1:
167			* menu: [main, navigation]
168			* case 2:
169			* menu:
170			* main:
171			* weight: 999
172			*/
173			if (\is_array($page->getVariable('menu'))) {
174			foreach ($page->getVariable('menu') as $key => $value) {
175			$menuName = $key;
176			$properties = $value;
177			if (\is_int($key)) {
178			$menuName = $value;
179			$properties = null;
180			}
181			if (!\is_string($menuName)) {
182			$this->builder->getLogger()->error(\sprintf('Menu\'s name of page "%s" must be a string, not "%s"', $page->getId(), PrintLogger::format($menuName)), ['progress' => [$count, $total]]);
183			continue;
184			}
185			$item = (new Entry($page->getIdWithoutLang()))
186			->setName($page->getVariable('title'))
187			->setUrl((new PageRenderer($this->builder, $page))->getPath());
188			if (isset($properties['weight'])) {
189			$item->setWeight((int) $properties['weight']);
190			}
191			// add Menu if not exists
192			if (!$this->menus[$language]->has($menuName)) {
193			$this->menus[$language]->add(new Menu($menuName));
194			}
195			/** @var \Cecil\Collection\Menu\Menu $menu */
196			$menu = $this->menus[$language]->get($menuName);
197			$menu->add($item);
198
199			$message = \sprintf('Page menu entry "%s (%s) > %s" created {name: %s, weight: %s}', $menu->getId(), $language, $item->getId(), $item->getName(), $properties['weight'] ?? 'N/A');
200			$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
201			}
202			continue;
203			}
204			/**
205			* String case.
206			*
207			* e.g.:
208			* menu: main
209			*/
210			$item = (new Entry($page->getIdWithoutLang()))
211			->setName($page->getVariable('title'))
212			->setUrl((new PageRenderer($this->builder, $page))->getPath());
213			// add Menu if not exists
214			if (!$this->menus[$language]->has($page->getVariable('menu'))) {
215			$this->menus[$language]->add(new Menu($page->getVariable('menu')));
216			}
217			/** @var \Cecil\Collection\Menu\Menu $menu */
218			$menu = $this->menus[$language]->get($page->getVariable('menu'));
219			$menu->add($item);
220
221			$message = \sprintf('Page menu entry "%s (%s) > %s" created {name: %s}', $menu->getId(), $language, $item->getId(), $item->getName());
222			$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
223			}
224			}
225			}
226

Cecilapp / Cecil

Create::createMenusFromPages() B last analyzed 2025-10-27 12:25 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Create::createMenusFromPages() B
last analyzed 2025-10-27 12:25 UTC