ModuleThemeTrait::menuControlPanel() - Code Metrics - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

ModuleThemeTrait::menuControlPanel() A
last analyzed 2025-10-31 12:49 UTC

↳ Parent: ModuleThemeTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2025 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Module;

use Fisharebest\Webtrees\Auth;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Contracts\UserInterface;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\Http\RequestHandlers\AccountEdit;
use Fisharebest\Webtrees\Http\RequestHandlers\ControlPanel;
use Fisharebest\Webtrees\Http\RequestHandlers\HomePage;
use Fisharebest\Webtrees\Http\RequestHandlers\LoginPage;
use Fisharebest\Webtrees\Http\RequestHandlers\Logout;
use Fisharebest\Webtrees\Http\RequestHandlers\ManageTrees;
use Fisharebest\Webtrees\Http\RequestHandlers\PendingChanges;
use Fisharebest\Webtrees\Http\RequestHandlers\SelectLanguage;
use Fisharebest\Webtrees\Http\RequestHandlers\SelectTheme;
use Fisharebest\Webtrees\Http\RequestHandlers\TreePage;
use Fisharebest\Webtrees\Http\RequestHandlers\TreePageEdit;
use Fisharebest\Webtrees\Http\RequestHandlers\UserPage;
use Fisharebest\Webtrees\Http\RequestHandlers\UserPageEdit;
use Fisharebest\Webtrees\I18N;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Individual;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Services\ModuleService;
filter:
    dependency_paths: ["lib/*"]
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ServerRequestInterface;

use function count;
use function in_array;
use function route;
use function view;

/**
 * Trait ModuleThemeTrait - default implementation of ModuleThemeInterface
 */
trait ModuleThemeTrait
{
    abstract public function title(): string;

    public function description(): string
    {
        return I18N::translate('Theme') . ' — ' . $this->title();
    }

    /**
     * Generate the facts, for display in charts.
     *
     * @param Individual $individual
     *
     * @return string
     */
    public function individualBoxFacts(Individual $individual): string
    {
        $html = '';

        $opt_tags = preg_split('/\W/', $individual->tree()->getPreference('CHART_BOX_TAGS'), 0, PREG_SPLIT_NO_EMPTY);
        // Show BIRT or equivalent event
        foreach (Gedcom::BIRTH_EVENTS as $birttag) {
            if (!in_array($birttag, $opt_tags, true)) {
                $event = $individual->facts([$birttag])->first();
                if ($event instanceof Fact) {
                    $html .= $event->summary();
                    break;
                }
            }
        }
        // Show optional events (before death)
        foreach ($opt_tags as $key => $tag) {
            if (!in_array($tag, Gedcom::DEATH_EVENTS, true)) {
                $event = $individual->facts([$tag])->first();
                if ($event instanceof Fact) {
                    $html .= $event->summary();
                    unset($opt_tags[$key]);
                }
            }
        }
        // Show DEAT or equivalent event
        foreach (Gedcom::DEATH_EVENTS as $deattag) {
            $event = $individual->facts([$deattag])->first();
            if ($event instanceof Fact) {
                $html .= $event->summary();
                if (in_array($deattag, $opt_tags, true)) {
                    unset($opt_tags[array_search($deattag, $opt_tags, true)]);
                }
                break;
            }
        }
        // Show remaining optional events (after death)
        foreach ($opt_tags as $tag) {
            $event = $individual->facts([$tag])->first();
            if ($event instanceof Fact) {
                $html .= $event->summary();
            }
        }

        return $html;
    }

    /**
     * Links, to show in chart boxes;
     *
     * @param Individual $individual
     *
     * @return array<Menu>
     */
    public function individualBoxMenu(Individual $individual): array
    {
        return array_merge(
            $this->individualBoxMenuCharts($individual),
            $this->individualBoxMenuFamilyLinks($individual)
        );
    }

    /**
     * Chart links, to show in chart boxes;
     *
     * @param Individual $individual
     *
     * @return array<Menu>
     */
    public function individualBoxMenuCharts(Individual $individual): array
    {
        $menus = [];

        $module_service = Registry::container()->get(ModuleService::class);

        foreach ($module_service->findByComponent(ModuleChartInterface::class, $individual->tree(), Auth::user()) as $chart) {
            $menu = $chart->chartBoxMenu($individual);
            if ($menu) {
                $menus[] = $menu;
            }
        }

        usort($menus, static fn (Menu $x, Menu $y): int => I18N::comparator()($x->getLabel(), $y->getLabel()));

        return $menus;
    }

    /**
     * Family links, to show in chart boxes.
     *
     * @param Individual $individual
     *
     * @return array<Menu>
     */
    public function individualBoxMenuFamilyLinks(Individual $individual): array
    {
        $menus = [];

        foreach ($individual->spouseFamilies() as $family) {
            $menus[] = new Menu('<strong>' . I18N::translate('Family with spouse') . '</strong>', $family->url());
            $spouse  = $family->spouse($individual);
            if ($spouse && $spouse->canShowName()) {
                $menus[] = new Menu($spouse->fullName(), $spouse->url());
            }
            foreach ($family->children() as $child) {
                if ($child->canShowName()) {
                    $menus[] = new Menu($child->fullName(), $child->url());
                }
            }
        }

        return $menus;
    }

    /**
     * Generate a menu item to change the blocks on the current tree/user page.
     *
     * @param Tree $tree
     *
     * @return Menu|null
     */
    public function menuChangeBlocks(Tree $tree): Menu|null
    {
        $request = Registry::container()->get(ServerRequestInterface::class);
        $route   = Validator::attributes($request)->route();

        if (Auth::check() && $route->name === UserPage::class) {
            return new Menu(I18N::translate('Customize this page'), route(UserPageEdit::class, ['tree' => $tree->name()]), 'menu-change-blocks');
        }

        if (Auth::isManager($tree) && $route->name === TreePage::class) {
            return new Menu(I18N::translate('Customize this page'), route(TreePageEdit::class, ['tree' => $tree->name()]), 'menu-change-blocks');
        }

        return null;
    }

    /**
     * Generate a menu item for the control panel.
     *
     * @param Tree $tree
     *
     * @return Menu|null
     */
    public function menuControlPanel(Tree $tree): Menu|null
    {
        if (Auth::isAdmin()) {
            return new Menu(I18N::translate('Control panel'), route(ControlPanel::class), 'menu-admin');
        }

        if (Auth::isManager($tree)) {
            return new Menu(I18N::translate('Control panel'), route(ManageTrees::class, ['tree' => $tree->name()]), 'menu-admin');
        }

        return null;
    }

    /**
     * A menu to show a list of available languages.
     *
     * @return Menu|null
     */
    public function menuLanguages(): Menu|null
    {
        $menu = new Menu(I18N::translate('Language'), '#', 'menu-language');

        foreach (I18N::activeLocales() as $active_locale) {
            $language_tag = $active_locale->languageTag();
            $class        = 'menu-language-' . $language_tag . (I18N::languageTag() === $language_tag ? ' active' : '');
            $menu->addSubmenu(new Menu($active_locale->endonym(), '#', $class, [
                'data-wt-post-url' => route(SelectLanguage::class, ['language' => $language_tag]),
            ]));
        }

        if (count($menu->getSubmenus()) > 1) {
            return $menu;
        }

        return null;
    }

    /**
     * A login menu option (or null if we are already logged in).
     *
     * @return Menu|null
     */
    public function menuLogin(): Menu|null
    {
        if (Auth::check()) {
            return null;
        }

        $request = Registry::container()->get(ServerRequestInterface::class);

        // Return to this page after login...
        $redirect = Validator::queryParams($request)->string('url', (string) $request->getUri());
        $tree     = Validator::attributes($request)->treeOptional();
        $route    = Validator::attributes($request)->route();

        // ...but switch from the tree-page to the user-page
        if ($route->name === TreePage::class) {
            $redirect = route(UserPage::class, ['tree' => $tree?->name()]);
        }

        // Stay on the same tree page
        $url = route(LoginPage::class, ['tree' => $tree?->name(), 'url' => $redirect]);

        return new Menu(I18N::translate('Sign in'), $url, 'menu-login', ['rel' => 'nofollow']);
    }

    /**
     * A logout menu option (or null if we are already logged out).
     *
     * @return Menu|null
     */
    public function menuLogout(): Menu|null
    {
        if (Auth::check()) {
            $parameters = [
                'data-wt-post-url'   => route(Logout::class),
                'data-wt-reload-url' => route(HomePage::class)
            ];

            return new Menu(I18N::translate('Sign out'), '#', 'menu-logout', $parameters);
        }

        return null;
    }

    /**
     * A link to allow users to edit their account settings.
     *
     * @param Tree|null $tree
     *
     * @return Menu
     */
    public function menuMyAccount(Tree|null $tree): Menu
    {
        $url = route(AccountEdit::class, ['tree' => $tree?->name()]);

        return new Menu(I18N::translate('My account'), $url, 'menu-myaccount');
    }

    /**
     * A link to the user's individual record (individual.php).
     *
     * @param Tree $tree
     *
     * @return Menu|null
     */
    public function menuMyIndividualRecord(Tree $tree): Menu|null
    {
        $record = Registry::individualFactory()->make($tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF), $tree);

        if ($record instanceof Individual) {
            return new Menu(I18N::translate('My individual record'), $record->url(), 'menu-myrecord');
        }

        return null;
    }

    /**
     * A link to the user's personal home page.
     *
     * @param Tree $tree
     *
     * @return Menu
     */
    public function menuMyPage(Tree $tree): Menu
    {
        return new Menu(I18N::translate('My page'), route(UserPage::class, ['tree' => $tree->name()]), 'menu-mypage');
    }

    /**
     * A menu for the user's personal pages.
     *
     * @param Tree|null $tree
     *
     * @return Menu|null
     */
    public function menuMyPages(Tree|null $tree): Menu|null
    {
        if (Auth::check()) {
            if ($tree instanceof Tree) {
                return new Menu(I18N::translate('My pages'), '#', 'menu-mymenu', [], array_filter([
                    $this->menuMyPage($tree),
                    $this->menuMyIndividualRecord($tree),
                    $this->menuMyPedigree($tree),
                    $this->menuMyAccount($tree),
                    $this->menuControlPanel($tree),
                    $this->menuChangeBlocks($tree),
                ]));
            }

            return $this->menuMyAccount($tree);
        }

        return null;
    }

    /**
     * A link to the user's individual record.
     *
     * @param Tree $tree
     *
     * @return Menu|null
     */
    public function menuMyPedigree(Tree $tree): Menu|null
    {
        $my_xref = $tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF);

        $module_service = Registry::container()->get(ModuleService::class);
        $pedigree_chart = $module_service
            ->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
            ->first(static fn (ModuleInterface $module): bool => $module instanceof PedigreeChartModule);
filter:
    dependency_paths: ["lib/*"]

        if ($my_xref !== '' && $pedigree_chart instanceof PedigreeChartModule) {
            $individual = Registry::individualFactory()->make($my_xref, $tree);

            if ($individual instanceof Individual) {
                return new Menu(
                    I18N::translate('My pedigree'),
                    $pedigree_chart->chartUrl($individual),
                    'menu-mypedigree'
                );
            }
        }

        return null;
    }

    /**
     * Create a pending changes menu.
     *
     * @param Tree|null $tree
     *
     * @return Menu|null
     */
    public function menuPendingChanges(Tree|null $tree): Menu|null
    {
        if ($tree instanceof Tree && $tree->hasPendingEdit() && Auth::isModerator($tree)) {
            $request = Registry::container()->get(ServerRequestInterface::class);

            $url = route(PendingChanges::class, [
                'tree' => $tree->name(),
                'url' => (string) $request->getUri(),
            ]);

            return new Menu(I18N::translate('Pending changes'), $url, 'menu-pending');
        }

        return null;
    }

    /**
     * Themes menu.
     *
     * @return Menu|null
     */
    public function menuThemes(): Menu|null
    {
        $module_service = Registry::container()->get(ModuleService::class);
        $themes         = $module_service->findByInterface(ModuleThemeInterface::class, false, true);
        $current_theme  = Registry::container()->get(ModuleThemeInterface::class);

        if ($themes->count() > 1) {
            $submenus = $themes->map(static function (ModuleThemeInterface $theme) use ($current_theme): Menu {
                $active     = $theme->name() === $current_theme->name();
                $class      = 'menu-theme-' . $theme->name() . ($active ? ' active' : '');

                return new Menu($theme->title(), '#', $class, [
                    'data-wt-post-url' => route(SelectTheme::class, ['theme' => $theme->name()]),
                ]);
            });

            return new Menu(I18N::translate('Theme'), '#', 'menu-theme', [], $submenus->all());
        }

        return null;
    }

    /**
     * Generate a list of items for the main menu.
     *
     * @param Tree|null $tree
     *
     * @return array<Menu>
     */
    public function genealogyMenu(Tree|null $tree): array
    {
        if ($tree === null) {
            return [];
        }

        $module_service = Registry::container()->get(ModuleService::class);

        return $module_service
            ->findByComponent(ModuleMenuInterface::class, $tree, Auth::user())
            ->map(static fn (ModuleMenuInterface $menu): Menu|null => $menu->getMenu($tree))
            ->filter()
            ->all();
    }

    /**
     * Create the genealogy menu.
     *
     * @param array<Menu> $menus
     *
     * @return string
     */
    public function genealogyMenuContent(array $menus): string
    {
        return implode('', array_map(static fn (Menu $menu): string => view('components/menu-item', ['menu' => $menu]), $menus));
    }

    /**
     * Generate a list of items for the user menu.
     *
     * @param Tree|null $tree
     *
     * @return array<Menu>
     */
    public function userMenu(Tree|null $tree): array
    {
        return array_filter([
            $this->menuPendingChanges($tree),
            $this->menuMyPages($tree),
            $this->menuThemes(),
            $this->menuLanguages(),
            $this->menuLogin(),
            $this->menuLogout(),
        ]);
    }

    /**
     * A list of CSS files to include for this page.
     *
     * @return array<string>
     */
    public function stylesheets(): array
    {
        return [];
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2025 webtrees development team
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <https://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Module;
21
22			use Fisharebest\Webtrees\Auth;
			0 ignored issues – show Bug introduced 2024-11-23 00:11 UTC by Report Bug Copy Issue Report The type `Fisharebest\Webtrees\Auth` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23			use Fisharebest\Webtrees\Contracts\UserInterface;
			0 ignored issues – show Bug introduced 2024-11-23 00:11 UTC by Report Bug Copy Issue Report The type `Fisharebest\Webtrees\Contracts\UserInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
24			use Fisharebest\Webtrees\Fact;
25			use Fisharebest\Webtrees\Gedcom;
26			use Fisharebest\Webtrees\Http\RequestHandlers\AccountEdit;
27			use Fisharebest\Webtrees\Http\RequestHandlers\ControlPanel;
28			use Fisharebest\Webtrees\Http\RequestHandlers\HomePage;
29			use Fisharebest\Webtrees\Http\RequestHandlers\LoginPage;
30			use Fisharebest\Webtrees\Http\RequestHandlers\Logout;
31			use Fisharebest\Webtrees\Http\RequestHandlers\ManageTrees;
32			use Fisharebest\Webtrees\Http\RequestHandlers\PendingChanges;
33			use Fisharebest\Webtrees\Http\RequestHandlers\SelectLanguage;
34			use Fisharebest\Webtrees\Http\RequestHandlers\SelectTheme;
35			use Fisharebest\Webtrees\Http\RequestHandlers\TreePage;
36			use Fisharebest\Webtrees\Http\RequestHandlers\TreePageEdit;
37			use Fisharebest\Webtrees\Http\RequestHandlers\UserPage;
38			use Fisharebest\Webtrees\Http\RequestHandlers\UserPageEdit;
39			use Fisharebest\Webtrees\I18N;
			0 ignored issues – show Bug introduced 2024-11-23 00:11 UTC by Report Bug Copy Issue Report The type `Fisharebest\Webtrees\I18N` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
40			use Fisharebest\Webtrees\Individual;
			0 ignored issues – show Bug introduced 2024-11-23 00:11 UTC by Report Bug Copy Issue Report The type `Fisharebest\Webtrees\Individual` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
41			use Fisharebest\Webtrees\Menu;
42			use Fisharebest\Webtrees\Registry;
43			use Fisharebest\Webtrees\Services\ModuleService;
			0 ignored issues – show Bug introduced 2021-06-13 14:53 UTC by Report Bug Copy Issue Report The type `Fisharebest\Webtrees\Services\ModuleService` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
44			use Fisharebest\Webtrees\Tree;
45			use Fisharebest\Webtrees\Validator;
46			use Psr\Http\Message\ServerRequestInterface;
47
48			use function count;
49			use function in_array;
50			use function route;
51			use function view;
52
53			/**
54			* Trait ModuleThemeTrait - default implementation of ModuleThemeInterface
55			*/
56			trait ModuleThemeTrait
57			{
58			abstract public function title(): string;
59
60			public function description(): string
61			{
62			return I18N::translate('Theme') . ' — ' . $this->title();
63			}
64
65			/**
66			* Generate the facts, for display in charts.
67			*
68			* @param Individual $individual
69			*
70			* @return string
71			*/
72			public function individualBoxFacts(Individual $individual): string
73			{
74			$html = '';
75
76			$opt_tags = preg_split('/\W/', $individual->tree()->getPreference('CHART_BOX_TAGS'), 0, PREG_SPLIT_NO_EMPTY);
77			// Show BIRT or equivalent event
78			foreach (Gedcom::BIRTH_EVENTS as $birttag) {
79			if (!in_array($birttag, $opt_tags, true)) {
80			$event = $individual->facts([$birttag])->first();
81			if ($event instanceof Fact) {
82			$html .= $event->summary();
83			break;
84			}
85			}
86			}
87			// Show optional events (before death)
88			foreach ($opt_tags as $key => $tag) {
89			if (!in_array($tag, Gedcom::DEATH_EVENTS, true)) {
90			$event = $individual->facts([$tag])->first();
91			if ($event instanceof Fact) {
92			$html .= $event->summary();
93			unset($opt_tags[$key]);
94			}
95			}
96			}
97			// Show DEAT or equivalent event
98			foreach (Gedcom::DEATH_EVENTS as $deattag) {
99			$event = $individual->facts([$deattag])->first();
100			if ($event instanceof Fact) {
101			$html .= $event->summary();
102			if (in_array($deattag, $opt_tags, true)) {
103			unset($opt_tags[array_search($deattag, $opt_tags, true)]);
104			}
105			break;
106			}
107			}
108			// Show remaining optional events (after death)
109			foreach ($opt_tags as $tag) {
110			$event = $individual->facts([$tag])->first();
111			if ($event instanceof Fact) {
112			$html .= $event->summary();
113			}
114			}
115
116			return $html;
117			}
118
119			/**
120			* Links, to show in chart boxes;
121			*
122			* @param Individual $individual
123			*
124			* @return array<Menu>
125			*/
126			public function individualBoxMenu(Individual $individual): array
127			{
128			return array_merge(
129			$this->individualBoxMenuCharts($individual),
130			$this->individualBoxMenuFamilyLinks($individual)
131			);
132			}
133
134			/**
135			* Chart links, to show in chart boxes;
136			*
137			* @param Individual $individual
138			*
139			* @return array<Menu>
140			*/
141			public function individualBoxMenuCharts(Individual $individual): array
142			{
143			$menus = [];
144
145			$module_service = Registry::container()->get(ModuleService::class);
146
147			foreach ($module_service->findByComponent(ModuleChartInterface::class, $individual->tree(), Auth::user()) as $chart) {
148			$menu = $chart->chartBoxMenu($individual);
149			if ($menu) {
150			$menus[] = $menu;
151			}
152			}
153
154			usort($menus, static fn (Menu $x, Menu $y): int => I18N::comparator()($x->getLabel(), $y->getLabel()));
155
156			return $menus;
157			}
158
159			/**
160			* Family links, to show in chart boxes.
161			*
162			* @param Individual $individual
163			*
164			* @return array<Menu>
165			*/
166			public function individualBoxMenuFamilyLinks(Individual $individual): array
167			{
168			$menus = [];
169
170			foreach ($individual->spouseFamilies() as $family) {
171			$menus[] = new Menu('<strong>' . I18N::translate('Family with spouse') . '</strong>', $family->url());
172			$spouse = $family->spouse($individual);
173			if ($spouse && $spouse->canShowName()) {
174			$menus[] = new Menu($spouse->fullName(), $spouse->url());
175			}
176			foreach ($family->children() as $child) {
177			if ($child->canShowName()) {
178			$menus[] = new Menu($child->fullName(), $child->url());
179			}
180			}
181			}
182
183			return $menus;
184			}
185
186			/**
187			* Generate a menu item to change the blocks on the current tree/user page.
188			*
189			* @param Tree $tree
190			*
191			* @return Menu\|null
192			*/
193			public function menuChangeBlocks(Tree $tree): Menu\|null
194			{
195			$request = Registry::container()->get(ServerRequestInterface::class);
196			$route = Validator::attributes($request)->route();
197
198			if (Auth::check() && $route->name === UserPage::class) {
199			return new Menu(I18N::translate('Customize this page'), route(UserPageEdit::class, ['tree' => $tree->name()]), 'menu-change-blocks');
200			}
201
202			if (Auth::isManager($tree) && $route->name === TreePage::class) {
203			return new Menu(I18N::translate('Customize this page'), route(TreePageEdit::class, ['tree' => $tree->name()]), 'menu-change-blocks');
204			}
205
206			return null;
207			}
208
209			/**
210			* Generate a menu item for the control panel.
211			*
212			* @param Tree $tree
213			*
214			* @return Menu\|null
215			*/
216			public function menuControlPanel(Tree $tree): Menu\|null
217			{
218			if (Auth::isAdmin()) {
219			return new Menu(I18N::translate('Control panel'), route(ControlPanel::class), 'menu-admin');
220			}
221
222			if (Auth::isManager($tree)) {
223			return new Menu(I18N::translate('Control panel'), route(ManageTrees::class, ['tree' => $tree->name()]), 'menu-admin');
224			}
225
226			return null;
227			}
228
229			/**
230			* A menu to show a list of available languages.
231			*
232			* @return Menu\|null
233			*/
234			public function menuLanguages(): Menu\|null
235			{
236			$menu = new Menu(I18N::translate('Language'), '#', 'menu-language');
237
238			foreach (I18N::activeLocales() as $active_locale) {
239			$language_tag = $active_locale->languageTag();
240			$class = 'menu-language-' . $language_tag . (I18N::languageTag() === $language_tag ? ' active' : '');
241			$menu->addSubmenu(new Menu($active_locale->endonym(), '#', $class, [
242			'data-wt-post-url' => route(SelectLanguage::class, ['language' => $language_tag]),
243			]));
244			}
245
246			if (count($menu->getSubmenus()) > 1) {
247			return $menu;
248			}
249
250			return null;
251			}
252
253			/**
254			* A login menu option (or null if we are already logged in).
255			*
256			* @return Menu\|null
257			*/
258			public function menuLogin(): Menu\|null
259			{
260			if (Auth::check()) {
261			return null;
262			}
263
264			$request = Registry::container()->get(ServerRequestInterface::class);
265
266			// Return to this page after login...
267			$redirect = Validator::queryParams($request)->string('url', (string) $request->getUri());
268			$tree = Validator::attributes($request)->treeOptional();
269			$route = Validator::attributes($request)->route();
270
271			// ...but switch from the tree-page to the user-page
272			if ($route->name === TreePage::class) {
273			$redirect = route(UserPage::class, ['tree' => $tree?->name()]);
274			}
275
276			// Stay on the same tree page
277			$url = route(LoginPage::class, ['tree' => $tree?->name(), 'url' => $redirect]);
278
279			return new Menu(I18N::translate('Sign in'), $url, 'menu-login', ['rel' => 'nofollow']);
280			}
281
282			/**
283			* A logout menu option (or null if we are already logged out).
284			*
285			* @return Menu\|null
286			*/
287			public function menuLogout(): Menu\|null
288			{
289			if (Auth::check()) {
290			$parameters = [
291			'data-wt-post-url' => route(Logout::class),
292			'data-wt-reload-url' => route(HomePage::class)
293			];
294
295			return new Menu(I18N::translate('Sign out'), '#', 'menu-logout', $parameters);
296			}
297
298			return null;
299			}
300
301			/**
302			* A link to allow users to edit their account settings.
303			*
304			* @param Tree\|null $tree
305			*
306			* @return Menu
307			*/
308			public function menuMyAccount(Tree\|null $tree): Menu
309			{
310			$url = route(AccountEdit::class, ['tree' => $tree?->name()]);
311
312			return new Menu(I18N::translate('My account'), $url, 'menu-myaccount');
313			}
314
315			/**
316			* A link to the user's individual record (individual.php).
317			*
318			* @param Tree $tree
319			*
320			* @return Menu\|null
321			*/
322			public function menuMyIndividualRecord(Tree $tree): Menu\|null
323			{
324			$record = Registry::individualFactory()->make($tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF), $tree);
325
326			if ($record instanceof Individual) {
327			return new Menu(I18N::translate('My individual record'), $record->url(), 'menu-myrecord');
328			}
329
330			return null;
331			}
332
333			/**
334			* A link to the user's personal home page.
335			*
336			* @param Tree $tree
337			*
338			* @return Menu
339			*/
340			public function menuMyPage(Tree $tree): Menu
341			{
342			return new Menu(I18N::translate('My page'), route(UserPage::class, ['tree' => $tree->name()]), 'menu-mypage');
343			}
344
345			/**
346			* A menu for the user's personal pages.
347			*
348			* @param Tree\|null $tree
349			*
350			* @return Menu\|null
351			*/
352			public function menuMyPages(Tree\|null $tree): Menu\|null
353			{
354			if (Auth::check()) {
355			if ($tree instanceof Tree) {
356			return new Menu(I18N::translate('My pages'), '#', 'menu-mymenu', [], array_filter([
357			$this->menuMyPage($tree),
358			$this->menuMyIndividualRecord($tree),
359			$this->menuMyPedigree($tree),
360			$this->menuMyAccount($tree),
361			$this->menuControlPanel($tree),
362			$this->menuChangeBlocks($tree),
363			]));
364			}
365
366			return $this->menuMyAccount($tree);
367			}
368
369			return null;
370			}
371
372			/**
373			* A link to the user's individual record.
374			*
375			* @param Tree $tree
376			*
377			* @return Menu\|null
378			*/
379			public function menuMyPedigree(Tree $tree): Menu\|null
380			{
381			$my_xref = $tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF);
382
383			$module_service = Registry::container()->get(ModuleService::class);
384			$pedigree_chart = $module_service
385			->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
386			->first(static fn (ModuleInterface $module): bool => $module instanceof PedigreeChartModule);
			0 ignored issues – show Bug introduced 2024-11-23 00:11 UTC by Report Bug Copy Issue Report The type `Fisharebest\Webtrees\Module\PedigreeChartModule` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
387
388			if ($my_xref !== '' && $pedigree_chart instanceof PedigreeChartModule) {
389			$individual = Registry::individualFactory()->make($my_xref, $tree);
390
391			if ($individual instanceof Individual) {
392			return new Menu(
393			I18N::translate('My pedigree'),
394			$pedigree_chart->chartUrl($individual),
395			'menu-mypedigree'
396			);
397			}
398			}
399
400			return null;
401			}
402
403			/**
404			* Create a pending changes menu.
405			*
406			* @param Tree\|null $tree
407			*
408			* @return Menu\|null
409			*/
410			public function menuPendingChanges(Tree\|null $tree): Menu\|null
411			{
412			if ($tree instanceof Tree && $tree->hasPendingEdit() && Auth::isModerator($tree)) {
413			$request = Registry::container()->get(ServerRequestInterface::class);
414
415			$url = route(PendingChanges::class, [
416			'tree' => $tree->name(),
417			'url' => (string) $request->getUri(),
418			]);
419
420			return new Menu(I18N::translate('Pending changes'), $url, 'menu-pending');
421			}
422
423			return null;
424			}
425
426			/**
427			* Themes menu.
428			*
429			* @return Menu\|null
430			*/
431			public function menuThemes(): Menu\|null
432			{
433			$module_service = Registry::container()->get(ModuleService::class);
434			$themes = $module_service->findByInterface(ModuleThemeInterface::class, false, true);
435			$current_theme = Registry::container()->get(ModuleThemeInterface::class);
436
437			if ($themes->count() > 1) {
438			$submenus = $themes->map(static function (ModuleThemeInterface $theme) use ($current_theme): Menu {
439			$active = $theme->name() === $current_theme->name();
440			$class = 'menu-theme-' . $theme->name() . ($active ? ' active' : '');
441
442			return new Menu($theme->title(), '#', $class, [
443			'data-wt-post-url' => route(SelectTheme::class, ['theme' => $theme->name()]),
444			]);
445			});
446
447			return new Menu(I18N::translate('Theme'), '#', 'menu-theme', [], $submenus->all());
448			}
449
450			return null;
451			}
452
453			/**
454			* Generate a list of items for the main menu.
455			*
456			* @param Tree\|null $tree
457			*
458			* @return array<Menu>
459			*/
460			public function genealogyMenu(Tree\|null $tree): array
461			{
462			if ($tree === null) {
463			return [];
464			}
465
466			$module_service = Registry::container()->get(ModuleService::class);
467
468			return $module_service
469			->findByComponent(ModuleMenuInterface::class, $tree, Auth::user())
470			->map(static fn (ModuleMenuInterface $menu): Menu\|null => $menu->getMenu($tree))
471			->filter()
472			->all();
473			}
474
475			/**
476			* Create the genealogy menu.
477			*
478			* @param array<Menu> $menus
479			*
480			* @return string
481			*/
482			public function genealogyMenuContent(array $menus): string
483			{
484			return implode('', array_map(static fn (Menu $menu): string => view('components/menu-item', ['menu' => $menu]), $menus));
485			}
486
487			/**
488			* Generate a list of items for the user menu.
489			*
490			* @param Tree\|null $tree
491			*
492			* @return array<Menu>
493			*/
494			public function userMenu(Tree\|null $tree): array
495			{
496			return array_filter([
497			$this->menuPendingChanges($tree),
498			$this->menuMyPages($tree),
499			$this->menuThemes(),
500			$this->menuLanguages(),
501			$this->menuLogin(),
502			$this->menuLogout(),
503			]);
504			}
505
506			/**
507			* A list of CSS files to include for this page.
508			*
509			* @return array<string>
510			*/
511			public function stylesheets(): array
512			{
513			return [];
514			}
515			}
516

fisharebest / webtrees

ModuleThemeTrait::menuControlPanel() A last analyzed 2025-10-31 12:49 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ModuleThemeTrait::menuControlPanel() A
last analyzed 2025-10-31 12:49 UTC