summaryrefslogtreecommitdiff
path: root/app/Module/TopSurnamesModule.php
diff options
context:
space:
mode:
Diffstat (limited to 'app/Module/TopSurnamesModule.php')
-rw-r--r--app/Module/TopSurnamesModule.php40
1 files changed, 29 insertions, 11 deletions
diff --git a/app/Module/TopSurnamesModule.php b/app/Module/TopSurnamesModule.php
index 85e0423737..7d64759e25 100644
--- a/app/Module/TopSurnamesModule.php
+++ b/app/Module/TopSurnamesModule.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\Filter;
use Fisharebest\Webtrees\Functions\FunctionsDb;
@@ -28,17 +28,33 @@ use Fisharebest\Webtrees\Theme;
* Class TopSurnamesModule
*/
class TopSurnamesModule extends AbstractModule implements ModuleBlockInterface {
- /** {@inheritdoc} */
+ /**
+ * How should this module be labelled on tabs, menus, etc.?
+ *
+ * @return string
+ */
public function getTitle() {
return /* I18N: Name of a module. Top=Most common */ I18N::translate('Top surnames');
}
- /** {@inheritdoc} */
+ /**
+ * A sentence describing what this module does.
+ *
+ * @return string
+ */
public function getDescription() {
return /* I18N: Description of the “Top surnames” module */ I18N::translate('A list of the most popular surnames.');
}
- /** {@inheritdoc} */
+ /**
+ * 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 = null) {
global $WT_TREE, $ctype;
@@ -49,11 +65,9 @@ class TopSurnamesModule extends AbstractModule implements ModuleBlockInterface {
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', 'table');
$block = $this->getBlockSetting($block_id, 'block', '0');
- if ($cfg) {
- foreach (array('num', 'infoStyle', 'block') as $name) {
- if (array_key_exists($name, $cfg)) {
- $$name = $cfg[$name];
- }
+ foreach (array('num', 'infoStyle', 'block') as $name) {
+ if (array_key_exists($name, $cfg)) {
+ $$name = $cfg[$name];
}
}
@@ -142,7 +156,11 @@ class TopSurnamesModule extends AbstractModule implements ModuleBlockInterface {
return true;
}
- /** {@inheritdoc} */
+ /**
+ * An HTML form to edit block settings
+ *
+ * @param int $block_id
+ */
public function configureBlock($block_id) {
if (Filter::postBool('save') && Filter::checkCsrf()) {
$this->setBlockSetting($block_id, 'num', Filter::postInteger('num', 1, 10000, 10));