About Features Downloads Getting Started Documentation Events Support GitHub

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

VuFind Documentation

Site Tools

You are here: start » legacy » vufind_1.x_developer_manual » system_classes
Trace:
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.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
system_classes [2010/12/23 17:22] – demiankatzlegacy: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 documents some of the key files and classes.+:!: // This page refers to VuFind 1.x; for information on newer versions, see the current [[:development:architecture]] page. // 
 + 
 +The web/sys folder in VuFind contains a variety of useful classes that may help with the [[legacy:vufind_1.x_developer_manual:building_a_module|building of modules]] and other code changes.  This page documents some of the key files and classes.
  
 ===== Accessing System Classes ===== ===== Accessing System Classes =====
Line 16: Line 18:
  
 This section details the actual files and classes available under web/sys.  This is only an overview, and information of this nature tends to become stale quickly, so look at the code itself for more details and to check for additional modules beyond the ones documented here. This section details the actual files and classes available under web/sys.  This is only an overview, and information of this nature tends to become stale quickly, so look at the code itself for more details and to check for additional modules beyond the ones documented here.
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 25: Line 36:
  
 ==== General Purpose ==== ==== 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 === === 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's logic for connecting to resources like the database, index engine, catalog, etc.
  
 === Counter.php === === Counter.php ===
Line 37: Line 64:
  
 The DataGrid class is an extension of the PEAR Structures_DataGrid class.  As of this writing, it does not appear to be used by any existing code.  //This file has been removed from newer versions of VuFind.// The DataGrid class is an extension of the PEAR Structures_DataGrid class.  As of this writing, it does not appear to be used by any existing code.  //This file has been removed from newer versions of VuFind.//
 +
 +=== HoldLogic.php ===
 +
 +Used to help with formatting (and deciding when to display) hold/recall links.
  
 === Interface.php === === Interface.php ===
Line 57: 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://openlibrary.org/dev|Open Library API]].
 +
 +=== 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 "next/prev" links to navigate a result set from the record page.
  
 === SIP2.php === === SIP2.php ===
Line 69: Line 120:
  
 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 ==== ==== External Content ====
Line 105: Line 160:
  
 The Zebra class provides an interface to the Zebra index server.  //This code became obsolete and has been removed from later versions of VuFind.// The Zebra class provides an interface to the Zebra index server.  //This code became obsolete and has been removed from later versions of VuFind.//
 +
  
 ==== Searching ==== ==== Searching ====
Line 111: Line 167:
  
 The SRU class is an implementation of the [[http://www.loc.gov/standards/sru/|Search/Retrieval via URL (SRU)]] standard. The SRU class is an implementation of the [[http://www.loc.gov/standards/sru/|Search/Retrieval via URL (SRU)]] standard.
 +
 +=== Summon.php ===
 +
 +The Summon class communicates with Serials Solutions [[http://api.summon.serialssolutions.com/help/api/|Summon API]].
  
 === WorldCat.php === === WorldCat.php ===
  
 Worldcat extends the SRU class into an implementation of the [[http://www.worldcat.org/affiliate/tools?atype=wcapi|OCLC WorldCat Search API]]. Worldcat extends the SRU class into an implementation of the [[http://www.worldcat.org/affiliate/tools?atype=wcapi|OCLC WorldCat Search API]].
 +
  
 ==== Session Interface ==== ==== Session Interface ====
  
-These files offer a variety of methods of maintaining a user's session information; the exact class to be included and instantiated is based on the [Session] type setting in web/conf/config.ini.+These files offer a variety of methods of maintaining a user's session information; the exact class to be included and instantiated is based on the [Session] type setting in web/conf/config.ini.  See [[legacy:vufind_1.x_developer_manual:creating_a_session_handler|Creating a Session Handler]] for more details.
  
 === MemcacheSession.php === === MemcacheSession.php ===
legacy/vufind_1.x_developer_manual/system_classes.txt · Last modified: 2018/12/19 14:18 by demiankatz