. */ namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\Database; use Fisharebest\Webtrees\Filter; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Tree; /** * Class ResearchTaskModule */ class ResearchTaskModule extends AbstractModule implements ModuleBlockInterface { const DEFAULT_SHOW_OTHER = '1'; const DEFAULT_SHOW_UNASSIGNED = '1'; const DEFAULT_SHOW_FUTURE = '1'; const DEFAULT_BLOCK = '1'; /** {@inheritdoc} */ public function getTitle() { /* I18N: Name of a module. Tasks that need further research. */ return I18N::translate('Research tasks'); } /** {@inheritdoc} */ public function getDescription() { /* I18N: Description of “Research tasks” module */ return I18N::translate('A list of tasks and activities that are linked to the family tree.'); } /** * Generate the HTML content of this block. * * @param Tree $tree * @param int $block_id * @param bool $template * @param string[] $cfg * * @return string */ public function getBlock(Tree $tree, int $block_id, bool $template = true, array $cfg = []): string { global $ctype; $show_other = $this->getBlockSetting($block_id, 'show_other', self::DEFAULT_SHOW_OTHER); $show_unassigned = $this->getBlockSetting($block_id, 'show_unassigned', self::DEFAULT_SHOW_UNASSIGNED); $show_future = $this->getBlockSetting($block_id, 'show_future', self::DEFAULT_SHOW_FUTURE); extract($cfg, EXTR_OVERWRITE); $end_jd = $show_future ? 99999999 : WT_CLIENT_JD; $xrefs = Database::prepare( "SELECT DISTINCT d_gid FROM `##dates`" . " WHERE d_file = :tree_id AND d_fact = '_TODO' AND d_julianday1 < :jd" )->execute([ 'tree_id' => $tree->getTreeId(), 'jd' => $end_jd, ])->fetchOneColumn(); $records = array_map(function ($xref) use ($tree) { return GedcomRecord::getInstance($xref, $tree); }, $xrefs); $tasks = []; foreach ($records as $record) { foreach ($record->getFacts('_TODO') as $task) { $user_name = $task->getAttribute('_WT_USER'); if ($user_name === Auth::user()->getUserName() || empty($user_name) && $show_unassigned || !empty($user_name) && $show_other) { $tasks[] = $task; } } } if (empty($records)) { $content = '

' . I18N::translate('There are no research tasks in this family tree.') . '

'; } else { $content = view('modules/todo/research-tasks', ['tasks' => $tasks]); } if ($template) { if ($ctype === 'gedcom' && Auth::isManager($tree)) { $config_url = route('tree-page-block-edit', [ 'block_id' => $block_id, 'ged' => $tree->getName(), ]); } elseif ($ctype === 'user' && Auth::check()) { $config_url = route('user-page-block-edit', [ 'block_id' => $block_id, 'ged' => $tree->getName(), ]); } else { $config_url = ''; } return view('modules/block-template', [ 'block' => str_replace('_', '-', $this->getName()), 'id' => $block_id, 'config_url' => $config_url, 'title' => $this->getTitle(), 'content' => $content, ]); } else { return $content; } } /** {@inheritdoc} */ public function loadAjax(): bool { return false; } /** {@inheritdoc} */ public function isUserBlock(): bool { return true; } /** {@inheritdoc} */ public function isGedcomBlock(): bool { return true; } /** * An HTML form to edit block settings * * @param Tree $tree * @param int $block_id * * @return void */ public function configureBlock(Tree $tree, int $block_id) { if ($_SERVER['REQUEST_METHOD'] === 'POST') { $this->setBlockSetting($block_id, 'show_other', Filter::postBool('show_other')); $this->setBlockSetting($block_id, 'show_unassigned', Filter::postBool('show_unassigned')); $this->setBlockSetting($block_id, 'show_future', Filter::postBool('show_future')); return; } $show_other = $this->getBlockSetting($block_id, 'show_other', self::DEFAULT_SHOW_OTHER); $show_unassigned = $this->getBlockSetting($block_id, 'show_unassigned', self::DEFAULT_SHOW_UNASSIGNED); $show_future = $this->getBlockSetting($block_id, 'show_future', self::DEFAULT_SHOW_FUTURE); echo view('modules/todo/config', [ 'show_future' => $show_future, 'show_other' => $show_other, 'show_unassigned' => $show_unassigned, ]); } }