/**
* Options:
* appendToSearch = optional text to be AND'ed wuth current search expression
* output_format = determines format out search result output. "PDF" and "HTML" are currently supported; "HTML" is the default
* view = view with path relative to controller to use overriding default ("search/<table_name>_search_basic_html.php")
* vars = associative array with key value pairs to assign to the view
*
* Callbacks:
* hookBeforeNewSearch() is called just before executing a new search. The first parameter is the BrowseEngine object containing the search.
*/
public function Index($pa_options = null)
{
$po_search = isset($pa_options['search']) ? $pa_options['search'] : null;
if (isset($pa_options['saved_search']) && $pa_options['saved_search']) {
$this->opo_result_context->setSearchExpression($pa_options['saved_search']['search']);
$this->opo_result_context->isNewSearch(true);
}
parent::Index($pa_options);
AssetLoadManager::register('hierBrowser');
AssetLoadManager::register('browsable');
// need this to support browse panel when filtering/refining search results
$t_model = $this->opo_datamodel->getInstanceByTableName($this->ops_tablename, true);
$va_access_values = caGetUserAccessValues($this->request);
// Get elements of result context
$vn_page_num = $this->opo_result_context->getCurrentResultsPageNumber();
$vs_search = $this->opo_result_context->getSearchExpression();
$vb_is_new_search = $this->opo_result_context->isNewSearch();
if ((bool) $this->request->getParameter('reset', pString) && $this->request->getParameter('reset', pString) != 'save') {
$vs_search = '';
$vb_is_new_search = true;
}
if (!($vn_items_per_page = $this->opo_result_context->getItemsPerPage())) {
$vn_items_per_page = $this->opn_items_per_page_default;
$this->opo_result_context->setItemsPerPage($vn_items_per_page);
}
if (!($vs_view = $this->opo_result_context->getCurrentView())) {
$va_tmp = array_keys($this->opa_views);
$vs_view = $this->ops_view_default ? $this->ops_view_default : array_shift($va_tmp);
$this->opo_result_context->setCurrentView($vs_view);
}
if (!isset($this->opa_views[$vs_view])) {
$va_tmp = array_keys($this->opa_views);
$vs_view = array_shift($va_tmp);
}
if (!($vs_sort = $this->opo_result_context->getCurrentSort())) {
$va_tmp = array_keys($this->opa_sorts);
$vs_sort = array_shift($va_tmp);
}
$vs_sort_direction = $this->opo_result_context->getCurrentSortDirection();
$vb_sort_has_changed = $this->opo_result_context->sortHasChanged();
if (!$this->opn_type_restriction_id) {
$this->opn_type_restriction_id = '';
}
$this->view->setVar('type_id', $this->opn_type_restriction_id);
MetaTagManager::setWindowTitle(_t('%1 search', $this->searchName('plural')));
// Get attribute sorts
$va_sortable_elements = ca_metadata_elements::getSortableElements($this->ops_tablename, $this->opn_type_restriction_id);
if (!is_array($this->opa_sorts)) {
$this->opa_sorts = array();
}
foreach ($va_sortable_elements as $va_sortable_element) {
$this->opa_sorts[$this->ops_tablename . '.' . $va_sortable_element['element_code']] = $va_sortable_element['display_label'];
}
if ($pa_options['appendToSearch']) {
$vs_append_to_search .= " AND (" . $pa_options['appendToSearch'] . ")";
}
//
// Execute the search
//
if ($vs_search && $vs_search != "") {
/* any request? */
$va_search_opts = array('sort' => $vs_sort, 'sort_direction' => $vs_sort_direction, 'appendToSearch' => $vs_append_to_search, 'checkAccess' => $va_access_values, 'no_cache' => $vb_is_new_search, 'dontCheckFacetAvailability' => true, 'filterNonPrimaryRepresentations' => true);
if ($vb_is_new_search || isset($pa_options['saved_search']) || is_subclass_of($po_search, "BrowseEngine") && !$po_search->numCriteria()) {
$vs_browse_classname = get_class($po_search);
$po_search = new $vs_browse_classname();
if (is_subclass_of($po_search, "BrowseEngine")) {
$po_search->addCriteria('_search', $vs_search);
if (method_exists($this, "hookBeforeNewSearch")) {
$this->hookBeforeNewSearch($po_search);
}
}
$this->opo_result_context->setParameter('show_type_id', null);
}
if ($this->opn_type_restriction_id) {
$po_search->setTypeRestrictions(array($this->opn_type_restriction_id), array('includeSubtypes' => false));
}
$vb_criteria_have_changed = false;
if (is_subclass_of($po_search, "BrowseEngine")) {
//
// Restrict facets to specific group for main browse landing page (if set in app.conf config)
//
if ($vs_facet_group = $this->request->config->get($this->ops_tablename . '_search_refine_facet_group')) {
$po_search->setFacetGroup($vs_facet_group);
}
$vb_criteria_have_changed = $po_search->criteriaHaveChanged();
$po_search->execute($va_search_opts);
$this->opo_result_context->setParameter('browse_id', $po_search->getBrowseID());
if ($vs_group_name = $this->request->config->get('browse_facet_group_for_' . $this->ops_tablename)) {
$po_search->setFacetGroup($vs_group_name);
}
$vo_result = $po_search->getResults($va_search_opts);
} else {
$vo_result = $po_search->search($vs_search, $va_search_opts);
}
$vo_result = isset($pa_options['result']) ? $pa_options['result'] : $vo_result;
$this->opo_result_context->validateCache();
// Only prefetch what we need
$vo_result->setOption('prefetch', $vn_items_per_page);
//
// Handle details of partitioning search results by type, if required
//
if ((bool) $this->request->config->get('search_results_partition_by_type')) {
$va_type_counts = $vo_result->getResultCountForFieldValues(array('ca_objects.type_id'));
$va_type_counts_obj_type = $va_type_counts['ca_objects.type_id'];
ksort($va_type_counts_obj_type);
$this->view->setVar('counts_by_type', $va_type_counts_obj_type);
$vn_show_type_id = $this->opo_result_context->getParameter('show_type_id');
if (!isset($va_type_counts_obj_type[$vn_show_type_id])) {
$va_tmp = array_keys($va_type_counts_obj_type);
$vn_show_type_id = array_shift($va_tmp);
}
$this->view->setVar('show_type_id', $vn_show_type_id);
$vo_result->filterResult('ca_objects.type_id', $vn_show_type_id);
}
if ($vb_is_new_search || $vb_criteria_have_changed || $vb_sort_has_changed) {
$this->opo_result_context->setResultList($vo_result->getPrimaryKeyValues());
$this->opo_result_context->setParameter('availableVisualizationChecked', 0);
if ($this->opo_result_context->searchExpressionHasChanged()) {
$vn_page_num = 1;
}
}
$this->view->setVar('num_hits', $vo_result->numHits());
$this->view->setVar('num_pages', $vn_num_pages = ceil($vo_result->numHits() / $vn_items_per_page));
if ($vn_page_num > $vn_num_pages) {
$vn_page_num = 1;
}
$vo_result->seek(($vn_page_num - 1) * $vn_items_per_page);
$this->view->setVar('page', $vn_page_num);
$this->view->setVar('search', $vs_search);
$this->view->setVar('result', $vo_result);
}
//
// Set up view for display of results
//
$t_model = $this->opo_datamodel->getInstanceByTableName($this->ops_tablename, true);
$this->view->setVar('views', $this->opa_views);
// pass view list to view for rendering
$this->view->setVar('current_view', $vs_view);
$this->view->setVar('sorts', $this->opa_sorts);
// pass sort list to view for rendering
$this->view->setVar('current_sort', $vs_sort);
$this->view->setVar('current_sort_direction', $vs_sort_direction);
$this->view->setVar('current_items_per_page', $vn_items_per_page);
$this->view->setVar('items_per_page', $this->opa_items_per_page);
$this->view->setVar('t_subject', $t_model);
$this->view->setVar('mode_name', _t('search'));
$this->view->setVar('mode', 'search');
$this->view->setVar('mode_type_singular', $this->searchName('singular'));
$this->view->setVar('mode_type_plural', $this->searchName('plural'));
$this->view->setVar('search_history', $this->opo_result_context->getSearchHistory());
$this->view->setVar('result_context', $this->opo_result_context);
$this->view->setVar('uses_hierarchy_browser', $this->usesHierarchyBrowser());
$this->view->setVar('access_values', $va_access_values);
$this->view->setVar('browse', $po_search);
$t_display = $this->view->getVar('t_display');
if (!is_array($va_display_list = $this->view->getVar('display_list'))) {
$va_display_list = array();
}
if ($vs_view == 'editable') {
$va_initial_data = array();
$va_row_headers = array();
$vn_item_count = 0;
if ($vo_result) {
$vs_pk = $vo_result->primaryKey();
while ($vn_item_count < 100 && $vo_result->nextHit()) {
$va_result = array('item_id' => $vn_id = $vo_result->get($vs_pk));
foreach ($va_display_list as $vn_placement_id => $va_bundle_info) {
$va_result[str_replace(".", "-", $va_bundle_info['bundle_name'])] = $t_display->getDisplayValue($vo_result, $vn_placement_id, array('request' => $this->request));
}
$va_initial_data[] = $va_result;
$vn_item_count++;
$va_row_headers[] = $vn_item_count . " " . caEditorLink($this->request, caNavIcon($this->request, __CA_NAV_BUTTON_EDIT__), 'caResultsEditorEditLink', $this->ops_tablename, $vn_id);
}
}
$this->view->setVar('initialData', $va_initial_data);
$this->view->setVar('rowHeaders', $va_row_headers);
}
//
// Bottom line
//
$va_bottom_line = array();
$vb_bottom_line_is_set = false;
foreach ($va_display_list as $vn_placement_id => $va_placement) {
if (isset($va_placement['settings']['bottom_line']) && $va_placement['settings']['bottom_line']) {
$va_bottom_line[$vn_placement_id] = caProcessBottomLineTemplate($this->request, $va_placement, $vo_result, array('pageStart' => ($vn_page_num - 1) * $vn_items_per_page, 'pageEnd' => ($vn_page_num - 1) * $vn_items_per_page + $vn_items_per_page));
$vb_bottom_line_is_set = true;
} else {
$va_bottom_line[$vn_placement_id] = '';
}
}
$this->view->setVar('bottom_line', $vb_bottom_line_is_set ? $va_bottom_line : null);
switch ($pa_options['output_format']) {
# ------------------------------------
case 'LABELS':
$this->_genLabels($vo_result, $this->request->getParameter("label_form", pString), $vs_search, $vs_search);
break;
# ------------------------------------
# ------------------------------------
case 'EXPORT':
$this->_genExport($vo_result, $this->request->getParameter("export_format", pString), $vs_search, $vs_search);
break;
# ------------------------------------
# ------------------------------------
case 'HTML':
default:
// generate type menu and type value list
if (method_exists($t_model, "getTypeList")) {
$this->view->setVar('type_list', $t_model->getTypeList());
}
if ($this->opb_uses_hierarchy_browser) {
AssetLoadManager::register('hierBrowser');
// only for interfaces that use the hierarchy browser
$t_list = new ca_lists();
if ($vs_type_list_code = $t_model->getTypeListCode()) {
$this->view->setVar('num_types', $t_list->numItemsInList($vs_type_list_code));
$this->view->setVar('type_menu', $t_list->getListAsHTMLFormElement($vs_type_list_code, 'type_id', array('id' => 'hierTypeList')));
}
// set last browse id for hierarchy browser
$this->view->setVar('browse_last_id', intval($this->request->session->getVar($this->ops_tablename . '_browse_last_id')));
}
$this->opo_result_context->setAsLastFind();
$this->opo_result_context->saveContext();
if (isset($pa_options['vars']) && is_array($pa_options['vars'])) {
foreach ($pa_options['vars'] as $vs_key => $vs_val) {
$this->view->setVar($vs_key, $vs_val);
}
}
if (isset($pa_options['view']) && $pa_options['view']) {
$this->render($pa_options['view']);
} else {
$this->render('Search/' . $this->ops_tablename . '_search_basic_html.php');
}
break;
# ------------------------------------
}
}
/**
*
*/
public function Index($pa_options = null)
{
$po_search = isset($pa_options['search']) ? $pa_options['search'] : null;
$pb_dont_render_view = isset($pa_options['dontRenderView']) && (bool) $pa_options['dontRenderView'] ? true : false;
parent::Index($pa_options);
AssetLoadManager::register('browsable');
AssetLoadManager::register('hierBrowser');
$va_access_values = caGetUserAccessValues($this->request);
//
// Restrict facets to specific group for main browse landing page (if set in app.conf config)
//
if ($vs_facet_group = $this->request->config->get($this->ops_tablename . '_browse_facet_group')) {
$this->opo_browse->setFacetGroup($vs_facet_group);
}
//
// Set useful values we'll need later
//
$t_model = $this->opo_datamodel->getInstanceByTableName($this->ops_tablename, true);
$vb_criteria_have_changed = $this->opo_browse->criteriaHaveChanged();
// Get elements of result context
$vn_page_num = $this->opo_result_context->getCurrentResultsPageNumber();
if ($this->opb_type_restriction_has_changed || $this->request->getParameter('reset', pString) == 'clear') {
$this->opo_browse->removeAllCriteria();
$this->opo_result_context->setSearchExpression($this->opo_browse->getBrowseID());
}
if (!($vn_items_per_page = $this->opo_result_context->getItemsPerPage())) {
$vn_items_per_page = $this->opn_items_per_page_default;
$this->opo_result_context->setItemsPerPage($vn_items_per_page);
}
if (!($vs_view = $this->opo_result_context->getCurrentView())) {
$va_tmp = array_keys($this->opa_views);
$vs_view = $this->ops_view_default ? $this->ops_view_default : array_shift($va_tmp);
$this->opo_result_context->setCurrentView($vs_view);
}
if (!isset($this->opa_views[$vs_view])) {
$va_tmp = array_keys($this->opa_views);
$vs_view = array_shift($va_tmp);
}
if (!($vs_sort = $this->opo_result_context->getCurrentSort())) {
$va_tmp = array_keys($this->opa_sorts);
$vs_sort = array_shift($va_tmp);
}
$vs_sort_direction = $this->opo_result_context->getCurrentSortDirection();
$vb_sort_has_changed = $this->opo_result_context->sortHasChanged();
if (!$vn_page_num || $vb_criteria_have_changed) {
$vn_page_num = 1;
}
// Do redirect directly to detail if configured to do so
if ($this->opo_browse->criteriaHaveChanged() && sizeof($va_criteria = $this->opo_browse->getCriteria()) == 1) {
$va_tmp = array_keys($va_criteria);
$va_tmp1 = array_keys($va_criteria[$va_tmp[0]]);
$va_facet_info = $this->opo_browse->getInfoForFacet($va_tmp[0]);
if ($this->request->config->get('redirect_to_' . $va_facet_info['table'] . '_detail_if_is_first_facet')) {
$t_table = $this->opo_datamodel->getInstanceByTableName($va_facet_info['table'], true);
$va_newmuseum_hack_occurrence_type_ids = $this->request->config->getList('newmuseum_hack_browse_should_redirect_occurrence_types_to_object_details');
if (is_array($va_newmuseum_hack_occurrence_type_ids) && sizeof($va_newmuseum_hack_occurrence_type_ids) && $va_facet_info['table'] == 'ca_occurrences') {
if ($t_table->load($va_tmp1[0])) {
if (in_array($t_table->getTypeID(), $va_newmuseum_hack_occurrence_type_ids)) {
if (sizeof($va_objects = $t_table->getRelatedItems('ca_objects'))) {
$va_object = array_shift($va_objects);
$vn_object_id = $va_object['object_id'];
$this->response->setRedirect(caNavUrl($this->request, 'Detail', 'Object', 'Show', array('object_id' => $vn_object_id)));
return;
}
}
}
}
$this->response->setRedirect(caNavUrl($this->request, 'Detail', ucfirst($t_table->getProperty('NAME_SINGULAR')), 'Show', array($t_table->primaryKey() => $va_tmp1[0])));
return;
}
}
//
// Enforce type restriction, if defined
//
$this->opo_browse->setTypeRestrictions(array($this->opn_type_restriction_id));
MetaTagManager::setWindowTitle(_t('%1 browse', $this->browseName('plural')));
//
// Actually execute the browse - do the queries
//
//if ($vs_group_name = $this->request->config->get('browse_facet_group_for_'.$this->ops_tablename)) {
// $this->opo_browse->setFacetGroup($vs_group_name);
//}
//
// Restrict facets to specific group (if set in app.conf config)
//
if ($vs_facet_group = $this->request->config->get($this->ops_tablename . ($this->opo_browse->numCriteria() < 1 ? '_browse_facet_group' : '_browse_refine_facet_group'))) {
$this->opo_browse->setFacetGroup($vs_facet_group);
}
$this->opo_browse->execute(array('checkAccess' => $va_access_values, 'no_cache' => !$this->opo_result_context->cacheIsValid()));
$this->opo_result_context->validateCache();
$this->opo_result_context->setSearchExpression($this->opo_browse->getBrowseID());
//
// Pass browse info (context + facets + criteria) to view
//
$this->view->setVar('browse', $this->opo_browse);
$this->view->setVar('target', $this->ops_tablename);
$this->view->setVar('result_context', $this->opo_result_context);
$this->view->setVar('criteria', $va_criteria = $this->opo_browse->getCriteriaWithLabels());
$this->view->setVar('available_facets', $this->opo_browse->getInfoForAvailableFacets());
$this->view->setVar('facets_with_content', $this->opo_browse->getInfoForFacetsWithContent());
$this->view->setVar('facet_info', $va_facet_info = $this->opo_browse->getInfoForFacets());
$va_single_facet_values = array();
foreach ($va_facet_info as $vs_facet => $va_facet_settings) {
$va_single_facet_values[$vs_facet] = isset($va_facet_settings['single_value']) ? $va_facet_settings['single_value'] : null;
}
$this->view->setVar('single_facet_values', $va_single_facet_values);
// browse criteria in an easy-to-display format
$va_browse_criteria = array();
foreach ($this->opo_browse->getCriteriaWithLabels() as $vs_facet_code => $va_criteria) {
$va_facet_info = $this->opo_browse->getInfoForFacet($vs_facet_code);
$va_criteria_list = array();
foreach ($va_criteria as $vn_criteria_id => $vs_criteria_label) {
$va_criteria_list[] = $vs_criteria_label;
}
$va_browse_criteria[$va_facet_info['label_singular']] = join('; ', $va_criteria_list);
}
$this->view->setVar('browse_criteria', $va_browse_criteria);
//
// Get the browse results
//
$this->view->setVar('num_hits', $vn_num_hits = $this->opo_browse->numResults());
$this->view->setVar('num_pages', $vn_num_pages = ceil($vn_num_hits / $vn_items_per_page));
if ($vn_page_num > $vn_num_pages) {
$vn_page_num = 1;
}
if ($pa_options['output_format']) {
$vo_result = $this->opo_browse->getResults(array('sort' => $vs_sort, 'sort_direction' => $vs_sort_direction));
} else {
$vo_result = $this->opo_browse->getResults(array('sort' => $vs_sort, 'sort_direction' => $vs_sort_direction, 'start' => ($vn_page_num - 1) * $vn_items_per_page, 'limit' => $vn_items_per_page));
}
// Only prefetch what we need
$vo_result->setOption('prefetch', $vn_items_per_page);
if ($vo_result) {
if ($vb_criteria_have_changed || $vb_sort_has_changed) {
// Put the results id list into the results context - we used this for previous/next navigation
$this->opo_result_context->setResultList($vo_result->getPrimaryKeyValues());
$this->opo_result_context->setParameter('availableVisualizationChecked', 0);
}
$vo_result->seek(0);
}
//
// Set up view for display of results
//
$this->view->setVar('page', $vn_page_num);
$this->view->setVar('result', $vo_result);
$this->view->setVar('views', $this->opa_views);
// pass view list to view for rendering
$this->view->setVar('current_view', $vs_view);
$this->view->setVar('sorts', $this->opa_sorts);
// pass sort list to view for rendering
$this->view->setVar('current_sort', $vs_sort);
$this->view->setVar('current_sort_direction', $vs_sort_direction);
$this->view->setVar('items_per_page', $this->opa_items_per_page);
$this->view->setVar('current_items_per_page', $vn_items_per_page);
$this->view->setVar('t_subject', $t_model);
$this->view->setVar('mode_name', _t('browse'));
$this->view->setVar('mode', 'browse');
$this->view->setVar('mode_type_singular', $this->browseName('singular'));
$this->view->setVar('mode_type_plural', $this->browseName('plural'));
$this->view->setVar('access_values', $va_access_values);
$t_display = $this->view->getVar('t_display');
$va_display_list = $this->view->getVar('display_list');
if ($vs_view == 'editable') {
$va_initial_data = array();
$va_row_headers = array();
$vn_item_count = 0;
if ($vo_result) {
$vs_pk = $vo_result->primaryKey();
while ($vn_item_count < 100 && $vo_result->nextHit()) {
$va_result = array('item_id' => $vn_id = $vo_result->get($vs_pk));
foreach ($va_display_list as $vn_placement_id => $va_bundle_info) {
$va_result[str_replace(".", "-", $va_bundle_info['bundle_name'])] = $t_display->getDisplayValue($vo_result, $vn_placement_id, array('request' => $this->request));
}
$va_initial_data[] = $va_result;
$vn_item_count++;
$va_row_headers[] = $vn_item_count . " " . caEditorLink($this->request, caNavIcon($this->request, __CA_NAV_BUTTON_EDIT__), 'caResultsEditorEditLink', $this->ops_tablename, $vn_id);
}
}
$this->view->setVar('initialData', $va_initial_data);
$this->view->setVar('rowHeaders', $va_row_headers);
}
//
// Bottom line
//
$va_bottom_line = array();
$vb_bottom_line_is_set = false;
foreach ($va_display_list as $vn_placement_id => $va_placement) {
if (isset($va_placement['settings']['bottom_line']) && $va_placement['settings']['bottom_line']) {
$va_bottom_line[$vn_placement_id] = caProcessBottomLineTemplate($this->request, $va_placement, $vo_result, array('pageStart' => ($vn_page_num - 1) * $vn_items_per_page, 'pageEnd' => ($vn_page_num - 1) * $vn_items_per_page + $vn_items_per_page));
$vb_bottom_line_is_set = true;
} else {
$va_bottom_line[$vn_placement_id] = '';
}
}
$this->view->setVar('bottom_line', $vb_bottom_line_is_set ? $va_bottom_line : null);
switch ($pa_options['output_format']) {
# ------------------------------------
case 'LABELS':
$this->_genLabels($vo_result, $this->request->getParameter("label_form", pString), _t('Browse'), _t('Browse'));
break;
# ------------------------------------
# ------------------------------------
case 'EXPORT':
$this->_genExport($vo_result, $this->request->getParameter("export_format", pString), _t('Browse'), _t('Browse'));
break;
# ------------------------------------
# ------------------------------------
case 'HTML':
default:
// generate type menu and type value list
if (method_exists($t_model, "getTypeList")) {
$this->view->setVar('type_list', $t_model->getTypeList());
}
$this->opo_result_context->setAsLastFind();
$this->opo_result_context->saveContext();
if (!$pb_dont_render_view) {
$this->render('Browse/browse_controls_html.php');
}
break;
}
}
