.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\FunctionsDate;
use Fisharebest\Webtrees\Functions\FunctionsEdit;
use Fisharebest\Webtrees\GedcomTag;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Site;
use Fisharebest\Webtrees\Stats;
use Fisharebest\Webtrees\Theme;
use Fisharebest\Webtrees\Tree;
/**
* Class HtmlBlockModule
*/
class HtmlBlockModule extends AbstractModule implements ModuleBlockInterface {
/** {@inheritdoc} */
public function getTitle() {
return /* I18N: Name of a module */ I18N::translate('HTML');
}
/** {@inheritdoc} */
public function getDescription() {
return /* I18N: Description of the “HTML” module */ I18N::translate('Add your own text and graphics.');
}
/**
* Generate the HTML content of this block.
*
* @param int $block_id
* @param bool $template
* @param string[] $cfg
*
* @return string
*/
public function getBlock($block_id, $template = true, $cfg = array()) {
global $ctype, $WT_TREE;
$title = $this->getBlockSetting($block_id, 'title');
$html = $this->getBlockSetting($block_id, 'html');
$gedcom = $this->getBlockSetting($block_id, 'gedcom');
$show_timestamp = $this->getBlockSetting($block_id, 'show_timestamp', '0');
$languages = $this->getBlockSetting($block_id, 'languages');
// Only show this block for certain languages
if ($languages && !in_array(WT_LOCALE, explode(',', $languages))) {
return '';
}
/*
* Select GEDCOM
*/
switch ($gedcom) {
case '__current__':
$stats = new Stats($WT_TREE);
break;
case '__default__':
$tree = Tree::findByName(Site::getPreference('DEFAULT_GEDCOM'));
if ($tree) {
$stats = new Stats($tree);
} else {
$stats = new Stats($WT_TREE);
}
break;
default:
$tree = Tree::findByName($gedcom);
if ($tree) {
$stats = new Stats($tree);
} else {
$stats = new Stats($WT_TREE);
}
break;
}
/*
* Retrieve text, process embedded variables
*/
if (strpos($title, '#') !== false || strpos($html, '#') !== false) {
$title = $stats->embedTags($title);
$html = $stats->embedTags($html);
}
/*
* Start Of Output
*/
$id = $this->getName() . $block_id;
$class = $this->getName() . '_block';
if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) {
$title = '' . $title;
}
$content = $html;
if ($show_timestamp) {
$content .= ' ' . FunctionsDate::formatTimestamp($this->getBlockSetting($block_id, 'timestamp', WT_TIMESTAMP) + WT_TIMESTAMP_OFFSET);
}
if ($template) {
return Theme::theme()->formatBlock($id, $title, $class, $content);
} else {
return $content;
}
}
/** {@inheritdoc} */
public function loadAjax() {
return false;
}
/** {@inheritdoc} */
public function isUserBlock() {
return true;
}
/** {@inheritdoc} */
public function isGedcomBlock() {
return true;
}
/**
* An HTML form to edit block settings
*
* @param int $block_id
*/
public function configureBlock($block_id) {
global $WT_TREE;
if (Filter::postBool('save') && Filter::checkCsrf()) {
$languages = Filter::postArray('lang');
$this->setBlockSetting($block_id, 'gedcom', Filter::post('gedcom'));
$this->setBlockSetting($block_id, 'title', Filter::post('title'));
$this->setBlockSetting($block_id, 'html', Filter::post('html'));
$this->setBlockSetting($block_id, 'show_timestamp', Filter::postBool('show_timestamp'));
$this->setBlockSetting($block_id, 'timestamp', Filter::post('timestamp'));
$this->setBlockSetting($block_id, 'languages', implode(',', $languages));
}
$templates = array(
I18N::translate('Keyword examples') =>
'#getAllTagsTable#',
I18N::translate('Narrative description') =>
/* I18N: do not translate the #keywords# */ I18N::translate('This family tree was last updated on #gedcomUpdated#. There are #totalSurnames# surnames in this family tree. The earliest recorded event is the #firstEventType# of #firstEventName# in #firstEventYear#. The most recent event is the #lastEventType# of #lastEventName# in #lastEventYear#.
If you have any comments or feedback please contact #contactWebmaster#.'),
I18N::translate('Statistics') =>
'
#gedcomTitle#
' . I18N::translate('This family tree was last updated on %s.', '#gedcomUpdated#') . '
';
// The CK editor needs lots of help to load/save data :-(
if (Module::getModuleByName('ckeditor')) {
$ckeditor_onchange = 'CKEDITOR.instances.html.setData(document.block.html.value);';
} else {
$ckeditor_onchange = '';
}
echo '';
if (!$html) {
echo '
', I18N::translate('To assist you in getting started with this block, we have created several standard templates. When you select one of these templates, the text area will contain a copy that you can then alter to suit your site’s requirements.'), '
',
I18N::translate('Content');
if (!$html) {
echo '
', I18N::translate('As well as using the toolbar to apply HTML formatting, you can insert database fields which are updated automatically. These special fields are marked with # characters. For example #totalFamilies# will be replaced with the actual number of families in the database. Advanced users may wish to apply CSS classes to their text, so that the formatting matches the currently selected theme.'), '
';
}
echo
'
',
'
';
echo '';
echo '
';
echo '
';
echo I18N::translate('Show the date and time of update');
echo '