VuFind API Documentation

Controller

Packages

Plugins

Interfaces, Classes, Traits and Enums

ApiInterface
Additional functionality for API controllers.
Version
Version check utility
AbstractBase
VuFind controller base class (defines some methods that can be shared by other controllers).
AbstractBaseFactory
Generic controller factory.
AbstractBaseWithConfigFactory
Generic controller factory (with config injection).
AbstractRecord
VuFind Record Controller
AbstractSearch
VuFind Search Controller
AbstractSolrSearch
AbstractSearch with Solr-specific features added.
AjaxController
This controller handles global AJAX functionality
AjaxControllerFactory
Ajax controller factory.
AlmaController
Alma controller, mainly for webhooks.
AlphabrowseController
AlphabrowseController Class
AuthorController
Author Search Options
AuthorityController
Authority Controller
AuthorityRecordController
Authority Record Controller
BlenderController
Blended Search Controller
BrowseController
BrowseController Class
BrowZineController
BrowZine Controller
CartController
Book Bag / Bulk Action Controller
CartControllerFactory
Cart controller factory.
ChannelsController
Channels Class
ChannelsControllerFactory
Channels controller factory.
CheckoutsController
Controller for the user checkouts area.
CheckoutsControllerFactory
Checkouts controller factory.
CollectionController
Collection Controller
CollectionsController
Collections Controller
CombinedController
Redirects the user to the appropriate default VuFind action.
ConfirmController
Redirects the user to the appropriate VuFind action.
ContentController
Controller for mostly static pages that doesn't fall under any particular function.
CoverController
Generates covers for book entries
CoverControllerFactory
Cover controller factory.
EdsController
EDS Controller
EdsrecordController
EDS Record Controller
EITController
EIT Controller
EITrecordController
EIT Record Controller Largely copied from Summon Record Controller
EPFController
EPF Controller
EPFrecordController
EPF Record Controller
ErrorController
Error Controller
ExternalAuthController
External Authentication/Authorization Controller
FeedbackController
Controller for configurable forms (feedback etc).
HelpController
Home action for Help module
HierarchyController
Hierarchy Controller
HoldsController
Controller for the user holds area.
HoldsControllerFactory
Holds controller factory.
IndexController
Redirects the user to the appropriate default VuFind action.
IndexControllerFactory
Index controller factory.
InstallController
Class controls VuFind auto-configuration.
LibGuidesAZController
LibGuides A-Z Databases Controller
LibGuidesController
LibGuides Controller
LibraryCardsController
Controller for the library card functionality.
MissingrecordController
Missing Record Controller
MyResearchController
Controller for the user account area.
MyResearchControllerFactory
MyResearch controller factory.
OaiController
OAIController Class
OAuth2Controller
OAuth2 Controller
OAuth2ControllerFactory
OAuth2 controller factory.
OverdriveController
Overdrive Controller supports actions for Overdrive Integration
Pazpar2Controller
Pazpar2 Controller
Pazpar2recordController
Pazpar2 Record Controller
PrimoController
Primo Central Controller
PrimorecordController
Primo Central Record Controller
QRCodeController
Generates qrcodes
QRCodeControllerFactory
QRCode controller factory.
RecordController
Record Controller
RecordsController
Records Controller
RelaisController
Relais Controller
Search2collectionController
Collection Controller
Search2Controller
Search2 Controller
Search2recordController
Search2 Record Controller
SearchController
Redirects the user to the appropriate default VuFind action.
ShibbolethLogoutNotificationController
Handles Shibboleth back-channel logout notifications.
ShortlinkController
Short link controller
SimulatedSSOController
Simulated Single Sign-On Controller
SummonController
Summon Controller
SummonrecordController
Summon Record Controller
TagController
Tag Controller
UpgradeController
Class controls VuFind upgrading.
UpgradeControllerFactory
Upgrade controller factory.
WebController
Web Controller
WorldcatController
WorldCat Controller
WorldcatrecordController
WorldCat Record Controller
AbstractAdmin
VuFind Admin Controller Base
AdminController
Class controls VuFind administration.
ConfigController
Class controls VuFind administration.
MaintenanceController
Class helps maintain database
OverdriveController
Class controls distribution of tags and resource tags.
SocialstatsController
Class controls VuFind social statistical data.
TagsController
Class controls distribution of tags and resource tags.
AdminApiController
Admin Api Controller
AdminApiControllerFactory
Factory for AdminApiController.
ApiController
API Controller
ApiControllerFactory
Factory for ApiController.
Search2ApiControllerFactory
Factory for Search2ApiController.
SearchApiControllerFactory
Factory for SearchApiController.
WebApiControllerFactory
Factory for WebApiController.
DevtoolsController
Development Tools Controller
MaintenanceControllerFactory
Maintenance controller factory.
AjaxResponseTrait
Trait to allow AJAX response generation.
HoldsTrait
Holds trait (for subclasses of AbstractRecord)
ILLRequestsTrait
ILL trait (for subclasses of AbstractRecord)
StorageRetrievalRequestsTrait
Storage retrieval requests trait (for subclasses of AbstractRecord)
ApiTrait
Additional functionality for API controllers.

Search results