PedigreeMapModule::getMapData() - Code Metrics - Inspection of "Remove json callback (#3053)" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ab039d...985793 )

by Greg

created 2020-02-04 18:56 UTC

PedigreeMapModule::getMapData() B

↳ Parent: PedigreeMapModule

Complexity

Conditions	8
Paths	7

Size

Total Lines	72
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	43
nc	7
nop	1
dl	0
loc	72
rs	7.9875
c	0
b	0
f	0

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\Gedcom;
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;
    private const MINZOOM            = 2;

    // 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 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', [
            'data'     => $this->getMapData($request),
            'provider' => [
                'name'    => "OpenStreetMap.Mapnik",
                'options' => []
            ]
        ]);

        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
     *
     * @return array $geojson
     *
     */
    private function getMapData(ServerRequestInterface $request): array
    {
        $tree = $request->getAttribute('tree');
        assert($tree instanceof 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,
                    ],
                ];
            }
        }

        return $geojson;
    }

    /**
     * @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->getAttribute('generations');
        $xref        = $request->getAttribute('xref');
        $individual  = Individual::getInstance($xref, $tree);
        $ancestors   = $chart_service->sosaStradonitzAncestors($individual, $generations);
        $facts       = [];
        foreach ($ancestors as $sosa => $person) {
            if ($person->canShow()) {
                $birth = $person->facts(Gedcom::BIRTH_EVENTS, true)
                    ->filter(static function (Fact $fact): bool {
                        return $fact->place()->gedcomName() !== '';
                    })
                    ->first();

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

fisharebest / webtrees

Push — master ( ab039d...985793 )

PedigreeMapModule::getMapData() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like