summaryrefslogtreecommitdiff
path: root/library/WT/Module/Block.php
blob: 6e832bf1abe31eca6d6570bff824e3c65f53cdd8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?php
// webtrees: Web based Family History software
// Copyright (C) 2014 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 2 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, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

/**
 * Interface WT_Module_Block - Classes and libraries for module system
 */
interface WT_Module_Block {
	/**
	 * Generate the HTML content of this block.
	 * 
	 * @param integer $block_id
	 *
	 * @return string
	 */
	public function getBlock($block_id);

	/**
	 * Should this block load asynchronously using AJAX?
	 * Simple blocks are faster in-line, more comples ones
	 * can be loaded later.
	 *
	 * @return boolean
	 */
	public function loadAjax();

	/**
	 * Can this block be shown on the user’s home page?
	 *
	 * @return boolean
	 */
	public function isUserBlock();

	/**
	 * Can this block be shown on the tree’s home page?
	 *
	 * @return boolean
	 */
	public function isGedcomBlock();

	/**
	 * An HTML form to edit block settings
	 *
	 * @param integer $block_id
	 *
	 * @return void
	 */
	public function configureBlock($block_id);
}