xref: /webtrees/app/Report/ReportBaseLine.php (revision 41cfb9e2204e7a7e8919e48098071f28e9a0fc54)
1a25f0a04SGreg Roach<?php
23976b470SGreg Roach
3a25f0a04SGreg Roach/**
4a25f0a04SGreg Roach * webtrees: online genealogy
589f7189bSGreg Roach * Copyright (C) 2021 webtrees development team
6a25f0a04SGreg Roach * This program is free software: you can redistribute it and/or modify
7a25f0a04SGreg Roach * it under the terms of the GNU General Public License as published by
8a25f0a04SGreg Roach * the Free Software Foundation, either version 3 of the License, or
9a25f0a04SGreg Roach * (at your option) any later version.
10a25f0a04SGreg Roach * This program is distributed in the hope that it will be useful,
11a25f0a04SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
12a25f0a04SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13a25f0a04SGreg Roach * GNU General Public License for more details.
14a25f0a04SGreg Roach * You should have received a copy of the GNU General Public License
1589f7189bSGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>.
16a25f0a04SGreg Roach */
17fcfa147eSGreg Roach
18e7f56f2aSGreg Roachdeclare(strict_types=1);
19e7f56f2aSGreg Roach
2076692c8bSGreg Roachnamespace Fisharebest\Webtrees\Report;
21a25f0a04SGreg Roach
22b6f35a76SGreg Roachuse function abs;
23b6f35a76SGreg Roach
24a25f0a04SGreg Roach/**
25a25f0a04SGreg Roach * Class ReportBaseLine
26a25f0a04SGreg Roach */
27c1010edaSGreg Roachclass ReportBaseLine extends ReportBaseElement
28c1010edaSGreg Roach{
29a25f0a04SGreg Roach    /**
30a25f0a04SGreg Roach     * Start horizontal position, current position (default)
31a25f0a04SGreg Roach     *
32c21bdddcSGreg Roach     * @var float
33a25f0a04SGreg Roach     */
34c21bdddcSGreg Roach    public $x1 = ReportBaseElement::CURRENT_POSITION;
35a25f0a04SGreg Roach    /**
36a25f0a04SGreg Roach     * Start vertical position, current position (default)
37a25f0a04SGreg Roach     *
38c21bdddcSGreg Roach     * @var float
39a25f0a04SGreg Roach     */
40c21bdddcSGreg Roach    public $y1 = ReportBaseElement::CURRENT_POSITION;
41a25f0a04SGreg Roach    /**
42a25f0a04SGreg Roach     * End horizontal position, maximum width (default)
43a25f0a04SGreg Roach     *
44c21bdddcSGreg Roach     * @var float
45a25f0a04SGreg Roach     */
46c21bdddcSGreg Roach    public $x2 = ReportBaseElement::CURRENT_POSITION;
47a25f0a04SGreg Roach    /**
48a25f0a04SGreg Roach     * End vertical position
49a25f0a04SGreg Roach     *
50c21bdddcSGreg Roach     * @var float
51a25f0a04SGreg Roach     */
52c21bdddcSGreg Roach    public $y2 = ReportBaseElement::CURRENT_POSITION;
53a25f0a04SGreg Roach
54a25f0a04SGreg Roach    /**
55a25f0a04SGreg Roach     * Create a line class - Base
56a25f0a04SGreg Roach     *
57a25f0a04SGreg Roach     * @param mixed $x1
58a25f0a04SGreg Roach     * @param mixed $y1
59a25f0a04SGreg Roach     * @param mixed $x2
60a25f0a04SGreg Roach     * @param mixed $y2
61a25f0a04SGreg Roach     */
62c1010edaSGreg Roach    public function __construct($x1, $y1, $x2, $y2)
63c1010edaSGreg Roach    {
64a25f0a04SGreg Roach        $this->x1 = $x1;
65a25f0a04SGreg Roach        $this->y1 = $y1;
66a25f0a04SGreg Roach        $this->x2 = $x2;
67a25f0a04SGreg Roach        $this->y2 = $y2;
68a25f0a04SGreg Roach    }
69a25f0a04SGreg Roach
70a25f0a04SGreg Roach    /**
7176692c8bSGreg Roach     * Get the height of the line.
7276692c8bSGreg Roach     *
73b6f35a76SGreg Roach     * @param HtmlRenderer|PdfRenderer $renderer
74a25f0a04SGreg Roach     *
75e93111adSRico Sonntag     * @return float
76a25f0a04SGreg Roach     */
778f53f488SRico Sonntag    public function getHeight($renderer): float
78c1010edaSGreg Roach    {
79a25f0a04SGreg Roach        return abs($this->y2 - $this->y1);
80a25f0a04SGreg Roach    }
81a25f0a04SGreg Roach
82a25f0a04SGreg Roach    /**
8376692c8bSGreg Roach     * Get the width of the line.
8476692c8bSGreg Roach     *
85b6f35a76SGreg Roach     * @param HtmlRenderer|PdfRenderer $renderer
86a25f0a04SGreg Roach     *
87*41cfb9e2SGreg Roach     * @return array{0:float,1:int,2:float|int}
88a25f0a04SGreg Roach     */
89*41cfb9e2SGreg Roach    public function getWidth($renderer): array
90c1010edaSGreg Roach    {
91*41cfb9e2SGreg Roach        return [abs($this->x2 - $this->x1), 1, $this->getHeight($renderer)];
92a25f0a04SGreg Roach    }
93a25f0a04SGreg Roach}
94