-
Notifications
You must be signed in to change notification settings - Fork 0
/
interfaces.html
402 lines (393 loc) · 24.7 KB
/
interfaces.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Interfaces | API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
<script src="js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="doctum.js"></script>
<script async defer src="js/bootstrap.min.js"></script>
<script async defer src="js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="interfaces" data-name="" data-root-path="" data-search-index-url="doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">API</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="classes.html">Classes</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="interfaces.html">Interfaces</a></li>
<li><a href="traits.html">Traits</a></li>
<li><a href="doc-index.html">Index</a></li>
<li><a href="search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div id="page-content"> <div class="page-header">
<h1>Interfaces</h1>
</div>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<em><a href="KnihovnyCz/Service/LinkServiceInterface.html"><abbr title="KnihovnyCz\Service\LinkServiceInterface">LinkServiceInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface LinkServiceInterface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindApi/Controller/ApiInterface.html"><abbr title="VuFindApi\Controller\ApiInterface">ApiInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Additional functionality for API controllers.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Backend/BackendInterface.html"><abbr title="VuFindSearch\Backend\BackendInterface">BackendInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Search backend interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Backend/Solr/Document/DocumentInterface.html"><abbr title="VuFindSearch\Backend\Solr\Document\DocumentInterface">DocumentInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for Solr document classes</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Backend/Solr/QueryBuilderInterface.html"><abbr title="VuFindSearch\Backend\Solr\QueryBuilderInterface">QueryBuilderInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>SOLR QueryBuilder interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Backend/Solr/Record/SerializableRecordInterface.html"><abbr title="VuFindSearch\Backend\Solr\Record\SerializableRecordInterface">SerializableRecordInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>SOLR serializable record interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Backend/Solr/SimilarBuilderInterface.html"><abbr title="VuFindSearch\Backend\Solr\SimilarBuilderInterface">SimilarBuilderInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>SOLR SimilarBuilder interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Command/CommandInterface.html"><abbr title="VuFindSearch\Command\CommandInterface">CommandInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Command interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Exception/ExceptionInterface.html"><abbr title="VuFindSearch\Exception\ExceptionInterface">ExceptionInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Marker interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Feature/GetIdsInterface.html"><abbr title="VuFindSearch\Feature\GetIdsInterface">GetIdsInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Optional backend feature: Get identifiers of records.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Feature/RandomInterface.html"><abbr title="VuFindSearch\Feature\RandomInterface">RandomInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Random record retrieval feature interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Feature/RetrieveBatchInterface.html"><abbr title="VuFindSearch\Feature\RetrieveBatchInterface">RetrieveBatchInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Optional backend feature: retrieve batch of records.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Feature/SimilarInterface.html"><abbr title="VuFindSearch\Feature\SimilarInterface">SimilarInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>MLT feature interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Feature/WorkExpressionsInterface.html"><abbr title="VuFindSearch\Feature\WorkExpressionsInterface">WorkExpressionsInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Work expressions feature interface definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Query/QueryInterface.html"><abbr title="VuFindSearch\Query\QueryInterface">QueryInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Common methods that must be shared by all query objects.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Response/RecordCollectionFactoryInterface.html"><abbr title="VuFindSearch\Response\RecordCollectionFactoryInterface">RecordCollectionFactoryInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Search backend record collection factory interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Response/RecordCollectionInterface.html"><abbr title="VuFindSearch\Response\RecordCollectionInterface">RecordCollectionInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for backend responses to a search() operation.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindSearch/Response/RecordInterface.html"><abbr title="VuFindSearch\Response\RecordInterface">RecordInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Record interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFindTheme/GeneratorInterface.html"><abbr title="VuFindTheme\GeneratorInterface">GeneratorInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface shared by theme and mixin generator classes.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/AjaxHandler/AjaxHandlerInterface.html"><abbr title="VuFind\AjaxHandler\AjaxHandlerInterface">AjaxHandlerInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>AJAX handler interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Auth/Shibboleth/ConfigurationLoaderInterface.html"><abbr title="VuFind\Auth\Shibboleth\ConfigurationLoaderInterface">ConfigurationLoaderInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Configuration loader interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Autocomplete/AutocompleteInterface.html"><abbr title="VuFind\Autocomplete\AutocompleteInterface">AutocompleteInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Autocomplete Plug-In Interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/ChannelProvider/ChannelProviderInterface.html"><abbr title="VuFind\ChannelProvider\ChannelProviderInterface">ChannelProviderInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Channel provider interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/ContentBlock/ContentBlockInterface.html"><abbr title="VuFind\ContentBlock\ContentBlockInterface">ContentBlockInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Content block interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Cover/Layer/LayerInterface.html"><abbr title="VuFind\Cover\Layer\LayerInterface">LayerInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Cover layer interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Db/Table/DbTableAwareInterface.html"><abbr title="VuFind\Db\Table\DbTableAwareInterface">DbTableAwareInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Marker interface for classes that depend on the \VuFind\Db\Table\PluginManager</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/DoiLinker/DoiLinkerInterface.html"><abbr title="VuFind\DoiLinker\DoiLinkerInterface">DoiLinkerInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>DOI linker interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Exception/HttpStatusInterface.html"><abbr title="VuFind\Exception\HttpStatusInterface">HttpStatusInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for exceptions that should trigger specific HTTP status codes
when unhandled.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Exception/SeverityLevelInterface.html"><abbr title="VuFind\Exception\SeverityLevelInterface">SeverityLevelInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for exceptions to indicate the logging severity level.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Form/Handler/HandlerInterface.html"><abbr title="VuFind\Form\Handler\HandlerInterface">HandlerInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface HandlerInterface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Http/CachingDownloaderAwareInterface.html"><abbr title="VuFind\Http\CachingDownloaderAwareInterface">CachingDownloaderAwareInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Lightweight caching downloader aware marker interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/I18n/HasSorterInterface.html"><abbr title="VuFind\I18n\HasSorterInterface">HasSorterInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface SortingInterface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/I18n/SorterInterface.html"><abbr title="VuFind\I18n\SorterInterface">SorterInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface SorterInterface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/I18n/TranslatableStringInterface.html"><abbr title="VuFind\I18n\TranslatableStringInterface">TranslatableStringInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for translatable strings.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/I18n/Translator/TranslatorAwareInterface.html"><abbr title="VuFind\I18n\Translator\TranslatorAwareInterface">TranslatorAwareInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Lightweight translator aware marker interface (used as an alternative to
\Laminas\I18n\Translator\TranslatorAwareInterface, which requires an excessive
number of methods to be implemented).</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/ILS/Driver/DriverInterface.html"><abbr title="VuFind\ILS\Driver\DriverInterface">DriverInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Catalog Specific Driver Class</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/MetadataVocabulary/MetadataVocabularyInterface.html"><abbr title="VuFind\MetadataVocabulary\MetadataVocabularyInterface">MetadataVocabularyInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Metadata vocabulary interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Recommend/RecommendInterface.html"><abbr title="VuFind\Recommend\RecommendInterface">RecommendInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Search Recommendations Interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/RecordDriver/Feature/PreviousUniqueIdInterface.html"><abbr title="VuFind\RecordDriver\Feature\PreviousUniqueIdInterface">PreviousUniqueIdInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface to support "previous unique ID" behavior.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/RecordDriver/Feature/VersionAwareInterface.html"><abbr title="VuFind\RecordDriver\Feature\VersionAwareInterface">VersionAwareInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Version aware marker interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/RecordTab/TabInterface.html"><abbr title="VuFind\RecordTab\TabInterface">TabInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Record tab interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Record/Cache/RecordCacheAwareInterface.html"><abbr title="VuFind\Record\Cache\RecordCacheAwareInterface">RecordCacheAwareInterface</abbr></a></em>
</div>
<div class="col-md-6">RecordCacheAwareInterface</div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Record/FallbackLoader/FallbackLoaderInterface.html"><abbr title="VuFind\Record\FallbackLoader\FallbackLoaderInterface">FallbackLoaderInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Record fallback loader interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Related/RelatedInterface.html"><abbr title="VuFind\Related\RelatedInterface">RelatedInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Related Records Interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Resolver/Driver/DriverInterface.html"><abbr title="VuFind\Resolver\Driver\DriverInterface">DriverInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Resolver Specific Driver Class</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Role/PermissionProvider/PermissionProviderInterface.html"><abbr title="VuFind\Role\PermissionProvider\PermissionProviderInterface">PermissionProviderInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Permission provider interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/SMS/SMSInterface.html"><abbr title="VuFind\SMS\SMSInterface">SMSInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for SMS classes.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Search/Base/HierarchicalFacetHelperInterface.html"><abbr title="VuFind\Search\Base\HierarchicalFacetHelperInterface">HierarchicalFacetHelperInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Hierarchical facet helper interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Session/HandlerInterface.html"><abbr title="VuFind\Session\HandlerInterface">HandlerInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Session handler interface</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Sitemap/Plugin/GeneratorPluginInterface.html"><abbr title="VuFind\Sitemap\Plugin\GeneratorPluginInterface">GeneratorPluginInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for sitemap generator plugins</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/UrlShortener/UrlShortenerInterface.html"><abbr title="VuFind\UrlShortener\UrlShortenerInterface">UrlShortenerInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>URL shortener interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="VuFind/Validator/CsrfInterface.html"><abbr title="VuFind\Validator\CsrfInterface">CsrfInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Interface for Csrf validator</p></div>
</div>
</div>
</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
</div>
</body>
</html>