diff options
Diffstat (limited to 'app/Module/BatchUpdateModule.php')
| -rw-r--r-- | app/Module/BatchUpdateModule.php | 30 |
1 files changed, 24 insertions, 6 deletions
diff --git a/app/Module/BatchUpdateModule.php b/app/Module/BatchUpdateModule.php index 81dc4913d9..e53468cf62 100644 --- a/app/Module/BatchUpdateModule.php +++ b/app/Module/BatchUpdateModule.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\Controller\PageController; use Fisharebest\Webtrees\Database; @@ -68,17 +68,30 @@ class BatchUpdateModule extends AbstractModule implements ModuleConfigInterface /** @var GedcomRecord The record corresponding to $curr_xref */ private $record; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function getTitle() { return /* I18N: Name of a module */ I18N::translate('Batch update'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function getDescription() { return /* I18N: Description of the “Batch update” module */ I18N::translate('Apply automatic corrections to your genealogy data.'); } - /** {@inheritdoc} */ + /** + * This is a general purpose hook, allowing modules to respond to routes + * of the form module.php?mod=FOO&mod_action=BAR + * + * @param string $mod_action + */ public function modAction($mod_action) { switch ($mod_action) { case 'admin_batch_update': @@ -399,7 +412,12 @@ class BatchUpdateModule extends AbstractModule implements ModuleConfigInterface } } - /** {@inheritdoc} */ + /** + * The URL to a page where the user can modify the configuration of this module. + * These links are displayed in the admin page menu. + * + * @return string + */ public function getConfigLink() { return 'module.php?mod=' . $this->getName() . '&mod_action=admin_batch_update'; } |