About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:general_information

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
development:plugins:general_information [2015/12/11 18:53] – ↷ Links adapted because of a move operation demiankatzdevelopment:plugins:general_information [2017/01/06 13:35] – [General Plugin Information] demiankatz
Line 3: Line 3:
 A Zend plugin is any class that is determined at runtime. A Zend plugin is any class that is determined at runtime.
  
-Although VuFind 2.0 provides a wide variety of plugins for a wide variety of purposes, they all follow certain basic patterns:+Although VuFind versions 2.x and later provide a wide variety of plugins for a wide variety of purposes, they all follow certain basic patterns:
  
   * Each family of plugins has a common interface and/or base class.   * Each family of plugins has a common interface and/or base class.
Line 12: Line 12:
 All of the specific details for each plugin type can be found in the [[:development|VuFind 2.x Developer Manual]]. All of the specific details for each plugin type can be found in the [[:development|VuFind 2.x Developer Manual]].
  
 +:!: In some cases [[development:code_generators|code generators]] can be used to automate parts of the procedures described below.
 ===== Creating a New Plugin ===== ===== Creating a New Plugin =====
  
Line 32: Line 33:
 3.) Edit your module's module.config.php so that the service locator configuration for your plugin overrides the default setting from the main VuFind configuration. 3.) Edit your module's module.config.php so that the service locator configuration for your plugin overrides the default setting from the main VuFind configuration.
  
-Starting with VuFind 2.4, you can use [[vufind2:code_generators|code generators]] to automate this process in many cases.+Starting with VuFind 2.4, you can use [[development:code_generators|code generators]] to automate this process in many cases.
  
 ===== Using a Plugin ===== ===== Using a Plugin =====
  
-Most plugins are configured through [[:config.ini]] or other VuFind user configuration files.  To configure a plugin, just use the name that you chose when you registered the plugin in the service locator.  Most plugin configurations will also support a fully-qualified class name if you prefer to bypass service locator configuration, but this is not recommended.+Most plugins are configured through [[configuration:files:config.ini]] or other VuFind user configuration files.  To configure a plugin, just use the name that you chose when you registered the plugin in the service locator.  Most plugin configurations will also support a fully-qualified class name if you prefer to bypass service locator configuration, but this is not recommended.
  
 ===== Accessing Other Plugins / Services ===== ===== Accessing Other Plugins / Services =====
development/plugins/general_information.txt · Last modified: 2020/03/03 20:08 by demiankatz