xref: /webtrees/app/Census/CensusColumnInterface.php (revision 873953697c930fadbf3243d2b8c0029fd684da0e)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17namespace Fisharebest\Webtrees\Census;
18
19use Fisharebest\Webtrees\Date;
20use Fisharebest\Webtrees\Individual;
21
22/**
23 * Definitions for a census column
24 */
25interface CensusColumnInterface
26{
27    /**
28     * A short version of the column's name.
29     *
30     * @return string
31     */
32    public function abbreviation(): string;
33
34    /**
35     * When did this census occur
36     *
37     * @return Date
38     */
39    public function date(): Date;
40
41    /**
42     * Generate the likely value of this census column, based on available information.
43     *
44     * @param Individual $individual
45     * @param Individual $head
46     *
47     * @return string
48     */
49    public function generate(Individual $individual, Individual $head): string;
50
51    /**
52     * Where did this census occur
53     *
54     * @return string
55     */
56    public function place(): string;
57
58    /**
59     * The full version of the column's name.
60     *
61     * @return string
62     */
63    public function title(): string;
64}
65