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:content_provider_components

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
development:plugins:content_provider_components [2018/03/14 18:01] demiankatzdevelopment:plugins:content_provider_components [2023/11/09 22:01] (current) demiankatz
Line 1: Line 1:
 ====== Content Provider Components ====== ====== Content Provider Components ======
  
-Starting in VuFind 2.3, content-loading capabilities (for retrieving cover images, reviews, etc. from third-party APIs) were significantly refactored to rely on plugins.+Starting in VuFind® 2.3, content-loading capabilities (for retrieving cover images, reviews, etc. from third-party APIs) were significantly refactored to rely on plugins.
  
 ===== Content Loader Plugin Details ===== ===== Content Loader Plugin Details =====
Line 9: Line 9:
 **Default Namespace:** \VuFind\Content **Default Namespace:** \VuFind\Content
  
-**Base Class:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Content/Loader.php|\VuFind\Content\Loader]]+**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Content/Loader.php|\VuFind\Content\Loader]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content']
  
-**Service Manager Name for Service Locator:** VuFind\ContentPluginManager (VuFind 2.x-4.x), VuFind\Content\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\ContentPluginManager (VuFind® 2.x-4.x), VuFind\Content\PluginManager (VuFind® 5.0+)
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ===== Content-Specific Plugin Details ===== ===== Content-Specific Plugin Details =====
Line 26: Line 26:
 **Default Namespace:** \VuFind\Content\AuthorNotes **Default Namespace:** \VuFind\Content\AuthorNotes
  
-**Base Class:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]+**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_authornotes'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_authornotes']
  
-**Service Manager Name for Service Locator:** VuFind\ContentAuthorNotesPluginManager (VuFind 2.x-4.x), VuFind\Content\AuthorNotes\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\ContentAuthorNotesPluginManager (VuFind® 2.x-4.x), VuFind\Content\AuthorNotes\PluginManager (VuFind® 5.0+)
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ==== Covers ==== ==== Covers ====
Line 40: Line 40:
 **Default Namespace:** \VuFind\Content\Covers **Default Namespace:** \VuFind\Content\Covers
  
-**Base Class:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Content/AbstractCover.php|\VuFind\Content\AbstractCover]]+**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Content/AbstractCover.php|\VuFind\Content\AbstractCover]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_covers'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_covers']
  
-**Service Manager Name for Service Locator:** VuFind\ContentCoversPluginManager (VuFind 2.x-4.x), VuFind\Content\Covers\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\ContentCoversPluginManager (VuFind® 2.x-4.x), VuFind\Content\Covers\PluginManager (VuFind® 5.0+)
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ==== Excerpts ==== ==== Excerpts ====
Line 54: Line 54:
 **Default Namespace:** \VuFind\Content\Excerpts **Default Namespace:** \VuFind\Content\Excerpts
  
-**Base Class:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]+**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_excerpts'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_excerpts']
  
-**Service Manager Name for Service Locator:** VuFind\ContentExcerptsPluginManager (VuFind 2.x-4.x), VuFind\Content\Excerpts\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\ContentExcerptsPluginManager (VuFind® 2.x-4.x), VuFind\Content\Excerpts\PluginManager (VuFind® 5.0+)
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ==== Reviews ==== ==== Reviews ====
Line 68: Line 68:
 **Default Namespace:** \VuFind\Content\Reviews **Default Namespace:** \VuFind\Content\Reviews
  
-**Base Class:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]+**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_reviews'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_reviews']
  
-**Service Manager Name for Service Locator:** VuFind\ContentReviewsPluginManager (VuFind 2.x-4.x), VuFind\Content\Reviews\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\ContentReviewsPluginManager (VuFind® 2.x-4.x), VuFind\Content\Reviews\PluginManager (VuFind® 5.0+)
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ==== Summaries ==== ==== Summaries ====
  
-// These plugins retrieve summaries of a particular title. :!: Added in VuFind 5.0. //+// These plugins retrieve summaries of a particular title. :!: Added in VuFind® 5.0. //
  
 **Default Namespace:** \VuFind\Content\Summaries **Default Namespace:** \VuFind\Content\Summaries
  
-**Base Class:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]+**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_summaries'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_summaries']
  
-**Service Manager Name for Service Locator:** VuFind\ContentSummariesPluginManager (VuFind 2.x-4.x), VuFind\Content\Summaries\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\ContentSummariesPluginManager (VuFind® 2.x-4.x), VuFind\Content\Summaries\PluginManager (VuFind® 5.0+)
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ==== Tables of Contents ==== ==== Tables of Contents ====
  
-// These plugins retrieve the table of contents for a particular title. :!: Added in VuFind 5.0. //+// These plugins retrieve the table of contents for a particular title. :!: Added in VuFind® 5.0. //
  
 **Default Namespace:** \VuFind\Content\TOC **Default Namespace:** \VuFind\Content\TOC
  
-**Base Class:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]+**Base Class:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Content/AbstractBase.php|\VuFind\Content\AbstractBase]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_toc'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['content_toc']
  
-**Service Manager Name for Service Locator:** VuFind\ContentTOCPluginManager (VuFind 2.x-4.x), VuFind\Content\TOC\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\ContentTOCPluginManager (VuFind® 2.x-4.x), VuFind\Content\TOC\PluginManager (VuFind® 5.0+)
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
development/plugins/content_provider_components.1521050498.txt.gz · Last modified: 2018/03/14 18:01 by demiankatz