xref: /webtrees/app/Report/ReportBaseImage.php (revision 83cdc021ef3cbd30c7b73b429e75d0d3c95ff416)
1a25f0a04SGreg Roach<?php
2a25f0a04SGreg Roach/**
3a25f0a04SGreg Roach * webtrees: online genealogy
41062a142SGreg Roach * Copyright (C) 2018 webtrees development team
5a25f0a04SGreg Roach * This program is free software: you can redistribute it and/or modify
6a25f0a04SGreg Roach * it under the terms of the GNU General Public License as published by
7a25f0a04SGreg Roach * the Free Software Foundation, either version 3 of the License, or
8a25f0a04SGreg Roach * (at your option) any later version.
9a25f0a04SGreg Roach * This program is distributed in the hope that it will be useful,
10a25f0a04SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
11a25f0a04SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12a25f0a04SGreg Roach * GNU General Public License for more details.
13a25f0a04SGreg Roach * You should have received a copy of the GNU General Public License
14a25f0a04SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
15a25f0a04SGreg Roach */
1676692c8bSGreg Roachnamespace Fisharebest\Webtrees\Report;
17a25f0a04SGreg Roach
18a25f0a04SGreg Roach/**
19a25f0a04SGreg Roach * Class ReportBaseImage
20a25f0a04SGreg Roach */
21c1010edaSGreg Roachclass ReportBaseImage extends ReportBaseElement
22c1010edaSGreg Roach{
23*83cdc021SGreg Roach    /** @var string Filename of the image */
24a25f0a04SGreg Roach    public $file;
25*83cdc021SGreg Roach
26*83cdc021SGreg Roach    /** @var int Height of the image */
27a25f0a04SGreg Roach    public $height;
28*83cdc021SGreg Roach
29*83cdc021SGreg Roach    /** @var int Width of the image */
30a25f0a04SGreg Roach    public $width;
31*83cdc021SGreg Roach
32*83cdc021SGreg Roach    /** @var int X-position (left) of the image */
33a25f0a04SGreg Roach    public $x;
34*83cdc021SGreg Roach
35*83cdc021SGreg Roach    /** @var int Y-position (top) of the image */
36a25f0a04SGreg Roach    public $y;
37*83cdc021SGreg Roach
38*83cdc021SGreg Roach    /** @var string Placement fo the image. L: left, C:center, R:right (or empty for x/y) */
39*83cdc021SGreg Roach    public $align;
40*83cdc021SGreg Roach
41*83cdc021SGreg Roach    /** @var string T:same line, N:next line */
42*83cdc021SGreg Roach    public $line;
43a25f0a04SGreg Roach
44a25f0a04SGreg Roach    /**
45a25f0a04SGreg Roach     * Image class function - Base
46a25f0a04SGreg Roach     *
47a25f0a04SGreg Roach     * @param string $file  Filename of the image
48*83cdc021SGreg Roach     * @param int    $x     X-position (left) of the image
49*83cdc021SGreg Roach     * @param int    $y     Y-position (top) of the image
50*83cdc021SGreg Roach     * @param int    $w     Width of the image
51*83cdc021SGreg Roach     * @param int    $h     Height of the image
52a25f0a04SGreg Roach     * @param string $align Placement of the image. L: left, C:center, R:right
53a25f0a04SGreg Roach     * @param string $ln    T:same line, N:next line
54a25f0a04SGreg Roach     */
55*83cdc021SGreg Roach    public function __construct(string $file, int $x, int $y, int $w, int $h, string $align, string $ln)
56c1010edaSGreg Roach    {
57a25f0a04SGreg Roach        $this->file   = $file;
58a25f0a04SGreg Roach        $this->width  = $w;
59a25f0a04SGreg Roach        $this->height = $h;
60a25f0a04SGreg Roach        $this->x      = $x;
61a25f0a04SGreg Roach        $this->y      = $y;
62a25f0a04SGreg Roach        $this->align  = $align;
63a25f0a04SGreg Roach        $this->line   = $ln;
64a25f0a04SGreg Roach    }
65a25f0a04SGreg Roach
66a25f0a04SGreg Roach    /**
6776692c8bSGreg Roach     * Get the height.
6876692c8bSGreg Roach     *
69a25f0a04SGreg Roach     * @param $renderer
70a25f0a04SGreg Roach     *
71a25f0a04SGreg Roach     * @return float
72a25f0a04SGreg Roach     */
738f53f488SRico Sonntag    public function getHeight($renderer): float
74c1010edaSGreg Roach    {
75a25f0a04SGreg Roach        return $this->height;
76a25f0a04SGreg Roach    }
77a25f0a04SGreg Roach
78a25f0a04SGreg Roach    /**
7976692c8bSGreg Roach     * Get the width.
8076692c8bSGreg Roach     *
81a25f0a04SGreg Roach     * @param $renderer
82a25f0a04SGreg Roach     *
838ba2e626SGreg Roach     * @return float|array
84a25f0a04SGreg Roach     */
858ba2e626SGreg Roach    public function getWidth($renderer)
86c1010edaSGreg Roach    {
87a25f0a04SGreg Roach        return $this->width;
88a25f0a04SGreg Roach    }
89a25f0a04SGreg Roach}
90