-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathislandora_iiif.api.php
123 lines (117 loc) · 4.1 KB
/
islandora_iiif.api.php
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
<?php
/**
* @file
* Hooks provided by Islandora IIIF.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Describe "backends" which might be selected between.
*
* We have a number of different mechanisms which might be used to generate
* lists of PIDs and basic metadata belonging to given collections.
*
* @return array
* Should return an associative array mapping unique (module-prefixed,
* preferably) keys to associative arrays containing:
* - title: A human-readable title for the backend.
* - callable: A PHP callable to call for this backend, implementing
* callback_islandora_iiif_manifest_query_backends().
* - file: An optional file to load before attempting to call the callable.
*/
function hook_islandora_iiif_collection_query_backends() {
$a_callable = function ($object, $page, $limit) {
// Do something to get the total number of objects and this page return
// them.
$iiif = array('islandora:1' => 'Object one', 'islandora:2' => 'Second object');
// Could be more of course.
$total = count($iiif);
return array($total, $iiif);
};
return array(
'awesome_backend' => array(
'title' => t('Awesome IIIF Backend'),
'callable' => $a_callable,
),
);
}
/**
* Generate a total count and paged list of PIDs.
*
* Callback for hook_islandora_basic_collection_query_backends().
*
* @param AbstractObject $object
* A collection object for which to obtain members.
* @param int $page
* The page of PIDs for which to query.
* @param int $limit
* The number of PIDs for which to query.
*
* @return array
* An array containing:
* - An integer representing the total number of objects in the collection.
* - An associative array containing up to $limit strings with keys containing object PIDs
* belonging to the given collection and label as value.
*/
function callback_iiif_collection_query_backends(AbstractObject $object, $page, $limit) {
// Do something to get the total number of objects and this page return
// them.
$iiif = array('islandora:1' => 'Object one', 'islandora:2' => 'Second object');
return array($total, $iiif);
}
/**
* Describe "backends" which might be selected between.
*
* We have a number of different mechanisms which might be used to generate
* lists of PIDs and basic metadata belonging to given collections.
*
* @return array
* Should return an associative array mapping unique (module-prefixed,
* preferably) keys to associative arrays containing:
* - title: A human-readable title for the backend.
* - callable: A PHP callable to call for this backend, implementing
* callback_islandora_iiif_manifest_query_backends().
* - file: An optional file to load before attempting to call the callable.
*/
function hook_islandora_iiif_manifest_query_backends() {
$a_callable = function ($object, $page, $limit) {
// Do something to get the total number of objects and this page return
// them.
$iiif = array('islandora:1' => 'Object one', 'islandora:2' => 'Second object');
// Could be more of course.
$total = count($iiif);
return array($total, $iiif);
};
return array(
'awesome_backend' => array(
'title' => t('Awesome IIIF Backend'),
'callable' => $a_callable,
),
);
}
/**
* Generate a total count and paged list of PIDs.
*
* Callback for hook_islandora_basic_collection_query_backends().
*
* @param AbstractObject $object
* A collection object for which to obtain members.
* @param int $page
* The page of PIDs for which to query.
* @param int $limit
* The number of PIDs for which to query.
*
* @return array
* An array containing:
* - An integer representing the total number of objects in the collection.
* - An associative array containing up to $limit strings with keys containing object PIDs
* belonging to the given collection and label as value.
*/
function callback_iiif_manifest_query_backends(AbstractObject $object, $page, $limit) {
// Do something to get the total number of objects and this page return
// them.
$iiif = array('islandora:1' => 'Object one', 'islandora:2' => 'Second object');
return array($total, $iiif);
}