xref: /webtrees/app/Statistics/Repository/IndividualRepository.php (revision dd7dd2a11a7399e56fa4d21fb56b0ecdff69c7d0)
18add1155SRico Sonntag<?php
28add1155SRico Sonntag/**
38add1155SRico Sonntag * webtrees: online genealogy
48add1155SRico Sonntag * Copyright (C) 2018 webtrees development team
58add1155SRico Sonntag * This program is free software: you can redistribute it and/or modify
68add1155SRico Sonntag * it under the terms of the GNU General Public License as published by
78add1155SRico Sonntag * the Free Software Foundation, either version 3 of the License, or
88add1155SRico Sonntag * (at your option) any later version.
98add1155SRico Sonntag * This program is distributed in the hope that it will be useful,
108add1155SRico Sonntag * but WITHOUT ANY WARRANTY; without even the implied warranty of
118add1155SRico Sonntag * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
128add1155SRico Sonntag * GNU General Public License for more details.
138add1155SRico Sonntag * You should have received a copy of the GNU General Public License
148add1155SRico Sonntag * along with this program. If not, see <http://www.gnu.org/licenses/>.
158add1155SRico Sonntag */
168add1155SRico Sonntagdeclare(strict_types=1);
178add1155SRico Sonntag
188add1155SRico Sonntagnamespace Fisharebest\Webtrees\Statistics\Repository;
198add1155SRico Sonntag
208add1155SRico Sonntaguse Fisharebest\Webtrees\Auth;
218add1155SRico Sonntaguse Fisharebest\Webtrees\Database;
228add1155SRico Sonntaguse Fisharebest\Webtrees\Functions\FunctionsDate;
238add1155SRico Sonntaguse Fisharebest\Webtrees\Functions\FunctionsPrintLists;
248add1155SRico Sonntaguse Fisharebest\Webtrees\Gedcom;
258add1155SRico Sonntaguse Fisharebest\Webtrees\I18N;
268add1155SRico Sonntaguse Fisharebest\Webtrees\Individual;
278add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartAge;
288add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartBirth;
298add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartCommonGiven;
308add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartCommonSurname;
318add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartDeath;
328add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartFamilyWithSources;
3388de55fdSRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartIndividualWithSources;
348add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartMortality;
358add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Google\ChartSex;
368add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Helper\Sql;
378add1155SRico Sonntaguse Fisharebest\Webtrees\Statistics\Repository\Interfaces\IndividualRepositoryInterface;
388add1155SRico Sonntaguse Fisharebest\Webtrees\Tree;
398add1155SRico Sonntaguse Illuminate\Database\Capsule\Manager as DB;
403dc8167dSGreg Roachuse Illuminate\Database\Query\Builder;
418add1155SRico Sonntaguse Illuminate\Database\Query\JoinClause;
428add1155SRico Sonntag
438add1155SRico Sonntag/**
448add1155SRico Sonntag *
458add1155SRico Sonntag */
468add1155SRico Sonntagclass IndividualRepository implements IndividualRepositoryInterface
478add1155SRico Sonntag{
488add1155SRico Sonntag    /**
498add1155SRico Sonntag     * @var Tree
508add1155SRico Sonntag     */
518add1155SRico Sonntag    private $tree;
528add1155SRico Sonntag
538add1155SRico Sonntag    /**
548add1155SRico Sonntag     * Constructor.
558add1155SRico Sonntag     *
568add1155SRico Sonntag     * @param Tree $tree
578add1155SRico Sonntag     */
588add1155SRico Sonntag    public function __construct(Tree $tree)
598add1155SRico Sonntag    {
608add1155SRico Sonntag        $this->tree = $tree;
618add1155SRico Sonntag    }
628add1155SRico Sonntag
638add1155SRico Sonntag    /**
648add1155SRico Sonntag     * Run an SQL query and cache the result.
658add1155SRico Sonntag     *
668add1155SRico Sonntag     * @param string $sql
678add1155SRico Sonntag     *
688add1155SRico Sonntag     * @return \stdClass[]
698add1155SRico Sonntag     */
708add1155SRico Sonntag    private function runSql(string $sql): array
718add1155SRico Sonntag    {
728add1155SRico Sonntag        return Sql::runSql($sql);
738add1155SRico Sonntag    }
748add1155SRico Sonntag
758add1155SRico Sonntag    /**
768add1155SRico Sonntag     * Find common given names.
778add1155SRico Sonntag     *
788add1155SRico Sonntag     * @param string $sex
798add1155SRico Sonntag     * @param string $type
808add1155SRico Sonntag     * @param bool   $show_tot
818add1155SRico Sonntag     * @param int    $threshold
828add1155SRico Sonntag     * @param int    $maxtoshow
838add1155SRico Sonntag     *
848add1155SRico Sonntag     * @return string|int[]
858add1155SRico Sonntag     */
868add1155SRico Sonntag    private function commonGivenQuery(string $sex, string $type, bool $show_tot, int $threshold, int $maxtoshow)
878add1155SRico Sonntag    {
888add1155SRico Sonntag        switch ($sex) {
898add1155SRico Sonntag            case 'M':
908add1155SRico Sonntag                $sex_sql = "i_sex='M'";
918add1155SRico Sonntag                break;
928add1155SRico Sonntag            case 'F':
938add1155SRico Sonntag                $sex_sql = "i_sex='F'";
948add1155SRico Sonntag                break;
958add1155SRico Sonntag            case 'U':
968add1155SRico Sonntag                $sex_sql = "i_sex='U'";
978add1155SRico Sonntag                break;
988add1155SRico Sonntag            case 'B':
998add1155SRico Sonntag            default:
1008add1155SRico Sonntag                $sex_sql = "i_sex<>'U'";
1018add1155SRico Sonntag                break;
1028add1155SRico Sonntag        }
1038add1155SRico Sonntag
1048add1155SRico Sonntag        $ged_id = $this->tree->id();
1058add1155SRico Sonntag
1068add1155SRico Sonntag        $rows     = Database::prepare("SELECT n_givn, COUNT(*) AS num FROM `##name` JOIN `##individuals` ON (n_id=i_id AND n_file=i_file) WHERE n_file={$ged_id} AND n_type<>'_MARNM' AND n_givn NOT IN ('@P.N.', '') AND LENGTH(n_givn)>1 AND {$sex_sql} GROUP BY n_id, n_givn")
1078add1155SRico Sonntag            ->fetchAll();
1088add1155SRico Sonntag
1098add1155SRico Sonntag        $nameList = [];
1108add1155SRico Sonntag        foreach ($rows as $row) {
1118add1155SRico Sonntag            $row->num = (int) $row->num;
1128add1155SRico Sonntag
1138add1155SRico Sonntag            // Split “John Thomas” into “John” and “Thomas” and count against both totals
1148add1155SRico Sonntag            foreach (explode(' ', $row->n_givn) as $given) {
1158add1155SRico Sonntag                // Exclude initials and particles.
1168add1155SRico Sonntag                if (!preg_match('/^([A-Z]|[a-z]{1,3})$/', $given)) {
1178add1155SRico Sonntag                    if (\array_key_exists($given, $nameList)) {
1188add1155SRico Sonntag                        $nameList[$given] += (int) $row->num;
1198add1155SRico Sonntag                    } else {
1208add1155SRico Sonntag                        $nameList[$given] = (int) $row->num;
1218add1155SRico Sonntag                    }
1228add1155SRico Sonntag                }
1238add1155SRico Sonntag            }
1248add1155SRico Sonntag        }
1258add1155SRico Sonntag        arsort($nameList);
1268add1155SRico Sonntag        $nameList = \array_slice($nameList, 0, $maxtoshow);
1278add1155SRico Sonntag
1288add1155SRico Sonntag        foreach ($nameList as $given => $total) {
1298add1155SRico Sonntag            if ($total < $threshold) {
1308add1155SRico Sonntag                unset($nameList[$given]);
1318add1155SRico Sonntag            }
1328add1155SRico Sonntag        }
1338add1155SRico Sonntag
1348add1155SRico Sonntag        switch ($type) {
1358add1155SRico Sonntag            case 'chart':
1368add1155SRico Sonntag                return $nameList;
1378add1155SRico Sonntag
1388add1155SRico Sonntag            case 'table':
1398add1155SRico Sonntag                return view('lists/given-names-table', [
1408add1155SRico Sonntag                    'given_names' => $nameList,
1418add1155SRico Sonntag                ]);
1428add1155SRico Sonntag
1438add1155SRico Sonntag            case 'list':
1448add1155SRico Sonntag                return view('lists/given-names-list', [
1458add1155SRico Sonntag                    'given_names' => $nameList,
1468add1155SRico Sonntag                    'show_totals' => $show_tot,
1478add1155SRico Sonntag                ]);
1488add1155SRico Sonntag
1498add1155SRico Sonntag            case 'nolist':
1508add1155SRico Sonntag            default:
1518add1155SRico Sonntag                array_walk($nameList, function (int &$value, string $key) use ($show_tot): void {
1528add1155SRico Sonntag                    if ($show_tot) {
1538add1155SRico Sonntag                        $value = '<span dir="auto">' . e($key);
1548add1155SRico Sonntag                    } else {
1558add1155SRico Sonntag                        $value = '<span dir="auto">' . e($key) . ' (' . I18N::number($value) . ')';
1568add1155SRico Sonntag                    }
1578add1155SRico Sonntag                });
1588add1155SRico Sonntag
1598add1155SRico Sonntag                return implode(I18N::$list_separator, $nameList);
1608add1155SRico Sonntag        }
1618add1155SRico Sonntag    }
1628add1155SRico Sonntag
1638add1155SRico Sonntag    /**
1648add1155SRico Sonntag     * Find common give names.
1658add1155SRico Sonntag     *
1668add1155SRico Sonntag     * @param int $threshold
1678add1155SRico Sonntag     * @param int $maxtoshow
1688add1155SRico Sonntag     *
1698add1155SRico Sonntag     * @return string
1708add1155SRico Sonntag     */
1718add1155SRico Sonntag    public function commonGiven(int $threshold = 1, int $maxtoshow = 10): string
1728add1155SRico Sonntag    {
1738add1155SRico Sonntag        return $this->commonGivenQuery('B', 'nolist', false, $threshold, $maxtoshow);
1748add1155SRico Sonntag    }
1758add1155SRico Sonntag
1768add1155SRico Sonntag    /**
1778add1155SRico Sonntag     * Find common give names.
1788add1155SRico Sonntag     *
1798add1155SRico Sonntag     * @param int $threshold
1808add1155SRico Sonntag     * @param int $maxtoshow
1818add1155SRico Sonntag     *
1828add1155SRico Sonntag     * @return string
1838add1155SRico Sonntag     */
1848add1155SRico Sonntag    public function commonGivenTotals(int $threshold = 1, int $maxtoshow = 10): string
1858add1155SRico Sonntag    {
1868add1155SRico Sonntag        return $this->commonGivenQuery('B', 'nolist', true, $threshold, $maxtoshow);
1878add1155SRico Sonntag    }
1888add1155SRico Sonntag
1898add1155SRico Sonntag    /**
1908add1155SRico Sonntag     * Find common give names.
1918add1155SRico Sonntag     *
1928add1155SRico Sonntag     * @param int $threshold
1938add1155SRico Sonntag     * @param int $maxtoshow
1948add1155SRico Sonntag     *
1958add1155SRico Sonntag     * @return string
1968add1155SRico Sonntag     */
1978add1155SRico Sonntag    public function commonGivenList(int $threshold = 1, int $maxtoshow = 10): string
1988add1155SRico Sonntag    {
1998add1155SRico Sonntag        return $this->commonGivenQuery('B', 'list', false, $threshold, $maxtoshow);
2008add1155SRico Sonntag    }
2018add1155SRico Sonntag
2028add1155SRico Sonntag    /**
2038add1155SRico Sonntag     * Find common give names.
2048add1155SRico Sonntag     *
2058add1155SRico Sonntag     * @param int $threshold
2068add1155SRico Sonntag     * @param int $maxtoshow
2078add1155SRico Sonntag     *
2088add1155SRico Sonntag     * @return string
2098add1155SRico Sonntag     */
2108add1155SRico Sonntag    public function commonGivenListTotals(int $threshold = 1, int $maxtoshow = 10): string
2118add1155SRico Sonntag    {
2128add1155SRico Sonntag        return $this->commonGivenQuery('B', 'list', true, $threshold, $maxtoshow);
2138add1155SRico Sonntag    }
2148add1155SRico Sonntag
2158add1155SRico Sonntag    /**
2168add1155SRico Sonntag     * Find common give names.
2178add1155SRico Sonntag     *
2188add1155SRico Sonntag     * @param int $threshold
2198add1155SRico Sonntag     * @param int $maxtoshow
2208add1155SRico Sonntag     *
2218add1155SRico Sonntag     * @return string
2228add1155SRico Sonntag     */
2238add1155SRico Sonntag    public function commonGivenTable(int $threshold = 1, int $maxtoshow = 10): string
2248add1155SRico Sonntag    {
2258add1155SRico Sonntag        return $this->commonGivenQuery('B', 'table', false, $threshold, $maxtoshow);
2268add1155SRico Sonntag    }
2278add1155SRico Sonntag
2288add1155SRico Sonntag    /**
2298add1155SRico Sonntag     * Find common give names of females.
2308add1155SRico Sonntag     *
2318add1155SRico Sonntag     * @param int $threshold
2328add1155SRico Sonntag     * @param int $maxtoshow
2338add1155SRico Sonntag     *
2348add1155SRico Sonntag     * @return string
2358add1155SRico Sonntag     */
2368add1155SRico Sonntag    public function commonGivenFemale(int $threshold = 1, int $maxtoshow = 10): string
2378add1155SRico Sonntag    {
2388add1155SRico Sonntag        return $this->commonGivenQuery('F', 'nolist', false, $threshold, $maxtoshow);
2398add1155SRico Sonntag    }
2408add1155SRico Sonntag
2418add1155SRico Sonntag    /**
2428add1155SRico Sonntag     * Find common give names of females.
2438add1155SRico Sonntag     *
2448add1155SRico Sonntag     * @param int $threshold
2458add1155SRico Sonntag     * @param int $maxtoshow
2468add1155SRico Sonntag     *
2478add1155SRico Sonntag     * @return string
2488add1155SRico Sonntag     */
2498add1155SRico Sonntag    public function commonGivenFemaleTotals(int $threshold = 1, int $maxtoshow = 10): string
2508add1155SRico Sonntag    {
2518add1155SRico Sonntag        return $this->commonGivenQuery('F', 'nolist', true, $threshold, $maxtoshow);
2528add1155SRico Sonntag    }
2538add1155SRico Sonntag
2548add1155SRico Sonntag    /**
2558add1155SRico Sonntag     * Find common give names of females.
2568add1155SRico Sonntag     *
2578add1155SRico Sonntag     * @param int $threshold
2588add1155SRico Sonntag     * @param int $maxtoshow
2598add1155SRico Sonntag     *
2608add1155SRico Sonntag     * @return string
2618add1155SRico Sonntag     */
2628add1155SRico Sonntag    public function commonGivenFemaleList(int $threshold = 1, int $maxtoshow = 10): string
2638add1155SRico Sonntag    {
2648add1155SRico Sonntag        return $this->commonGivenQuery('F', 'list', false, $threshold, $maxtoshow);
2658add1155SRico Sonntag    }
2668add1155SRico Sonntag
2678add1155SRico Sonntag    /**
2688add1155SRico Sonntag     * Find common give names of females.
2698add1155SRico Sonntag     *
2708add1155SRico Sonntag     * @param int $threshold
2718add1155SRico Sonntag     * @param int $maxtoshow
2728add1155SRico Sonntag     *
2738add1155SRico Sonntag     * @return string
2748add1155SRico Sonntag     */
2758add1155SRico Sonntag    public function commonGivenFemaleListTotals(int $threshold = 1, int $maxtoshow = 10): string
2768add1155SRico Sonntag    {
2778add1155SRico Sonntag        return $this->commonGivenQuery('F', 'list', true, $threshold, $maxtoshow);
2788add1155SRico Sonntag    }
2798add1155SRico Sonntag
2808add1155SRico Sonntag    /**
2818add1155SRico Sonntag     * Find common give names of females.
2828add1155SRico Sonntag     *
2838add1155SRico Sonntag     * @param int $threshold
2848add1155SRico Sonntag     * @param int $maxtoshow
2858add1155SRico Sonntag     *
2868add1155SRico Sonntag     * @return string
2878add1155SRico Sonntag     */
2888add1155SRico Sonntag    public function commonGivenFemaleTable(int $threshold = 1, int $maxtoshow = 10): string
2898add1155SRico Sonntag    {
2908add1155SRico Sonntag        return $this->commonGivenQuery('F', 'table', false, $threshold, $maxtoshow);
2918add1155SRico Sonntag    }
2928add1155SRico Sonntag
2938add1155SRico Sonntag    /**
2948add1155SRico Sonntag     * Find common give names of males.
2958add1155SRico Sonntag     *
2968add1155SRico Sonntag     * @param int $threshold
2978add1155SRico Sonntag     * @param int $maxtoshow
2988add1155SRico Sonntag     *
2998add1155SRico Sonntag     * @return string
3008add1155SRico Sonntag     */
3018add1155SRico Sonntag    public function commonGivenMale(int $threshold = 1, int $maxtoshow = 10): string
3028add1155SRico Sonntag    {
3038add1155SRico Sonntag        return $this->commonGivenQuery('M', 'nolist', false, $threshold, $maxtoshow);
3048add1155SRico Sonntag    }
3058add1155SRico Sonntag
3068add1155SRico Sonntag    /**
3078add1155SRico Sonntag     * Find common give names of males.
3088add1155SRico Sonntag     *
3098add1155SRico Sonntag     * @param int $threshold
3108add1155SRico Sonntag     * @param int $maxtoshow
3118add1155SRico Sonntag     *
3128add1155SRico Sonntag     * @return string
3138add1155SRico Sonntag     */
3148add1155SRico Sonntag    public function commonGivenMaleTotals(int $threshold = 1, int $maxtoshow = 10): string
3158add1155SRico Sonntag    {
3168add1155SRico Sonntag        return $this->commonGivenQuery('M', 'nolist', true, $threshold, $maxtoshow);
3178add1155SRico Sonntag    }
3188add1155SRico Sonntag
3198add1155SRico Sonntag    /**
3208add1155SRico Sonntag     * Find common give names of males.
3218add1155SRico Sonntag     *
3228add1155SRico Sonntag     * @param int $threshold
3238add1155SRico Sonntag     * @param int $maxtoshow
3248add1155SRico Sonntag     *
3258add1155SRico Sonntag     * @return string
3268add1155SRico Sonntag     */
3278add1155SRico Sonntag    public function commonGivenMaleList(int $threshold = 1, int $maxtoshow = 10): string
3288add1155SRico Sonntag    {
3298add1155SRico Sonntag        return $this->commonGivenQuery('M', 'list', false, $threshold, $maxtoshow);
3308add1155SRico Sonntag    }
3318add1155SRico Sonntag
3328add1155SRico Sonntag    /**
3338add1155SRico Sonntag     * Find common give names of males.
3348add1155SRico Sonntag     *
3358add1155SRico Sonntag     * @param int $threshold
3368add1155SRico Sonntag     * @param int $maxtoshow
3378add1155SRico Sonntag     *
3388add1155SRico Sonntag     * @return string
3398add1155SRico Sonntag     */
3408add1155SRico Sonntag    public function commonGivenMaleListTotals(int $threshold = 1, int $maxtoshow = 10): string
3418add1155SRico Sonntag    {
3428add1155SRico Sonntag        return $this->commonGivenQuery('M', 'list', true, $threshold, $maxtoshow);
3438add1155SRico Sonntag    }
3448add1155SRico Sonntag
3458add1155SRico Sonntag    /**
3468add1155SRico Sonntag     * Find common give names of males.
3478add1155SRico Sonntag     *
3488add1155SRico Sonntag     * @param int $threshold
3498add1155SRico Sonntag     * @param int $maxtoshow
3508add1155SRico Sonntag     *
3518add1155SRico Sonntag     * @return string
3528add1155SRico Sonntag     */
3538add1155SRico Sonntag    public function commonGivenMaleTable(int $threshold = 1, int $maxtoshow = 10): string
3548add1155SRico Sonntag    {
3558add1155SRico Sonntag        return $this->commonGivenQuery('M', 'table', false, $threshold, $maxtoshow);
3568add1155SRico Sonntag    }
3578add1155SRico Sonntag
3588add1155SRico Sonntag    /**
3598add1155SRico Sonntag     * Find common give names of unknown sexes.
3608add1155SRico Sonntag     *
3618add1155SRico Sonntag     * @param int $threshold
3628add1155SRico Sonntag     * @param int $maxtoshow
3638add1155SRico Sonntag     *
3648add1155SRico Sonntag     * @return string
3658add1155SRico Sonntag     */
3668add1155SRico Sonntag    public function commonGivenUnknown(int $threshold = 1, int $maxtoshow = 10): string
3678add1155SRico Sonntag    {
3688add1155SRico Sonntag        return $this->commonGivenQuery('U', 'nolist', false, $threshold, $maxtoshow);
3698add1155SRico Sonntag    }
3708add1155SRico Sonntag
3718add1155SRico Sonntag    /**
3728add1155SRico Sonntag     * Find common give names of unknown sexes.
3738add1155SRico Sonntag     *
3748add1155SRico Sonntag     * @param int $threshold
3758add1155SRico Sonntag     * @param int $maxtoshow
3768add1155SRico Sonntag     *
3778add1155SRico Sonntag     * @return string
3788add1155SRico Sonntag     */
3798add1155SRico Sonntag    public function commonGivenUnknownTotals(int $threshold = 1, int $maxtoshow = 10): string
3808add1155SRico Sonntag    {
3818add1155SRico Sonntag        return $this->commonGivenQuery('U', 'nolist', true, $threshold, $maxtoshow);
3828add1155SRico Sonntag    }
3838add1155SRico Sonntag
3848add1155SRico Sonntag    /**
3858add1155SRico Sonntag     * Find common give names of unknown sexes.
3868add1155SRico Sonntag     *
3878add1155SRico Sonntag     * @param int $threshold
3888add1155SRico Sonntag     * @param int $maxtoshow
3898add1155SRico Sonntag     *
3908add1155SRico Sonntag     * @return string
3918add1155SRico Sonntag     */
3928add1155SRico Sonntag    public function commonGivenUnknownList(int $threshold = 1, int $maxtoshow = 10): string
3938add1155SRico Sonntag    {
3948add1155SRico Sonntag        return $this->commonGivenQuery('U', 'list', false, $threshold, $maxtoshow);
3958add1155SRico Sonntag    }
3968add1155SRico Sonntag
3978add1155SRico Sonntag    /**
3988add1155SRico Sonntag     * Find common give names of unknown sexes.
3998add1155SRico Sonntag     *
4008add1155SRico Sonntag     * @param int $threshold
4018add1155SRico Sonntag     * @param int $maxtoshow
4028add1155SRico Sonntag     *
4038add1155SRico Sonntag     * @return string
4048add1155SRico Sonntag     */
4058add1155SRico Sonntag    public function commonGivenUnknownListTotals(int $threshold = 1, int $maxtoshow = 10): string
4068add1155SRico Sonntag    {
4078add1155SRico Sonntag        return $this->commonGivenQuery('U', 'list', true, $threshold, $maxtoshow);
4088add1155SRico Sonntag    }
4098add1155SRico Sonntag
4108add1155SRico Sonntag    /**
4118add1155SRico Sonntag     * Find common give names of unknown sexes.
4128add1155SRico Sonntag     *
4138add1155SRico Sonntag     * @param int $threshold
4148add1155SRico Sonntag     * @param int $maxtoshow
4158add1155SRico Sonntag     *
4168add1155SRico Sonntag     * @return string
4178add1155SRico Sonntag     */
4188add1155SRico Sonntag    public function commonGivenUnknownTable(int $threshold = 1, int $maxtoshow = 10): string
4198add1155SRico Sonntag    {
4208add1155SRico Sonntag        return $this->commonGivenQuery('U', 'table', false, $threshold, $maxtoshow);
4218add1155SRico Sonntag    }
4228add1155SRico Sonntag
4238add1155SRico Sonntag    /**
4243dc8167dSGreg Roach     * Count the number of distinct given names (or the number of occurences of specific given names).
4258add1155SRico Sonntag     *
4263dc8167dSGreg Roach     * @param string[] ...$params
4278add1155SRico Sonntag     *
4288add1155SRico Sonntag     * @return string
4298add1155SRico Sonntag     */
4308add1155SRico Sonntag    public function totalGivennames(...$params): string
4318add1155SRico Sonntag    {
4323dc8167dSGreg Roach        $query = DB::table('name')
4333dc8167dSGreg Roach            ->where('n_file', '=', $this->tree->id());
4343dc8167dSGreg Roach
4353dc8167dSGreg Roach        if (empty($params)) {
436c09e99bfSRico Sonntag            // Count number of distinct given names.
4373dc8167dSGreg Roach            $query
438c09e99bfSRico Sonntag                ->distinct()
4392ccd1f0bSGreg Roach                ->where('n_givn', '<>', '@P.N.')
440c09e99bfSRico Sonntag                ->whereNotNull('n_givn');
4418add1155SRico Sonntag        } else {
442c09e99bfSRico Sonntag            // Count number of occurences of specific given names.
44344cdc21eSGreg Roach            $query->whereIn('n_givn', $params);
4448add1155SRico Sonntag        }
4458add1155SRico Sonntag
446c09e99bfSRico Sonntag        $count = $query->count('n_givn');
4473dc8167dSGreg Roach
4483dc8167dSGreg Roach        return I18N::number($count);
4498add1155SRico Sonntag    }
4508add1155SRico Sonntag
4518add1155SRico Sonntag    /**
452c09e99bfSRico Sonntag     * Count the number of distinct surnames (or the number of occurences of specific surnames).
4538add1155SRico Sonntag     *
4543dc8167dSGreg Roach     * @param string[] ...$params
4558add1155SRico Sonntag     *
4568add1155SRico Sonntag     * @return string
4578add1155SRico Sonntag     */
4588add1155SRico Sonntag    public function totalSurnames(...$params): string
4598add1155SRico Sonntag    {
4603dc8167dSGreg Roach        $query = DB::table('name')
4613dc8167dSGreg Roach            ->where('n_file', '=', $this->tree->id());
4623dc8167dSGreg Roach
4633dc8167dSGreg Roach        if (empty($params)) {
4643dc8167dSGreg Roach            // Count number of distinct surnames
465c09e99bfSRico Sonntag            $query->distinct()
466c09e99bfSRico Sonntag                ->whereNotNull('n_surn');
4678add1155SRico Sonntag        } else {
4683dc8167dSGreg Roach            // Count number of occurences of specific surnames.
4693dc8167dSGreg Roach            $query->whereIn('n_surn', $params);
4708add1155SRico Sonntag        }
4718add1155SRico Sonntag
472c09e99bfSRico Sonntag        $count = $query->count('n_surn');
4738add1155SRico Sonntag
4743dc8167dSGreg Roach        return I18N::number($count);
4758add1155SRico Sonntag    }
4768add1155SRico Sonntag
4778add1155SRico Sonntag    /**
4788add1155SRico Sonntag     * @param int $number_of_surnames
4798add1155SRico Sonntag     * @param int $threshold
4808add1155SRico Sonntag     *
4818add1155SRico Sonntag     * @return \stdClass[]
4828add1155SRico Sonntag     */
4838add1155SRico Sonntag    private function topSurnames(int $number_of_surnames, int $threshold): array
4848add1155SRico Sonntag    {
4858add1155SRico Sonntag        // Use the count of base surnames.
4868add1155SRico Sonntag        $top_surnames = Database::prepare(
4878add1155SRico Sonntag            "SELECT n_surn FROM `##name`" .
4888add1155SRico Sonntag            " WHERE n_file = :tree_id AND n_type != '_MARNM' AND n_surn NOT IN ('@N.N.', '')" .
4898add1155SRico Sonntag            " GROUP BY n_surn" .
4908add1155SRico Sonntag            " ORDER BY COUNT(n_surn) DESC" .
4918add1155SRico Sonntag            " LIMIT :limit"
4928add1155SRico Sonntag        )->execute([
4938add1155SRico Sonntag            'tree_id' => $this->tree->id(),
4948add1155SRico Sonntag            'limit'   => $number_of_surnames,
4958add1155SRico Sonntag        ])->fetchOneColumn();
4968add1155SRico Sonntag
4978add1155SRico Sonntag        $surnames = [];
4988add1155SRico Sonntag        foreach ($top_surnames as $top_surname) {
4998add1155SRico Sonntag            $variants = Database::prepare(
5008add1155SRico Sonntag                "SELECT n_surname COLLATE utf8_bin, COUNT(*) FROM `##name` WHERE n_file = :tree_id AND n_surn COLLATE :collate = :surname GROUP BY 1"
5018add1155SRico Sonntag            )->execute([
5028add1155SRico Sonntag                'collate' => I18N::collation(),
5038add1155SRico Sonntag                'surname' => $top_surname,
5048add1155SRico Sonntag                'tree_id' => $this->tree->id(),
5058add1155SRico Sonntag            ])->fetchAssoc();
5068add1155SRico Sonntag
5078add1155SRico Sonntag            if (array_sum($variants) > $threshold) {
5088add1155SRico Sonntag                $surnames[$top_surname] = $variants;
5098add1155SRico Sonntag            }
5108add1155SRico Sonntag        }
5118add1155SRico Sonntag
5128add1155SRico Sonntag        return $surnames;
5138add1155SRico Sonntag    }
5148add1155SRico Sonntag
5158add1155SRico Sonntag    /**
5168add1155SRico Sonntag     * Find common surnames.
5178add1155SRico Sonntag     *
5188add1155SRico Sonntag     * @return string
5198add1155SRico Sonntag     */
5208add1155SRico Sonntag    public function getCommonSurname(): string
5218add1155SRico Sonntag    {
5228add1155SRico Sonntag        $top_surname = $this->topSurnames(1, 0);
5238add1155SRico Sonntag        return implode(', ', array_keys(array_shift($top_surname)) ?? []);
5248add1155SRico Sonntag    }
5258add1155SRico Sonntag
5268add1155SRico Sonntag    /**
5278add1155SRico Sonntag     * Find common surnames.
5288add1155SRico Sonntag     *
5298add1155SRico Sonntag     * @param string $type
5308add1155SRico Sonntag     * @param bool   $show_tot
5318add1155SRico Sonntag     * @param int    $threshold
5328add1155SRico Sonntag     * @param int    $number_of_surnames
5338add1155SRico Sonntag     * @param string $sorting
5348add1155SRico Sonntag     *
5358add1155SRico Sonntag     * @return string
5368add1155SRico Sonntag     */
5378add1155SRico Sonntag    private function commonSurnamesQuery(
5388add1155SRico Sonntag        string $type,
5398add1155SRico Sonntag        bool $show_tot,
5408add1155SRico Sonntag        int $threshold,
5418add1155SRico Sonntag        int $number_of_surnames,
5428add1155SRico Sonntag        string $sorting
5438add1155SRico Sonntag    ): string {
5448add1155SRico Sonntag        $surnames = $this->topSurnames($number_of_surnames, $threshold);
5458add1155SRico Sonntag
5468add1155SRico Sonntag        switch ($sorting) {
5478add1155SRico Sonntag            default:
5488add1155SRico Sonntag            case 'alpha':
5498add1155SRico Sonntag                uksort($surnames, [I18N::class, 'strcasecmp']);
5508add1155SRico Sonntag                break;
5518add1155SRico Sonntag            case 'count':
5528add1155SRico Sonntag                break;
5538add1155SRico Sonntag            case 'rcount':
5548add1155SRico Sonntag                $surnames = array_reverse($surnames, true);
5558add1155SRico Sonntag                break;
5568add1155SRico Sonntag        }
5578add1155SRico Sonntag
5588add1155SRico Sonntag        return FunctionsPrintLists::surnameList(
5598add1155SRico Sonntag            $surnames,
5608add1155SRico Sonntag            ($type === 'list' ? 1 : 2),
5618add1155SRico Sonntag            $show_tot,
5628add1155SRico Sonntag            'individual-list',
5638add1155SRico Sonntag            $this->tree
5648add1155SRico Sonntag        );
5658add1155SRico Sonntag    }
5668add1155SRico Sonntag
5678add1155SRico Sonntag    /**
5688add1155SRico Sonntag     * Find common surnames.
5698add1155SRico Sonntag     *
5708add1155SRico Sonntag     * @param int    $threshold
5718add1155SRico Sonntag     * @param int    $number_of_surnames
5728add1155SRico Sonntag     * @param string $sorting
5738add1155SRico Sonntag     *
5748add1155SRico Sonntag     * @return string
5758add1155SRico Sonntag     */
5768add1155SRico Sonntag    public function commonSurnames(
5778add1155SRico Sonntag        int $threshold = 1,
5788add1155SRico Sonntag        int $number_of_surnames = 10,
5798add1155SRico Sonntag        string $sorting = 'alpha'
5808add1155SRico Sonntag    ): string {
5818add1155SRico Sonntag        return $this->commonSurnamesQuery('nolist', false, $threshold, $number_of_surnames, $sorting);
5828add1155SRico Sonntag    }
5838add1155SRico Sonntag
5848add1155SRico Sonntag    /**
5858add1155SRico Sonntag     * Find common surnames.
5868add1155SRico Sonntag     *
5878add1155SRico Sonntag     * @param int    $threshold
5888add1155SRico Sonntag     * @param int    $number_of_surnames
5898add1155SRico Sonntag     * @param string $sorting
5908add1155SRico Sonntag     *
5918add1155SRico Sonntag     * @return string
5928add1155SRico Sonntag     */
5938add1155SRico Sonntag    public function commonSurnamesTotals(
5948add1155SRico Sonntag        int $threshold = 1,
5958add1155SRico Sonntag        int $number_of_surnames = 10,
5968add1155SRico Sonntag        string $sorting = 'rcount'
5978add1155SRico Sonntag    ): string {
5988add1155SRico Sonntag        return $this->commonSurnamesQuery('nolist', true, $threshold, $number_of_surnames, $sorting);
5998add1155SRico Sonntag    }
6008add1155SRico Sonntag
6018add1155SRico Sonntag    /**
6028add1155SRico Sonntag     * Find common surnames.
6038add1155SRico Sonntag     *
6048add1155SRico Sonntag     * @param int    $threshold
6058add1155SRico Sonntag     * @param int    $number_of_surnames
6068add1155SRico Sonntag     * @param string $sorting
6078add1155SRico Sonntag     *
6088add1155SRico Sonntag     * @return string
6098add1155SRico Sonntag     */
6108add1155SRico Sonntag    public function commonSurnamesList(
6118add1155SRico Sonntag        int $threshold = 1,
6128add1155SRico Sonntag        int $number_of_surnames = 10,
6138add1155SRico Sonntag        string $sorting = 'alpha'
6148add1155SRico Sonntag    ): string {
6158add1155SRico Sonntag        return $this->commonSurnamesQuery('list', false, $threshold, $number_of_surnames, $sorting);
6168add1155SRico Sonntag    }
6178add1155SRico Sonntag
6188add1155SRico Sonntag    /**
6198add1155SRico Sonntag     * Find common surnames.
6208add1155SRico Sonntag     *
6218add1155SRico Sonntag     * @param int    $threshold
6228add1155SRico Sonntag     * @param int    $number_of_surnames
6238add1155SRico Sonntag     * @param string $sorting
6248add1155SRico Sonntag     *
6258add1155SRico Sonntag     * @return string
6268add1155SRico Sonntag     */
6278add1155SRico Sonntag    public function commonSurnamesListTotals(
6288add1155SRico Sonntag        int $threshold = 1,
6298add1155SRico Sonntag        int $number_of_surnames = 10,
6308add1155SRico Sonntag        string $sorting = 'rcount'
6318add1155SRico Sonntag    ): string {
6328add1155SRico Sonntag        return $this->commonSurnamesQuery('list', true, $threshold, $number_of_surnames, $sorting);
6338add1155SRico Sonntag    }
6348add1155SRico Sonntag
6358add1155SRico Sonntag    /**
6368add1155SRico Sonntag     * Get a list of birth dates.
6378add1155SRico Sonntag     *
6388add1155SRico Sonntag     * @param bool $sex
6398add1155SRico Sonntag     * @param int  $year1
6408add1155SRico Sonntag     * @param int  $year2
6418add1155SRico Sonntag     *
6428add1155SRico Sonntag     * @return array
6438add1155SRico Sonntag     */
6448add1155SRico Sonntag    public function statsBirthQuery(bool $sex = false, int $year1 = -1, int $year2 = -1): array
6458add1155SRico Sonntag    {
6468add1155SRico Sonntag        if ($sex) {
6478add1155SRico Sonntag            $sql =
6488add1155SRico Sonntag                "SELECT d_month, i_sex, COUNT(*) AS total FROM `##dates` " .
6498add1155SRico Sonntag                "JOIN `##individuals` ON d_file = i_file AND d_gid = i_id " .
6508add1155SRico Sonntag                "WHERE " .
6518add1155SRico Sonntag                "d_file={$this->tree->id()} AND " .
6528add1155SRico Sonntag                "d_fact='BIRT' AND " .
6538add1155SRico Sonntag                "d_type IN ('@#DGREGORIAN@', '@#DJULIAN@')";
6548add1155SRico Sonntag        } else {
6558add1155SRico Sonntag            $sql =
6568add1155SRico Sonntag                "SELECT d_month, COUNT(*) AS total FROM `##dates` " .
6578add1155SRico Sonntag                "WHERE " .
6588add1155SRico Sonntag                "d_file={$this->tree->id()} AND " .
6598add1155SRico Sonntag                "d_fact='BIRT' AND " .
6608add1155SRico Sonntag                "d_type IN ('@#DGREGORIAN@', '@#DJULIAN@')";
6618add1155SRico Sonntag        }
6628add1155SRico Sonntag
6638add1155SRico Sonntag        if ($year1 >= 0 && $year2 >= 0) {
6648add1155SRico Sonntag            $sql .= " AND d_year BETWEEN '{$year1}' AND '{$year2}'";
6658add1155SRico Sonntag        }
6668add1155SRico Sonntag
6678add1155SRico Sonntag        $sql .= " GROUP BY d_month";
6688add1155SRico Sonntag
6698add1155SRico Sonntag        if ($sex) {
6708add1155SRico Sonntag            $sql .= ", i_sex";
6718add1155SRico Sonntag        }
6728add1155SRico Sonntag
6738add1155SRico Sonntag        return $this->runSql($sql);
6748add1155SRico Sonntag    }
6758add1155SRico Sonntag
6768add1155SRico Sonntag    /**
6778add1155SRico Sonntag     * General query on births.
6788add1155SRico Sonntag     *
6798add1155SRico Sonntag     * @param string|null $color_from
6808add1155SRico Sonntag     * @param string|null $color_to
6818add1155SRico Sonntag     *
6828add1155SRico Sonntag     * @return string
6838add1155SRico Sonntag     */
68488de55fdSRico Sonntag    public function statsBirth(string $color_from = null, string $color_to = null): string
6858add1155SRico Sonntag    {
6868add1155SRico Sonntag        return (new ChartBirth($this->tree))
68788de55fdSRico Sonntag            ->chartBirth($color_from, $color_to);
6888add1155SRico Sonntag    }
6898add1155SRico Sonntag
6908add1155SRico Sonntag    /**
6918add1155SRico Sonntag     * Get a list of death dates.
6928add1155SRico Sonntag     *
6938add1155SRico Sonntag     * @param bool $sex
6948add1155SRico Sonntag     * @param int  $year1
6958add1155SRico Sonntag     * @param int  $year2
6968add1155SRico Sonntag     *
6978add1155SRico Sonntag     * @return array
6988add1155SRico Sonntag     */
6998add1155SRico Sonntag    public function statsDeathQuery(bool $sex = false, int $year1 = -1, int $year2 = -1): array
7008add1155SRico Sonntag    {
7018add1155SRico Sonntag        if ($sex) {
7028add1155SRico Sonntag            $sql =
7038add1155SRico Sonntag                "SELECT d_month, i_sex, COUNT(*) AS total FROM `##dates` " .
7048add1155SRico Sonntag                "JOIN `##individuals` ON d_file = i_file AND d_gid = i_id " .
7058add1155SRico Sonntag                "WHERE " .
7068add1155SRico Sonntag                "d_file={$this->tree->id()} AND " .
7078add1155SRico Sonntag                "d_fact='DEAT' AND " .
7088add1155SRico Sonntag                "d_type IN ('@#DGREGORIAN@', '@#DJULIAN@')";
7098add1155SRico Sonntag        } else {
7108add1155SRico Sonntag            $sql =
7118add1155SRico Sonntag                "SELECT d_month, COUNT(*) AS total FROM `##dates` " .
7128add1155SRico Sonntag                "WHERE " .
7138add1155SRico Sonntag                "d_file={$this->tree->id()} AND " .
7148add1155SRico Sonntag                "d_fact='DEAT' AND " .
7158add1155SRico Sonntag                "d_type IN ('@#DGREGORIAN@', '@#DJULIAN@')";
7168add1155SRico Sonntag        }
7178add1155SRico Sonntag
7188add1155SRico Sonntag        if ($year1 >= 0 && $year2 >= 0) {
7198add1155SRico Sonntag            $sql .= " AND d_year BETWEEN '{$year1}' AND '{$year2}'";
7208add1155SRico Sonntag        }
7218add1155SRico Sonntag
7228add1155SRico Sonntag        $sql .= " GROUP BY d_month";
7238add1155SRico Sonntag
7248add1155SRico Sonntag        if ($sex) {
7258add1155SRico Sonntag            $sql .= ", i_sex";
7268add1155SRico Sonntag        }
7278add1155SRico Sonntag
7288add1155SRico Sonntag        return $this->runSql($sql);
7298add1155SRico Sonntag    }
7308add1155SRico Sonntag
7318add1155SRico Sonntag    /**
7328add1155SRico Sonntag     * General query on deaths.
7338add1155SRico Sonntag     *
7348add1155SRico Sonntag     * @param string|null $color_from
7358add1155SRico Sonntag     * @param string|null $color_to
7368add1155SRico Sonntag     *
7378add1155SRico Sonntag     * @return string
7388add1155SRico Sonntag     */
73988de55fdSRico Sonntag    public function statsDeath(string $color_from = null, string $color_to = null): string
7408add1155SRico Sonntag    {
7418add1155SRico Sonntag        return (new ChartDeath($this->tree))
74288de55fdSRico Sonntag            ->chartDeath($color_from, $color_to);
7438add1155SRico Sonntag    }
7448add1155SRico Sonntag
7458add1155SRico Sonntag    /**
7468add1155SRico Sonntag     * General query on ages.
7478add1155SRico Sonntag     *
7488add1155SRico Sonntag     * @param string $related
7498add1155SRico Sonntag     * @param string $sex
7508add1155SRico Sonntag     * @param int    $year1
7518add1155SRico Sonntag     * @param int    $year2
7528add1155SRico Sonntag     *
7538add1155SRico Sonntag     * @return array|string
7548add1155SRico Sonntag     */
7558add1155SRico Sonntag    public function statsAgeQuery(string $related = 'BIRT', string $sex = 'BOTH', int $year1 = -1, int $year2 = -1)
7568add1155SRico Sonntag    {
75744cdc21eSGreg Roach        $prefix = DB::connection()->getTablePrefix();
7588add1155SRico Sonntag
75944cdc21eSGreg Roach        $query = $this->birthAndDeathQuery($sex);
7608add1155SRico Sonntag
7618add1155SRico Sonntag        if ($year1 >= 0 && $year2 >= 0) {
76244cdc21eSGreg Roach            $query
76344cdc21eSGreg Roach                ->whereIn('birth.d_type', ['@#DGREGORIAN@', '@#DJULIAN@'])
76444cdc21eSGreg Roach                ->whereIn('death.d_type', ['@#DGREGORIAN@', '@#DJULIAN@']);
76544cdc21eSGreg Roach
7668add1155SRico Sonntag            if ($related === 'BIRT') {
76744cdc21eSGreg Roach                $query->whereBetween('birth.d_year', [$year1, $year2]);
7688add1155SRico Sonntag            } elseif ($related === 'DEAT') {
76944cdc21eSGreg Roach                $query->whereBetween('death.d_year', [$year1, $year2]);
7708add1155SRico Sonntag            }
7718add1155SRico Sonntag        }
7728add1155SRico Sonntag
77344cdc21eSGreg Roach        return $query
77444cdc21eSGreg Roach            ->select(DB::raw($prefix . 'death.d_julianday2 - ' . $prefix . 'birth.d_julianday1 AS days'))
775c8c87812SRico Sonntag            ->orderBy('days', 'desc')
77644cdc21eSGreg Roach            ->get()
77744cdc21eSGreg Roach            ->all();
7788add1155SRico Sonntag    }
7798add1155SRico Sonntag
7808add1155SRico Sonntag    /**
7818add1155SRico Sonntag     * General query on ages.
7828add1155SRico Sonntag     *
7838add1155SRico Sonntag     * @return string
7848add1155SRico Sonntag     */
78588de55fdSRico Sonntag    public function statsAge(): string
7868add1155SRico Sonntag    {
78788de55fdSRico Sonntag        return (new ChartAge($this->tree))->chartAge();
7888add1155SRico Sonntag    }
7898add1155SRico Sonntag
7908add1155SRico Sonntag    /**
7918add1155SRico Sonntag     * Lifespan
7928add1155SRico Sonntag     *
7938add1155SRico Sonntag     * @param string $type
7948add1155SRico Sonntag     * @param string $sex
7958add1155SRico Sonntag     *
7968add1155SRico Sonntag     * @return string
7978add1155SRico Sonntag     */
7988add1155SRico Sonntag    private function longlifeQuery(string $type, string $sex): string
7998add1155SRico Sonntag    {
80044cdc21eSGreg Roach        $prefix = DB::connection()->getTablePrefix();
8018add1155SRico Sonntag
80244cdc21eSGreg Roach        $row = $this->birthAndDeathQuery($sex)
80344cdc21eSGreg Roach            ->orderBy('days', 'desc')
80444cdc21eSGreg Roach            ->select(['individuals.*', DB::raw($prefix . 'death.d_julianday2 - ' . $prefix . 'birth.d_julianday1 AS days')])
80544cdc21eSGreg Roach            ->first();
80644cdc21eSGreg Roach
80744cdc21eSGreg Roach        if ($row === null) {
8088add1155SRico Sonntag            return '';
8098add1155SRico Sonntag        }
81044cdc21eSGreg Roach
81144cdc21eSGreg Roach        /** @var Individual $individual */
81244cdc21eSGreg Roach        $individual = Individual::rowMapper()($row);
81344cdc21eSGreg Roach
81444cdc21eSGreg Roach        if (!$individual->canShow()) {
81544cdc21eSGreg Roach            return I18N::translate('This information is private and cannot be shown.');
81644cdc21eSGreg Roach        }
81744cdc21eSGreg Roach
8188add1155SRico Sonntag        switch ($type) {
8198add1155SRico Sonntag            default:
8208add1155SRico Sonntag            case 'full':
82144cdc21eSGreg Roach                return $individual->formatList();
8228add1155SRico Sonntag
82344cdc21eSGreg Roach            case 'age':
82444cdc21eSGreg Roach                return I18N::number((int) ($row->days / 365.25));
82544cdc21eSGreg Roach
82644cdc21eSGreg Roach            case 'name':
82744cdc21eSGreg Roach                return '<a href="' . e($individual->url()) . '">' . $individual->getFullName() . '</a>';
82844cdc21eSGreg Roach        }
8298add1155SRico Sonntag    }
8308add1155SRico Sonntag
8318add1155SRico Sonntag    /**
8328add1155SRico Sonntag     * Find the longest lived individual.
8338add1155SRico Sonntag     *
8348add1155SRico Sonntag     * @return string
8358add1155SRico Sonntag     */
8368add1155SRico Sonntag    public function longestLife(): string
8378add1155SRico Sonntag    {
8388add1155SRico Sonntag        return $this->longlifeQuery('full', 'BOTH');
8398add1155SRico Sonntag    }
8408add1155SRico Sonntag
8418add1155SRico Sonntag    /**
8428add1155SRico Sonntag     * Find the age of the longest lived individual.
8438add1155SRico Sonntag     *
8448add1155SRico Sonntag     * @return string
8458add1155SRico Sonntag     */
8468add1155SRico Sonntag    public function longestLifeAge(): string
8478add1155SRico Sonntag    {
8488add1155SRico Sonntag        return $this->longlifeQuery('age', 'BOTH');
8498add1155SRico Sonntag    }
8508add1155SRico Sonntag
8518add1155SRico Sonntag    /**
8528add1155SRico Sonntag     * Find the name of the longest lived individual.
8538add1155SRico Sonntag     *
8548add1155SRico Sonntag     * @return string
8558add1155SRico Sonntag     */
8568add1155SRico Sonntag    public function longestLifeName(): string
8578add1155SRico Sonntag    {
8588add1155SRico Sonntag        return $this->longlifeQuery('name', 'BOTH');
8598add1155SRico Sonntag    }
8608add1155SRico Sonntag
8618add1155SRico Sonntag    /**
8628add1155SRico Sonntag     * Find the longest lived female.
8638add1155SRico Sonntag     *
8648add1155SRico Sonntag     * @return string
8658add1155SRico Sonntag     */
8668add1155SRico Sonntag    public function longestLifeFemale(): string
8678add1155SRico Sonntag    {
8688add1155SRico Sonntag        return $this->longlifeQuery('full', 'F');
8698add1155SRico Sonntag    }
8708add1155SRico Sonntag
8718add1155SRico Sonntag    /**
8728add1155SRico Sonntag     * Find the age of the longest lived female.
8738add1155SRico Sonntag     *
8748add1155SRico Sonntag     * @return string
8758add1155SRico Sonntag     */
8768add1155SRico Sonntag    public function longestLifeFemaleAge(): string
8778add1155SRico Sonntag    {
8788add1155SRico Sonntag        return $this->longlifeQuery('age', 'F');
8798add1155SRico Sonntag    }
8808add1155SRico Sonntag
8818add1155SRico Sonntag    /**
8828add1155SRico Sonntag     * Find the name of the longest lived female.
8838add1155SRico Sonntag     *
8848add1155SRico Sonntag     * @return string
8858add1155SRico Sonntag     */
8868add1155SRico Sonntag    public function longestLifeFemaleName(): string
8878add1155SRico Sonntag    {
8888add1155SRico Sonntag        return $this->longlifeQuery('name', 'F');
8898add1155SRico Sonntag    }
8908add1155SRico Sonntag
8918add1155SRico Sonntag    /**
8928add1155SRico Sonntag     * Find the longest lived male.
8938add1155SRico Sonntag     *
8948add1155SRico Sonntag     * @return string
8958add1155SRico Sonntag     */
8968add1155SRico Sonntag    public function longestLifeMale(): string
8978add1155SRico Sonntag    {
8988add1155SRico Sonntag        return $this->longlifeQuery('full', 'M');
8998add1155SRico Sonntag    }
9008add1155SRico Sonntag
9018add1155SRico Sonntag    /**
9028add1155SRico Sonntag     * Find the age of the longest lived male.
9038add1155SRico Sonntag     *
9048add1155SRico Sonntag     * @return string
9058add1155SRico Sonntag     */
9068add1155SRico Sonntag    public function longestLifeMaleAge(): string
9078add1155SRico Sonntag    {
9088add1155SRico Sonntag        return $this->longlifeQuery('age', 'M');
9098add1155SRico Sonntag    }
9108add1155SRico Sonntag
9118add1155SRico Sonntag    /**
9128add1155SRico Sonntag     * Find the name of the longest lived male.
9138add1155SRico Sonntag     *
9148add1155SRico Sonntag     * @return string
9158add1155SRico Sonntag     */
9168add1155SRico Sonntag    public function longestLifeMaleName(): string
9178add1155SRico Sonntag    {
9188add1155SRico Sonntag        return $this->longlifeQuery('name', 'M');
9198add1155SRico Sonntag    }
9208add1155SRico Sonntag
9218add1155SRico Sonntag    /**
9228add1155SRico Sonntag     * Returns the calculated age the time of event.
9238add1155SRico Sonntag     *
9248add1155SRico Sonntag     * @param int $age The age from the database record
9258add1155SRico Sonntag     *
9268add1155SRico Sonntag     * @return string
9278add1155SRico Sonntag     */
9288add1155SRico Sonntag    private function calculateAge(int $age): string
9298add1155SRico Sonntag    {
9308add1155SRico Sonntag        if ((int) ($age / 365.25) > 0) {
9318add1155SRico Sonntag            $result = (int) ($age / 365.25) . 'y';
9328add1155SRico Sonntag        } elseif ((int) ($age / 30.4375) > 0) {
9338add1155SRico Sonntag            $result = (int) ($age / 30.4375) . 'm';
9348add1155SRico Sonntag        } else {
9358add1155SRico Sonntag            $result = $age . 'd';
9368add1155SRico Sonntag        }
9378add1155SRico Sonntag
9388add1155SRico Sonntag        return FunctionsDate::getAgeAtEvent($result);
9398add1155SRico Sonntag    }
9408add1155SRico Sonntag
9418add1155SRico Sonntag    /**
9428add1155SRico Sonntag     * Find the oldest individuals.
9438add1155SRico Sonntag     *
9448add1155SRico Sonntag     * @param string $sex
9458add1155SRico Sonntag     * @param int    $total
9468add1155SRico Sonntag     *
9478add1155SRico Sonntag     * @return array
9488add1155SRico Sonntag     */
9498add1155SRico Sonntag    private function topTenOldestQuery(string $sex, int $total): array
9508add1155SRico Sonntag    {
95144cdc21eSGreg Roach        $prefix = DB::connection()->getTablePrefix();
9528add1155SRico Sonntag
95344cdc21eSGreg Roach        $rows = $this->birthAndDeathQuery($sex)
95444cdc21eSGreg Roach            ->groupBy(['i_id', 'i_file'])
95544cdc21eSGreg Roach            ->orderBy('days', 'desc')
95644cdc21eSGreg Roach            ->select(['individuals.*', DB::raw('MAX(' . $prefix . 'death.d_julianday2 - ' . $prefix . 'birth.d_julianday1) AS days')])
95744cdc21eSGreg Roach            ->take($total)
95844cdc21eSGreg Roach            ->get();
9598add1155SRico Sonntag
9608add1155SRico Sonntag        $top10 = [];
9618add1155SRico Sonntag        foreach ($rows as $row) {
96244cdc21eSGreg Roach            /** @var Individual $individual */
96344cdc21eSGreg Roach            $individual = Individual::rowMapper()($row);
9648add1155SRico Sonntag
96544cdc21eSGreg Roach            if ($individual->canShow()) {
9668add1155SRico Sonntag                $top10[] = [
96744cdc21eSGreg Roach                    'person' => $individual,
96844cdc21eSGreg Roach                    'age'    => $this->calculateAge((int) $row->days),
9698add1155SRico Sonntag                ];
9708add1155SRico Sonntag            }
9718add1155SRico Sonntag        }
9728add1155SRico Sonntag
9738add1155SRico Sonntag        return $top10;
9748add1155SRico Sonntag    }
9758add1155SRico Sonntag
9768add1155SRico Sonntag    /**
9778add1155SRico Sonntag     * Find the oldest individuals.
9788add1155SRico Sonntag     *
9798add1155SRico Sonntag     * @param int $total
9808add1155SRico Sonntag     *
9818add1155SRico Sonntag     * @return string
9828add1155SRico Sonntag     */
9838add1155SRico Sonntag    public function topTenOldest(int $total = 10): string
9848add1155SRico Sonntag    {
9858add1155SRico Sonntag        $records = $this->topTenOldestQuery('BOTH', $total);
9868add1155SRico Sonntag
9878add1155SRico Sonntag        return view(
9888add1155SRico Sonntag            'statistics/individuals/top10-nolist',
9898add1155SRico Sonntag            [
9908add1155SRico Sonntag                'records' => $records,
9918add1155SRico Sonntag            ]
9928add1155SRico Sonntag        );
9938add1155SRico Sonntag    }
9948add1155SRico Sonntag
9958add1155SRico Sonntag    /**
9968add1155SRico Sonntag     * Find the oldest living individuals.
9978add1155SRico Sonntag     *
9988add1155SRico Sonntag     * @param int $total
9998add1155SRico Sonntag     *
10008add1155SRico Sonntag     * @return string
10018add1155SRico Sonntag     */
10028add1155SRico Sonntag    public function topTenOldestList(int $total = 10): string
10038add1155SRico Sonntag    {
10048add1155SRico Sonntag        $records = $this->topTenOldestQuery('BOTH', $total);
10058add1155SRico Sonntag
10068add1155SRico Sonntag        return view(
10078add1155SRico Sonntag            'statistics/individuals/top10-list',
10088add1155SRico Sonntag            [
10098add1155SRico Sonntag                'records' => $records,
10108add1155SRico Sonntag            ]
10118add1155SRico Sonntag        );
10128add1155SRico Sonntag    }
10138add1155SRico Sonntag
10148add1155SRico Sonntag    /**
10158add1155SRico Sonntag     * Find the oldest females.
10168add1155SRico Sonntag     *
10178add1155SRico Sonntag     * @param int $total
10188add1155SRico Sonntag     *
10198add1155SRico Sonntag     * @return string
10208add1155SRico Sonntag     */
10218add1155SRico Sonntag    public function topTenOldestFemale(int $total = 10): string
10228add1155SRico Sonntag    {
10238add1155SRico Sonntag        $records = $this->topTenOldestQuery('F', $total);
10248add1155SRico Sonntag
10258add1155SRico Sonntag        return view(
10268add1155SRico Sonntag            'statistics/individuals/top10-nolist',
10278add1155SRico Sonntag            [
10288add1155SRico Sonntag                'records' => $records,
10298add1155SRico Sonntag            ]
10308add1155SRico Sonntag        );
10318add1155SRico Sonntag    }
10328add1155SRico Sonntag
10338add1155SRico Sonntag    /**
10348add1155SRico Sonntag     * Find the oldest living females.
10358add1155SRico Sonntag     *
10368add1155SRico Sonntag     * @param int $total
10378add1155SRico Sonntag     *
10388add1155SRico Sonntag     * @return string
10398add1155SRico Sonntag     */
10408add1155SRico Sonntag    public function topTenOldestFemaleList(int $total = 10): string
10418add1155SRico Sonntag    {
10428add1155SRico Sonntag        $records = $this->topTenOldestQuery('F', $total);
10438add1155SRico Sonntag
10448add1155SRico Sonntag        return view(
10458add1155SRico Sonntag            'statistics/individuals/top10-list',
10468add1155SRico Sonntag            [
10478add1155SRico Sonntag                'records' => $records,
10488add1155SRico Sonntag            ]
10498add1155SRico Sonntag        );
10508add1155SRico Sonntag    }
10518add1155SRico Sonntag
10528add1155SRico Sonntag    /**
10538add1155SRico Sonntag     * Find the longest lived males.
10548add1155SRico Sonntag     *
10558add1155SRico Sonntag     * @param int $total
10568add1155SRico Sonntag     *
10578add1155SRico Sonntag     * @return string
10588add1155SRico Sonntag     */
10598add1155SRico Sonntag    public function topTenOldestMale(int $total = 10): string
10608add1155SRico Sonntag    {
10618add1155SRico Sonntag        $records = $this->topTenOldestQuery('M', $total);
10628add1155SRico Sonntag
10638add1155SRico Sonntag        return view(
10648add1155SRico Sonntag            'statistics/individuals/top10-nolist',
10658add1155SRico Sonntag            [
10668add1155SRico Sonntag                'records' => $records,
10678add1155SRico Sonntag            ]
10688add1155SRico Sonntag        );
10698add1155SRico Sonntag    }
10708add1155SRico Sonntag
10718add1155SRico Sonntag    /**
10728add1155SRico Sonntag     * Find the longest lived males.
10738add1155SRico Sonntag     *
10748add1155SRico Sonntag     * @param int $total
10758add1155SRico Sonntag     *
10768add1155SRico Sonntag     * @return string
10778add1155SRico Sonntag     */
10788add1155SRico Sonntag    public function topTenOldestMaleList(int $total = 10): string
10798add1155SRico Sonntag    {
10808add1155SRico Sonntag        $records = $this->topTenOldestQuery('M', $total);
10818add1155SRico Sonntag
10828add1155SRico Sonntag        return view(
10838add1155SRico Sonntag            'statistics/individuals/top10-list',
10848add1155SRico Sonntag            [
10858add1155SRico Sonntag                'records' => $records,
10868add1155SRico Sonntag            ]
10878add1155SRico Sonntag        );
10888add1155SRico Sonntag    }
10898add1155SRico Sonntag
10908add1155SRico Sonntag    /**
10918add1155SRico Sonntag     * Find the oldest living individuals.
10928add1155SRico Sonntag     *
10938add1155SRico Sonntag     * @param string $sex
10948add1155SRico Sonntag     * @param int    $total
10958add1155SRico Sonntag     *
10968add1155SRico Sonntag     * @return array
10978add1155SRico Sonntag     */
10988add1155SRico Sonntag    private function topTenOldestAliveQuery(string $sex = 'BOTH', int $total = 10): array
10998add1155SRico Sonntag    {
11008add1155SRico Sonntag        if ($sex === 'F') {
11018add1155SRico Sonntag            $sex_search = " AND i_sex='F'";
11028add1155SRico Sonntag        } elseif ($sex === 'M') {
11038add1155SRico Sonntag            $sex_search = " AND i_sex='M'";
11048add1155SRico Sonntag        } else {
11058add1155SRico Sonntag            $sex_search = '';
11068add1155SRico Sonntag        }
11078add1155SRico Sonntag
11088add1155SRico Sonntag        $rows = $this->runSql(
11098add1155SRico Sonntag            "SELECT" .
11108add1155SRico Sonntag            " birth.d_gid AS id," .
11118add1155SRico Sonntag            " MIN(birth.d_julianday1) AS age" .
11128add1155SRico Sonntag            " FROM" .
11138add1155SRico Sonntag            " `##dates` AS birth," .
11148add1155SRico Sonntag            " `##individuals` AS indi" .
11158add1155SRico Sonntag            " WHERE" .
11168add1155SRico Sonntag            " indi.i_id=birth.d_gid AND" .
11178add1155SRico Sonntag            " indi.i_gedcom NOT REGEXP '\\n1 (" . implode('|', Gedcom::DEATH_EVENTS) . ")' AND" .
11188add1155SRico Sonntag            " birth.d_file={$this->tree->id()} AND" .
11198add1155SRico Sonntag            " birth.d_fact='BIRT' AND" .
11208add1155SRico Sonntag            " birth.d_file=indi.i_file AND" .
11218add1155SRico Sonntag            " birth.d_julianday1<>0" .
11228add1155SRico Sonntag            $sex_search .
11238add1155SRico Sonntag            " GROUP BY id" .
11248add1155SRico Sonntag            " ORDER BY age" .
11258add1155SRico Sonntag            " ASC LIMIT " . $total
11268add1155SRico Sonntag        );
11278add1155SRico Sonntag
11288add1155SRico Sonntag        $top10 = [];
11298add1155SRico Sonntag
11308add1155SRico Sonntag        foreach ($rows as $row) {
11318add1155SRico Sonntag            $person = Individual::getInstance($row->id, $this->tree);
11328add1155SRico Sonntag
11338add1155SRico Sonntag            $top10[] = [
11348add1155SRico Sonntag                'person' => $person,
11358add1155SRico Sonntag                'age'    => $this->calculateAge(WT_CLIENT_JD - ((int) $row->age)),
11368add1155SRico Sonntag            ];
11378add1155SRico Sonntag        }
11388add1155SRico Sonntag
11398add1155SRico Sonntag        return $top10;
11408add1155SRico Sonntag    }
11418add1155SRico Sonntag
11428add1155SRico Sonntag    /**
11438add1155SRico Sonntag     * Find the oldest living individuals.
11448add1155SRico Sonntag     *
11458add1155SRico Sonntag     * @param int $total
11468add1155SRico Sonntag     *
11478add1155SRico Sonntag     * @return string
11488add1155SRico Sonntag     */
11498add1155SRico Sonntag    public function topTenOldestAlive(int $total = 10): string
11508add1155SRico Sonntag    {
11518add1155SRico Sonntag        if (!Auth::isMember($this->tree)) {
11528add1155SRico Sonntag            return I18N::translate('This information is private and cannot be shown.');
11538add1155SRico Sonntag        }
11548add1155SRico Sonntag
11558add1155SRico Sonntag        $records = $this->topTenOldestAliveQuery('BOTH', $total);
11568add1155SRico Sonntag
11578add1155SRico Sonntag        return view(
11588add1155SRico Sonntag            'statistics/individuals/top10-nolist',
11598add1155SRico Sonntag            [
11608add1155SRico Sonntag                'records' => $records,
11618add1155SRico Sonntag            ]
11628add1155SRico Sonntag        );
11638add1155SRico Sonntag    }
11648add1155SRico Sonntag
11658add1155SRico Sonntag    /**
11668add1155SRico Sonntag     * Find the oldest living individuals.
11678add1155SRico Sonntag     *
11688add1155SRico Sonntag     * @param int $total
11698add1155SRico Sonntag     *
11708add1155SRico Sonntag     * @return string
11718add1155SRico Sonntag     */
11728add1155SRico Sonntag    public function topTenOldestListAlive(int $total = 10): string
11738add1155SRico Sonntag    {
11748add1155SRico Sonntag        if (!Auth::isMember($this->tree)) {
11758add1155SRico Sonntag            return I18N::translate('This information is private and cannot be shown.');
11768add1155SRico Sonntag        }
11778add1155SRico Sonntag
11788add1155SRico Sonntag        $records = $this->topTenOldestAliveQuery('BOTH', $total);
11798add1155SRico Sonntag
11808add1155SRico Sonntag        return view(
11818add1155SRico Sonntag            'statistics/individuals/top10-list',
11828add1155SRico Sonntag            [
11838add1155SRico Sonntag                'records' => $records,
11848add1155SRico Sonntag            ]
11858add1155SRico Sonntag        );
11868add1155SRico Sonntag    }
11878add1155SRico Sonntag
11888add1155SRico Sonntag    /**
11898add1155SRico Sonntag     * Find the oldest living females.
11908add1155SRico Sonntag     *
11918add1155SRico Sonntag     * @param int $total
11928add1155SRico Sonntag     *
11938add1155SRico Sonntag     * @return string
11948add1155SRico Sonntag     */
11958add1155SRico Sonntag    public function topTenOldestFemaleAlive(int $total = 10): string
11968add1155SRico Sonntag    {
11978add1155SRico Sonntag        if (!Auth::isMember($this->tree)) {
11988add1155SRico Sonntag            return I18N::translate('This information is private and cannot be shown.');
11998add1155SRico Sonntag        }
12008add1155SRico Sonntag
12018add1155SRico Sonntag        $records = $this->topTenOldestAliveQuery('F', $total);
12028add1155SRico Sonntag
12038add1155SRico Sonntag        return view(
12048add1155SRico Sonntag            'statistics/individuals/top10-nolist',
12058add1155SRico Sonntag            [
12068add1155SRico Sonntag                'records' => $records,
12078add1155SRico Sonntag            ]
12088add1155SRico Sonntag        );
12098add1155SRico Sonntag    }
12108add1155SRico Sonntag
12118add1155SRico Sonntag    /**
12128add1155SRico Sonntag     * Find the oldest living females.
12138add1155SRico Sonntag     *
12148add1155SRico Sonntag     * @param int $total
12158add1155SRico Sonntag     *
12168add1155SRico Sonntag     * @return string
12178add1155SRico Sonntag     */
12188add1155SRico Sonntag    public function topTenOldestFemaleListAlive(int $total = 10): string
12198add1155SRico Sonntag    {
12208add1155SRico Sonntag        if (!Auth::isMember($this->tree)) {
12218add1155SRico Sonntag            return I18N::translate('This information is private and cannot be shown.');
12228add1155SRico Sonntag        }
12238add1155SRico Sonntag
12248add1155SRico Sonntag        $records = $this->topTenOldestAliveQuery('F', $total);
12258add1155SRico Sonntag
12268add1155SRico Sonntag        return view(
12278add1155SRico Sonntag            'statistics/individuals/top10-list',
12288add1155SRico Sonntag            [
12298add1155SRico Sonntag                'records' => $records,
12308add1155SRico Sonntag            ]
12318add1155SRico Sonntag        );
12328add1155SRico Sonntag    }
12338add1155SRico Sonntag
12348add1155SRico Sonntag    /**
12358add1155SRico Sonntag     * Find the longest lived living males.
12368add1155SRico Sonntag     *
12378add1155SRico Sonntag     * @param int $total
12388add1155SRico Sonntag     *
12398add1155SRico Sonntag     * @return string
12408add1155SRico Sonntag     */
12418add1155SRico Sonntag    public function topTenOldestMaleAlive(int $total = 10): string
12428add1155SRico Sonntag    {
12438add1155SRico Sonntag        if (!Auth::isMember($this->tree)) {
12448add1155SRico Sonntag            return I18N::translate('This information is private and cannot be shown.');
12458add1155SRico Sonntag        }
12468add1155SRico Sonntag
12478add1155SRico Sonntag        $records = $this->topTenOldestAliveQuery('M', $total);
12488add1155SRico Sonntag
12498add1155SRico Sonntag        return view(
12508add1155SRico Sonntag            'statistics/individuals/top10-nolist',
12518add1155SRico Sonntag            [
12528add1155SRico Sonntag                'records' => $records,
12538add1155SRico Sonntag            ]
12548add1155SRico Sonntag        );
12558add1155SRico Sonntag    }
12568add1155SRico Sonntag
12578add1155SRico Sonntag    /**
12588add1155SRico Sonntag     * Find the longest lived living males.
12598add1155SRico Sonntag     *
12608add1155SRico Sonntag     * @param int $total
12618add1155SRico Sonntag     *
12628add1155SRico Sonntag     * @return string
12638add1155SRico Sonntag     */
12648add1155SRico Sonntag    public function topTenOldestMaleListAlive(int $total = 10): string
12658add1155SRico Sonntag    {
12668add1155SRico Sonntag        if (!Auth::isMember($this->tree)) {
12678add1155SRico Sonntag            return I18N::translate('This information is private and cannot be shown.');
12688add1155SRico Sonntag        }
12698add1155SRico Sonntag
12708add1155SRico Sonntag        $records = $this->topTenOldestAliveQuery('M', $total);
12718add1155SRico Sonntag
12728add1155SRico Sonntag        return view(
12738add1155SRico Sonntag            'statistics/individuals/top10-list',
12748add1155SRico Sonntag            [
12758add1155SRico Sonntag                'records' => $records,
12768add1155SRico Sonntag            ]
12778add1155SRico Sonntag        );
12788add1155SRico Sonntag    }
12798add1155SRico Sonntag
12808add1155SRico Sonntag    /**
12818add1155SRico Sonntag     * Find the average lifespan.
12828add1155SRico Sonntag     *
12838add1155SRico Sonntag     * @param string $sex
12848add1155SRico Sonntag     * @param bool   $show_years
12858add1155SRico Sonntag     *
12868add1155SRico Sonntag     * @return string
12878add1155SRico Sonntag     */
12888add1155SRico Sonntag    private function averageLifespanQuery(string $sex = 'BOTH', bool $show_years = false): string
12898add1155SRico Sonntag    {
129044cdc21eSGreg Roach        $prefix = DB::connection()->getTablePrefix();
12918add1155SRico Sonntag
129244cdc21eSGreg Roach        $days = (int) $this->birthAndDeathQuery($sex)
1293e4235cb4SRico Sonntag            ->select(DB::raw('AVG(' . $prefix . 'death.d_julianday2 - ' . $prefix . 'birth.d_julianday1) AS days'))
129444cdc21eSGreg Roach            ->value('days');
12958add1155SRico Sonntag
12968add1155SRico Sonntag        if ($show_years) {
129744cdc21eSGreg Roach            return $this->calculateAge($days);
12988add1155SRico Sonntag        }
12998add1155SRico Sonntag
130044cdc21eSGreg Roach        return I18N::number((int) ($days / 365.25));
13018add1155SRico Sonntag    }
13028add1155SRico Sonntag
13038add1155SRico Sonntag    /**
13048add1155SRico Sonntag     * Find the average lifespan.
13058add1155SRico Sonntag     *
13068add1155SRico Sonntag     * @param bool $show_years
13078add1155SRico Sonntag     *
13088add1155SRico Sonntag     * @return string
13098add1155SRico Sonntag     */
13108add1155SRico Sonntag    public function averageLifespan($show_years = false): string
13118add1155SRico Sonntag    {
13128add1155SRico Sonntag        return $this->averageLifespanQuery('BOTH', $show_years);
13138add1155SRico Sonntag    }
13148add1155SRico Sonntag
13158add1155SRico Sonntag    /**
13168add1155SRico Sonntag     * Find the average lifespan of females.
13178add1155SRico Sonntag     *
13188add1155SRico Sonntag     * @param bool $show_years
13198add1155SRico Sonntag     *
13208add1155SRico Sonntag     * @return string
13218add1155SRico Sonntag     */
13228add1155SRico Sonntag    public function averageLifespanFemale($show_years = false): string
13238add1155SRico Sonntag    {
13248add1155SRico Sonntag        return $this->averageLifespanQuery('F', $show_years);
13258add1155SRico Sonntag    }
13268add1155SRico Sonntag
13278add1155SRico Sonntag    /**
13288add1155SRico Sonntag     * Find the average male lifespan.
13298add1155SRico Sonntag     *
13308add1155SRico Sonntag     * @param bool $show_years
13318add1155SRico Sonntag     *
13328add1155SRico Sonntag     * @return string
13338add1155SRico Sonntag     */
13348add1155SRico Sonntag    public function averageLifespanMale($show_years = false): string
13358add1155SRico Sonntag    {
13368add1155SRico Sonntag        return $this->averageLifespanQuery('M', $show_years);
13378add1155SRico Sonntag    }
13388add1155SRico Sonntag
13398add1155SRico Sonntag    /**
13408add1155SRico Sonntag     * Convert totals into percentages.
13418add1155SRico Sonntag     *
13428add1155SRico Sonntag     * @param int $count
13438add1155SRico Sonntag     * @param int $total
13448add1155SRico Sonntag     *
13458add1155SRico Sonntag     * @return string
13468add1155SRico Sonntag     */
13478add1155SRico Sonntag    private function getPercentage(int $count, int $total): string
13488add1155SRico Sonntag    {
13498add1155SRico Sonntag        return I18N::percentage($count / $total, 1);
13508add1155SRico Sonntag    }
13518add1155SRico Sonntag
13528add1155SRico Sonntag    /**
13538add1155SRico Sonntag     * Returns how many individuals exist in the tree.
13548add1155SRico Sonntag     *
13558add1155SRico Sonntag     * @return int
13568add1155SRico Sonntag     */
13578add1155SRico Sonntag    private function totalIndividualsQuery(): int
13588add1155SRico Sonntag    {
13598add1155SRico Sonntag        return DB::table('individuals')
13608add1155SRico Sonntag            ->where('i_file', '=', $this->tree->id())
13618add1155SRico Sonntag            ->count();
13628add1155SRico Sonntag    }
13638add1155SRico Sonntag
13648add1155SRico Sonntag    /**
13658add1155SRico Sonntag     * Count the number of living individuals.
13668add1155SRico Sonntag     *
13678add1155SRico Sonntag     * The totalLiving/totalDeceased queries assume that every dead person will
13688add1155SRico Sonntag     * have a DEAT record. It will not include individuals who were born more
13698add1155SRico Sonntag     * than MAX_ALIVE_AGE years ago, and who have no DEAT record.
13708add1155SRico Sonntag     * A good reason to run the “Add missing DEAT records” batch-update!
13718add1155SRico Sonntag     *
13728add1155SRico Sonntag     * @return int
13738add1155SRico Sonntag     */
13748add1155SRico Sonntag    private function totalLivingQuery(): int
13758add1155SRico Sonntag    {
13763dc8167dSGreg Roach        $query = DB::table('individuals')
13773dc8167dSGreg Roach            ->where('i_file', '=', $this->tree->id());
13783dc8167dSGreg Roach
13793dc8167dSGreg Roach        foreach (Gedcom::DEATH_EVENTS as $death_event) {
138068d9d7c9SRico Sonntag            $query->where('i_gedcom', 'NOT LIKE', "%\n1 " . $death_event . '%');
13813dc8167dSGreg Roach        }
13823dc8167dSGreg Roach
13833dc8167dSGreg Roach        return $query->count();
13848add1155SRico Sonntag    }
13858add1155SRico Sonntag
13868add1155SRico Sonntag    /**
13878add1155SRico Sonntag     * Count the number of dead individuals.
13888add1155SRico Sonntag     *
13898add1155SRico Sonntag     * @return int
13908add1155SRico Sonntag     */
13918add1155SRico Sonntag    private function totalDeceasedQuery(): int
13928add1155SRico Sonntag    {
13938add1155SRico Sonntag        return DB::table('individuals')
13948add1155SRico Sonntag            ->where('i_file', '=', $this->tree->id())
13953dc8167dSGreg Roach            ->where(function (Builder $query): void {
13963dc8167dSGreg Roach                foreach (Gedcom::DEATH_EVENTS as $death_event) {
139768d9d7c9SRico Sonntag                    $query->orWhere('i_gedcom', 'LIKE', "%\n1 " . $death_event . '%');
13983dc8167dSGreg Roach                }
13993dc8167dSGreg Roach            })
14008add1155SRico Sonntag            ->count();
14018add1155SRico Sonntag    }
14028add1155SRico Sonntag
14038add1155SRico Sonntag    /**
14048add1155SRico Sonntag     * Returns the total count of a specific sex.
14058add1155SRico Sonntag     *
14068add1155SRico Sonntag     * @param string $sex The sex to query
14078add1155SRico Sonntag     *
14088add1155SRico Sonntag     * @return int
14098add1155SRico Sonntag     */
14108add1155SRico Sonntag    private function getTotalSexQuery(string $sex): int
14118add1155SRico Sonntag    {
14128add1155SRico Sonntag        return DB::table('individuals')
14138add1155SRico Sonntag            ->where('i_file', '=', $this->tree->id())
14148add1155SRico Sonntag            ->where('i_sex', '=', $sex)
14158add1155SRico Sonntag            ->count();
14168add1155SRico Sonntag    }
14178add1155SRico Sonntag
14188add1155SRico Sonntag    /**
14198add1155SRico Sonntag     * Returns the total number of males.
14208add1155SRico Sonntag     *
14218add1155SRico Sonntag     * @return int
14228add1155SRico Sonntag     */
14238add1155SRico Sonntag    private function totalSexMalesQuery(): int
14248add1155SRico Sonntag    {
14258add1155SRico Sonntag        return $this->getTotalSexQuery('M');
14268add1155SRico Sonntag    }
14278add1155SRico Sonntag
14288add1155SRico Sonntag    /**
14298add1155SRico Sonntag     * Returns the total number of females.
14308add1155SRico Sonntag     *
14318add1155SRico Sonntag     * @return int
14328add1155SRico Sonntag     */
14338add1155SRico Sonntag    private function totalSexFemalesQuery(): int
14348add1155SRico Sonntag    {
14358add1155SRico Sonntag        return $this->getTotalSexQuery('F');
14368add1155SRico Sonntag    }
14378add1155SRico Sonntag
14388add1155SRico Sonntag    /**
14398add1155SRico Sonntag     * Returns the total number of individuals with unknown sex.
14408add1155SRico Sonntag     *
14418add1155SRico Sonntag     * @return int
14428add1155SRico Sonntag     */
14438add1155SRico Sonntag    private function totalSexUnknownQuery(): int
14448add1155SRico Sonntag    {
14458add1155SRico Sonntag        return $this->getTotalSexQuery('U');
14468add1155SRico Sonntag    }
14478add1155SRico Sonntag
14488add1155SRico Sonntag    /**
14498add1155SRico Sonntag     * Count the total families.
14508add1155SRico Sonntag     *
14518add1155SRico Sonntag     * @return int
14528add1155SRico Sonntag     */
14538add1155SRico Sonntag    private function totalFamiliesQuery(): int
14548add1155SRico Sonntag    {
14558add1155SRico Sonntag        return DB::table('families')
14568add1155SRico Sonntag            ->where('f_file', '=', $this->tree->id())
14578add1155SRico Sonntag            ->count();
14588add1155SRico Sonntag    }
14598add1155SRico Sonntag
14608add1155SRico Sonntag    /**
14618add1155SRico Sonntag     * How many individuals have one or more sources.
14628add1155SRico Sonntag     *
14638add1155SRico Sonntag     * @return int
14648add1155SRico Sonntag     */
14658add1155SRico Sonntag    private function totalIndisWithSourcesQuery(): int
14668add1155SRico Sonntag    {
14678add1155SRico Sonntag        return DB::table('individuals')
14688add1155SRico Sonntag            ->select(['i_id'])
14698add1155SRico Sonntag            ->distinct()
14708add1155SRico Sonntag            ->join('link', function (JoinClause $join) {
14718add1155SRico Sonntag                $join->on('i_id', '=', 'l_from')
14728add1155SRico Sonntag                    ->on('i_file', '=', 'l_file');
14738add1155SRico Sonntag            })
14748add1155SRico Sonntag            ->where('l_file', '=', $this->tree->id())
14758add1155SRico Sonntag            ->where('l_type', '=', 'SOUR')
14768add1155SRico Sonntag            ->count('i_id');
14778add1155SRico Sonntag    }
14788add1155SRico Sonntag
14798add1155SRico Sonntag    /**
14808add1155SRico Sonntag     * Count the families with source records.
14818add1155SRico Sonntag     *
14828add1155SRico Sonntag     * @return int
14838add1155SRico Sonntag     */
14848add1155SRico Sonntag    private function totalFamsWithSourcesQuery(): int
14858add1155SRico Sonntag    {
14868add1155SRico Sonntag        return DB::table('families')
14878add1155SRico Sonntag            ->select(['f_id'])
14888add1155SRico Sonntag            ->distinct()
14898add1155SRico Sonntag            ->join('link', function (JoinClause $join) {
14908add1155SRico Sonntag                $join->on('f_id', '=', 'l_from')
14918add1155SRico Sonntag                    ->on('f_file', '=', 'l_file');
14928add1155SRico Sonntag            })
14938add1155SRico Sonntag            ->where('l_file', '=', $this->tree->id())
14948add1155SRico Sonntag            ->where('l_type', '=', 'SOUR')
14958add1155SRico Sonntag            ->count('f_id');
14968add1155SRico Sonntag    }
14978add1155SRico Sonntag
14988add1155SRico Sonntag    /**
14998add1155SRico Sonntag     * Count the number of repositories.
15008add1155SRico Sonntag     *
15018add1155SRico Sonntag     * @return int
15028add1155SRico Sonntag     */
15038add1155SRico Sonntag    private function totalRepositoriesQuery(): int
15048add1155SRico Sonntag    {
15058add1155SRico Sonntag        return DB::table('other')
15068add1155SRico Sonntag            ->where('o_file', '=', $this->tree->id())
15078add1155SRico Sonntag            ->where('o_type', '=', 'REPO')
15088add1155SRico Sonntag            ->count();
15098add1155SRico Sonntag    }
15108add1155SRico Sonntag
15118add1155SRico Sonntag    /**
15128add1155SRico Sonntag     * Count the total number of sources.
15138add1155SRico Sonntag     *
15148add1155SRico Sonntag     * @return int
15158add1155SRico Sonntag     */
15168add1155SRico Sonntag    private function totalSourcesQuery(): int
15178add1155SRico Sonntag    {
15188add1155SRico Sonntag        return DB::table('sources')
15198add1155SRico Sonntag            ->where('s_file', '=', $this->tree->id())
15208add1155SRico Sonntag            ->count();
15218add1155SRico Sonntag    }
15228add1155SRico Sonntag
15238add1155SRico Sonntag    /**
15248add1155SRico Sonntag     * Count the number of notes.
15258add1155SRico Sonntag     *
15268add1155SRico Sonntag     * @return int
15278add1155SRico Sonntag     */
15288add1155SRico Sonntag    private function totalNotesQuery(): int
15298add1155SRico Sonntag    {
15308add1155SRico Sonntag        return DB::table('other')
15318add1155SRico Sonntag            ->where('o_file', '=', $this->tree->id())
15328add1155SRico Sonntag            ->where('o_type', '=', 'NOTE')
15338add1155SRico Sonntag            ->count();
15348add1155SRico Sonntag    }
15358add1155SRico Sonntag
15368add1155SRico Sonntag    /**
15378add1155SRico Sonntag     * Returns the total number of records.
15388add1155SRico Sonntag     *
15398add1155SRico Sonntag     * @return int
15408add1155SRico Sonntag     */
15418add1155SRico Sonntag    private function totalRecordsQuery(): int
15428add1155SRico Sonntag    {
15438add1155SRico Sonntag        return $this->totalIndividualsQuery()
15448add1155SRico Sonntag            + $this->totalFamiliesQuery()
15458add1155SRico Sonntag            + $this->totalNotesQuery()
15468add1155SRico Sonntag            + $this->totalRepositoriesQuery()
15478add1155SRico Sonntag            + $this->totalSourcesQuery();
15488add1155SRico Sonntag    }
15498add1155SRico Sonntag
15508add1155SRico Sonntag    /**
15518add1155SRico Sonntag     * @inheritDoc
15528add1155SRico Sonntag     */
15538add1155SRico Sonntag    public function totalRecords(): string
15548add1155SRico Sonntag    {
15558add1155SRico Sonntag        return I18N::number($this->totalRecordsQuery());
15568add1155SRico Sonntag    }
15578add1155SRico Sonntag
15588add1155SRico Sonntag    /**
15598add1155SRico Sonntag     * @inheritDoc
15608add1155SRico Sonntag     */
15618add1155SRico Sonntag    public function totalIndividuals(): string
15628add1155SRico Sonntag    {
15638add1155SRico Sonntag        return I18N::number($this->totalIndividualsQuery());
15648add1155SRico Sonntag    }
15658add1155SRico Sonntag
15668add1155SRico Sonntag    /**
15678add1155SRico Sonntag     * Count the number of living individuals.
15688add1155SRico Sonntag     *
15698add1155SRico Sonntag     * @return string
15708add1155SRico Sonntag     */
15718add1155SRico Sonntag    public function totalLiving(): string
15728add1155SRico Sonntag    {
15738add1155SRico Sonntag        return I18N::number($this->totalLivingQuery());
15748add1155SRico Sonntag    }
15758add1155SRico Sonntag
15768add1155SRico Sonntag    /**
15778add1155SRico Sonntag     * Count the number of dead individuals.
15788add1155SRico Sonntag     *
15798add1155SRico Sonntag     * @return string
15808add1155SRico Sonntag     */
15818add1155SRico Sonntag    public function totalDeceased(): string
15828add1155SRico Sonntag    {
15838add1155SRico Sonntag        return I18N::number($this->totalDeceasedQuery());
15848add1155SRico Sonntag    }
15858add1155SRico Sonntag
15868add1155SRico Sonntag    /**
15878add1155SRico Sonntag     * @inheritDoc
15888add1155SRico Sonntag     */
15898add1155SRico Sonntag    public function totalSexMales(): string
15908add1155SRico Sonntag    {
15918add1155SRico Sonntag        return I18N::number($this->totalSexMalesQuery());
15928add1155SRico Sonntag    }
15938add1155SRico Sonntag
15948add1155SRico Sonntag    /**
15958add1155SRico Sonntag     * @inheritDoc
15968add1155SRico Sonntag     */
15978add1155SRico Sonntag    public function totalSexFemales(): string
15988add1155SRico Sonntag    {
15998add1155SRico Sonntag        return I18N::number($this->totalSexFemalesQuery());
16008add1155SRico Sonntag    }
16018add1155SRico Sonntag
16028add1155SRico Sonntag    /**
16038add1155SRico Sonntag     * @inheritDoc
16048add1155SRico Sonntag     */
16058add1155SRico Sonntag    public function totalSexUnknown(): string
16068add1155SRico Sonntag    {
16078add1155SRico Sonntag        return I18N::number($this->totalSexUnknownQuery());
16088add1155SRico Sonntag    }
16098add1155SRico Sonntag
16108add1155SRico Sonntag    /**
16118add1155SRico Sonntag     * @inheritDoc
16128add1155SRico Sonntag     */
16138add1155SRico Sonntag    public function totalFamilies(): string
16148add1155SRico Sonntag    {
16158add1155SRico Sonntag        return I18N::number($this->totalFamiliesQuery());
16168add1155SRico Sonntag    }
16178add1155SRico Sonntag
16188add1155SRico Sonntag    /**
16198add1155SRico Sonntag     * How many individuals have one or more sources.
16208add1155SRico Sonntag     *
16218add1155SRico Sonntag     * @return string
16228add1155SRico Sonntag     */
16238add1155SRico Sonntag    public function totalIndisWithSources(): string
16248add1155SRico Sonntag    {
16258add1155SRico Sonntag        return I18N::number($this->totalIndisWithSourcesQuery());
16268add1155SRico Sonntag    }
16278add1155SRico Sonntag
16288add1155SRico Sonntag    /**
16298add1155SRico Sonntag     * Count the families with with source records.
16308add1155SRico Sonntag     *
16318add1155SRico Sonntag     * @return string
16328add1155SRico Sonntag     */
16338add1155SRico Sonntag    public function totalFamsWithSources(): string
16348add1155SRico Sonntag    {
16358add1155SRico Sonntag        return I18N::number($this->totalFamsWithSourcesQuery());
16368add1155SRico Sonntag    }
16378add1155SRico Sonntag
16388add1155SRico Sonntag    /**
16398add1155SRico Sonntag     * @inheritDoc
16408add1155SRico Sonntag     */
16418add1155SRico Sonntag    public function totalRepositories(): string
16428add1155SRico Sonntag    {
16438add1155SRico Sonntag        return I18N::number($this->totalRepositoriesQuery());
16448add1155SRico Sonntag    }
16458add1155SRico Sonntag
16468add1155SRico Sonntag    /**
16478add1155SRico Sonntag     * @inheritDoc
16488add1155SRico Sonntag     */
16498add1155SRico Sonntag    public function totalSources(): string
16508add1155SRico Sonntag    {
16518add1155SRico Sonntag        return I18N::number($this->totalSourcesQuery());
16528add1155SRico Sonntag    }
16538add1155SRico Sonntag
16548add1155SRico Sonntag    /**
16558add1155SRico Sonntag     * @inheritDoc
16568add1155SRico Sonntag     */
16578add1155SRico Sonntag    public function totalNotes(): string
16588add1155SRico Sonntag    {
16598add1155SRico Sonntag        return I18N::number($this->totalNotesQuery());
16608add1155SRico Sonntag    }
16618add1155SRico Sonntag
16628add1155SRico Sonntag    /**
16638add1155SRico Sonntag     * @inheritDoc
16648add1155SRico Sonntag     */
16658add1155SRico Sonntag    public function totalIndividualsPercentage(): string
16668add1155SRico Sonntag    {
16678add1155SRico Sonntag        return $this->getPercentage(
16688add1155SRico Sonntag            $this->totalIndividualsQuery(),
16698add1155SRico Sonntag            $this->totalRecordsQuery()
16708add1155SRico Sonntag        );
16718add1155SRico Sonntag    }
16728add1155SRico Sonntag
16738add1155SRico Sonntag    /**
16748add1155SRico Sonntag     * @inheritDoc
16758add1155SRico Sonntag     */
16768add1155SRico Sonntag    public function totalFamiliesPercentage(): string
16778add1155SRico Sonntag    {
16788add1155SRico Sonntag        return $this->getPercentage(
16798add1155SRico Sonntag            $this->totalFamiliesQuery(),
16808add1155SRico Sonntag            $this->totalRecordsQuery()
16818add1155SRico Sonntag        );
16828add1155SRico Sonntag    }
16838add1155SRico Sonntag
16848add1155SRico Sonntag    /**
16858add1155SRico Sonntag     * @inheritDoc
16868add1155SRico Sonntag     */
16878add1155SRico Sonntag    public function totalRepositoriesPercentage(): string
16888add1155SRico Sonntag    {
16898add1155SRico Sonntag        return $this->getPercentage(
16908add1155SRico Sonntag            $this->totalRepositoriesQuery(),
16918add1155SRico Sonntag            $this->totalRecordsQuery()
16928add1155SRico Sonntag        );
16938add1155SRico Sonntag    }
16948add1155SRico Sonntag
16958add1155SRico Sonntag    /**
16968add1155SRico Sonntag     * @inheritDoc
16978add1155SRico Sonntag     */
16988add1155SRico Sonntag    public function totalSourcesPercentage(): string
16998add1155SRico Sonntag    {
17008add1155SRico Sonntag        return $this->getPercentage(
17018add1155SRico Sonntag            $this->totalSourcesQuery(),
17028add1155SRico Sonntag            $this->totalRecordsQuery()
17038add1155SRico Sonntag        );
17048add1155SRico Sonntag    }
17058add1155SRico Sonntag
17068add1155SRico Sonntag    /**
17078add1155SRico Sonntag     * @inheritDoc
17088add1155SRico Sonntag     */
17098add1155SRico Sonntag    public function totalNotesPercentage(): string
17108add1155SRico Sonntag    {
17118add1155SRico Sonntag        return $this->getPercentage(
17128add1155SRico Sonntag            $this->totalNotesQuery(),
17138add1155SRico Sonntag            $this->totalRecordsQuery()
17148add1155SRico Sonntag        );
17158add1155SRico Sonntag    }
17168add1155SRico Sonntag
17178add1155SRico Sonntag    /**
17188add1155SRico Sonntag     * @inheritDoc
17198add1155SRico Sonntag     */
17208add1155SRico Sonntag    public function totalLivingPercentage(): string
17218add1155SRico Sonntag    {
17228add1155SRico Sonntag        return $this->getPercentage(
17238add1155SRico Sonntag            $this->totalLivingQuery(),
17248add1155SRico Sonntag            $this->totalIndividualsQuery()
17258add1155SRico Sonntag        );
17268add1155SRico Sonntag    }
17278add1155SRico Sonntag
17288add1155SRico Sonntag    /**
17298add1155SRico Sonntag     * @inheritDoc
17308add1155SRico Sonntag     */
17318add1155SRico Sonntag    public function totalDeceasedPercentage(): string
17328add1155SRico Sonntag    {
17338add1155SRico Sonntag        return $this->getPercentage(
17348add1155SRico Sonntag            $this->totalDeceasedQuery(),
17358add1155SRico Sonntag            $this->totalIndividualsQuery()
17368add1155SRico Sonntag        );
17378add1155SRico Sonntag    }
17388add1155SRico Sonntag
17398add1155SRico Sonntag    /**
17408add1155SRico Sonntag     * @inheritDoc
17418add1155SRico Sonntag     */
17428add1155SRico Sonntag    public function totalSexMalesPercentage(): string
17438add1155SRico Sonntag    {
17448add1155SRico Sonntag        return $this->getPercentage(
17458add1155SRico Sonntag            $this->totalSexMalesQuery(),
17468add1155SRico Sonntag            $this->totalIndividualsQuery()
17478add1155SRico Sonntag        );
17488add1155SRico Sonntag    }
17498add1155SRico Sonntag
17508add1155SRico Sonntag    /**
17518add1155SRico Sonntag     * @inheritDoc
17528add1155SRico Sonntag     */
17538add1155SRico Sonntag    public function totalSexFemalesPercentage(): string
17548add1155SRico Sonntag    {
17558add1155SRico Sonntag        return $this->getPercentage(
17568add1155SRico Sonntag            $this->totalSexFemalesQuery(),
17578add1155SRico Sonntag            $this->totalIndividualsQuery()
17588add1155SRico Sonntag        );
17598add1155SRico Sonntag    }
17608add1155SRico Sonntag
17618add1155SRico Sonntag    /**
17628add1155SRico Sonntag     * @inheritDoc
17638add1155SRico Sonntag     */
17648add1155SRico Sonntag    public function totalSexUnknownPercentage(): string
17658add1155SRico Sonntag    {
17668add1155SRico Sonntag        return $this->getPercentage(
17678add1155SRico Sonntag            $this->totalSexUnknownQuery(),
17688add1155SRico Sonntag            $this->totalIndividualsQuery()
17698add1155SRico Sonntag        );
17708add1155SRico Sonntag    }
17718add1155SRico Sonntag
17728add1155SRico Sonntag    /**
17738add1155SRico Sonntag     * Create a chart of common given names.
17748add1155SRico Sonntag     *
17758add1155SRico Sonntag     * @param string|null $color_from
17768add1155SRico Sonntag     * @param string|null $color_to
17778add1155SRico Sonntag     * @param int         $maxtoshow
17788add1155SRico Sonntag     *
17798add1155SRico Sonntag     * @return string
17808add1155SRico Sonntag     */
17818add1155SRico Sonntag    public function chartCommonGiven(
17828add1155SRico Sonntag        string $color_from = null,
17838add1155SRico Sonntag        string $color_to = null,
17848add1155SRico Sonntag        int $maxtoshow = 7
17858add1155SRico Sonntag    ): string {
17868add1155SRico Sonntag        $tot_indi = $this->totalIndividualsQuery();
17878add1155SRico Sonntag        $given    = $this->commonGivenQuery('B', 'chart', false, 1, $maxtoshow);
17888add1155SRico Sonntag
178988de55fdSRico Sonntag        if (empty($given)) {
1790*dd7dd2a1SRico Sonntag            return I18N::translate('This information is not available.');
179188de55fdSRico Sonntag        }
179288de55fdSRico Sonntag
179388de55fdSRico Sonntag        return (new ChartCommonGiven($this->tree))
179488de55fdSRico Sonntag            ->chartCommonGiven($tot_indi, $given, $color_from, $color_to);
17958add1155SRico Sonntag    }
17968add1155SRico Sonntag
17978add1155SRico Sonntag    /**
17988add1155SRico Sonntag     * Create a chart of common surnames.
17998add1155SRico Sonntag     *
18008add1155SRico Sonntag     * @param string|null $color_from
18018add1155SRico Sonntag     * @param string|null $color_to
18028add1155SRico Sonntag     * @param int         $number_of_surnames
18038add1155SRico Sonntag     *
18048add1155SRico Sonntag     * @return string
18058add1155SRico Sonntag     */
18068add1155SRico Sonntag    public function chartCommonSurnames(
18078add1155SRico Sonntag        string $color_from = null,
18088add1155SRico Sonntag        string $color_to = null,
18098add1155SRico Sonntag        int $number_of_surnames = 10
18108add1155SRico Sonntag    ): string {
18118add1155SRico Sonntag        $tot_indi     = $this->totalIndividualsQuery();
18128add1155SRico Sonntag        $all_surnames = $this->topSurnames($number_of_surnames, 0);
18138add1155SRico Sonntag
181488de55fdSRico Sonntag        if (empty($all_surnames)) {
1815*dd7dd2a1SRico Sonntag            return I18N::translate('This information is not available.');
181688de55fdSRico Sonntag        }
181788de55fdSRico Sonntag
18188add1155SRico Sonntag        return (new ChartCommonSurname($this->tree))
181988de55fdSRico Sonntag            ->chartCommonSurnames($tot_indi, $all_surnames, $color_from, $color_to);
18208add1155SRico Sonntag    }
18218add1155SRico Sonntag
18228add1155SRico Sonntag    /**
18238add1155SRico Sonntag     * Create a chart showing mortality.
18248add1155SRico Sonntag     *
18258add1155SRico Sonntag     * @param string|null $color_living
18268add1155SRico Sonntag     * @param string|null $color_dead
18278add1155SRico Sonntag     *
18288add1155SRico Sonntag     * @return string
18298add1155SRico Sonntag     */
183088de55fdSRico Sonntag    public function chartMortality(string $color_living = null, string $color_dead = null): string
18318add1155SRico Sonntag    {
18328add1155SRico Sonntag        $tot_l = $this->totalLivingQuery();
18338add1155SRico Sonntag        $tot_d = $this->totalDeceasedQuery();
18348add1155SRico Sonntag
18358add1155SRico Sonntag        return (new ChartMortality($this->tree))
183688de55fdSRico Sonntag            ->chartMortality($tot_l, $tot_d, $color_living, $color_dead);
18378add1155SRico Sonntag    }
18388add1155SRico Sonntag
18398add1155SRico Sonntag    /**
18408add1155SRico Sonntag     * Create a chart showing individuals with/without sources.
18418add1155SRico Sonntag     *
18428add1155SRico Sonntag     * @param string|null $color_from
18438add1155SRico Sonntag     * @param string|null $color_to
18448add1155SRico Sonntag     *
18458add1155SRico Sonntag     * @return string
18468add1155SRico Sonntag     */
18478add1155SRico Sonntag    public function chartIndisWithSources(
18488add1155SRico Sonntag        string $color_from = null,
18498add1155SRico Sonntag        string $color_to   = null
18508add1155SRico Sonntag    ): string {
18518add1155SRico Sonntag        $tot_indi        = $this->totalIndividualsQuery();
18528add1155SRico Sonntag        $tot_indi_source = $this->totalIndisWithSourcesQuery();
18538add1155SRico Sonntag
185488de55fdSRico Sonntag        return (new ChartIndividualWithSources($this->tree))
185588de55fdSRico Sonntag            ->chartIndisWithSources($tot_indi, $tot_indi_source, $color_from, $color_to);
18568add1155SRico Sonntag    }
18578add1155SRico Sonntag
18588add1155SRico Sonntag    /**
18598add1155SRico Sonntag     * Create a chart of individuals with/without sources.
18608add1155SRico Sonntag     *
18618add1155SRico Sonntag     * @param string|null $color_from
18628add1155SRico Sonntag     * @param string|null $color_to
18638add1155SRico Sonntag     *
18648add1155SRico Sonntag     * @return string
18658add1155SRico Sonntag     */
18668add1155SRico Sonntag    public function chartFamsWithSources(
18678add1155SRico Sonntag        string $color_from = null,
18688add1155SRico Sonntag        string $color_to   = null
18698add1155SRico Sonntag    ): string {
18708add1155SRico Sonntag        $tot_fam        = $this->totalFamiliesQuery();
18718add1155SRico Sonntag        $tot_fam_source = $this->totalFamsWithSourcesQuery();
18728add1155SRico Sonntag
187388de55fdSRico Sonntag        return (new ChartFamilyWithSources($this->tree))
187488de55fdSRico Sonntag            ->chartFamsWithSources($tot_fam, $tot_fam_source, $color_from, $color_to);
18758add1155SRico Sonntag    }
18768add1155SRico Sonntag
18778add1155SRico Sonntag    /**
18788add1155SRico Sonntag     * @inheritDoc
18798add1155SRico Sonntag     */
18808add1155SRico Sonntag    public function chartSex(
18818add1155SRico Sonntag        string $color_female  = null,
18828add1155SRico Sonntag        string $color_male    = null,
18838add1155SRico Sonntag        string $color_unknown = null
18848add1155SRico Sonntag    ): string {
18858add1155SRico Sonntag        $tot_m = $this->totalSexMalesQuery();
18868add1155SRico Sonntag        $tot_f = $this->totalSexFemalesQuery();
18878add1155SRico Sonntag        $tot_u = $this->totalSexUnknownQuery();
18888add1155SRico Sonntag
18898add1155SRico Sonntag        return (new ChartSex($this->tree))
189088de55fdSRico Sonntag            ->chartSex($tot_m, $tot_f, $tot_u, $color_female, $color_male, $color_unknown);
18918add1155SRico Sonntag    }
189244cdc21eSGreg Roach
189344cdc21eSGreg Roach    /**
189444cdc21eSGreg Roach     * Query individuals, with their births and deaths.
189544cdc21eSGreg Roach     *
189644cdc21eSGreg Roach     * @param string $sex
189744cdc21eSGreg Roach     *
189844cdc21eSGreg Roach     * @return Builder
189944cdc21eSGreg Roach     */
1900e2cbf57aSGreg Roach    private function birthAndDeathQuery(string $sex): Builder
1901e2cbf57aSGreg Roach    {
190244cdc21eSGreg Roach        $query = DB::table('individuals')
190344cdc21eSGreg Roach            ->where('i_file', '=', $this->tree->id())
190444cdc21eSGreg Roach            ->join('dates AS birth', function (JoinClause $join): void {
190544cdc21eSGreg Roach                $join
190644cdc21eSGreg Roach                    ->on('birth.d_file', '=', 'i_file')
190744cdc21eSGreg Roach                    ->on('birth.d_gid', '=', 'i_id');
190844cdc21eSGreg Roach            })
190944cdc21eSGreg Roach            ->join('dates AS death', function (JoinClause $join): void {
191044cdc21eSGreg Roach                $join
191144cdc21eSGreg Roach                    ->on('death.d_file', '=', 'i_file')
191244cdc21eSGreg Roach                    ->on('death.d_gid', '=', 'i_id');
191344cdc21eSGreg Roach            })
191444cdc21eSGreg Roach            ->where('birth.d_fact', '=', 'BIRT')
191544cdc21eSGreg Roach            ->where('death.d_fact', '=', 'DEAT')
191644cdc21eSGreg Roach            ->whereColumn('death.d_julianday1', '>=', 'birth.d_julianday2')
191744cdc21eSGreg Roach            ->where('birth.d_julianday2', '<>', 0);
191844cdc21eSGreg Roach
191944cdc21eSGreg Roach        if ($sex === 'M' || $sex === 'F') {
192044cdc21eSGreg Roach            $query->where('i_sex', '=', $sex);
192144cdc21eSGreg Roach        }
192244cdc21eSGreg Roach
192344cdc21eSGreg Roach        return $query;
192444cdc21eSGreg Roach    }
19258add1155SRico Sonntag}
1926