.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Controller\PageController;
use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\FunctionsEdit;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Tree;
/**
* Class FrequentlyAskedQuestionsModule
*/
class FrequentlyAskedQuestionsModule extends AbstractModule implements ModuleMenuInterface, ModuleConfigInterface {
/** {@inheritdoc} */
public function getTitle() {
return /* I18N: Name of a module. Abbreviation for “Frequently Asked Questions” */ I18N::translate('FAQ');
}
/** {@inheritdoc} */
public function getDescription() {
return /* I18N: Description of the “FAQ” module */ I18N::translate('A list of frequently asked questions and answers.');
}
/**
* 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_config':
$this->config();
break;
case 'admin_delete':
if (Auth::isAdmin()) {
$this->delete();
}
header('Location: ' . WT_BASE_URL . 'module.php?mod=faq&mod_action=admin_config');
break;
case 'admin_edit':
$this->edit();
break;
case 'admin_edit_save':
if (Auth::isAdmin()) {
$this->editSave();
}
header('Location: ' . WT_BASE_URL . 'module.php?mod=faq&mod_action=admin_config');
break;
case 'admin_movedown':
if (Auth::isAdmin()) {
$this->movedown();
}
header('Location: ' . WT_BASE_URL . 'module.php?mod=faq&mod_action=admin_config');
break;
case 'admin_moveup':
if (Auth::isAdmin()) {
$this->moveup();
}
header('Location: ' . WT_BASE_URL . 'module.php?mod=faq&mod_action=admin_config');
break;
case 'show':
$this->show();
break;
default:
http_response_code(404);
}
}
/** {@inheritdoc} */
public function getConfigLink() {
return 'module.php?mod=' . $this->getName() . '&mod_action=admin_config';
}
/**
* Action from the configuration page
*/
private function editSave() {
if (Filter::checkCsrf()) {
$block_id = Filter::postInteger('block_id');
if ($block_id) {
Database::prepare(
"UPDATE `##block` SET gedcom_id = NULLIF(:tree_id, '0'), block_order = :block_order WHERE block_id = :block_id"
)->execute(array(
'tree_id' => Filter::postInteger('gedcom_id'),
'block_order' => Filter::postInteger('block_order'),
'block_id' => $block_id,
));
} else {
Database::prepare(
"INSERT INTO `##block` (gedcom_id, module_name, block_order) VALUES (NULLIF(:tree_id, '0'), :module_name, :block_order)"
)->execute(array(
'tree_id' => Filter::postInteger('gedcom_id'),
'module_name' => $this->getName(),
'block_order' => Filter::postInteger('block_order'),
));
$block_id = Database::getInstance()->lastInsertId();
}
$this->setBlockSetting($block_id, 'header', Filter::post('header'));
$this->setBlockSetting($block_id, 'faqbody', Filter::post('faqbody'));
$languages = Filter::postArray('lang');
$this->setBlockSetting($block_id, 'languages', implode(',', $languages));
}
}
/**
* Action from the configuration page
*/
private function edit() {
global $WT_TREE;
$controller = new PageController;
$controller->restrictAccess(Auth::isAdmin());
$block_id = Filter::getInteger('block_id');
if ($block_id) {
$controller->setPageTitle(I18N::translate('Edit the FAQ item'));
$header = $this->getBlockSetting($block_id, 'header');
$faqbody = $this->getBlockSetting($block_id, 'faqbody');
$block_order = Database::prepare(
"SELECT block_order FROM `##block` WHERE block_id = :block_id"
)->execute(array('block_id' => $block_id))->fetchOne();
$gedcom_id = Database::prepare(
"SELECT gedcom_id FROM `##block` WHERE block_id = :block_id"
)->execute(array('block_id' => $block_id))->fetchOne();
} else {
$controller->setPageTitle(I18N::translate('Add an FAQ item'));
$header = '';
$faqbody = '';
$block_order = Database::prepare(
"SELECT IFNULL(MAX(block_order)+1, 0) FROM `##block` WHERE module_name = :module_name"
)->execute(array('module_name' => $this->getName()))->fetchOne();
$gedcom_id = $WT_TREE->getTreeId();
}
$controller->pageHeader();
if (Module::getModuleByName('ckeditor')) {
CkeditorModule::enableEditor($controller);
}
?>
getPageTitle(); ?>
getPageTitle(); ?>
execute(array('block_id' => $block_id));
Database::prepare(
"DELETE FROM `##block` WHERE block_id = :block_id"
)->execute(array('block_id' => $block_id));
}
/**
* Respond to a request to move a FAQ up the list.
*/
private function moveup() {
$block_id = Filter::getInteger('block_id');
$block_order = Database::prepare(
"SELECT block_order FROM `##block` WHERE block_id = :block_id"
)->execute(array('block_id' => $block_id))->fetchOne();
$swap_block = Database::prepare(
"SELECT block_order, block_id" .
" FROM `##block`" .
" WHERE block_order = (" .
" SELECT MAX(block_order) FROM `##block` WHERE block_order < :block_order AND module_name = :module_name_1" .
" ) AND module_name = :module_name_2" .
" LIMIT 1"
)->execute(array(
'block_order' => $block_order,
'module_name_1' => $this->getName(),
'module_name_2' => $this->getName(),
))->fetchOneRow();
if ($swap_block) {
Database::prepare(
"UPDATE `##block` SET block_order = :block_order WHERE block_id = :block_id"
)->execute(array(
'block_order' => $swap_block->block_order,
'block_id' => $block_id,
));
Database::prepare(
"UPDATE `##block` SET block_order = :block_order WHERE block_id = :block_id"
)->execute(array(
'block_order' => $block_order,
'block_id' => $swap_block->block_id,
));
}
}
/**
* Respond to a request to move a FAQ down the list.
*/
private function movedown() {
$block_id = Filter::get('block_id');
$block_order = Database::prepare(
"SELECT block_order FROM `##block` WHERE block_id = :block_id"
)->execute(array(
'block_id' => $block_id,
))->fetchOne();
$swap_block = Database::prepare(
"SELECT block_order, block_id" .
" FROM `##block`" .
" WHERE block_order=(" .
" SELECT MIN(block_order) FROM `##block` WHERE block_order > :block_order AND module_name = :module_name_1" .
" ) AND module_name = :module_name_2" .
" LIMIT 1"
)->execute(array(
'block_order' => $block_order,
'module_name_1' => $this->getName(),
'module_name_2' => $this->getName(),
))->fetchOneRow();
if ($swap_block) {
Database::prepare(
"UPDATE `##block` SET block_order = :block_order WHERE block_id = :block_id"
)->execute(array(
'block_order' => $swap_block->block_order,
'block_id' => $block_id,
));
Database::prepare(
"UPDATE `##block` SET block_order = :block_order WHERE block_id = :block_id"
)->execute(array(
'block_order' => $block_order,
'block_id' => $swap_block->block_id,
));
}
}
/**
* Show a list of FAQs
*/
private function show() {
global $controller, $WT_TREE;
$controller = new PageController;
$controller
->setPageTitle(I18N::translate('Frequently asked questions'))
->pageHeader();
$faqs = Database::prepare(
"SELECT block_id, bs1.setting_value AS header, bs2.setting_value AS body, bs3.setting_value AS languages" .
" FROM `##block` b" .
" JOIN `##block_setting` bs1 USING (block_id)" .
" JOIN `##block_setting` bs2 USING (block_id)" .
" JOIN `##block_setting` bs3 USING (block_id)" .
" WHERE module_name = :module_name" .
" AND bs1.setting_name = 'header'" .
" AND bs2.setting_name = 'faqbody'" .
" AND bs3.setting_name = 'languages'" .
" AND IFNULL(gedcom_id, :tree_id_1) = :tree_id_2" .
" ORDER BY block_order"
)->execute(array(
'module_name' => $this->getName(),
'tree_id_1' => $WT_TREE->getTreeId(),
'tree_id_2' => $WT_TREE->getTreeId(),
))->fetchAll();
// Define your colors for the alternating rows
echo '', I18N::translate('Frequently asked questions'), ' ';
// Instructions
echo '', I18N::translate('Click on a title to go straight to it, or scroll down to read them all.');
if (Auth::isManager($WT_TREE)) {
echo '
';
}
echo '
';
$row_count = 0;
echo '';
// List of titles
foreach ($faqs as $id => $faq) {
if (!$faq->languages || in_array(WT_LOCALE, explode(',', $faq->languages))) {
$row_color = ($row_count % 2) ? 'odd' : 'even';
// NOTE: Print the header of the current item
echo '';
echo '', $faq->header, ' ';
echo ' ';
$row_count++;
}
}
echo '
';
// Detailed entries
foreach ($faqs as $id => $faq) {
if (!$faq->languages || in_array(WT_LOCALE, explode(',', $faq->languages))) {
echo '', $faq->header;
echo '
';
echo '
';
echo '', substr($faq->body, 0, 1) == '<' ? $faq->body : nl2br($faq->body, false), '
';
echo ' ';
}
}
}
/**
* Provide a form to manage the FAQs.
*/
private function config() {
global $WT_TREE;
$controller = new PageController;
$controller
->restrictAccess(Auth::isAdmin())
->setPageTitle(I18N::translate('Frequently asked questions'))
->pageHeader();
$faqs = Database::prepare(
"SELECT block_id, block_order, gedcom_id, bs1.setting_value AS header, bs2.setting_value AS faqbody" .
" FROM `##block` b" .
" JOIN `##block_setting` bs1 USING (block_id)" .
" JOIN `##block_setting` bs2 USING (block_id)" .
" WHERE module_name = :module_name" .
" AND bs1.setting_name = 'header'" .
" AND bs2.setting_name = 'faqbody'" .
" AND IFNULL(gedcom_id, :tree_id_1) = :tree_id_2" .
" ORDER BY block_order"
)->execute(array(
'module_name' => $this->getName(),
'tree_id_1' => $WT_TREE->getTreeId(),
'tree_id_2' => $WT_TREE->getTreeId(),
))->fetchAll();
$min_block_order = Database::prepare(
"SELECT MIN(block_order) FROM `##block` WHERE module_name = 'faq' AND (gedcom_id = :tree_id OR gedcom_id IS NULL)"
)->execute(array(
'tree_id' => $WT_TREE->getTreeId(),
))->fetchOne();
$max_block_order = Database::prepare(
"SELECT MAX(block_order) FROM `##block` WHERE module_name = 'faq' AND (gedcom_id = :tree_id OR gedcom_id IS NULL)"
)->execute(array(
'tree_id' => $WT_TREE->getTreeId(),
))->fetchOne();
?>
getPageTitle(); ?>
getPageTitle(); ?>
getName(), 'class="form-control"'); ?>
';
if (empty($faqs)) {
echo '', I18N::translate('The FAQ list is empty.'), ' ';
} else {
foreach ($faqs as $faq) {
// NOTE: Print the position of the current item
echo '';
echo I18N::translate('#%s', $faq->block_order + 1), ' ';
if ($faq->gedcom_id === null) {
echo I18N::translate('All');
} else {
echo $WT_TREE->getTitleHtml();
}
echo ' ';
// NOTE: Print the edit options of the current item
echo '';
if ($faq->block_order == $min_block_order) {
echo ' ';
} else {
echo ' ', I18N::translate('Move up'), ' ';
}
echo ' ';
if ($faq->block_order == $max_block_order) {
echo ' ';
} else {
echo ' ', I18N::translate('Move down'), ' ';
}
echo ' ';
echo ' ', I18N::translate('Edit'), ' ';
echo ' ';
echo ' ', I18N::translate('Delete'), ' ';
echo ' ';
// NOTE: Print the title text of the current item
echo '';
echo '';
echo '
', $faq->header, '
';
// NOTE: Print the body text of the current item
echo '
', substr($faq->faqbody, 0, 1) == '<' ? $faq->faqbody : nl2br($faq->faqbody, false), '
';
}
echo '';
}
}
/**
* The user can re-order menus. Until they do, they are shown in this order.
*
* @return int
*/
public function defaultMenuOrder() {
return 40;
}
/**
* A menu, to be added to the main application menu.
*
* @return Menu|null
*/
public function getMenu() {
global $WT_TREE;
$faqs = Database::prepare(
"SELECT block_id FROM `##block`" .
" JOIN `##block_setting` USING (block_id)" .
" WHERE module_name = :module_name AND IFNULL(gedcom_id, :tree_id_1) = :tree_id_2" .
" AND setting_name='languages' AND (setting_value LIKE CONCAT('%', :locale, '%') OR setting_value='')"
)->execute(array(
'module_name' => $this->getName(),
'tree_id_1' => $WT_TREE->getTreeId(),
'tree_id_2' => $WT_TREE->getTreeId(),
'locale' => WT_LOCALE,
))->fetchAll();
if ($faqs) {
return new Menu(I18N::translate('FAQ'), 'module.php?mod=faq&mod_action=show', 'menu-help');
} else {
return null;
}
}
}