xref: /webtrees/app/Report/ReportBaseImage.php (revision 369c0ce6d43eee62858778711fa4744ed347814a)
1a25f0a04SGreg Roach<?php
2a25f0a04SGreg Roach/**
3a25f0a04SGreg Roach * webtrees: online genealogy
4*369c0ce6SGreg Roach * Copyright (C) 2016 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 */
21a25f0a04SGreg Roachclass ReportBaseImage extends ReportBaseElement {
22a25f0a04SGreg Roach	/**
23a25f0a04SGreg Roach	 * Filename of the image
24a25f0a04SGreg Roach	 *
25a25f0a04SGreg Roach	 * @var string
26a25f0a04SGreg Roach	 */
27a25f0a04SGreg Roach	public $file;
28a25f0a04SGreg Roach	/**
29a25f0a04SGreg Roach	 * Height of the image
30a25f0a04SGreg Roach	 *
31a25f0a04SGreg Roach	 * @var float
32a25f0a04SGreg Roach	 */
33a25f0a04SGreg Roach	public $height;
34a25f0a04SGreg Roach	/**
35a25f0a04SGreg Roach	 * Width of the image
36a25f0a04SGreg Roach	 *
37a25f0a04SGreg Roach	 * @var float
38a25f0a04SGreg Roach	 */
39a25f0a04SGreg Roach	public $width;
40a25f0a04SGreg Roach	/**
41a25f0a04SGreg Roach	 * X-position (left) of the image
42a25f0a04SGreg Roach	 *
43a25f0a04SGreg Roach	 * @var float
44a25f0a04SGreg Roach	 */
45a25f0a04SGreg Roach	public $x;
46a25f0a04SGreg Roach	/**
47a25f0a04SGreg Roach	 * Y-position (top) of the image
48a25f0a04SGreg Roach	 *
49a25f0a04SGreg Roach	 * @var float
50a25f0a04SGreg Roach	 */
51a25f0a04SGreg Roach	public $y;
52a25f0a04SGreg Roach	/**
53a25f0a04SGreg Roach	 * Placement fo the image. L: left, C:center, R:right
54a25f0a04SGreg Roach	 *
55a25f0a04SGreg Roach	 * @var string
56a25f0a04SGreg Roach	 */
57a25f0a04SGreg Roach	public $align = "";
58a25f0a04SGreg Roach	/**
59a25f0a04SGreg Roach	 * T:same line, N:next line
60a25f0a04SGreg Roach	 *
61a25f0a04SGreg Roach	 * @var string
62a25f0a04SGreg Roach	 */
63a25f0a04SGreg Roach	public $line = "";
64a25f0a04SGreg Roach
65a25f0a04SGreg Roach	/**
66a25f0a04SGreg Roach	 * Image class function - Base
67a25f0a04SGreg Roach	 *
68a25f0a04SGreg Roach	 * @param string $file  Filename of the image
69a25f0a04SGreg Roach	 * @param float  $x     X-position (left) of the image
70a25f0a04SGreg Roach	 * @param float  $y     Y-position (top) of the image
71a25f0a04SGreg Roach	 * @param float  $w     Width of the image
72a25f0a04SGreg Roach	 * @param float  $h     Height of the image
73a25f0a04SGreg Roach	 * @param string $align Placement of the image. L: left, C:center, R:right
74a25f0a04SGreg Roach	 * @param string $ln    T:same line, N:next line
75a25f0a04SGreg Roach	 */
76e2d2f0ebSGreg Roach	public function __construct($file, $x, $y, $w, $h, $align, $ln) {
77a25f0a04SGreg Roach		$this->file   = $file;
78a25f0a04SGreg Roach		$this->width  = $w;
79a25f0a04SGreg Roach		$this->height = $h;
80a25f0a04SGreg Roach		$this->x      = $x;
81a25f0a04SGreg Roach		$this->y      = $y;
82a25f0a04SGreg Roach		$this->align  = $align;
83a25f0a04SGreg Roach		$this->line   = $ln;
84a25f0a04SGreg Roach
85a25f0a04SGreg Roach		return 0;
86a25f0a04SGreg Roach	}
87a25f0a04SGreg Roach
88a25f0a04SGreg Roach	/**
8976692c8bSGreg Roach	 * Get the height.
9076692c8bSGreg Roach	 *
91a25f0a04SGreg Roach	 * @param $renderer
92a25f0a04SGreg Roach	 *
93a25f0a04SGreg Roach	 * @return float
94a25f0a04SGreg Roach	 */
95ffd703eaSGreg Roach	public function getHeight($renderer) {
96a25f0a04SGreg Roach		return $this->height;
97a25f0a04SGreg Roach	}
98a25f0a04SGreg Roach
99a25f0a04SGreg Roach	/**
10076692c8bSGreg Roach	 * Get the width.
10176692c8bSGreg Roach	 *
102a25f0a04SGreg Roach	 * @param $renderer
103a25f0a04SGreg Roach	 *
104a25f0a04SGreg Roach	 * @return float
105a25f0a04SGreg Roach	 */
106ffd703eaSGreg Roach	public function getWidth($renderer) {
107a25f0a04SGreg Roach		return $this->width;
108a25f0a04SGreg Roach	}
109a25f0a04SGreg Roach}
110