From 69c741f4dca17b21ea885b94d25df5ed34653b8e Mon Sep 17 00:00:00 2001 From: James Wilson Date: Tue, 28 Aug 2018 09:49:54 -0500 Subject: [PATCH] Implement Twig best practices for ebsco result display #16 --- ebsco.module | 173 ++++++++----------------------- templates/ebsco-result.html.twig | 101 +++++++++++++++++- 2 files changed, 144 insertions(+), 130 deletions(-) diff --git a/ebsco.module b/ebsco.module index d9101be..1cb1dc1 100644 --- a/ebsco.module +++ b/ebsco.module @@ -17,10 +17,14 @@ * limitations under the License. */ -use Symfony\Component\HttpFoundation\RedirectResponse; + +use Drupal\Component\Utility\Html; use Drupal\Component\Utility\Unicode; use Drupal\Core\Block\BlockPluginInterface; +use Drupal\Core\Link; use Drupal\Core\Url; +use Symfony\Component\HttpFoundation\RedirectResponse; +use Symfony\Cmf\Component\Routing\RouteObjectInterface; require_once __DIR__ . '/lib/EBSCODocument.php'; @@ -1151,163 +1155,74 @@ function template_preprocess_ebsco_advanced_search(&$variables) { * @see ebsco-result.tpl.php */ function template_preprocess_ebsco_result(&$variables) { - $params = $_REQUEST; $params['op'] = isset($params['op']) ? $params['op'] : 'Next'; - $_SESSION['EBSCO']['redirect'] = drupal_get_destination(); + $destination = \Drupal::destination()->getAsArray(); + + $_SESSION['EBSCO']['redirect'] = $destination; if (empty($Document)) { $Document = new EBSCODocument(); } $Document->retrieve(); - $record = $Document->record(); - - $variables['record'] = $record; - $lastSearch['count'] = $Document->record_count(); - $variables['count'] = $Document->record_count(); - - $lastSearch = isset($params['id']) ? $Document->search_read($params['id'], $params['op']) : 'fail'; - $variables['last_search'] = $_SESSION['EBSCO']['lastsearch']; - $detailRecordHTML=""; - - if (isset($record) ){ - - $id = \Drupal\Component\Utility\Html::escape($record->record_id()); - $fulltextUrl= \Drupal\Core\Url::fromRoute('ebsco.fulltext', array('id' => $id))->toString();; - $pdfUrl= \Drupal\Core\Url::fromRoute('ebsco.pdf', array('id' => $id))->toString(); - + $variables['record'] = $record = $Document->record(); - $detailRecordHTML='
' - .'
' - .'
' + if (isset($record)) { + $link_parameters = [ + 'id' => Html::escape($record->record_id()) + ]; - .'
    ' - ; - if($record->p_link){ - $detailRecordHTML.= "
  • " . t('View in EDS') . "
    • "; + if ($record->p_link) { + $variables['p_link_url'] = $record->p_link; } - if ($record->pdf_link){ - $detailRecordHTML.= ' -
  • - ' . t('PDF full text') . ' -
    • '; + if ($record->pdf_link) { + $variables['pdf_link_url'] = Url::fromRoute('ebsco.pdf', $link_parameters)->toString(); } - if ($record->full_text_availability){ - $detailRecordHTML.= ' -
  • - ' . t('HTML full text') . ' -
    • '; - } + if ($record->full_text_availability) { + $variables['fulltext_link_url'] = Url::fromRoute('ebsco.fulltext', $link_parameters, ['fragment' => 'html'])->toString(); - if (!empty($record->custom_links)){ - foreach ($record->custom_links as $link){ - $detailRecordHTML.= ' -
  • - ' . ($link['Icon']) ? '' : '' . $link['Name'] . ' -
    • '; + // Simplify the link if the user is logged in already. + if (\Drupal::currentUser()->isAuthenticated()) { + $variables['fulltext_link_url'] = '#html'; } } - $detailRecordHTML.='
' - ; + $variables['login_link'] = Link::createFromRoute(t('Login'), 'user.login', [], ['query' => $destination, 'fragment' => 'html'])->toString(); - $detailRecordHTML.='
' + $lastSearch = isset($params['id']) ? $Document->search_read($params['id'], $params['op']) : []; + if (!empty($lastSearch)) { + $variables['last_search'] = $lastSearch; + $variables['current_index'] = $lastSearch['current_index']; - - .'
' - .'
' - ; - if ($lastSearch){ - $detailRecordHTML.='
'; - if ($lastSearch['previous']){ - $previousUrl= \Drupal\Core\Url::fromRoute('ebsco.detailedrecord', array('id' => $lastSearch['previous']->record_id, 'op' => 'Previous'))->toString(); - $detailRecordHTML.= '« ' . t('Previous') . ' '; + if (!empty($_SESSION['search_total'])) { + $variables['last_search_total'] = $_SESSION['search_total']; } - $detailRecordHTML.= $lastSearch['current_index'].' of ' . $_SESSION['search_total']; - if ($lastSearch['next']!==''){ - $nextUrl= \Drupal\Core\Url::fromRoute('ebsco.detailedrecord', array('id' => $lastSearch['next']->record_id, 'op' => 'Next'))->toString(); - $detailRecordHTML.= ' ' . t('Next') . ' »'; + if ($lastSearch['previous']) { + $variables['previous_url'] = Url::fromRoute('ebsco.detailedrecord', array('id' => $lastSearch['previous']->record_id, 'op' => 'Previous'))->toString(); } - $detailRecordHTML.='
' - ; - if (isset($_SESSION['EBSCO']['lastsearch']["destination"])) { - $detailRecordHTML.'
' - .' « '.t('Back to Results list').'' - .'
' - .'
' - ; - } - } - $detailRecordHTML.='
'; - - $detailRecordHTML.='
' - .' ' - ; - foreach ($record->items as $item){ - if (!empty($item['Data'])){ - $detailRecordHTML.='' - .'' - .'' - .''; + if ($lastSearch['next'] !== '') { + $variables['next_url'] = Url::fromRoute('ebsco.detailedrecord', array('id' => $lastSearch['next']->record_id, 'op' => 'Next'))->toString(); } - } - - if ($record->db_label){ - $detailRecordHTML.='' - .'' - .''; - } - if ($record->full_text){ - $detailRecordHTML.='' - .'' - .''; - } - elseif ($record->access_level && !\Drupal::currentUser()->isAuthenticated()){ - - $link = '' . t('Login') . ''; - $detailRecordHTML.='' - .'' - .''; + if (isset($_SESSION['EBSCO']['lastsearch']['destination'])) { + $variables['backlink_url'] = $_SESSION['EBSCO']['lastsearch']['destination']; + } } - $detailRecordHTML.='
' . t($item['Label']) . ':'. auto_link($item['Data']) . '
' . t('Database') . ':' . \Drupal\Component\Utility\Html::escape($record->db_label) . '
' . $record->full_text . '
' - .'

' . t('The full text cannot be displayed to guests.') . '
' - .'' . sprintf(t('%s for full access.'), $link) . '' - .'

' - .'
' - .'
' - ; - $detailRecordHTML.='
'; - if ($record->medium_thumb_link){ - $detailRecordHTML.='' . t('Book jacket') . ''; + foreach ($record->items as &$item) { + if (!empty($item['Data'])) { + $item['Auto_Link'] = auto_link($item['Data']); + } } - if ($record->publication_type){ - $detailRecordHTML.= '

' . \Drupal\Component\Utility\Html::escape($record->publication_type) . '

'; + $request = \Drupal::request(); + if ($route = $request->attributes->get(RouteObjectInterface::ROUTE_OBJECT)) { + $route->setDefault('_title', $record->title); } - $detailRecordHTML.='
' - - .'
' - .'
' - ; - - $detailRecordHTML.='
'; - - $detailRecordHTML.='
'; - } - $variables['detailrecord'] = $detailRecordHTML; - - - - - $request = \Drupal::request(); - if ($route = $request->attributes->get(\Symfony\Cmf\Component\Routing\RouteObjectInterface::ROUTE_OBJECT)) { - $route->setDefault('_title', $record->title); } } @@ -1519,4 +1434,4 @@ function auto_link($string) $string ); return $linkedString; -} \ No newline at end of file +} diff --git a/templates/ebsco-result.html.twig b/templates/ebsco-result.html.twig index b3bebc5..fd0f169 100644 --- a/templates/ebsco-result.html.twig +++ b/templates/ebsco-result.html.twig @@ -5,6 +5,7 @@ * * @see template_preprocess_ebsco_result() * + * @ingroup themeable * * Copyright [2017] [EBSCO Information Services] * @@ -21,7 +22,105 @@ * limitations under the License. */ #} +
+
+ +
+
+
+ {% if last_search %} +
+ {% if previous_url %} + {% trans %}« Previous{% endtrans %} + {% endif %} + + {% if last_search_total %} + {% trans %}{{ current_index }} of {{ last_search_total }}{% endtrans %} + {% endif %} + + {% if next_url %} + {% trans %}Next »{% endtrans %} + {% endif %} +
+ {% endif %} + + {% if backlink_url %} +
+ {% trans %}« Back to Results list{% endtrans %} +
+ {% endif %} +
+
+ +
+ + {% for item in record.items %} + + + + + {% endfor %} + + {% if record.db_label is not empty %} + + + + + {% endif %} + + {% if record.full_text is not empty %} + + + + {% elseif record.access_level and not logged_in %} + + + + {% endif %} +
{{ item.Label }}:{{ item.Auto_Link|raw }}
{% trans %}Database{% endtrans %}:{{ record.db_label }}
{{ record.full_text }}
+

+ {% trans %}The full text cannot be displayed to guests.{% endtrans %} +
+ {% trans %}{{ login_link }} for full access.{% endtrans %} +

+
+
+ +
+ {% if record.medium_thumb_link %} + {% trans %}Book jacket{% endtrans %} + {% endif %} + + {% if record.publication_type %} +

{{ record.publication_type }}

+ {% endif %} +
+ +
+ +
+