Warning: This page has not been updated in over over a year and may be outdated or deprecated.
legacy:vufind_1.x_developer_manual:system_classes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
legacy:vufind_1.x_developer_manual:system_classes [2015/12/10 18:10] – ↷ Page moved from system_classes to legacy:vufind_1.x_developer_manual:system_classes demiankatz | legacy:vufind_1.x_developer_manual:system_classes [2018/12/19 14:18] (current) – demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== System Classes ====== | ====== System Classes ====== | ||
- | The web/sys folder in VuFind contains a variety of useful classes that may help with the [[building a module|building of modules]] and other code changes. This page documents some of the key files and classes. | + | // This outdated page has been deleted to prevent confusion; for current documentation, |
- | ===== Accessing System Classes ===== | ||
- | |||
- | To use any of the system classes listed on this page, just include this line at the top of your PHP code: | ||
- | |||
- | <code php> | ||
- | require_once ' | ||
- | </ | ||
- | |||
- | Where " | ||
- | |||
- | ===== Available Files ===== | ||
- | |||
- | This section details the actual files and classes available under web/ | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ==== General Purpose ==== | ||
- | |||
- | === Autoloader.php === | ||
- | |||
- | Not currently formatted as a class, this file contains a single function for autoloading classes. | ||
- | |||
- | === Cart_Model.php === | ||
- | |||
- | Used for storing collections of IDs selected by the user while browsing result lists (work in progress as of this writing). | ||
- | |||
- | === CitationBuilder.php === | ||
- | |||
- | The CitationBuilder class is used to build APA and MLA citations for use in the VuFind interface. | ||
- | |||
- | === ConfigArray.php === | ||
- | |||
- | Not currently formatted as a class, this module contains an assortment of stand-alone functions for dealing with configuration files. | ||
- | |||
- | === ConnectionManager.php === | ||
- | |||
- | Introduced in VuFind 1.1, this class centralizes VuFind' | ||
- | |||
- | === Counter.php === | ||
- | |||
- | This is a simple class for maintaining an incremental counter. | ||
- | |||
- | === Datagrid.php === | ||
- | |||
- | The DataGrid class is an extension of the PEAR Structures_DataGrid class. | ||
- | |||
- | === HoldLogic.php === | ||
- | |||
- | Used to help with formatting (and deciding when to display) hold/recall links. | ||
- | |||
- | === Interface.php === | ||
- | |||
- | This file defines the UInterface class, an extension of the base [[http:// | ||
- | |||
- | === ISBN.php === | ||
- | |||
- | Perform ISBN validation and conversion between 10/13-digit formats. | ||
- | |||
- | === Language.php === | ||
- | |||
- | The Language class contains methods for dealing with ISO 639-2 language codes. | ||
- | |||
- | === Logger.php === | ||
- | |||
- | The Logger class is a wrapper around the PEAR Log class which allows messages to be logged by a variety of mechanisms configurable through web/ | ||
- | |||
- | === Mailer.php === | ||
- | |||
- | This file contains wrapper classes used for sending email and text messages from within VuFind. | ||
- | |||
- | === OpenLibraryUtils.php === | ||
- | |||
- | Utility functions for interfacing with the [[http:// | ||
- | |||
- | === Oracle_Connection.php === | ||
- | |||
- | Database wrapper for Oracle access (currently used only by the Virtua ILS driver; not recommended for other purposes at this time). | ||
- | |||
- | === Pager.php === | ||
- | |||
- | The VuFindPager class is a wrapper around the PEAR Pager which instantiates a Pager object with VuFind-specific defaults in place. | ||
- | |||
- | === Proxy_Request.php === | ||
- | |||
- | An extension of the PEAR HTTP_Request class that allows VuFind to use a proxy server when necessary. | ||
- | |||
- | === ResultScroller.php === | ||
- | |||
- | This class manages the data necessary to maintain " | ||
- | |||
- | === SIP2.php === | ||
- | |||
- | The sip2 class implement' | ||
- | |||
- | === Translator.php === | ||
- | |||
- | The I18N_Translator class is used (via a custom Smarty plug-in) to translate text used by the presentation layer into multiple languages. | ||
- | |||
- | === User.php === | ||
- | |||
- | This module contains the UserAccount class that handles user authentication by a variety of methods (method used varies based on config.ini settings). | ||
- | |||
- | === VuFindDate.php === | ||
- | |||
- | Either converts date and times from a defined time string to a universal display format or from the universal display format to a requested format (often used by ILS drivers for normalization of time representation). | ||
- | |||
- | ==== External Content ==== | ||
- | |||
- | === Amazon.php === | ||
- | |||
- | The AWS_Request class in this module provides a simple interface to Amazon Web Services (used for obtaining cover images and reviews). | ||
- | |||
- | === Excerpts.php === | ||
- | |||
- | The ExternalExcerpts class is used for loading book excerpts from third-party APIs. | ||
- | |||
- | === Reviews.php === | ||
- | |||
- | The ExternalReviews class is used for loading book reviews from third-party APIs. | ||
- | |||
- | ==== Index Interface ==== | ||
- | |||
- | === IndexEngine.php === | ||
- | |||
- | This file contains the abstract IndexEngine interface implemented by the Solr and Zebra classes. | ||
- | |||
- | === Solr.php === | ||
- | |||
- | The Solr class provides an interface to the Solr index server. | ||
- | |||
- | === SolrStats.php === | ||
- | |||
- | SolrStats is an extension of the Solr class repurposed for storing information on VuFind' | ||
- | |||
- | === SolrUtils.php === | ||
- | |||
- | A collection of static utility methods useful in processing Solr queries. | ||
- | |||
- | === Zebra.php === | ||
- | |||
- | The Zebra class provides an interface to the Zebra index server. | ||
- | |||
- | |||
- | ==== Searching ==== | ||
- | |||
- | === SRU.php === | ||
- | |||
- | The SRU class is an implementation of the [[http:// | ||
- | |||
- | === Summon.php === | ||
- | |||
- | The Summon class communicates with Serials Solutions [[http:// | ||
- | |||
- | === WorldCat.php === | ||
- | |||
- | Worldcat extends the SRU class into an implementation of the [[http:// | ||
- | |||
- | |||
- | ==== Session Interface ==== | ||
- | |||
- | These files offer a variety of methods of maintaining a user's session information; | ||
- | |||
- | === MemcacheSession.php === | ||
- | |||
- | The MemcacheSession class uses memcache to maintain sessions. | ||
- | |||
- | === MySQLSession.php === | ||
- | |||
- | The MySQLSession class uses the MySQL database to maintain sessions. | ||
- | |||
- | === SessionInterface.php === | ||
- | |||
- | SessionInterface.php is an abstract base class for the other session handlers. | ||
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
legacy/vufind_1.x_developer_manual/system_classes.1449771007.txt.gz · Last modified: 2015/12/10 18:10 by demiankatz