xref: /webtrees/app/Census/CensusInterface.php (revision 4ccf2a72a960de8375eee0787bc02e7d6dc065eb)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2015 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 */
16namespace Fisharebest\Webtrees\Census;
17
18use Fisharebest\Webtrees\Individual;
19
20/**
21 * Definitions for a census
22 */
23interface CensusInterface {
24	/**
25	 * Where did this census occur, in GEDCOM format.
26	 *
27	 * @return string
28	 */
29	public function censusPlace();
30
31	/**
32	 * When did this census occur, in GEDCOM format.
33	 *
34	 * @return string
35	 */
36	public function censusDate();
37
38	/**
39	 * All available censuses for this census place.
40	 *
41	 * @return CensusInterface[]
42	 */
43	public function allCensusDates();
44
45	/**
46	 * The columns of the census.
47	 *
48	 * @param Individual $individual
49	 *
50	 * @return CensusColumnInterface[]
51	 */
52	public function columns(Individual $individual);
53}
54