diff options
| author | Greg Roach <fisharebest@gmail.com> | 2015-06-08 15:09:08 +0100 |
|---|---|---|
| committer | Greg Roach <fisharebest@gmail.com> | 2015-06-08 21:42:34 +0100 |
| commit | 76692c8b291f16d9251d67f27078779f6737fe7e (patch) | |
| tree | d92ba170d781d60d4fcff107d5a46bad5bdbce4f /app/Module/WelcomeBlockModule.php | |
| parent | 238d6f46440eb68ffb982a7af1ec9dd37c8e75d7 (diff) | |
| download | webtrees-76692c8b291f16d9251d67f27078779f6737fe7e.tar.gz webtrees-76692c8b291f16d9251d67f27078779f6737fe7e.tar.bz2 webtrees-76692c8b291f16d9251d67f27078779f6737fe7e.zip | |
PHPDoc
Diffstat (limited to 'app/Module/WelcomeBlockModule.php')
| -rw-r--r-- | app/Module/WelcomeBlockModule.php | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/app/Module/WelcomeBlockModule.php b/app/Module/WelcomeBlockModule.php index e3a74b97d8..144293ec65 100644 --- a/app/Module/WelcomeBlockModule.php +++ b/app/Module/WelcomeBlockModule.php @@ -1,6 +1,4 @@ <?php -namespace Fisharebest\Webtrees\Module; - /** * webtrees: online genealogy * Copyright (C) 2015 webtrees development team @@ -15,6 +13,8 @@ namespace Fisharebest\Webtrees\Module; * 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\Auth; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Site; @@ -34,8 +34,16 @@ class WelcomeBlockModule extends AbstractModule implements ModuleBlockInterface return /* I18N: Description of the “Home page” module */ I18N::translate('A greeting message for site visitors.'); } - /** {@inheritdoc} */ - public function getBlock($block_id, $template = true, $cfg = null) { + /** + * Generate the HTML content of this block. + * + * @param int $block_id + * @param bool $template + * @param array $cfg + * + * @return string + */ + public function getBlock($block_id, $template = true, $cfg = array()) { global $controller, $WT_TREE; $indi_xref = $controller->getSignificantIndividual()->getXref(); @@ -73,7 +81,11 @@ class WelcomeBlockModule extends AbstractModule implements ModuleBlockInterface return true; } - /** {@inheritdoc} */ + /** + * An HTML form to edit block settings + * + * @param int $block_id + */ public function configureBlock($block_id) { } } |
