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 revisionLast revisionBoth sides next revision | ||
system_classes [2010/12/22 19:50] – demiankatz | legacy:vufind_1.x_developer_manual:system_classes [2015/12/10 18:18] – ↷ Links adapted because of a move operation 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 refers to VuFind 1.x; for information on newer versions, see the current [[: |
+ | |||
+ | The web/sys folder in VuFind contains a variety of useful classes that may help with the [[legacy: | ||
===== Accessing System Classes ===== | ===== Accessing System Classes ===== | ||
Line 16: | Line 18: | ||
This section details the actual files and classes available under web/ | This section details the actual files and classes available under web/ | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
Line 26: | Line 37: | ||
==== General Purpose ==== | ==== General Purpose ==== | ||
- | === Amazon.php === | + | === Autoloader.php === |
- | The AWS_Request | + | Not currently formatted as a class, this file contains |
+ | |||
+ | === 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 === | === CitationBuilder.php === | ||
The CitationBuilder class is used to build APA and MLA citations for use in the VuFind interface. | 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 === | === Counter.php === | ||
Line 41: | Line 64: | ||
The DataGrid class is an extension of the PEAR Structures_DataGrid class. | 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 === | === Interface.php === | ||
Line 61: | Line 88: | ||
This file contains wrapper classes used for sending email and text messages from within VuFind. | 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 === | === SIP2.php === | ||
Line 74: | Line 121: | ||
This module contains the UserAccount class that handles user authentication by a variety of methods (method used varies based on config.ini settings). | 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 ==== | ==== Index Interface ==== | ||
Line 97: | Line 160: | ||
The Zebra class provides an interface to the Zebra index server. | The Zebra class provides an interface to the Zebra index server. | ||
+ | |||
==== Searching ==== | ==== Searching ==== | ||
Line 103: | Line 167: | ||
The SRU class is an implementation of the [[http:// | The SRU class is an implementation of the [[http:// | ||
+ | |||
+ | === Summon.php === | ||
+ | |||
+ | The Summon class communicates with Serials Solutions [[http:// | ||
=== WorldCat.php === | === WorldCat.php === | ||
Worldcat extends the SRU class into an implementation of the [[http:// | Worldcat extends the SRU class into an implementation of the [[http:// | ||
+ | |||
==== Session Interface ==== | ==== Session Interface ==== | ||
- | These files offer a variety of methods of maintaining a user's session information; | + | These files offer a variety of methods of maintaining a user's session information; |
=== MemcacheSession.php === | === MemcacheSession.php === |
legacy/vufind_1.x_developer_manual/system_classes.txt · Last modified: 2018/12/19 14:18 by demiankatz