Module API

1 files changed, 1 insertions, 250 deletions

diff --git a/modules_v3/families/module.php b/modules_v3/families/module.php
index c695292efa..eb5caac691 100644
--- a/modules_v3/families/module.php
+++ b/modules_v3/families/module.php
@@ -16,253 +16,4 @@ namespace Fisharebest\Webtrees;
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-use Zend_Session;
-
-/**
- * Class families_WT_Module
- */
-class families_WT_Module extends Module implements ModuleSidebarInterface {
-	/** {@inheritdoc} */
-	public function getTitle() {
-		return /* I18N: Name of a module/sidebar */ I18N::translate('Family list');
-	}
-
-	/** {@inheritdoc} */
-	public function getDescription() {
-		return /* I18N: Description of the “Families” module */ I18N::translate('A sidebar showing an alphabetic list of all the families in the family tree.');
-	}
-
-	/** {@inheritdoc} */
-	public function modAction($modAction) {
-		switch ($modAction) {
-		case 'ajax':
-			Zend_Session::writeClose();
-			header('Content-Type: text/html; charset=UTF-8');
-			echo $this->getSidebarAjaxContent();
-			break;
-		default:
-			http_response_code(404);
-			break;
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function defaultSidebarOrder() {
-		return 50;
-	}
-
-	/** {@inheritdoc} */
-	public function hasSidebarContent() {
-		return !Auth::isSearchEngine();
-	}
-
-	/** {@inheritdoc} */
-	public function getSidebarAjaxContent() {
-		$alpha   = Filter::get('alpha'); // All surnames beginning with this letter where "@"=unknown and ","=none
-		$surname = Filter::get('surname'); // All indis with this surname.
-		$search  = Filter::get('search');
-
-		if ($search) {
-			return $this->search($search);
-		} elseif ($alpha == '@' || $alpha == ',' || $surname) {
-			return $this->getSurnameFams($alpha, $surname);
-		} elseif ($alpha) {
-			return $this->getAlphaSurnames($alpha, $surname);
-		} else {
-			return '';
-		}
-	}
-
-	/** {@inheritdoc} */
-	public function getSidebarContent() {
-		global $UNKNOWN_NN, $controller;
-
-		// Fetch a list of the initial letters of all surnames in the database
-		$initials = WT_Query_Name::surnameAlpha(true, false, WT_GED_ID, false);
-
-		$controller->addInlineJavascript('
-			var famloadedNames = new Array();
-
-			function fsearchQ() {
-				var query = jQuery("#sb_fam_name").val();
-				if (query.length>1) {
-					jQuery("#sb_fam_content").load("module.php?mod=' . $this->getName() . '&mod_action=ajax&sb_action=families&search="+query);
-				}
-			}
-
-			var famtimerid = null;
-			jQuery("#sb_fam_name").keyup(function(e) {
-				if (famtimerid) window.clearTimeout(famtimerid);
-				famtimerid = window.setTimeout("fsearchQ()", 500);
-			});
-			jQuery("#sb_content_families").on("click", ".sb_fam_letter", function() {
-				jQuery("#sb_fam_content").load(this.href);
-				return false;
-			});
-			jQuery("#sb_content_families").on("click", ".sb_fam_surname", function() {
-				var surname = jQuery(this).attr("title");
-				var alpha = jQuery(this).attr("alt");
-
-				if (!famloadedNames[surname]) {
-					jQuery.ajax({
-					  url: "module.php?mod='.$this->getName() . '&mod_action=ajax&sb_action=families&alpha="+alpha+"&surname="+surname,
-					  cache: false,
-					  success: function(html) {
-					    jQuery("#sb_fam_"+surname+" div").html(html);
-					    jQuery("#sb_fam_"+surname+" div").show();
-					    jQuery("#sb_fam_"+surname).css("list-style-image", "url(' . Theme::theme()->parameter('image-minus') . ')");
-					    famloadedNames[surname]=2;
-					  }
-					});
-				}
-				else if (famloadedNames[surname]==1) {
-					famloadedNames[surname]=2;
-					jQuery("#sb_fam_"+surname+" div").show();
-					jQuery("#sb_fam_"+surname).css("list-style-image", "url(' . Theme::theme()->parameter('image-minus') . ')");
-				}
-				else {
-					famloadedNames[surname]=1;
-					jQuery("#sb_fam_"+surname+" div").hide();
-					jQuery("#sb_fam_"+surname).css("list-style-image", "url(' . Theme::theme()->parameter('image-plus') . ')");
-				}
-				return false;
-			});
-		');
-		$out =
-			'<form method="post" action="module.php?mod=' . $this->getName() . '&amp;mod_action=ajax" onsubmit="return false;">' .
-			'<input type="search" name="sb_fam_name" id="sb_fam_name" placeholder="' . I18N::translate('Search') . '">' .
-			'<p>';
-		foreach ($initials as $letter=>$count) {
-			switch ($letter) {
-			case '@':
-				$html = $UNKNOWN_NN;
-				break;
-			case ',':
-				$html = I18N::translate('None');
-				break;
-			case ' ':
-				$html = '&nbsp;';
-				break;
-			default:
-				$html = $letter;
-				break;
-			}
-			$html = '<a href="module.php?mod=' . $this->getName() . '&amp;mod_action=ajax&amp;sb_action=families&amp;alpha=' . urlencode($letter) . '" class="sb_fam_letter">' . $html . '</a>';
-			$out .= $html . " ";
-		}
-
-		$out .= '</p>';
-		$out .= '<div id="sb_fam_content">';
-		$out .= '</div></form>';
-		return $out;
-	}
-
-	/**
-	 * @param string $alpha
-	 * @param string $surname1
-	 *
-	 * @return string
-	 */
-	public function getAlphaSurnames($alpha, $surname1 = '') {
-		$surnames = WT_Query_Name::surnames('', $alpha, true, true, WT_GED_ID);
-		$out = '<ul>';
-		foreach (array_keys($surnames) as $surname) {
-			$out .= '<li id="sb_fam_' . $surname . '" class="sb_fam_surname_li"><a href="' . $surname . '" title="' . $surname . '" alt="' . $alpha . '" class="sb_fam_surname">' . $surname . '</a>';
-			if (!empty($surname1) && $surname1 == $surname) {
-				$out .= '<div class="name_tree_div_visible">';
-				$out .= $this->getSurnameFams($alpha, $surname1);
-				$out .= '</div>';
-			} else {
-				$out .= '<div class="name_tree_div"></div>';
-			}
-			$out .= '</li>';
-		}
-		$out .= '</ul>';
-		return $out;
-	}
-
-	/**
-	 * @param string $alpha
-	 * @param string $surname
-	 *
-	 * @return string
-	 */
-	public function getSurnameFams($alpha, $surname) {
-		$families = WT_Query_Name::families($surname, $alpha, '', true, WT_GED_ID);
-		$out = '<ul>';
-		foreach ($families as $family) {
-			if ($family->canShowName()) {
-				$out .= '<li><a href="' . $family->getHtmlUrl() . '">' . $family->getFullName() . ' ';
-				if ($family->canShow()) {
-					$marriage_year = $family->getMarriageYear();
-					if ($marriage_year) {
-						$out .= ' (' . $marriage_year . ')';
-					}
-				}
-				$out .= '</a></li>';
-			}
-		}
-		$out .= '</ul>';
-		return $out;
-	}
-
-	/**
-	 * @param string $query
-	 *
-	 * @return string
-	 */
-	public function search($query) {
-		if (strlen($query) < 2) {
-			return '';
-		}
-
-		//-- search for INDI names
-		$rows = Database::prepare(
-			"SELECT i_id AS xref" .
-			" FROM `##individuals`, `##name`" .
-			" WHERE (i_id LIKE ? OR n_sort LIKE ?)" .
-			" AND i_id=n_id AND i_file=n_file AND i_file=?" .
-			" ORDER BY n_sort"
-		)
-		->execute(array("%{$query}%", "%{$query}%", WT_GED_ID))
-		->fetchAll();
-		$ids = array();
-		foreach ($rows as $row) {
-			$ids[] = $row->xref;
-		}
-
-		$vars = array();
-		if (empty($ids)) {
-			//-- no match : search for FAM id
-			$where = "f_id LIKE ?";
-			$vars[] = "%{$query}%";
-		} else {
-			//-- search for spouses
-			$qs = implode(',', array_fill(0, count($ids), '?'));
-			$where = "(f_husb IN ($qs) OR f_wife IN ($qs))";
-			$vars = array_merge($vars, $ids, $ids);
-		}
-
-		$vars[] = WT_GED_ID;
-		$rows = Database::prepare("SELECT f_id AS xref, f_file AS gedcom_id, f_gedcom AS gedcom FROM `##families` WHERE {$where} AND f_file=?")
-		->execute($vars)
-		->fetchAll();
-
-		$out = '<ul>';
-		foreach ($rows as $row) {
-			$family = Family::getInstance($row->xref, $row->gedcom_id, $row->gedcom);
-			if ($family->canShowName()) {
-				$out .= '<li><a href="' . $family->getHtmlUrl() . '">' . $family->getFullName() . ' ';
-				if ($family->canShow()) {
-					$marriage_year = $family->getMarriageYear();
-					if ($marriage_year) {
-						$out .= ' (' . $marriage_year . ')';
-					}
-				}
-				$out .= '</a></li>';
-			}
-		}
-		$out .= '</ul>';
-		return $out;
-	}
-}
+return new FamiliesModule(__DIR__);