Skip to content

Added an option to use site wide search instead of resource search #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Daniel-KM wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Added an option to use site wide search instead of resource search #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60bebc1
Fixed use of route params during background process.
Mar 18, 2024
2cebf2a
Removed useless and wrong query argument "Search".
Oct 28, 2024
52abe02
Added an option to redirect to the site wide full text search.
Oct 28, 2024
5f6effc
Fixed use with value annotations.
Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 81 additions & 58 deletions Module.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ public function handleConfigForm(AbstractController $controller)
}
$globalSettings = $this->getServiceLocator()->get('Omeka\Settings');
$globalSettings->set('metadata_browse_properties', $propertyIds);
$globalSettings->set('metadata_browse_use_globals', $params['metadata_browse_use_globals']);
$directLinks = $this->getServiceLocator()->get('Omeka\Settings');
$directLinks->set('metadata_browse_direct_links', $params['metadata_browse_direct_links']);
$globalSettings->set('metadata_browse_use_globals', !empty($params['metadata_browse_use_globals']));
$globalSettings->set('metadata_browse_direct_links', !empty($params['metadata_browse_direct_links']));
$globalSettings->set('metadata_browse_fulltext_search', !empty($params['metadata_browse_fulltext_search']));
}

public function getConfigForm(PhpRenderer $renderer)
Expand Down Expand Up @@ -150,28 +150,35 @@ public function addCSS($event)

public function repValueHtml($event)
{
/** @var \Omeka\Api\Representation\ValueRepresentation $target */
if ($event->getParam('value')) {
$target = $event->getParam('value');
} else {
$target = $event->getTarget();
}

$controllerName = $target->resource()->getControllerName();
// Value annotations are currently not managed.
$resource = $target->resource();
if (!$resource) {
return;
}

$controllerName = $resource->getControllerName();
if (!$controllerName) {
return;
}

$propertyId = $target->property()->id();

$routeMatch = $this->getServiceLocator()->get('Application')
->getMvcEvent()->getRouteMatch();
$routeMatchParams = $routeMatch->getParams();
/** @var \Omeka\Mvc\Status $status */
$services = $this->getServiceLocator();
$status = $services->get('Omeka\Status');

//setup the route params to pass to the Url helper. Both the route name and its parameters go here
$routeParams = [
'action' => 'browse',
];
if ($routeMatch->getParam('__ADMIN__')) {
$globalSettings = $this->getServiceLocator()->get('Omeka\Settings');
$routeParams = [];
$isAdminRequest = $status->isAdminRequest();
$globalSettings = $this->getServiceLocator()->get('Omeka\Settings');
if ($isAdminRequest) {
if ($globalSettings->get('metadata_browse_use_globals')) {
$filteredPropertyIds = $globalSettings->get('metadata_browse_properties', []);
} else {
Expand All @@ -185,14 +192,26 @@ public function repValueHtml($event)
$filteredPropertyIds = array_merge($currentSettings, $filteredPropertyIds);
}
}

$routeParams['route'] = 'admin/default';
} elseif ($routeMatch->getParam('__SITE__')) {
$routeParams['controller'] = $controllerName;
$routeParams['action'] = 'browse';
$useFullTextSearch = false;
} elseif ($status->isSiteRequest()) {
$siteSettings = $this->getServiceLocator()->get('Omeka\Settings\Site');
$filteredPropertyIds = $siteSettings->get('metadata_browse_properties', []);
$siteSlug = $routeMatch->getParam('site-slug');
$routeParams['route'] = 'site';
$routeParams['site-slug'] = $siteSlug . '/' . $controllerName;
$siteSlug = $status->getRouteParam('site-slug');
$useFullTextSearch = (bool) $globalSettings->get('metadata_browse_fulltext_search');
if ($useFullTextSearch) {
$route = 'site/resource';
$routeParams['site-slug'] = $siteSlug;
$routeParams['controller'] = 'index';
$routeParams['action'] = 'search';
} else {
$routeParams['route'] = 'site/resource';
$routeParams['site-slug'] = $siteSlug;
$routeParams['controller'] = $controllerName;
$routeParams['action'] = 'browse';
}
} else {
return;
}
Expand All @@ -201,55 +220,59 @@ public function repValueHtml($event)
$url = $viewHelperManager->get('Url');
$hyperlink = $viewHelperManager->get('hyperlink');
if (in_array($propertyId, $filteredPropertyIds)) {
$controllerName = $controllerName;
$routeParams['controller'] = $controllerName;

$translator = $this->getServiceLocator()->get('MvcTranslator');
$params = $event->getParams();
$translator = $this->getServiceLocator()->get('MvcTranslator');

$isLiteral = false;
switch ($target->type()) {
case 'resource':
$searchTarget = $target->valueResource()->id();
$searchUrl = $this->resourceSearchUrl($url, $routeParams, $propertyId, $searchTarget);
break;
case 'uri':
$searchTarget = $target->uri();
$searchUrl = $this->uriSearchUrl($url, $routeParams, $propertyId, $searchTarget);
break;
case 'literal':
if ($useFullTextSearch) {
if ($valueResource = $target->valueResource()) {
$searchTarget = $valueResource->title();
} elseif ($uri = $target->uri()) {
$val = $target->value();
$searchTarget = strlen((string) $val) ? $val : $uri;
} else {
$searchTarget = $target->value();
$searchUrl = $this->literalSearchUrl($url, $routeParams, $propertyId, $searchTarget);
$isLiteral = true;
break;
default:
$resource = $target->valueResource();
$uri = $target->uri();
if ($resource) {
}
$searchUrl = $url($route, $routeParams, ['query' => ['fulltext_search' => $searchTarget]]);
} else {
switch ($target->type()) {
case 'resource':
$searchTarget = $target->valueResource()->id();
$searchUrl = $this->resourceSearchUrl($url, $routeParams, $propertyId, $searchTarget);
} elseif ($uri) {
$searchUrl = $this->uriSearchUrl($url, $routeParams, $propertyId, $uri);
} else {
break;
case 'uri':
$searchTarget = $target->uri();
$searchUrl = $this->uriSearchUrl($url, $routeParams, $propertyId, $searchTarget);
break;
case 'literal':
$searchTarget = $target->value();
$searchUrl = $this->literalSearchUrl($url, $routeParams, $propertyId, $searchTarget);
$isLiteral = true;
}
break;
default:
$valueResource = $target->valueResource();
$uri = $target->uri();
if ($valueResource) {
$searchTarget = $valueResource->id();
$searchUrl = $this->resourceSearchUrl($url, $routeParams, $propertyId, $searchTarget);
} elseif ($uri) {
$searchUrl = $this->uriSearchUrl($url, $routeParams, $propertyId, $uri);
} else {
$searchTarget = $target->value();
$searchUrl = $this->literalSearchUrl($url, $routeParams, $propertyId, $searchTarget);
$isLiteral = true;
}
}
}

switch ($controllerName) {
case 'item':
$controllerLabel = 'items';
break;
case 'item-set':
$controllerLabel = 'item sets';
break;
default:
$controllerLabel = $controllerName;
break;
}
$controllerNamesToLabels = [
'item' => 'items',
'item-set' => 'item sets',
];
$controllerLabel = $controllerNamesToLabels[$controllerName] ?? $controllerName;

$html = $params['html'];
$globalSettings = $this->getServiceLocator()->get('Omeka\Settings');
if ($globalSettings->get('metadata_browse_direct_links') && $isLiteral == true) {
if ($isLiteral && $globalSettings->get('metadata_browse_direct_links')) {
$link = $hyperlink->raw($html, $searchUrl, ['class' => 'metadata-browse-direct-link']);
$event->setParam('html', $link);
} else {
Expand All @@ -264,7 +287,7 @@ protected function literalSearchUrl($url, $routeParams, $propertyId, $searchTarg
{
$searchUrl = $url($routeParams['route'],
$routeParams,
['query' => ['Search' => '',
['query' => [
'property[0][property]' => $propertyId,
'property[0][type]' => 'eq',
'property[0][text]' => $searchTarget,
Expand All @@ -279,7 +302,7 @@ protected function uriSearchUrl($url, $routeParams, $propertyId, $searchTarget)
{
$searchUrl = $url($routeParams['route'],
$routeParams,
['query' => ['Search' => '',
['query' => [
'property[0][property]' => $propertyId,
'property[0][type]' => 'eq',
'property[0][text]' => $searchTarget,
Expand All @@ -294,7 +317,7 @@ protected function resourceSearchUrl($url, $routeParams, $propertyId, $searchTar
{
$searchUrl = $url($routeParams['route'],
$routeParams,
['query' => ['Search' => '',
['query' => [
'property[0][property]' => $propertyId,
'property[0][type]' => 'res',
'property[0][text]' => $searchTarget,
Expand Down
12 changes: 12 additions & 0 deletions src/Form/ConfigForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,18 @@ public function init()
'id' => 'metadata_browse_direct_links',
],
]);
$this->add([
'type' => 'checkbox',
'name' => 'metadata_browse_fulltext_search',
'options' => [
'label' => 'Use full text search', // @translate
'info' => 'Redirect to the site wide search page instead of the resource search page.', // @translate
],
'attributes' => [
'checked' => $this->globalSettings->get('metadata_browse_fulltext_search') ? 'checked' : '',
'id' => 'metadata_browse_fulltext_search',
],
]);
}

public function setGlobalSettings($globalSettings)
Expand Down