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 */ 16declare(strict_types=1); 17 18namespace Fisharebest\Webtrees\Module; 19 20use Fisharebest\Webtrees\Tree; 21use Symfony\Component\HttpFoundation\Request; 22 23/** 24 * Interface ModuleInterface - Classes and libraries for module system 25 */ 26interface ModuleInterface 27{ 28 /** 29 * Create a new module. 30 * 31 * @param string $directory Where is this module installed 32 */ 33 public function __construct(string $directory); 34 35 /** 36 * How should this module be labelled on tabs, menus, etc.? 37 * 38 * @return string 39 */ 40 public function getTitle(): string; 41 42 /** 43 * A sentence describing what this module does. 44 * 45 * @return string 46 */ 47 public function getDescription(): string; 48 49 /** 50 * What is the default access level for this module? 51 * 52 * Some modules are aimed at admins or managers, and are not generally shown to users. 53 * 54 * @return int Returns one of: Auth::PRIV_HIDE, Auth::PRIV_PRIVATE, Auth::PRIV_USER, Auth::PRIV_NONE 55 */ 56 public function defaultAccessLevel(): int; 57 58 /** 59 * Provide a unique internal name for this module 60 * 61 * @return string 62 */ 63 public function getName(): string; 64} 65