Warning: This page has not been updated in over over a year and may be outdated or deprecated.
legacy:vufind_1.x_developer_manual:building_a_module
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
legacy:vufind_1.x_developer_manual:building_a_module [2015/12/11 20:28] – ↷ Links adapted because of a move operation demiankatz | legacy:vufind_1.x_developer_manual:building_a_module [2018/12/19 14:13] (current) – demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Building A Module ====== | ====== Building A Module ====== | ||
- | :!: // This page refers | + | // This outdated |
- | + | ||
- | ===== Current Modules ===== | + | |
- | + | ||
- | ^ Module ^ Notes ^ | + | |
- | | Search | Provides core search functionality | | + | |
- | | Record | Provides a web page for each record | | + | |
- | | MyResearch | A portal for users to save and organize resources in a central location | | + | |
- | | Help | Provides context sensitive help for the users | | + | |
- | | Author | Provides a web page for each author and harvests biographical information from Wikipedia | | + | |
- | | OAI | Provides an OAI content | + | |
- | + | ||
- | + | ||
- | + | ||
- | ===== Building Custom Modules ===== | + | |
- | + | ||
- | ==== Back End Logic ==== | + | |
- | + | ||
- | Modules are very easy to build. All you need to do to integrate your code with the system is to create a directory under the web/ | + | |
- | + | ||
- | A variety of utility classes exist in the web/sys directory. | + | |
- | + | ||
- | Your module needs to make use of [[legacy: | + | |
- | + | ||
- | Here is a shell for an action class: | + | |
- | <code php> | + | |
- | <?php | + | |
- | require_once ' | + | |
- | class MyAction extends Action | + | |
- | { | + | |
- | function launch() | + | |
- | { | + | |
- | global $interface; | + | |
- | global $configArray; | + | |
- | + | ||
- | $interface-> | + | |
- | $interface-> | + | |
- | + | ||
- | | + | |
- | + | ||
- | $interface-> | + | |
- | } | + | |
- | } | + | |
- | ?> | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | ==== Front End Presentation ==== | + | |
- | + | ||
- | In order to display the output of your new module, you also have to create a Smarty template file in the web/ | + | |
- | + | ||
- | <code html> | + | |
- | < | + | |
- | </ | + | |
- | + | ||
- | See the [[legacy: | + | |
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
legacy/vufind_1.x_developer_manual/building_a_module.txt · Last modified: 2018/12/19 14:13 by demiankatz