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