xref: /webtrees/app/Module/ModuleTabInterface.php (revision 225e381f36d59b49c8cdac0060465fa5af2fc308)

<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2018 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Individual;

/**
 * Interface ModuleTabInterface - Classes and libraries for module system
 */
interface ModuleTabInterface {
	/**
	 * The user can re-arrange the tab order, but until they do, this
	 * is the order in which tabs are shown.
	 *
	 * @return int
	 */
	public function defaultTabOrder();

	/**
	 * Generate the HTML content of this tab.
	 *
	 * @param Individual $individual
	 *
	 * @return string
	 */
	public function getTabContent(Individual $individual);

	/**
	 * Is this tab empty? If so, we don't always need to display it.
	 *
	 * @param Individual $individual
	 *
	 * @return bool
	 */
	public function hasTabContent(Individual $individual);

	/**
	 * Can this tab load asynchronously?
	 *
	 * @return bool
	 */
	public function canLoadAjax();

	/**
	 * A greyed out tab has no actual content, but may perhaps have
	 * options to create content.
	 *
	 * @param Individual $individual
	 *
	 * @return bool
	 */
	public function isGrayedOut(Individual $individual);
}