PedigreeMapModule::getMapDataAction() - Code Metrics - Inspection of "Inline trivial function" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1792ff...620da7 )

by Greg

created 2020-02-04 17:12 UTC

PedigreeMapModule::getMapDataAction() B

↳ Parent: PedigreeMapModule

Complexity

Conditions	9
Paths	14

Size

Total Lines	76
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	9
eloc	46
c	2
b	0
f	0
nc	14
nop	1
dl	0
loc	76
rs	7.6226

How to fix Long Method

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Module;

use Aura\Router\RouterContainer;
use Fig\Http\Message\RequestMethodInterface;
use Fig\Http\Message\StatusCodeInterface;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\Functions\Functions;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Location;
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Services\ChartService;
use Fisharebest\Webtrees\Tree;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use function app;
use function array_key_exists;
use function assert;
use function count;
use function intdiv;
use function is_string;
use function redirect;
use function response;
use function route;
use function strip_tags;
use function ucfirst;
use function view;

/**
 * Class PedigreeMapModule
 */
class PedigreeMapModule extends AbstractModule implements ModuleChartInterface, RequestHandlerInterface
{
    use ModuleChartTrait;

    protected const ROUTE_URL  = '/tree/{tree}/pedigree-map-{generations}/{xref}';

    // Defaults
    public const DEFAULT_GENERATIONS = '4';
    public const DEFAULT_PARAMETERS  = [
        'generations' => self::DEFAULT_GENERATIONS,
    ];

    // Limits
    public const MAXIMUM_GENERATIONS = 10;

    // CSS colors for each generation
    private const COLORS = [
        'Red',
        'Green',
        'Blue',
        'Gold',
        'Cyan',
        'Orange',
        'DarkBlue',
        'LightGreen',
        'Magenta',
        'Brown',
    ];

    private const DEFAULT_ZOOM = 2;

    /** @var ChartService */
    private $chart_service;

    /**
     * PedigreeMapModule constructor.
     *
     * @param ChartService $chart_service
     */
    public function __construct(ChartService $chart_service)
    {
        $this->chart_service = $chart_service;
    }

    /**
     * Initialization.
     *
     * @return void
     */
    public function boot(): void
    {
        $router_container = app(RouterContainer::class);
        assert($router_container instanceof RouterContainer);

        $router_container->getMap()
            ->get(static::class, static::ROUTE_URL, $this)
            ->allows(RequestMethodInterface::METHOD_POST)
            ->tokens([
                'generations' => '\d+',
            ]);
    }

    /**
     * How should this module be identified in the control panel, etc.?
     *
     * @return string
     */
    public function title(): string
    {
        /* I18N: Name of a module */
        return I18N::translate('Pedigree map');
    }

    /**
     * A sentence describing what this module does.
     *
     * @return string
     */
    public function description(): string
    {
        /* I18N: Description of the “Pedigree map” module */
        return I18N::translate('Show the birthplace of ancestors on a map.');
    }

    /**
     * CSS class for the URL.
     *
     * @return string
     */
    public function chartMenuClass(): string
    {
        return 'menu-chart-pedigreemap';
    }

    /**
     * Return a menu item for this chart - for use in individual boxes.
     *
     * @param Individual $individual
     *
     * @return Menu|null
     */
    public function chartBoxMenu(Individual $individual): ?Menu
    {
        return $this->chartMenu($individual);
    }

    /**
     * The title for a specific instance of this chart.
     *
     * @param Individual $individual
     *
     * @return string
     */
    public function chartTitle(Individual $individual): string
    {
        /* I18N: %s is an individual’s name */
        return I18N::translate('Pedigree map of %s', $individual->fullName());
    }

    /**
     * The URL for a page showing chart options.
     *
     * @param Individual $individual
     * @param mixed[]    $parameters
     *
     * @return string
     */
    public function chartUrl(Individual $individual, array $parameters = []): string
    {
        return route(static::class, [
                'tree' => $individual->tree()->name(),
                'xref' => $individual->xref(),
            ] + $parameters + self::DEFAULT_PARAMETERS);
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function getMapDataAction(ServerRequestInterface $request): ResponseInterface
    {
        $tree = $request->getAttribute('tree');
        assert($tree instanceof Tree);

        $xref        = $request->getQueryParams()['xref'];
        $individual  = Individual::getInstance($xref, $tree);
        $color_count = count(self::COLORS);

        $facts = $this->getPedigreeMapFacts($request, $this->chart_service);

        $geojson = [
            'type'     => 'FeatureCollection',
            'features' => [],
        ];

        $sosa_points = [];

        foreach ($facts as $sosa => $fact) {
            $location = new Location($fact->place()->gedcomName());

            // Use the co-ordinates from the fact (if they exist).
            $latitude  = $fact->latitude();
            $longitude = $fact->longitude();

            // Use the co-ordinates from the location otherwise.
            if ($latitude === 0.0 && $longitude === 0.0) {
                $latitude  = $location->latitude();
                $longitude = $location->longitude();
            }

            if ($latitude !== 0.0 || $longitude !== 0.0) {
                $polyline           = null;
                $sosa_points[$sosa] = [$latitude, $longitude];
                $sosa_child         = intdiv($sosa, 2);
                $color              = self::COLORS[$sosa_child % $color_count];

                if (array_key_exists($sosa_child, $sosa_points)) {
                    // Would like to use a GeometryCollection to hold LineStrings
                    // rather than generate polylines but the MarkerCluster library
                    // doesn't seem to like them
                    $polyline = [
                        'points'  => [
                            $sosa_points[$sosa_child],
                            [$latitude, $longitude],
                        ],
                        'options' => [
                            'color' => $color,
                        ],
                    ];
                }
                $geojson['features'][] = [
                    'type'       => 'Feature',
                    'id'         => $sosa,
                    'geometry'   => [
                        'type'        => 'Point',
                        'coordinates' => [$longitude, $latitude],
                    ],
                    'properties' => [
                        'polyline'  => $polyline,
                        'iconcolor' => $color,
                        'tooltip'   => strip_tags($fact->place()->fullName()),
                        'summary'   => view('modules/pedigree-map/events', [
                            'fact'         => $fact,
                            'relationship' => ucfirst($this->getSosaName($sosa)),
                            'sosa'         => $sosa,
                        ]),
                        'zoom'      => $location->zoom() ?: self::DEFAULT_ZOOM,
                    ],
                ];
            }
        }

        $code = $facts === [] ? StatusCodeInterface::STATUS_NO_CONTENT : StatusCodeInterface::STATUS_OK;

        return response($geojson, $code);
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $tree = $request->getAttribute('tree');
        assert($tree instanceof Tree);

        $xref = $request->getAttribute('xref');
        assert(is_string($xref));

        $individual  = Individual::getInstance($xref, $tree);
        $individual  = Auth::checkIndividualAccess($individual);

        $user        = $request->getAttribute('user');
        $generations = (int) $request->getAttribute('generations');
        Auth::checkComponentAccess($this, 'chart', $tree, $user);

        // Convert POST requests into GET requests for pretty URLs.
        if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
            $params = (array) $request->getParsedBody();

            return redirect(route(static::class, [
                'tree'        => $tree->name(),
                'xref'        => $params['xref'],
                'generations' => $params['generations'],
            ]));
        }

        $map = view('modules/pedigree-map/chart', [
            'individual'  => $individual,
            'generations' => $generations,
        ]);

        return $this->viewResponse('modules/pedigree-map/page', [
            'module'         => $this->name(),
            /* I18N: %s is an individual’s name */
            'title'          => I18N::translate('Pedigree map of %s', $individual->fullName()),
            'tree'           => $tree,
            'individual'     => $individual,
            'generations'    => $generations,
            'maxgenerations' => self::MAXIMUM_GENERATIONS,
            'map'            => $map,
        ]);
    }

    /**
     * @param ServerRequestInterface $request
     * @param ChartService           $chart_service
     *
     * @return array
     */
    private function getPedigreeMapFacts(ServerRequestInterface $request, ChartService $chart_service): array
    {
        $tree = $request->getAttribute('tree');
        assert($tree instanceof Tree);

        $generations = (int) $request->getQueryParams()['generations'];
        $xref        = $request->getQueryParams()['xref'];
        $individual  = Individual::getInstance($xref, $tree);
        $ancestors   = $chart_service->sosaStradonitzAncestors($individual, $generations);
        $facts       = [];
        foreach ($ancestors as $sosa => $person) {
            if ($person->canShow()) {
                $birth = $person->facts(['BIRT'])->first();
                if ($birth instanceof Fact && $birth->place()->gedcomName() !== '') {
                    $facts[$sosa] = $birth;
                }
            }
        }

        return $facts;
    }

    /**
     * builds and returns sosa relationship name in the active language
     *
     * @param int $sosa Sosa number
     *
     * @return string
     */
    private function getSosaName(int $sosa): string
    {
        $path = '';

        while ($sosa > 1) {
            if ($sosa % 2 === 1) {
                $path = 'mot' . $path;
            } else {
                $path = 'fat' . $path;
            }
            $sosa = intdiv($sosa, 2);
        }

        return Functions::getRelationshipNameFromPath($path);
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Module;
21
22			use Aura\Router\RouterContainer;
23			use Fig\Http\Message\RequestMethodInterface;
24			use Fig\Http\Message\StatusCodeInterface;
25			use Fisharebest\Webtrees\Auth;
26			use Fisharebest\Webtrees\Fact;
27			use Fisharebest\Webtrees\Functions\Functions;
28			use Fisharebest\Webtrees\I18N;
29			use Fisharebest\Webtrees\Individual;
30			use Fisharebest\Webtrees\Location;
31			use Fisharebest\Webtrees\Menu;
32			use Fisharebest\Webtrees\Services\ChartService;
33			use Fisharebest\Webtrees\Tree;
34			use Psr\Http\Message\ResponseInterface;
35			use Psr\Http\Message\ServerRequestInterface;
36			use Psr\Http\Server\RequestHandlerInterface;
37			use function app;
38			use function array_key_exists;
39			use function assert;
40			use function count;
41			use function intdiv;
42			use function is_string;
43			use function redirect;
44			use function response;
45			use function route;
46			use function strip_tags;
47			use function ucfirst;
48			use function view;
49
50			/**
51			* Class PedigreeMapModule
52			*/
53			class PedigreeMapModule extends AbstractModule implements ModuleChartInterface, RequestHandlerInterface
54			{
55			use ModuleChartTrait;
56
57			protected const ROUTE_URL = '/tree/{tree}/pedigree-map-{generations}/{xref}';
58
59			// Defaults
60			public const DEFAULT_GENERATIONS = '4';
61			public const DEFAULT_PARAMETERS = [
62			'generations' => self::DEFAULT_GENERATIONS,
63			];
64
65			// Limits
66			public const MAXIMUM_GENERATIONS = 10;
67
68			// CSS colors for each generation
69			private const COLORS = [
70			'Red',
71			'Green',
72			'Blue',
73			'Gold',
74			'Cyan',
75			'Orange',
76			'DarkBlue',
77			'LightGreen',
78			'Magenta',
79			'Brown',
80			];
81
82			private const DEFAULT_ZOOM = 2;
83
84			/** @var ChartService */
85			private $chart_service;
86
87			/**
88			* PedigreeMapModule constructor.
89			*
90			* @param ChartService $chart_service
91			*/
92			public function __construct(ChartService $chart_service)
93			{
94			$this->chart_service = $chart_service;
95			}
96
97			/**
98			* Initialization.
99			*
100			* @return void
101			*/
102			public function boot(): void
103			{
104			$router_container = app(RouterContainer::class);
105			assert($router_container instanceof RouterContainer);
106
107			$router_container->getMap()
108			->get(static::class, static::ROUTE_URL, $this)
109			->allows(RequestMethodInterface::METHOD_POST)
110			->tokens([
111			'generations' => '\d+',
112			]);
113			}
114
115			/**
116			* How should this module be identified in the control panel, etc.?
117			*
118			* @return string
119			*/
120			public function title(): string
121			{
122			/* I18N: Name of a module */
123			return I18N::translate('Pedigree map');
124			}
125
126			/**
127			* A sentence describing what this module does.
128			*
129			* @return string
130			*/
131			public function description(): string
132			{
133			/* I18N: Description of the “Pedigree map” module */
134			return I18N::translate('Show the birthplace of ancestors on a map.');
135			}
136
137			/**
138			* CSS class for the URL.
139			*
140			* @return string
141			*/
142			public function chartMenuClass(): string
143			{
144			return 'menu-chart-pedigreemap';
145			}
146
147			/**
148			* Return a menu item for this chart - for use in individual boxes.
149			*
150			* @param Individual $individual
151			*
152			* @return Menu\|null
153			*/
154			public function chartBoxMenu(Individual $individual): ?Menu
155			{
156			return $this->chartMenu($individual);
157			}
158
159			/**
160			* The title for a specific instance of this chart.
161			*
162			* @param Individual $individual
163			*
164			* @return string
165			*/
166			public function chartTitle(Individual $individual): string
167			{
168			/* I18N: %s is an individual’s name */
169			return I18N::translate('Pedigree map of %s', $individual->fullName());
170			}
171
172			/**
173			* The URL for a page showing chart options.
174			*
175			* @param Individual $individual
176			* @param mixed[] $parameters
177			*
178			* @return string
179			*/
180			public function chartUrl(Individual $individual, array $parameters = []): string
181			{
182			return route(static::class, [
183			'tree' => $individual->tree()->name(),
184			'xref' => $individual->xref(),
185			] + $parameters + self::DEFAULT_PARAMETERS);
186			}
187
188			/**
189			* @param ServerRequestInterface $request
190			*
191			* @return ResponseInterface
192			*/
193			public function getMapDataAction(ServerRequestInterface $request): ResponseInterface
194			{
195			$tree = $request->getAttribute('tree');
196			assert($tree instanceof Tree);
197
198			$xref = $request->getQueryParams()['xref'];
199			$individual = Individual::getInstance($xref, $tree);
200			$color_count = count(self::COLORS);
201
202			$facts = $this->getPedigreeMapFacts($request, $this->chart_service);
203
204			$geojson = [
205			'type' => 'FeatureCollection',
206			'features' => [],
207			];
208
209			$sosa_points = [];
210
211			foreach ($facts as $sosa => $fact) {
212			$location = new Location($fact->place()->gedcomName());
213
214			// Use the co-ordinates from the fact (if they exist).
215			$latitude = $fact->latitude();
216			$longitude = $fact->longitude();
217
218			// Use the co-ordinates from the location otherwise.
219			if ($latitude === 0.0 && $longitude === 0.0) {
220			$latitude = $location->latitude();
221			$longitude = $location->longitude();
222			}
223
224			if ($latitude !== 0.0 \|\| $longitude !== 0.0) {
225			$polyline = null;
226			$sosa_points[$sosa] = [$latitude, $longitude];
227			$sosa_child = intdiv($sosa, 2);
228			$color = self::COLORS[$sosa_child % $color_count];
229
230			if (array_key_exists($sosa_child, $sosa_points)) {
231			// Would like to use a GeometryCollection to hold LineStrings
232			// rather than generate polylines but the MarkerCluster library
233			// doesn't seem to like them
234			$polyline = [
235			'points' => [
236			$sosa_points[$sosa_child],
237			[$latitude, $longitude],
238			],
239			'options' => [
240			'color' => $color,
241			],
242			];
243			}
244			$geojson['features'][] = [
245			'type' => 'Feature',
246			'id' => $sosa,
247			'geometry' => [
248			'type' => 'Point',
249			'coordinates' => [$longitude, $latitude],
250			],
251			'properties' => [
252			'polyline' => $polyline,
253			'iconcolor' => $color,
254			'tooltip' => strip_tags($fact->place()->fullName()),
255			'summary' => view('modules/pedigree-map/events', [
256			'fact' => $fact,
257			'relationship' => ucfirst($this->getSosaName($sosa)),
258			'sosa' => $sosa,
259			]),
260			'zoom' => $location->zoom() ?: self::DEFAULT_ZOOM,
261			],
262			];
263			}
264			}
265
266			$code = $facts === [] ? StatusCodeInterface::STATUS_NO_CONTENT : StatusCodeInterface::STATUS_OK;
267
268			return response($geojson, $code);
269			}
270
271			/**
272			* @param ServerRequestInterface $request
273			*
274			* @return ResponseInterface
275			*/
276			public function handle(ServerRequestInterface $request): ResponseInterface
277			{
278			$tree = $request->getAttribute('tree');
279			assert($tree instanceof Tree);
280
281			$xref = $request->getAttribute('xref');
282			assert(is_string($xref));
283
284			$individual = Individual::getInstance($xref, $tree);
285			$individual = Auth::checkIndividualAccess($individual);
286
287			$user = $request->getAttribute('user');
288			$generations = (int) $request->getAttribute('generations');
289			Auth::checkComponentAccess($this, 'chart', $tree, $user);
290
291			// Convert POST requests into GET requests for pretty URLs.
292			if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
293			$params = (array) $request->getParsedBody();
294
295			return redirect(route(static::class, [
296			'tree' => $tree->name(),
297			'xref' => $params['xref'],
298			'generations' => $params['generations'],
299			]));
300			}
301
302			$map = view('modules/pedigree-map/chart', [
303			'individual' => $individual,
304			'generations' => $generations,
305			]);
306
307			return $this->viewResponse('modules/pedigree-map/page', [
308			'module' => $this->name(),
309			/* I18N: %s is an individual’s name */
310			'title' => I18N::translate('Pedigree map of %s', $individual->fullName()),
311			'tree' => $tree,
312			'individual' => $individual,
313			'generations' => $generations,
314			'maxgenerations' => self::MAXIMUM_GENERATIONS,
315			'map' => $map,
316			]);
317			}
318
319			/**
320			* @param ServerRequestInterface $request
321			* @param ChartService $chart_service
322			*
323			* @return array
324			*/
325			private function getPedigreeMapFacts(ServerRequestInterface $request, ChartService $chart_service): array
326			{
327			$tree = $request->getAttribute('tree');
328			assert($tree instanceof Tree);
329
330			$generations = (int) $request->getQueryParams()['generations'];
331			$xref = $request->getQueryParams()['xref'];
332			$individual = Individual::getInstance($xref, $tree);
333			$ancestors = $chart_service->sosaStradonitzAncestors($individual, $generations);
334			$facts = [];
335			foreach ($ancestors as $sosa => $person) {
336			if ($person->canShow()) {
337			$birth = $person->facts(['BIRT'])->first();
338			if ($birth instanceof Fact && $birth->place()->gedcomName() !== '') {
339			$facts[$sosa] = $birth;
340			}
341			}
342			}
343
344			return $facts;
345			}
346
347			/**
348			* builds and returns sosa relationship name in the active language
349			*
350			* @param int $sosa Sosa number
351			*
352			* @return string
353			*/
354			private function getSosaName(int $sosa): string
355			{
356			$path = '';
357
358			while ($sosa > 1) {
359			if ($sosa % 2 === 1) {
360			$path = 'mot' . $path;
361			} else {
362			$path = 'fat' . $path;
363			}
364			$sosa = intdiv($sosa, 2);
365			}
366
367			return Functions::getRelationshipNameFromPath($path);
368			}
369			}
370

fisharebest / webtrees

Push — master ( 1792ff...620da7 )

PedigreeMapModule::getMapDataAction() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like