.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\FunctionsEdit;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\GedcomTag;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Theme;
use Fisharebest\Webtrees\Tree;
use Rhumsaa\Uuid\Uuid;
/**
* Class RecentChangesModule
*/
class RecentChangesModule extends AbstractModule implements ModuleBlockInterface {
const DEFAULT_BLOCK = '1';
const DEFAULT_DAYS = 7;
const DEFAULT_HIDE_EMPTY = '0';
const DEFAULT_SHOW_USER = '1';
const DEFAULT_SORT_STYLE = 'date_desc';
const DEFAULT_INFO_STYLE = 'table';
const MAX_DAYS = 90;
/** {@inheritdoc} */
public function getTitle() {
return /* I18N: Name of a module */ I18N::translate('Recent changes');
}
/** {@inheritdoc} */
public function getDescription() {
return /* I18N: Description of the “Recent changes” module */ I18N::translate('A list of records that have been updated recently.');
}
/** {@inheritdoc} */
public function getBlock($block_id, $template = true, $cfg = array()) {
global $ctype, $WT_TREE;
$days = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE);
$sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE);
$show_user = $this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER);
$block = $this->getBlockSetting($block_id, 'block', self::DEFAULT_BLOCK);
$hide_empty = $this->getBlockSetting($block_id, 'hide_empty', self::DEFAULT_HIDE_EMPTY);
foreach (array('days', 'infoStyle', 'sortStyle', 'hide_empty', 'show_user', 'block') as $name) {
if (array_key_exists($name, $cfg)) {
$$name = $cfg[$name];
}
}
$records = $this->getRecentChanges($WT_TREE, WT_CLIENT_JD - $days);
if (empty($records) && $hide_empty) {
return '';
}
// Print block header
$id = $this->getName() . $block_id;
$class = $this->getName() . '_block';
if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) {
$title = '';
echo I18N::translate('Number of days to show');
echo ' ';
echo '', I18N::plural('maximum %s day', 'maximum %s days', I18N::number(self::MAX_DAYS), I18N::number(self::MAX_DAYS)), ' ';
echo ' ';
echo I18N::translate('Presentation style');
echo ' ';
echo FunctionsEdit::selectEditControl('infoStyle', array('list' => I18N::translate('list'), 'table' => I18N::translate('table')), null, $infoStyle, '');
echo ' ';
echo I18N::translate('Sort order');
echo ' ';
echo FunctionsEdit::selectEditControl('sortStyle', array(
'name' => /* I18N: An option in a list-box */ I18N::translate('sort by name'),
'date_asc' => /* I18N: An option in a list-box */ I18N::translate('sort by date, oldest first'),
'date_desc' => /* I18N: An option in a list-box */ I18N::translate('sort by date, newest first'),
), null, $sortStyle, '');
echo ' ';
echo /* I18N: label for a yes/no option */ I18N::translate('Show the user who made the change');
echo ' ';
echo FunctionsEdit::editFieldYesNo('show_user', $show_user);
echo ' ';
echo /* I18N: label for a yes/no option */ I18N::translate('Add a scrollbar when block contents grow');
echo ' ';
echo FunctionsEdit::editFieldYesNo('block', $block);
echo ' ';
echo I18N::translate('Should this block be hidden when it is empty');
echo ' ';
echo FunctionsEdit::editFieldYesNo('hide_empty', $hide_empty);
echo ' ';
echo '', I18N::translate('If you hide an empty block, you will not be able to change its configuration until it becomes visible by no longer being empty.'), ' ';
echo ' ' . $record->getFullName() . ' ';
$html .= '';
if ($record instanceof Individual) {
if ($record->getAddName()) {
$html .= '
' . $record->getAddName() . ' ';
}
}
// The timestamp may be missing or private.
$timestamp = $record->lastChangeTimestamp();
if ($timestamp !== '') {
if ($show_user) {
$html .= /* I18N: [a record was] Changed on
by */
I18N::translate('Changed on %1$s by %2$s', $timestamp, Filter::escapeHtml($record->lastChangeUser()));
} else {
$html .= /* I18N: [a record was] Changed on */
I18N::translate('Changed on %1$s', $timestamp);
}
}
$html .= ' ';
$html .= '';
$html .= '' . I18N::translate('Record') . ' ';
$html .= 'SORTNAME ';
$html .= '' . GedcomTag::getLabel('CHAN') . ' ';
$html .= 'DATE ';
if ($show_user) {
$html .= '' . GedcomTag::getLabel('_WT_USER') . ' ';
}
$html .= ' ';
foreach ($records as $record) {
$html .= '';
switch ($record::RECORD_TYPE) {
case 'INDI':
$icon = $record->getSexImage('small');
break;
case 'FAM':
$icon = '' . $icon . ' ';
$html .= ' ';
$name = $record->getFullName();
$html .= '';
$html .= '' . $name . ' ';
if ($record instanceof Individual) {
$addname = $record->getAddName();
if ($addname) {
$html .= '';
}
}
$html .= ' ';
$html .= '' . $record->getSortName() . ' ';
$html .= '' . $record->lastChangeTimestamp() . ' ';
$html .= '' . $record->lastChangeTimestamp(true) . ' ';
if ($show_user) {
$html .= '' . Filter::escapeHtml($record->lastChangeUser()) . ' ';
}
$html .= '
';
return $html;
}
/**
* Sort the records by (1) last change date and (2) name
*
* @param GedcomRecord $a
* @param GedcomRecord $b
*
* @return int
*/
private static function sortByChangeDateAndName(GedcomRecord $a, GedcomRecord $b) {
return $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true) ?: GedcomRecord::compare($a, $b);
}
/**
* Sort the records by (1) name and (2) last change date
*
* @param GedcomRecord $a
* @param GedcomRecord $b
*
* @return int
*/
private static function sortByNameAndChangeDate(GedcomRecord $a, GedcomRecord $b) {
return GedcomRecord::compare($a, $b) ?: $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true);
}
}