About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


legacy:vufind_1.x_developer_manual:building_a_smarty_plugin

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
legacy:vufind_1.x_developer_manual:building_a_smarty_plugin [2015/12/11 19:15]
demiankatz ↷ Page moved and renamed from building_a_plugin to legacy:vufind_1.x_developer_manual:building_a_smarty_plugin
legacy:vufind_1.x_developer_manual:building_a_smarty_plugin [2018/12/19 14:12] (current)
demiankatz
Line 1: Line 1:
 ====== Building a Smarty Plugin ====== ====== Building a Smarty Plugin ======
  
-VuFind uses the [[http://www.smarty.net/|Smarty Template Engine]] to control the HTML templates.  Smarty has the ability to create plugins to be intergrated in with the templates If you would like to create a Plugin to enhance VuFind - for example a SQL Query to your ILS Database for additional data on the Record View Page or a new query to the Solr data store - you could simply create a PHP file that lives within the /web/interface/plugins directory.  Please follow the [[http://www.smarty.net/manual/en/plugins.php|Smarty Documentation]] on how to create a plugin. +// This outdated page has been deleted to prevent confusionTo view old content for historical interest, see the "Old Revisionslist below. //
- +
-Here is an arbitrary example of a plugin that interacts with the Solr data store: +
- +
-<code php> +
-filename: /web/interface/plugins/function.showqauthors.php +
-<?php +
-/* +
- * Smarty plugin +
- * ------------------------------------------------------------- +
- * File:     function.showqauthors.php +
- * Type:     function +
- * Name:     Show Q Authors +
- * Purpose:  Runs a SOLR query to find all Q authors +
- * ------------------------------------------------------------- +
- */ +
-function smarty_modifier_showqauthors() +
-+
-    global $solr; +
-     +
-    $solr->raw = false; // Do not return Raw XML data (use array) +
- +
-    $result = $solr->query('authorStr:Q*'); // Run Search +
- +
-    // Create Output +
-    $html = "<ul>\n"+
-    foreach ($result['record'] as $record) { +
-        $html .= '<li>' . $record['author'] . "</li>\n"; +
-    } +
-    $html .= "</ul>\n"; +
- +
-    /Return Output +
-    return $html; +
-+
-?> +
-</code> +
legacy/vufind_1.x_developer_manual/building_a_smarty_plugin.txt · Last modified: 2018/12/19 14:12 by demiankatz