Core Components

Core Components

System Classes (sys/)

1. Interface.php (sys/Interface.php)

• Purpose: Smarty template engine wrapper
• Extends: Smarty
• Key Methods:
  • __construct() - Sets up template directories, registers functions
  • assign() - Assign variables to templates
  • display() - Render template

2. VFSession.php (sys/VFSession.php)

• Purpose: Session management for VuFind
• Extends: DSession
• Singleton Pattern: VFSession::instance()
• Key Methods:
  • instance() - Get/create session instance
  • (Inherits from DSession: set, get, delete, is_set)

3. DSession.php (sys/DSession.php)

• Purpose: Database-backed session storage
• Storage: MySQL sessions table
• Key Features:
  • UUID-based session IDs
  • HttpOnly secure cookies
  • Automatic session expiration
  • Data serialization
• Key Methods:
  • singleton() - Get/create session
  • set($var, $val) - Store data
  • is_set($var, $val) - Check existence
  • get($var) - Retrieve data
  • delete($var) - Remove data
  • write() - Persist to database
  • kill() - Destroy session

4. Solr.php (sys/Solr.php)

• Purpose: Solr search interface
• Key Methods:
  • __construct($host, $index) - Connect to Solr
  • simplesearch($query) - Execute search
  • standardSearchComponents() - Construct Solr query
  • getRecord($id) - Fetch single record

5. SolrConnection.php (sys/SolrConnection.php)

• Purpose: HTTP client for Solr
• Uses: HTTP_Request2 (PEAR)
• Key Methods:
  • send($url) - Execute HTTP request
  • Response parsing and error handling

6. HTStatus.php (sys/HTStatus.php)

• Purpose: HathiTrust user access status
• Data Source: HTstatus cookie (set by Shibboleth SSO)
• Key Properties:
  • $logged_in - Boolean
  • $institution_code - Institution identifier
  • $auth_type - Authentication method
  • $emergency_access - Emergency access flag
  • $mapped_institution_code - Mapped institution for consortia

7. GeoIP.php (sys/GeoIP.php)

• Purpose: IP geolocation
• Database: MaxMind GeoIP2
• Key Methods:
  • ip_to_iso($ip) - Get country code from IP

8. RecordUtils.php (services/Record/RecordUtils.php)

• Purpose: Record-specific business logic
• Key Methods:
  • Access determination
  • Rights interpretation
  • Format detection
  • URL generation

Service Controllers (services/)

Pattern: Action Class

All controllers (service/Record/Record.php and service/Search/Home.php) extend base Action class (if it existed):

class Home extends Action { // `Search/Home.php`
    function setup() {
        // Initialize dependencies
    }

    function launch() {
        // Main entry point
    }

    // Additional methods for business logic
}

services/Search/

• Home.php - Search results page
• Advanced.php - Advanced search form
• Reserves.php - Course reserves
• Suggest.php - Autocomplete suggestions
• SearchExport.php - RSS feed generation
• Error.php - Error action

services/Record/

• Home.php - Record display
• Export.php - Citation export formats
• RecordUtils.php - Record utility functions . . .