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