From 8c2e82270a639a3acf607b432e54721116dae723 Mon Sep 17 00:00:00 2001 From: Greg Roach Date: Mon, 2 Mar 2015 08:02:00 +0000 Subject: Module API --- app/Module/YahrzeitModule.php | 274 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 274 insertions(+) create mode 100644 app/Module/YahrzeitModule.php (limited to 'app/Module/YahrzeitModule.php') diff --git a/app/Module/YahrzeitModule.php b/app/Module/YahrzeitModule.php new file mode 100644 index 0000000000..5039a1e3f7 --- /dev/null +++ b/app/Module/YahrzeitModule.php @@ -0,0 +1,274 @@ +. + */ + +use Fisharebest\ExtCalendar\JewishCalendar; +use Rhumsaa\Uuid\Uuid; + +/** + * Class YahrzeitModule + */ +class YahrzeitModule extends Module implements ModuleBlockInterface { + /** {@inheritdoc} */ + public function getTitle() { + return /* I18N: Name of a module. Yahrzeiten (the plural of Yahrzeit) are special anniversaries of deaths in the Hebrew faith/calendar. */ I18N::translate('Yahrzeiten'); + } + + /** {@inheritdoc} */ + public function getDescription() { + return /* I18N: Description of the “Yahrzeiten” module. A “Hebrew death” is a death where the date is recorded in the Hebrew calendar. */ I18N::translate('A list of the Hebrew death anniversaries that will occur in the near future.'); + } + + /** {@inheritdoc} */ + public function getBlock($block_id, $template = true, $cfg = null) { + global $ctype, $controller; + + $days = get_block_setting($block_id, 'days', '7'); + $infoStyle = get_block_setting($block_id, 'infoStyle', 'table'); + $calendar = get_block_setting($block_id, 'calendar', 'jewish'); + $block = get_block_setting($block_id, 'block', '1'); + + if ($cfg) { + foreach (array('days', 'infoStyle', 'block') as $name) { + if (array_key_exists($name, $cfg)) { + $$name = $cfg[$name]; + } + } + } + + $startjd = WT_CLIENT_JD; + $endjd = WT_CLIENT_JD + $days - 1; + + $id = $this->getName() . $block_id; + $class = $this->getName() . '_block'; + if ($ctype === 'gedcom' && WT_USER_GEDCOM_ADMIN || $ctype === 'user' && Auth::check()) { + $title = ''; + } else { + $title = ''; + } + $title .= $this->getTitle(); + + $content = ''; + // The standard anniversary rules cover most of the Yahrzeit rules, we just + // need to handle a few special cases. + // Fetch normal anniversaries... + $yahrzeits = array(); + for ($jd = $startjd - 1; $jd <= $endjd + $days; ++$jd) { + foreach (get_anniversary_events($jd, 'DEAT _YART') as $fact) { + // Exact hebrew dates only + $date = $fact->getDate(); + if ($date->minimumDate() instanceof JewishDate && $date->minimumJulianDay() === $date->maximumJulianDay()) { + $fact->jd = $jd; + $yahrzeits[] = $fact; + } + } + } + + // ...then adjust dates + $jewish_calendar = new JewishCalendar; + + foreach ($yahrzeits as $yahrzeit) { + if ($yahrzeit->getTag() === 'DEAT') { + $today = new JewishDate($yahrzeit->jd); + $hd = $yahrzeit->getDate()->MinDate(); + $hd1 = new JewishDate($hd); + $hd1->y += 1; + $hd1->setJdFromYmd(); + // Special rules. See http://www.hebcal.com/help/anniv.html + // Everything else is taken care of by our standard anniversary rules. + if ($hd->d == 30 && $hd->m == 2 && $hd->y != 0 && $hd1->daysInMonth() < 30) { + // 30 CSH - Last day in CSH + $yahrzeit->jd = $jewish_calendar->ymdToJd($today->y, 3, 1) - 1; + } elseif ($hd->d == 30 && $hd->m == 3 && $hd->y != 0 && $hd1->daysInMonth() < 30) { + // 30 KSL - Last day in KSL + $yahrzeit->jd = $jewish_calendar->ymdToJd($today->y, 4, 1) - 1; + } elseif ($hd->d == 30 && $hd->m == 6 && $hd->y != 0 && $today->daysInMonth() < 30 && !$today->isLeapYear()) { + // 30 ADR - Last day in SHV + $yahrzeit->jd = $jewish_calendar->ymdToJd($today->y, 6, 1) - 1; + } + } + } + + switch ($infoStyle) { + case 'list': + foreach ($yahrzeits as $yahrzeit) { + if ($yahrzeit->jd >= $startjd && $yahrzeit->jd < $startjd + $days) { + $ind = $yahrzeit->getParent(); + $content .= "getHtmlUrl() . "\" class=\"list_item name2\">" . $ind->getFullName() . "" . $ind->getSexImage(); + $content .= "
"; + $content .= $yahrzeit->getDate()->display(true); + $content .= ', ' . I18N::translate('%s year anniversary', $yahrzeit->anniv); + $content .= "
"; + } + } + break; + case 'table': + default: + $table_id = Uuid::uuid4(); // table requires a unique ID + $controller + ->addExternalJavascript(WT_JQUERY_DATATABLES_JS_URL) + ->addInlineJavascript(' + jQuery("#'.$table_id . '").dataTable({ + dom: \'t\', + ' . I18N::datatablesI18N() . ', + autoWidth: false, + paginate: false, + lengthChange: false, + filter: false, + info: true, + jQueryUI: true, + sorting: [[5,"asc"]], + columns: [ + /* 0-name */ { dataSort: 1 }, + /* 1-NAME */ { visible: false }, + /* 2-date */ { dataSort: 3 }, + /* 3-DATE */ { visible: false }, + /* 4-Aniv */ { class: "center"}, + /* 5-yart */ { dataSort: 6 }, + /* 6-YART */ { visible: false } + ] + }); + jQuery("#'.$table_id . '").css("visibility", "visible"); + jQuery(".loading-image").css("display", "none"); + '); + $content = ''; + $content .= '
 
'; + $content .= ''; + $content .= ''; + $content .= ''; + $content .= ''; + $content .= ''; + $content .= ''; + $content .= ''; + $content .= ''; + $content .= ''; + $content .= ''; + + foreach ($yahrzeits as $yahrzeit) { + if ($yahrzeit->jd >= $startjd && $yahrzeit->jd < $startjd + $days) { + $content .= ''; + $ind = $yahrzeit->getParent(); + // Individual name(s) + $name = $ind->getFullName(); + $url = $ind->getHtmlUrl(); + $content .= ''; + $content .= ''; + + // death/yahrzeit event date + $content .= ''; + $content .= ''; // sortable date + + // Anniversary + $content .= ''; + + // upcomming yahrzeit dates + switch ($calendar) { + case 'gregorian': + $today = new GregorianDate($yahrzeit->jd); + break; + case 'jewish': + default: + $today = new JewishDate($yahrzeit->jd); + break; + } + $td = new Date($today->format('%@ %A %O %E')); + $content .= ''; + $content .= ''; // sortable date + + $content .= ''; + } + } + $content .= ''; + + break; + } + + if ($template) { + if ($block) { + $class .= ' small_inner_block'; + } + return Theme::theme()->formatBlock($id, $title, $class, $content); + } else { + return $content; + } + } + + /** {@inheritdoc} */ + public function loadAjax() { + return true; + } + + /** {@inheritdoc} */ + public function isUserBlock() { + return true; + } + + /** {@inheritdoc} */ + public function isGedcomBlock() { + return true; + } + + /** {@inheritdoc} */ + public function configureBlock($block_id) { + if (Filter::postBool('save') && Filter::checkCsrf()) { + set_block_setting($block_id, 'days', Filter::postInteger('days', 1, 30, 7)); + set_block_setting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table', 'table')); + set_block_setting($block_id, 'calendar', Filter::post('calendar', 'jewish|gregorian', 'jewish')); + set_block_setting($block_id, 'block', Filter::postBool('block')); + } + + $days = get_block_setting($block_id, 'days', '7'); + $infoStyle = get_block_setting($block_id, 'infoStyle', 'table'); + $calendar = get_block_setting($block_id, 'calendar', 'jewish'); + $block = get_block_setting($block_id, 'block', '1'); + + echo ''; + echo I18N::translate('Number of days to show'); + echo ''; + echo ''; + echo ' ', I18N::plural('maximum %d day', 'maximum %d days', 30, 30), ''; + echo ''; + + echo ''; + echo I18N::translate('Presentation style'); + echo ''; + echo select_edit_control('infoStyle', array('list'=> I18N::translate('list'), 'table'=> I18N::translate('table')), null, $infoStyle, ''); + echo ''; + + echo ''; + echo I18N::translate('Calendar'); + echo ''; + echo select_edit_control('calendar', array( + 'jewish' => JewishDate::calendarName(), + 'gregorian'=> GregorianDate::calendarName(), + ), null, $calendar, ''); + echo ''; + + echo ''; + echo /* I18N: label for a yes/no option */ I18N::translate('Add a scrollbar when block contents grow'); + echo ''; + echo edit_field_yes_no('block', $block); + echo ''; + } +} -- cgit v1.3