summaryrefslogtreecommitdiff
path: root/app/Module/UserJournalModule.php
diff options
context:
space:
mode:
Diffstat (limited to 'app/Module/UserJournalModule.php')
-rw-r--r--app/Module/UserJournalModule.php48
1 files changed, 35 insertions, 13 deletions
diff --git a/app/Module/UserJournalModule.php b/app/Module/UserJournalModule.php
index 026d5e3730..537afecebd 100644
--- a/app/Module/UserJournalModule.php
+++ b/app/Module/UserJournalModule.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\Database;
use Fisharebest\Webtrees\Filter;
@@ -26,7 +26,11 @@ use Fisharebest\Webtrees\Theme;
* Class UserJournalModule
*/
class UserJournalModule extends AbstractModule implements ModuleBlockInterface {
- /** {@inheritdoc} */
+ /**
+ * Create a new module.
+ *
+ * @param string $directory Where is this module installed
+ */
public function __construct($directory) {
parent::__construct($directory);
@@ -34,18 +38,34 @@ class UserJournalModule extends AbstractModule implements ModuleBlockInterface {
Database::updateSchema('\Fisharebest\Webtrees\Module\FamilyTreeNews\Schema', 'NB_SCHEMA_VERSION', 3);
}
- /** {@inheritdoc} */
+ /**
+ * How should this module be labelled on tabs, menus, etc.?
+ *
+ * @return string
+ */
public function getTitle() {
return /* I18N: Name of a module */ I18N::translate('Journal');
}
- /** {@inheritdoc} */
+ /**
+ * A sentence describing what this module does.
+ *
+ * @return string
+ */
public function getDescription() {
return /* I18N: Description of the “Journal” module */ I18N::translate('A private area to record notes or keep a journal.');
}
- /** {@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 $ctype;
switch (Filter::get('action')) {
@@ -57,11 +77,9 @@ class UserJournalModule extends AbstractModule implements ModuleBlockInterface {
break;
}
$block = $this->getBlockSetting($block_id, 'block', '1');
- if ($cfg) {
- foreach (array('block') as $name) {
- if (array_key_exists($name, $cfg)) {
- $$name = $cfg[$name];
- }
+ foreach (array('block') as $name) {
+ if (array_key_exists($name, $cfg)) {
+ $$name = $cfg[$name];
}
}
$usernews = Database::prepare(
@@ -117,7 +135,11 @@ class UserJournalModule extends AbstractModule implements ModuleBlockInterface {
return false;
}
- /** {@inheritdoc} */
+ /**
+ * An HTML form to edit block settings
+ *
+ * @param int $block_id
+ */
public function configureBlock($block_id) {
}
}