xref: /webtrees/app/Repository.php (revision 64d9078a3a1fe7f0c5c5c13973b3b90b6329590e)
1a25f0a04SGreg Roach<?php
2dd04c183SGreg 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 Repository - Class file for a Repository (REPO) object
21a25f0a04SGreg Roach */
22a25f0a04SGreg Roachclass Repository extends GedcomRecord {
23a25f0a04SGreg Roach	const RECORD_TYPE = 'REPO';
24a25f0a04SGreg Roach	const URL_PREFIX = 'repo.php?rid=';
25a25f0a04SGreg Roach
26a25f0a04SGreg Roach	/**
27a25f0a04SGreg Roach	 * Get an instance of a repository object.  For single records,
28a25f0a04SGreg Roach	 * we just receive the XREF.  For bulk records (such as lists
29a25f0a04SGreg Roach	 * and search results) we can receive the GEDCOM data as well.
30a25f0a04SGreg Roach	 *
31a25f0a04SGreg Roach	 * @param string      $xref
3224ec66ceSGreg Roach	 * @param Tree        $tree
33a25f0a04SGreg Roach	 * @param string|null $gedcom
34a25f0a04SGreg Roach	 *
35a25f0a04SGreg Roach	 * @return Repository|null
36a25f0a04SGreg Roach	 */
3724ec66ceSGreg Roach	public static function getInstance($xref, Tree $tree, $gedcom = null) {
3824ec66ceSGreg Roach		$record = parent::getInstance($xref, $tree, $gedcom);
39a25f0a04SGreg Roach
40a25f0a04SGreg Roach		if ($record instanceof Repository) {
41a25f0a04SGreg Roach			return $record;
42a25f0a04SGreg Roach		} else {
43a25f0a04SGreg Roach			return null;
44a25f0a04SGreg Roach		}
45a25f0a04SGreg Roach	}
46a25f0a04SGreg Roach
47a25f0a04SGreg Roach	/** {@inheritdoc} */
48*64d9078aSGreg Roach	protected static function fetchGedcomRecord($xref, $tree_id) {
49*64d9078aSGreg Roach		return Database::prepare(
50*64d9078aSGreg Roach			"SELECT o_gedcom FROM `##other` WHERE o_id = :xref AND o_file = :tree_id AND o_type = 'REPO'"
51*64d9078aSGreg Roach		)->execute(array(
52*64d9078aSGreg Roach			'xref'    => $xref,
53*64d9078aSGreg Roach			'tree_id' => $tree_id,
54*64d9078aSGreg Roach		))->fetchOne();
55a25f0a04SGreg Roach	}
56a25f0a04SGreg Roach
57a25f0a04SGreg Roach	/** {@inheritdoc} */
58a25f0a04SGreg Roach	protected function createPrivateGedcomRecord($access_level) {
59a25f0a04SGreg Roach		return '0 @' . $this->xref . "@ REPO\n1 NAME " . I18N::translate('Private');
60a25f0a04SGreg Roach	}
61a25f0a04SGreg Roach
62a25f0a04SGreg Roach	/** {@inheritdoc} */
63a25f0a04SGreg Roach	public function extractNames() {
6436a0c51dSGreg Roach		parent::extractNamesFromFacts(1, 'NAME', $this->getFacts('NAME'));
65a25f0a04SGreg Roach	}
66a25f0a04SGreg Roach}
67