Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like GenericSparql often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use GenericSparql, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
6 | class GenericSparql { |
||
7 | /** |
||
8 | * A SPARQL Client eg. an EasyRDF instance. |
||
9 | * @property EasyRdf\Sparql\Client $client |
||
10 | */ |
||
11 | protected $client; |
||
12 | /** |
||
13 | * Graph uri. |
||
14 | * @property string $graph |
||
15 | */ |
||
16 | protected $graph; |
||
17 | /** |
||
18 | * A SPARQL query graph part template. |
||
19 | * @property string $graph |
||
20 | */ |
||
21 | protected $graphClause; |
||
22 | /** |
||
23 | * Model instance. |
||
24 | * @property Model $model |
||
25 | */ |
||
26 | protected $model; |
||
27 | |||
28 | /** |
||
29 | * Cache used to avoid expensive shorten() calls |
||
30 | * @property array $qnamecache |
||
31 | */ |
||
32 | private $qnamecache = array(); |
||
33 | |||
34 | /** |
||
35 | * Requires the following three parameters. |
||
36 | * @param string $endpoint SPARQL endpoint address. |
||
37 | * @param string|null $graph Which graph to query: Either an URI, the special value "?graph" |
||
38 | * to use the default graph, or NULL to not use a GRAPH clause. |
||
39 | * @param object $model a Model instance. |
||
40 | */ |
||
41 | public function __construct($endpoint, $graph, $model) { |
||
42 | $this->graph = $graph; |
||
43 | $this->model = $model; |
||
44 | |||
45 | // create the EasyRDF SPARQL client instance to use |
||
46 | $this->initializeHttpClient(); |
||
47 | $this->client = new EasyRdf\Sparql\Client($endpoint); |
||
48 | |||
49 | // set graphClause so that it can be used by all queries |
||
50 | if ($this->isDefaultEndpoint()) // default endpoint; query any graph (and catch it in a variable) |
||
51 | { |
||
52 | $this->graphClause = "GRAPH $graph"; |
||
53 | } elseif ($graph !== null) // query a specific graph |
||
54 | { |
||
55 | $this->graphClause = "GRAPH <$graph>"; |
||
56 | } else // query the default graph |
||
57 | { |
||
58 | $this->graphClause = ""; |
||
59 | } |
||
60 | |||
61 | } |
||
62 | |||
63 | /** |
||
64 | * Returns prefix-definitions for a query |
||
65 | * |
||
66 | * @param string $query |
||
67 | * @return string |
||
68 | */ |
||
69 | protected function generateQueryPrefixes($query) |
||
70 | { |
||
71 | // Check for undefined prefixes |
||
72 | $prefixes = ''; |
||
73 | foreach (EasyRdf\RdfNamespace::namespaces() as $prefix => $uri) { |
||
74 | if (strpos($query, "{$prefix}:") !== false and |
||
75 | strpos($query, "PREFIX {$prefix}:") === false |
||
76 | ) { |
||
77 | $prefixes .= "PREFIX {$prefix}: <{$uri}>\n"; |
||
78 | } |
||
79 | } |
||
80 | return $prefixes; |
||
81 | } |
||
82 | |||
83 | /** |
||
84 | * Execute the SPARQL query using the SPARQL client, logging it as well. |
||
85 | * @param string $query SPARQL query to perform |
||
86 | * @return Result|\EasyRdf\Graph query result |
||
87 | */ |
||
88 | protected function query($query) { |
||
89 | $queryId = sprintf("%05d", rand(0, 99999)); |
||
90 | $logger = $this->model->getLogger(); |
||
91 | $logger->info("[qid $queryId] SPARQL query:\n" . $this->generateQueryPrefixes($query) . "\n$query\n"); |
||
92 | $starttime = microtime(true); |
||
93 | $result = $this->client->query($query); |
||
94 | $elapsed = intval(round((microtime(true) - $starttime) * 1000)); |
||
95 | if(method_exists($result, 'numRows')) { |
||
96 | $numRows = $result->numRows(); |
||
|
|||
97 | $logger->info("[qid $queryId] result: $numRows rows returned in $elapsed ms"); |
||
98 | } else { // graph result |
||
99 | $numTriples = $result->countTriples(); |
||
100 | $logger->info("[qid $queryId] result: $numTriples triples returned in $elapsed ms"); |
||
101 | } |
||
102 | return $result; |
||
103 | } |
||
104 | |||
105 | |||
106 | /** |
||
107 | * Generates FROM clauses for the queries |
||
108 | * @param Vocabulary[]|null $vocabs |
||
109 | * @return string |
||
110 | */ |
||
111 | protected function generateFromClause($vocabs=null) { |
||
112 | $clause = ''; |
||
113 | if (!$vocabs) { |
||
114 | return $this->graph !== '?graph' && $this->graph !== NULL ? "FROM <$this->graph>" : ''; |
||
115 | } |
||
116 | $graphs = $this->getVocabGraphs($vocabs); |
||
117 | foreach ($graphs as $graph) { |
||
118 | $clause .= "FROM NAMED <$graph> "; |
||
119 | } |
||
120 | return $clause; |
||
121 | } |
||
122 | |||
123 | protected function initializeHttpClient() { |
||
124 | // configure the HTTP client used by EasyRdf\Sparql\Client |
||
125 | $httpclient = EasyRdf\Http::getDefaultHttpClient(); |
||
126 | $httpclient->setConfig(array('timeout' => $this->model->getConfig()->getSparqlTimeout())); |
||
127 | |||
128 | // if special cache control (typically no-cache) was requested by the |
||
129 | // client, set the same type of cache control headers also in subsequent |
||
130 | // in the SPARQL requests (this is useful for performance testing) |
||
131 | // @codeCoverageIgnoreStart |
||
132 | $cacheControl = filter_input(INPUT_SERVER, 'HTTP_CACHE_CONTROL', FILTER_SANITIZE_STRING); |
||
133 | $pragma = filter_input(INPUT_SERVER, 'HTTP_PRAGMA', FILTER_SANITIZE_STRING); |
||
134 | if ($cacheControl !== null || $pragma !== null) { |
||
135 | $val = $pragma !== null ? $pragma : $cacheControl; |
||
136 | $httpclient->setHeaders('Cache-Control', $val); |
||
137 | } |
||
138 | // @codeCoverageIgnoreEnd |
||
139 | |||
140 | EasyRdf\Http::setDefaultHttpClient($httpclient); // actually redundant.. |
||
141 | } |
||
142 | |||
143 | /** |
||
144 | * Return true if this is the default SPARQL endpoint, used as the facade to query |
||
145 | * all vocabularies. |
||
146 | */ |
||
147 | |||
148 | protected function isDefaultEndpoint() { |
||
149 | return !is_null($this->graph) && $this->graph[0] == '?'; |
||
150 | } |
||
151 | |||
152 | /** |
||
153 | * Returns the graph instance |
||
154 | * @return object EasyRDF graph instance. |
||
155 | */ |
||
156 | public function getGraph() { |
||
157 | return $this->graph; |
||
158 | } |
||
159 | |||
160 | /** |
||
161 | * Shorten a URI |
||
162 | * @param string $uri URI to shorten |
||
163 | * @return string shortened URI, or original URI if it cannot be shortened |
||
164 | */ |
||
165 | private function shortenUri($uri) { |
||
166 | if (!array_key_exists($uri, $this->qnamecache)) { |
||
167 | $res = new EasyRdf\Resource($uri); |
||
168 | $qname = $res->shorten(); // returns null on failure |
||
169 | $this->qnamecache[$uri] = ($qname !== null) ? $qname : $uri; |
||
170 | } |
||
171 | return $this->qnamecache[$uri]; |
||
172 | } |
||
173 | |||
174 | |||
175 | /** |
||
176 | * Generates the sparql query for retrieving concept and collection counts in a vocabulary. |
||
177 | * @return string sparql query |
||
178 | */ |
||
179 | private function generateCountConceptsQuery($array, $group) { |
||
180 | $fcl = $this->generateFromClause(); |
||
181 | $optional = $array ? "UNION { ?type rdfs:subClassOf* <$array> }" : ''; |
||
182 | $optional .= $group ? "UNION { ?type rdfs:subClassOf* <$group> }" : ''; |
||
183 | $query = <<<EOQ |
||
184 | SELECT (COUNT(?conc) as ?c) ?type ?typelabel $fcl WHERE { |
||
185 | { ?conc a ?type . |
||
186 | { ?type rdfs:subClassOf* skos:Concept . } UNION { ?type rdfs:subClassOf* skos:Collection . } $optional } |
||
187 | OPTIONAL { ?type rdfs:label ?typelabel . } |
||
188 | } |
||
189 | GROUP BY ?type ?typelabel |
||
190 | EOQ; |
||
191 | return $query; |
||
192 | } |
||
193 | |||
194 | /** |
||
195 | * Used for transforming the concept count query results. |
||
196 | * @param EasyRdf\Sparql\Result $result query results to be transformed |
||
197 | * @param string $lang language of labels |
||
198 | * @return Array containing the label counts |
||
199 | */ |
||
200 | private function transformCountConceptsResults($result, $lang) { |
||
201 | $ret = array(); |
||
202 | foreach ($result as $row) { |
||
203 | if (!isset($row->type)) { |
||
204 | continue; |
||
205 | } |
||
206 | $ret[$row->type->getUri()]['type'] = $row->type->getUri(); |
||
207 | $ret[$row->type->getUri()]['count'] = $row->c->getValue(); |
||
208 | if (isset($row->typelabel) && $row->typelabel->getLang() === $lang) { |
||
209 | $ret[$row->type->getUri()]['label'] = $row->typelabel->getValue(); |
||
210 | } |
||
211 | |||
212 | } |
||
213 | return $ret; |
||
214 | } |
||
215 | |||
216 | /** |
||
217 | * Used for counting number of concepts and collections in a vocabulary. |
||
218 | * @param string $lang language of labels |
||
219 | * @return int number of concepts in this vocabulary |
||
220 | */ |
||
221 | public function countConcepts($lang = null, $array = null, $group = null) { |
||
222 | $query = $this->generateCountConceptsQuery($array, $group); |
||
223 | $result = $this->query($query); |
||
224 | return $this->transformCountConceptsResults($result, $lang); |
||
225 | } |
||
226 | |||
227 | /** |
||
228 | * @param array $langs Languages to query for |
||
229 | * @param string[] $props property names |
||
230 | * @return string sparql query |
||
231 | */ |
||
232 | private function generateCountLangConceptsQuery($langs, $classes, $props) { |
||
233 | $gcl = $this->graphClause; |
||
234 | $classes = ($classes) ? $classes : array('http://www.w3.org/2004/02/skos/core#Concept'); |
||
235 | |||
236 | $quote_string = function($val) { return "'$val'"; }; |
||
237 | $quoted_values = array_map($quote_string, $langs); |
||
238 | $langFilter = "FILTER(?lang IN (" . implode(',', $quoted_values) . "))"; |
||
239 | |||
240 | $values = $this->formatValues('?type', $classes, 'uri'); |
||
241 | $valuesProp = $this->formatValues('?prop', $props, null); |
||
242 | |||
243 | $query = <<<EOQ |
||
244 | SELECT ?lang ?prop |
||
245 | (COUNT(?label) as ?count) |
||
246 | WHERE { |
||
247 | $gcl { |
||
248 | $values |
||
249 | $valuesProp |
||
250 | ?conc a ?type . |
||
251 | ?conc ?prop ?label . |
||
252 | BIND(LANG(?label) AS ?lang) |
||
253 | $langFilter |
||
254 | } |
||
255 | } |
||
256 | GROUP BY ?lang ?prop ?type |
||
257 | EOQ; |
||
258 | return $query; |
||
259 | } |
||
260 | |||
261 | /** |
||
262 | * Transforms the CountLangConcepts results into an array of label counts. |
||
263 | * @param EasyRdf\Sparql\Result $result query results to be transformed |
||
264 | * @param array $langs Languages to query for |
||
265 | * @param string[] $props property names |
||
266 | */ |
||
267 | private function transformCountLangConceptsResults($result, $langs, $props) { |
||
268 | $ret = array(); |
||
269 | // set default count to zero; overridden below if query found labels |
||
270 | foreach ($langs as $lang) { |
||
271 | foreach ($props as $prop) { |
||
272 | $ret[$lang][$prop] = 0; |
||
273 | } |
||
274 | } |
||
275 | foreach ($result as $row) { |
||
276 | if (isset($row->lang) && isset($row->prop) && isset($row->count)) { |
||
277 | $ret[$row->lang->getValue()][$row->prop->shorten()] += |
||
278 | $row->count->getValue(); |
||
279 | } |
||
280 | |||
281 | } |
||
282 | ksort($ret); |
||
283 | return $ret; |
||
284 | } |
||
285 | |||
286 | /** |
||
287 | * Counts the number of concepts in a easyRDF graph with a specific language. |
||
288 | * @param array $langs Languages to query for |
||
289 | * @return Array containing count of concepts for each language and property. |
||
290 | */ |
||
291 | public function countLangConcepts($langs, $classes = null) { |
||
292 | $props = array('skos:prefLabel', 'skos:altLabel', 'skos:hiddenLabel'); |
||
293 | $query = $this->generateCountLangConceptsQuery($langs, $classes, $props); |
||
294 | // Count the number of terms in each language |
||
295 | $result = $this->query($query); |
||
296 | return $this->transformCountLangConceptsResults($result, $langs, $props); |
||
297 | } |
||
298 | |||
299 | /** |
||
300 | * Formats a VALUES clause (SPARQL 1.1) which states that the variable should be bound to one |
||
301 | * of the constants given. |
||
302 | * @param string $varname variable name, e.g. "?uri" |
||
303 | * @param array $values the values |
||
304 | * @param string $type type of values: "uri", "literal" or null (determines quoting style) |
||
305 | */ |
||
306 | protected function formatValues($varname, $values, $type = null) { |
||
307 | $constants = array(); |
||
308 | foreach ($values as $val) { |
||
309 | if ($type == 'uri') { |
||
310 | $val = "<$val>"; |
||
311 | } |
||
312 | |||
313 | if ($type == 'literal') { |
||
314 | $val = "'$val'"; |
||
315 | } |
||
316 | |||
317 | $constants[] = "($val)"; |
||
318 | } |
||
319 | $values = implode(" ", $constants); |
||
320 | |||
321 | return "VALUES ($varname) { $values }"; |
||
322 | } |
||
323 | |||
324 | /** |
||
325 | * Filters multiple instances of the same vocabulary from the input array. |
||
326 | * @param \Vocabulary[]|null $vocabs array of Vocabulary objects |
||
327 | * @return \Vocabulary[] |
||
328 | */ |
||
329 | private function filterDuplicateVocabs($vocabs) { |
||
330 | // filtering duplicates |
||
331 | $uniqueVocabs = array(); |
||
332 | if ($vocabs !== null && sizeof($vocabs) > 0) { |
||
333 | foreach ($vocabs as $voc) { |
||
334 | $uniqueVocabs[$voc->getId()] = $voc; |
||
335 | } |
||
336 | } |
||
337 | |||
338 | return $uniqueVocabs; |
||
339 | } |
||
340 | |||
341 | /** |
||
342 | * Generates a sparql query for one or more concept URIs |
||
343 | * @param mixed $uris concept URI (string) or array of URIs |
||
344 | * @param string|null $arrayClass the URI for thesaurus array class, or null if not used |
||
345 | * @param \Vocabulary[]|null $vocabs array of Vocabulary objects |
||
346 | * @return string sparql query |
||
347 | */ |
||
348 | private function generateConceptInfoQuery($uris, $arrayClass, $vocabs) { |
||
349 | $gcl = $this->graphClause; |
||
350 | $fcl = empty($vocabs) ? '' : $this->generateFromClause($vocabs); |
||
351 | $values = $this->formatValues('?uri', $uris, 'uri'); |
||
352 | $uniqueVocabs = $this->filterDuplicateVocabs($vocabs); |
||
353 | $valuesGraph = empty($vocabs) ? $this->formatValuesGraph($uniqueVocabs) : ''; |
||
354 | |||
355 | if ($arrayClass === null) { |
||
356 | $construct = $optional = ""; |
||
357 | } else { |
||
358 | // add information that can be used to format narrower concepts by |
||
359 | // the array they belong to ("milk by source animal" use case) |
||
360 | $construct = "\n ?x skos:member ?o . ?x skos:prefLabel ?xl . ?x a <$arrayClass> ."; |
||
361 | $optional = "\n OPTIONAL { |
||
362 | ?x skos:member ?o . |
||
363 | ?x a <$arrayClass> . |
||
364 | ?x skos:prefLabel ?xl . |
||
365 | FILTER NOT EXISTS { |
||
366 | ?x skos:member ?other . |
||
367 | MINUS { ?other skos:broader ?uri } |
||
368 | } |
||
369 | }"; |
||
370 | } |
||
371 | $query = <<<EOQ |
||
372 | CONSTRUCT { |
||
373 | ?s ?p ?uri . |
||
374 | ?sp ?uri ?op . |
||
375 | ?uri ?p ?o . |
||
376 | ?p rdfs:label ?proplabel . |
||
377 | ?p rdfs:subPropertyOf ?pp . |
||
378 | ?pp rdfs:label ?plabel . |
||
379 | ?o a ?ot . |
||
380 | ?o skos:prefLabel ?opl . |
||
381 | ?o rdfs:label ?ol . |
||
382 | ?o rdf:value ?ov . |
||
383 | ?o skos:notation ?on . |
||
384 | ?o ?oprop ?oval . |
||
385 | ?o ?xlprop ?xlval . |
||
386 | ?directgroup skos:member ?uri . |
||
387 | ?parent skos:member ?group . |
||
388 | ?group skos:prefLabel ?grouplabel . |
||
389 | ?b1 rdf:first ?item . |
||
390 | ?b1 rdf:rest ?b2 . |
||
391 | ?item a ?it . |
||
392 | ?item skos:prefLabel ?il . |
||
393 | ?group a ?grouptype . $construct |
||
394 | } $fcl WHERE { |
||
395 | $values |
||
396 | $gcl { |
||
397 | { |
||
398 | ?s ?p ?uri . |
||
399 | FILTER(!isBlank(?s)) |
||
400 | FILTER(?p != skos:inScheme) |
||
401 | } |
||
402 | UNION |
||
403 | { ?sp ?uri ?op . } |
||
404 | UNION |
||
405 | { |
||
406 | ?directgroup skos:member ?uri . |
||
407 | ?group skos:member+ ?uri . |
||
408 | ?group skos:prefLabel ?grouplabel . |
||
409 | ?group a ?grouptype . |
||
410 | OPTIONAL { ?parent skos:member ?group } |
||
411 | } |
||
412 | UNION |
||
413 | { |
||
414 | ?uri ?p ?o . |
||
415 | OPTIONAL { |
||
416 | ?o rdf:rest* ?b1 . |
||
417 | ?b1 rdf:first ?item . |
||
418 | ?b1 rdf:rest ?b2 . |
||
419 | OPTIONAL { ?item a ?it . } |
||
420 | OPTIONAL { ?item skos:prefLabel ?il . } |
||
421 | } |
||
422 | OPTIONAL { |
||
423 | { ?p rdfs:label ?proplabel . } |
||
424 | UNION |
||
425 | { ?p rdfs:subPropertyOf ?pp . } |
||
426 | } |
||
427 | OPTIONAL { |
||
428 | { ?o a ?ot . } |
||
429 | UNION |
||
430 | { ?o skos:prefLabel ?opl . } |
||
431 | UNION |
||
432 | { ?o rdfs:label ?ol . } |
||
433 | UNION |
||
434 | { ?o rdf:value ?ov . |
||
435 | OPTIONAL { ?o ?oprop ?oval . } |
||
436 | } |
||
437 | UNION |
||
438 | { ?o skos:notation ?on . } |
||
439 | UNION |
||
440 | { ?o a skosxl:Label . |
||
441 | ?o ?xlprop ?xlval } |
||
442 | } $optional |
||
443 | } |
||
444 | } |
||
445 | } |
||
446 | $valuesGraph |
||
447 | EOQ; |
||
448 | return $query; |
||
449 | } |
||
450 | |||
451 | /** |
||
452 | * Transforms ConceptInfo query results into an array of Concept objects |
||
453 | * @param EasyRdf\Graph $result query results to be transformed |
||
454 | * @param array $uris concept URIs |
||
455 | * @param \Vocabulary[] $vocabs array of Vocabulary object |
||
456 | * @param string|null $clang content language |
||
457 | * @return Concept[] array of Concept objects |
||
458 | */ |
||
459 | private function transformConceptInfoResults($result, $uris, $vocabs, $clang) { |
||
460 | $conceptArray = array(); |
||
461 | foreach ($uris as $index => $uri) { |
||
462 | $conc = $result->resource($uri); |
||
463 | $vocab = (isset($vocabs) && sizeof($vocabs) == 1) ? $vocabs[0] : $vocabs[$index]; |
||
464 | $conceptArray[] = new Concept($this->model, $vocab, $conc, $result, $clang); |
||
465 | } |
||
466 | return $conceptArray; |
||
467 | } |
||
468 | |||
469 | /** |
||
470 | * Returns information (as a graph) for one or more concept URIs |
||
471 | * @param mixed $uris concept URI (string) or array of URIs |
||
472 | * @param string|null $arrayClass the URI for thesaurus array class, or null if not used |
||
473 | * @param \Vocabulary[]|null $vocabs vocabularies to target |
||
474 | * @return \EasyRdf\Graph |
||
475 | */ |
||
476 | public function queryConceptInfoGraph($uris, $arrayClass = null, $vocabs = array()) { |
||
477 | // if just a single URI is given, put it in an array regardless |
||
478 | if (!is_array($uris)) { |
||
479 | $uris = array($uris); |
||
480 | } |
||
481 | |||
482 | $query = $this->generateConceptInfoQuery($uris, $arrayClass, $vocabs); |
||
483 | $result = $this->query($query); |
||
484 | return $result; |
||
485 | } |
||
486 | |||
487 | /** |
||
488 | * Returns information (as an array of Concept objects) for one or more concept URIs |
||
489 | * @param mixed $uris concept URI (string) or array of URIs |
||
490 | * @param string|null $arrayClass the URI for thesaurus array class, or null if not used |
||
491 | * @param \Vocabulary[] $vocabs vocabularies to target |
||
492 | * @param string|null $clang content language |
||
493 | * @return Concept[] |
||
494 | */ |
||
495 | public function queryConceptInfo($uris, $arrayClass = null, $vocabs = array(), $clang = null) { |
||
496 | // if just a single URI is given, put it in an array regardless |
||
497 | if (!is_array($uris)) { |
||
498 | $uris = array($uris); |
||
499 | } |
||
500 | $result = $this->queryConceptInfoGraph($uris, $arrayClass, $vocabs); |
||
501 | if ($result->isEmpty()) { |
||
502 | return []; |
||
503 | } |
||
504 | return $this->transformConceptInfoResults($result, $uris, $vocabs, $clang); |
||
505 | } |
||
506 | |||
507 | /** |
||
508 | * Generates the sparql query for queryTypes |
||
509 | * @param string $lang |
||
510 | * @return string sparql query |
||
511 | */ |
||
512 | private function generateQueryTypesQuery($lang) { |
||
513 | $fcl = $this->generateFromClause(); |
||
514 | $query = <<<EOQ |
||
515 | SELECT DISTINCT ?type ?label ?superclass $fcl |
||
516 | WHERE { |
||
517 | { |
||
518 | { BIND( skos:Concept as ?type ) } |
||
519 | UNION |
||
520 | { BIND( skos:Collection as ?type ) } |
||
521 | UNION |
||
522 | { BIND( isothes:ConceptGroup as ?type ) } |
||
523 | UNION |
||
524 | { BIND( isothes:ThesaurusArray as ?type ) } |
||
525 | UNION |
||
526 | { ?type rdfs:subClassOf/rdfs:subClassOf* skos:Concept . } |
||
527 | UNION |
||
528 | { ?type rdfs:subClassOf/rdfs:subClassOf* skos:Collection . } |
||
529 | } |
||
530 | OPTIONAL { |
||
531 | ?type rdfs:label ?label . |
||
532 | FILTER(langMatches(lang(?label), '$lang')) |
||
533 | } |
||
534 | OPTIONAL { |
||
535 | ?type rdfs:subClassOf ?superclass . |
||
536 | } |
||
537 | FILTER EXISTS { |
||
538 | ?s a ?type . |
||
539 | ?s skos:prefLabel ?prefLabel . |
||
540 | } |
||
541 | } |
||
542 | EOQ; |
||
543 | return $query; |
||
544 | } |
||
545 | |||
546 | /** |
||
547 | * Transforms the results into an array format. |
||
548 | * @param EasyRdf\Sparql\Result $result |
||
549 | * @return array Array with URIs (string) as key and array of (label, superclassURI) as value |
||
550 | */ |
||
551 | View Code Duplication | private function transformQueryTypesResults($result) { |
|
552 | $ret = array(); |
||
553 | foreach ($result as $row) { |
||
554 | $type = array(); |
||
555 | if (isset($row->label)) { |
||
556 | $type['label'] = $row->label->getValue(); |
||
557 | } |
||
558 | |||
559 | if (isset($row->superclass)) { |
||
560 | $type['superclass'] = $row->superclass->getUri(); |
||
561 | } |
||
562 | |||
563 | $ret[$row->type->getURI()] = $type; |
||
564 | } |
||
565 | return $ret; |
||
566 | } |
||
567 | |||
568 | /** |
||
569 | * Retrieve information about types from the endpoint |
||
570 | * @param string $lang |
||
571 | * @return array Array with URIs (string) as key and array of (label, superclassURI) as value |
||
572 | */ |
||
573 | public function queryTypes($lang) { |
||
574 | $query = $this->generateQueryTypesQuery($lang); |
||
575 | $result = $this->query($query); |
||
576 | return $this->transformQueryTypesResults($result); |
||
577 | } |
||
578 | |||
579 | /** |
||
580 | * Generates the concept scheme query. |
||
581 | * @param string $conceptscheme concept scheme URI |
||
582 | * @return string sparql query |
||
583 | */ |
||
584 | private function generateQueryConceptSchemeQuery($conceptscheme) { |
||
585 | $fcl = $this->generateFromClause(); |
||
586 | $query = <<<EOQ |
||
587 | CONSTRUCT { |
||
588 | <$conceptscheme> ?property ?value . |
||
589 | } $fcl WHERE { |
||
590 | <$conceptscheme> ?property ?value . |
||
591 | FILTER (?property != skos:hasTopConcept) |
||
592 | } |
||
593 | EOQ; |
||
594 | return $query; |
||
595 | } |
||
596 | |||
597 | /** |
||
598 | * Retrieves conceptScheme information from the endpoint. |
||
599 | * @param string $conceptscheme concept scheme URI |
||
600 | * @return EasyRDF_Graph query result graph |
||
601 | */ |
||
602 | public function queryConceptScheme($conceptscheme) { |
||
603 | $query = $this->generateQueryConceptSchemeQuery($conceptscheme); |
||
604 | return $this->query($query); |
||
605 | } |
||
606 | |||
607 | /** |
||
608 | * Generates the queryConceptSchemes sparql query. |
||
609 | * @param string $lang language of labels |
||
610 | * @return string sparql query |
||
611 | */ |
||
612 | private function generateQueryConceptSchemesQuery($lang) { |
||
613 | $fcl = $this->generateFromClause(); |
||
614 | $query = <<<EOQ |
||
615 | SELECT ?cs ?label ?preflabel ?title ?domain ?domainLabel $fcl |
||
616 | WHERE { |
||
617 | ?cs a skos:ConceptScheme . |
||
618 | OPTIONAL{ |
||
619 | ?cs dcterms:subject ?domain. |
||
620 | ?domain skos:prefLabel ?domainLabel. |
||
621 | FILTER(langMatches(lang(?domainLabel), '$lang')) |
||
622 | } |
||
623 | OPTIONAL { |
||
624 | ?cs rdfs:label ?label . |
||
625 | FILTER(langMatches(lang(?label), '$lang')) |
||
626 | } |
||
627 | OPTIONAL { |
||
628 | ?cs skos:prefLabel ?preflabel . |
||
629 | FILTER(langMatches(lang(?preflabel), '$lang')) |
||
630 | } |
||
631 | OPTIONAL { |
||
632 | { ?cs dc11:title ?title } |
||
633 | UNION |
||
634 | { ?cs dc:title ?title } |
||
635 | FILTER(langMatches(lang(?title), '$lang')) |
||
636 | } |
||
637 | } |
||
638 | ORDER BY ?cs |
||
639 | EOQ; |
||
640 | return $query; |
||
641 | } |
||
642 | |||
643 | /** |
||
644 | * Transforms the queryConceptScheme results into an array format. |
||
645 | * @param EasyRdf\Sparql\Result $result |
||
646 | * @return array |
||
647 | */ |
||
648 | private function transformQueryConceptSchemesResults($result) { |
||
649 | $ret = array(); |
||
650 | foreach ($result as $row) { |
||
651 | $conceptscheme = array(); |
||
652 | if (isset($row->label)) { |
||
653 | $conceptscheme['label'] = $row->label->getValue(); |
||
654 | } |
||
655 | |||
656 | if (isset($row->preflabel)) { |
||
657 | $conceptscheme['prefLabel'] = $row->preflabel->getValue(); |
||
658 | } |
||
659 | |||
660 | if (isset($row->title)) { |
||
661 | $conceptscheme['title'] = $row->title->getValue(); |
||
662 | } |
||
663 | // add dct:subject and their labels in the result |
||
664 | if(isset($row->domain) && isset($row->domainLabel)){ |
||
665 | $conceptscheme['subject']['uri']=$row->domain->getURI(); |
||
666 | $conceptscheme['subject']['prefLabel']=$row->domainLabel->getValue(); |
||
667 | } |
||
668 | |||
669 | $ret[$row->cs->getURI()] = $conceptscheme; |
||
670 | } |
||
671 | return $ret; |
||
672 | } |
||
673 | |||
674 | /** |
||
675 | * return a list of skos:ConceptScheme instances in the given graph |
||
676 | * @param string $lang language of labels |
||
677 | * @return array Array with concept scheme URIs (string) as keys and labels (string) as values |
||
678 | */ |
||
679 | public function queryConceptSchemes($lang) { |
||
680 | $query = $this->generateQueryConceptSchemesQuery($lang); |
||
681 | $result = $this->query($query); |
||
682 | return $this->transformQueryConceptSchemesResults($result); |
||
683 | } |
||
684 | |||
685 | /** |
||
686 | * Generate a VALUES clause for limiting the targeted graphs. |
||
687 | * @param Vocabulary[]|null $vocabs the vocabularies to target |
||
688 | * @return string[] array of graph URIs |
||
689 | */ |
||
690 | protected function getVocabGraphs($vocabs) { |
||
691 | if ($vocabs === null || sizeof($vocabs) == 0) { |
||
692 | // searching from all vocabularies - limit to known graphs |
||
693 | $vocabs = $this->model->getVocabularies(); |
||
694 | } |
||
695 | $graphs = array(); |
||
696 | foreach ($vocabs as $voc) { |
||
697 | $graph = $voc->getGraph(); |
||
698 | if (!is_null($graph) && !in_array($graph, $graphs)) { |
||
699 | $graphs[] = $graph; |
||
700 | } |
||
701 | } |
||
702 | return $graphs; |
||
703 | } |
||
704 | |||
705 | /** |
||
706 | * Generate a VALUES clause for limiting the targeted graphs. |
||
707 | * @param Vocabulary[]|null $vocabs array of Vocabulary objects to target |
||
708 | * @return string VALUES clause, or "" if not necessary to limit |
||
709 | */ |
||
710 | protected function formatValuesGraph($vocabs) { |
||
717 | |||
718 | /** |
||
719 | * Generate a FILTER clause for limiting the targeted graphs. |
||
720 | * @param array $vocabs array of Vocabulary objects to target |
||
721 | * @return string FILTER clause, or "" if not necessary to limit |
||
722 | */ |
||
723 | protected function formatFilterGraph($vocabs) { |
||
724 | if (!$this->isDefaultEndpoint()) { |
||
725 | return ""; |
||
726 | } |
||
727 | $graphs = $this->getVocabGraphs($vocabs); |
||
728 | $values = array(); |
||
729 | foreach ($graphs as $graph) { |
||
730 | $values[] = "<$graph>"; |
||
731 | } |
||
732 | if (count($values)) { |
||
733 | return "FILTER (?graph IN (" . implode(',', $values) . "))"; |
||
734 | } |
||
735 | } |
||
736 | |||
737 | /** |
||
738 | * Formats combined limit and offset clauses for the sparql query |
||
739 | * @param int $limit maximum number of hits to retrieve; 0 for unlimited |
||
740 | * @param int $offset offset of results to retrieve; 0 for beginning of list |
||
741 | * @return string sparql query clauses |
||
742 | */ |
||
743 | protected function formatLimitAndOffset($limit, $offset) { |
||
744 | $limit = ($limit) ? 'LIMIT ' . $limit : ''; |
||
745 | $offset = ($offset) ? 'OFFSET ' . $offset : ''; |
||
746 | // eliminating whitespace and line changes when the conditions aren't needed. |
||
747 | $limitandoffset = ''; |
||
748 | if ($limit && $offset) { |
||
749 | $limitandoffset = "\n" . $limit . "\n" . $offset; |
||
750 | } elseif ($limit) { |
||
751 | $limitandoffset = "\n" . $limit; |
||
752 | } elseif ($offset) { |
||
753 | $limitandoffset = "\n" . $offset; |
||
754 | } |
||
755 | |||
756 | return $limitandoffset; |
||
757 | } |
||
758 | |||
759 | /** |
||
760 | * Formats a sparql query clause for limiting the search to specific concept types. |
||
761 | * @param array $types limit search to concepts of the given type(s) |
||
762 | * @return string sparql query clause |
||
763 | */ |
||
764 | protected function formatTypes($types) { |
||
765 | $typePatterns = array(); |
||
766 | if (!empty($types)) { |
||
767 | foreach ($types as $type) { |
||
768 | $unprefixed = EasyRdf\RdfNamespace::expand($type); |
||
769 | $typePatterns[] = "{ ?s a <$unprefixed> }"; |
||
770 | } |
||
771 | } |
||
772 | |||
773 | return implode(' UNION ', $typePatterns); |
||
774 | } |
||
775 | |||
776 | /** |
||
777 | * @param string $prop property to include in the result eg. 'broader' or 'narrower' |
||
778 | * @return string sparql query clause |
||
779 | */ |
||
780 | private function formatPropertyCsvClause($prop) { |
||
781 | # This expression creates a CSV row containing pairs of (uri,prefLabel) values. |
||
782 | # The REPLACE is performed for quotes (" -> "") so they don't break the CSV format. |
||
783 | $clause = <<<EOV |
||
784 | (GROUP_CONCAT(DISTINCT CONCAT( |
||
785 | '"', IF(isIRI(?$prop),STR(?$prop),''), '"', ',', |
||
786 | '"', REPLACE(IF(BOUND(?{$prop}lab),?{$prop}lab,''), '"', '""'), '"', ',', |
||
787 | '"', REPLACE(IF(isLiteral(?{$prop}),?{$prop},''), '"', '""'), '"' |
||
788 | ); separator='\\n') as ?{$prop}s) |
||
789 | EOV; |
||
790 | return $clause; |
||
791 | } |
||
792 | |||
793 | /** |
||
794 | * @return string sparql query clause |
||
795 | */ |
||
796 | private function formatPrefLabelCsvClause() { |
||
797 | # This expression creates a CSV row containing pairs of (prefLabel, lang) values. |
||
798 | # The REPLACE is performed for quotes (" -> "") so they don't break the CSV format. |
||
799 | $clause = <<<EOV |
||
800 | (GROUP_CONCAT(DISTINCT CONCAT( |
||
801 | '"', STR(?pref), '"', ',', '"', lang(?pref), '"' |
||
802 | ); separator='\\n') as ?preflabels) |
||
803 | EOV; |
||
804 | return $clause; |
||
805 | } |
||
806 | |||
807 | /** |
||
808 | * @param string $lang language code of the returned labels |
||
809 | * @param array|null $fields extra fields to include in the result (array of strings). (default: null = none) |
||
810 | * @return string sparql query clause |
||
811 | */ |
||
812 | protected function formatExtraFields($lang, $fields) { |
||
813 | // extra variable expressions to request and extra fields to query for |
||
814 | $ret = array('extravars' => '', 'extrafields' => ''); |
||
815 | |||
816 | if ($fields === null) { |
||
817 | return $ret; |
||
818 | } |
||
819 | |||
820 | if (in_array('prefLabel', $fields)) { |
||
821 | $ret['extravars'] .= $this->formatPreflabelCsvClause(); |
||
822 | $ret['extrafields'] .= <<<EOF |
||
823 | OPTIONAL { |
||
824 | ?s skos:prefLabel ?pref . |
||
825 | } |
||
826 | EOF; |
||
827 | // removing the prefLabel from the fields since it has been handled separately |
||
828 | $fields = array_diff($fields, array('prefLabel')); |
||
829 | } |
||
830 | |||
831 | foreach ($fields as $field) { |
||
832 | $ret['extravars'] .= $this->formatPropertyCsvClause($field); |
||
833 | $ret['extrafields'] .= <<<EOF |
||
834 | OPTIONAL { |
||
835 | ?s skos:$field ?$field . |
||
836 | FILTER(!isLiteral(?$field)||langMatches(lang(?{$field}), '$lang')) |
||
837 | OPTIONAL { ?$field skos:prefLabel ?{$field}lab . FILTER(langMatches(lang(?{$field}lab), '$lang')) } |
||
838 | } |
||
839 | EOF; |
||
840 | } |
||
841 | |||
842 | return $ret; |
||
843 | } |
||
844 | |||
845 | /** |
||
846 | * Generate condition for matching labels in SPARQL |
||
847 | * @param string $term search term |
||
848 | * @param string $searchLang language code used for matching labels (null means any language) |
||
849 | * @return string sparql query snippet |
||
850 | */ |
||
851 | protected function generateConceptSearchQueryCondition($term, $searchLang) |
||
852 | { |
||
853 | # use appropriate matching function depending on query type: =, strstarts, strends or full regex |
||
854 | if (preg_match('/^[^\*]+$/', $term)) { // exact query |
||
855 | $term = str_replace('\\', '\\\\', $term); // quote slashes |
||
856 | $term = str_replace('\'', '\\\'', mb_strtolower($term, 'UTF-8')); // make lowercase and escape single quotes |
||
857 | $filtercond = "LCASE(STR(?match)) = '$term'"; |
||
858 | } elseif (preg_match('/^[^\*]+\*$/', $term)) { // prefix query |
||
859 | $term = substr($term, 0, -1); // remove the final asterisk |
||
860 | $term = str_replace('\\', '\\\\', $term); // quote slashes |
||
861 | $term = str_replace('\'', '\\\'', mb_strtolower($term, 'UTF-8')); // make lowercase and escape single quotes |
||
862 | $filtercond = "STRSTARTS(LCASE(STR(?match)), '$term')"; |
||
863 | } elseif (preg_match('/^\*[^\*]+$/', $term)) { // suffix query |
||
864 | $term = substr($term, 1); // remove the preceding asterisk |
||
865 | $term = str_replace('\\', '\\\\', $term); // quote slashes |
||
866 | $term = str_replace('\'', '\\\'', mb_strtolower($term, 'UTF-8')); // make lowercase and escape single quotes |
||
867 | $filtercond = "STRENDS(LCASE(STR(?match)), '$term')"; |
||
868 | } else { // too complicated - have to use a regex |
||
869 | # make sure regex metacharacters are not passed through |
||
870 | $term = str_replace('\\', '\\\\', preg_quote($term)); |
||
871 | $term = str_replace('\\\\*', '.*', $term); // convert asterisk to regex syntax |
||
872 | $term = str_replace('\'', '\\\'', $term); // ensure single quotes are quoted |
||
873 | $filtercond = "REGEX(STR(?match), '^$term$', 'i')"; |
||
874 | } |
||
875 | |||
876 | $labelcondMatch = ($searchLang) ? "&& (?prop = skos:notation || LANGMATCHES(lang(?match), ?langParam))" : ""; |
||
877 | |||
878 | return "?s ?prop ?match . FILTER ($filtercond $labelcondMatch)"; |
||
879 | } |
||
880 | |||
881 | |||
882 | /** |
||
883 | * Inner query for concepts using a search term. |
||
884 | * @param string $term search term |
||
885 | * @param string $lang language code of the returned labels |
||
886 | * @param string $searchLang language code used for matching labels (null means any language) |
||
887 | * @param string[] $props properties to target e.g. array('skos:prefLabel','skos:altLabel') |
||
888 | * @param boolean $unique restrict results to unique concepts (default: false) |
||
889 | * @return string sparql query |
||
890 | */ |
||
891 | protected function generateConceptSearchQueryInner($term, $lang, $searchLang, $props, $unique, $filterGraph) |
||
892 | { |
||
893 | $valuesProp = $this->formatValues('?prop', $props); |
||
894 | $textcond = $this->generateConceptSearchQueryCondition($term, $searchLang); |
||
895 | |||
896 | $rawterm = str_replace(array('\\', '*', '"'), array('\\\\', '', '\"'), $term); |
||
897 | // graph clause, if necessary |
||
898 | $graphClause = $filterGraph != '' ? 'GRAPH ?graph' : ''; |
||
899 | |||
900 | // extra conditions for label language, if specified |
||
901 | $labelcondLabel = ($lang) ? "LANGMATCHES(lang(?label), '$lang')" : "lang(?match) = '' || LANGMATCHES(lang(?label), lang(?match))"; |
||
902 | // if search language and UI/display language differ, must also consider case where there is no prefLabel in |
||
903 | // the display language; in that case, should use the label with the same language as the matched label |
||
904 | $labelcondFallback = ($searchLang != $lang) ? |
||
905 | "OPTIONAL { # in case previous OPTIONAL block gives no labels\n" . |
||
906 | "?s skos:prefLabel ?label . FILTER (LANGMATCHES(LANG(?label), LANG(?match))) }" : ""; |
||
907 | |||
908 | // Including the labels if there is no query term given. |
||
909 | if ($rawterm === '') { |
||
910 | $labelClause = "?s skos:prefLabel ?label ."; |
||
911 | $labelClause = ($lang) ? $labelClause . " FILTER (LANGMATCHES(LANG(?label), '$lang'))" : $labelClause . ""; |
||
912 | return $labelClause . " BIND(?label AS ?match)"; |
||
913 | } |
||
914 | |||
915 | /* |
||
916 | * This query does some tricks to obtain a list of unique concepts. |
||
917 | * From each match generated by the text index, a string such as |
||
918 | * "1en@example" is generated, where the first character is a number |
||
919 | * encoding the property and priority, then comes the language tag and |
||
920 | * finally the original literal after an @ sign. Of these, the MIN |
||
921 | * function is used to pick the best match for each concept. Finally, |
||
922 | * the structure is unpacked to get back the original string. Phew! |
||
923 | */ |
||
924 | $hitvar = $unique ? '(MIN(?matchstr) AS ?hit)' : '(?matchstr AS ?hit)'; |
||
925 | $hitgroup = $unique ? 'GROUP BY ?s ?label ?notation' : ''; |
||
926 | |||
927 | $langClause = $this->generateLangClause($searchLang); |
||
928 | |||
929 | $query = <<<EOQ |
||
930 | SELECT DISTINCT ?s ?label ?notation $hitvar |
||
931 | WHERE { |
||
932 | $graphClause { |
||
933 | { |
||
934 | $valuesProp |
||
935 | VALUES (?prop ?pri ?langParam) { (skos:prefLabel 1 $langClause) (skos:altLabel 3 $langClause) (skos:notation 5 '') (skos:hiddenLabel 7 $langClause)} |
||
936 | $textcond |
||
937 | ?s ?prop ?match } |
||
938 | OPTIONAL { |
||
939 | ?s skos:prefLabel ?label . |
||
940 | FILTER ($labelcondLabel) |
||
941 | } $labelcondFallback |
||
942 | BIND(IF(langMatches(LANG(?match),'$lang'), ?pri, ?pri+1) AS ?npri) |
||
943 | BIND(CONCAT(STR(?npri), LANG(?match), '@', STR(?match)) AS ?matchstr) |
||
944 | OPTIONAL { ?s skos:notation ?notation } |
||
945 | } |
||
946 | $filterGraph |
||
947 | } |
||
948 | $hitgroup |
||
949 | EOQ; |
||
950 | |||
951 | return $query; |
||
952 | } |
||
953 | /** |
||
954 | * This function can be overwritten in other SPARQL dialects for the possibility of handling the differenc language clauses |
||
955 | * @param string $lang |
||
956 | * @return string formatted language clause |
||
957 | */ |
||
958 | protected function generateLangClause($lang) { |
||
959 | return "'$lang'"; |
||
960 | } |
||
961 | |||
962 | /** |
||
963 | * Query for concepts using a search term. |
||
964 | * @param array|null $fields extra fields to include in the result (array of strings). (default: null = none) |
||
965 | * @param boolean $unique restrict results to unique concepts (default: false) |
||
966 | * @param boolean $showDeprecated whether to include deprecated concepts in search results (default: false) |
||
967 | * @param ConceptSearchParameters $params |
||
968 | * @return string sparql query |
||
969 | */ |
||
970 | protected function generateConceptSearchQuery($fields, $unique, $params, $showDeprecated = false) { |
||
971 | $vocabs = $params->getVocabs(); |
||
972 | $gcl = $this->graphClause; |
||
973 | $fcl = empty($vocabs) ? '' : $this->generateFromClause($vocabs); |
||
974 | $formattedtype = $this->formatTypes($params->getTypeLimit()); |
||
975 | $formattedfields = $this->formatExtraFields($params->getLang(), $fields); |
||
976 | $extravars = $formattedfields['extravars']; |
||
977 | $extrafields = $formattedfields['extrafields']; |
||
978 | $schemes = $params->getSchemeLimit(); |
||
979 | |||
980 | // limit the search to only requested concept schemes |
||
981 | $schemecond = ''; |
||
982 | if (!empty($schemes)) { |
||
983 | $conditions = array(); |
||
984 | foreach($schemes as $scheme) { |
||
985 | $conditions[] = "{?s skos:inScheme <$scheme>}"; |
||
986 | } |
||
987 | $schemecond = '{'.implode(" UNION ",$conditions).'}'; |
||
988 | } |
||
989 | $filterDeprecated=""; |
||
990 | //show or hide deprecated concepts |
||
991 | if(!$showDeprecated){ |
||
992 | $filterDeprecated="FILTER NOT EXISTS { ?s owl:deprecated true }"; |
||
993 | } |
||
994 | // extra conditions for parent and group, if specified |
||
995 | $parentcond = ($params->getParentLimit()) ? "?s skos:broader+ <" . $params->getParentLimit() . "> ." : ""; |
||
996 | $groupcond = ($params->getGroupLimit()) ? "<" . $params->getGroupLimit() . "> skos:member ?s ." : ""; |
||
997 | $pgcond = $parentcond . $groupcond; |
||
998 | |||
999 | $orderextra = $this->isDefaultEndpoint() ? $this->graph : ''; |
||
1000 | |||
1001 | # make VALUES clauses |
||
1002 | $props = array('skos:prefLabel', 'skos:altLabel'); |
||
1003 | |||
1004 | //add notation into searchable data for the vocabularies which have been configured for it |
||
1005 | if ($vocabs) { |
||
1006 | $searchByNotation = false; |
||
1007 | foreach ($vocabs as $vocab) { |
||
1008 | if ($vocab->getConfig()->searchByNotation()) { |
||
1009 | $searchByNotation = true; |
||
1010 | } |
||
1011 | } |
||
1012 | if ($searchByNotation) { |
||
1013 | $props[] = 'skos:notation'; |
||
1014 | } |
||
1015 | } |
||
1016 | |||
1017 | if ($params->getHidden()) { |
||
1018 | $props[] = 'skos:hiddenLabel'; |
||
1019 | } |
||
1020 | $filterGraph = empty($vocabs) ? $this->formatFilterGraph($vocabs) : ''; |
||
1021 | |||
1022 | // remove futile asterisks from the search term |
||
1023 | $term = $params->getSearchTerm(); |
||
1024 | while (strpos($term, '**') !== false) { |
||
1025 | $term = str_replace('**', '*', $term); |
||
1026 | } |
||
1027 | |||
1028 | $labelpriority = <<<EOQ |
||
1029 | FILTER(BOUND(?s)) |
||
1030 | BIND(STR(SUBSTR(?hit,1,1)) AS ?pri) |
||
1031 | BIND(IF((SUBSTR(STRBEFORE(?hit, '@'),1) != ?pri), STRLANG(STRAFTER(?hit, '@'), SUBSTR(STRBEFORE(?hit, '@'),2)), STRAFTER(?hit, '@')) AS ?match) |
||
1032 | BIND(IF((?pri = "1" || ?pri = "2") && ?match != ?label, ?match, ?unbound) as ?plabel) |
||
1033 | BIND(IF((?pri = "3" || ?pri = "4"), ?match, ?unbound) as ?alabel) |
||
1034 | BIND(IF((?pri = "7" || ?pri = "8"), ?match, ?unbound) as ?hlabel) |
||
1035 | EOQ; |
||
1036 | $innerquery = $this->generateConceptSearchQueryInner($params->getSearchTerm(), $params->getLang(), $params->getSearchLang(), $props, $unique, $filterGraph); |
||
1037 | if ($params->getSearchTerm() === '*' || $params->getSearchTerm() === '') { |
||
1038 | $labelpriority = ''; |
||
1039 | } |
||
1040 | $query = <<<EOQ |
||
1041 | SELECT DISTINCT ?s ?label ?plabel ?alabel ?hlabel ?graph ?notation (GROUP_CONCAT(DISTINCT STR(?type);separator=' ') as ?types) $extravars |
||
1042 | $fcl |
||
1043 | WHERE { |
||
1044 | $gcl { |
||
1045 | { |
||
1046 | $innerquery |
||
1047 | } |
||
1048 | $labelpriority |
||
1049 | $formattedtype |
||
1050 | { $pgcond |
||
1051 | ?s a ?type . |
||
1052 | $extrafields $schemecond |
||
1053 | } |
||
1054 | $filterDeprecated |
||
1055 | } |
||
1056 | $filterGraph |
||
1057 | } |
||
1058 | GROUP BY ?s ?match ?label ?plabel ?alabel ?hlabel ?notation ?graph |
||
1059 | ORDER BY LCASE(STR(?match)) LANG(?match) $orderextra |
||
1060 | EOQ; |
||
1061 | return $query; |
||
1062 | } |
||
1063 | |||
1064 | /** |
||
1065 | * Transform a single concept search query results into the skosmos desired return format. |
||
1066 | * @param $row SPARQL query result row |
||
1067 | * @param array $vocabs array of Vocabulary objects to search; empty for global search |
||
1068 | * @return array query result object |
||
1069 | */ |
||
1070 | private function transformConceptSearchResult($row, $vocabs, $fields) |
||
1146 | |||
1147 | /** |
||
1148 | * Transform the concept search query results into the skosmos desired return format. |
||
1149 | * @param EasyRdf\Sparql\Result $results |
||
1150 | * @param array $vocabs array of Vocabulary objects to search; empty for global search |
||
1151 | * @return array query result object |
||
1152 | */ |
||
1153 | private function transformConceptSearchResults($results, $vocabs, $fields) { |
||
1165 | |||
1166 | /** |
||
1167 | * Query for concepts using a search term. |
||
1168 | * @param array $vocabs array of Vocabulary objects to search; empty for global search |
||
1169 | * @param array $fields extra fields to include in the result (array of strings). (default: null = none) |
||
1170 | * @param boolean $unique restrict results to unique concepts (default: false) |
||
1171 | * @param boolean $showDeprecated whether to include deprecated concepts in the result (default: false) |
||
1172 | * @param ConceptSearchParameters $params |
||
1173 | * @return array query result object |
||
1174 | */ |
||
1175 | public function queryConcepts($vocabs, $fields = null, $unique = false, $params, $showDeprecated = false) { |
||
1180 | |||
1181 | /** |
||
1182 | * Generates sparql query clauses used for creating the alphabetical index. |
||
1183 | * @param string $letter the letter (or special class) to search for |
||
1184 | * @return array of sparql query clause strings |
||
1185 | */ |
||
1186 | private function formatFilterConditions($letter, $lang) { |
||
1211 | |||
1212 | /** |
||
1213 | * Generates the sparql query used for rendering the alphabetical index. |
||
1214 | * @param string $letter the letter (or special class) to search for |
||
1215 | * @param string $lang language of labels |
||
1216 | * @param integer $limit limits the amount of results |
||
1217 | * @param integer $offset offsets the result set |
||
1218 | * @param array|null $classes |
||
1219 | * @param boolean $showDeprecated whether to include deprecated concepts in the result (default: false) |
||
1220 | * @param \EasyRdf\Resource|null $qualifier alphabetical list qualifier resource or null (default: null) |
||
1221 | * @return string sparql query |
||
1222 | */ |
||
1223 | protected function generateAlphabeticalListQuery($letter, $lang, $limit, $offset, $classes, $showDeprecated = false, $qualifier = null) { |
||
1224 | $fcl = $this->generateFromClause(); |
||
1225 | $classes = ($classes) ? $classes : array('http://www.w3.org/2004/02/skos/core#Concept'); |
||
1226 | $values = $this->formatValues('?type', $classes, 'uri'); |
||
1227 | $limitandoffset = $this->formatLimitAndOffset($limit, $offset); |
||
1228 | $conditions = $this->formatFilterConditions($letter, $lang); |
||
1229 | $filtercondLabel = $conditions['filterpref']; |
||
1230 | $filtercondALabel = $conditions['filteralt']; |
||
1231 | $qualifierClause = $qualifier ? "OPTIONAL { ?s <" . $qualifier->getURI() . "> ?qualifier }" : ""; |
||
1232 | $filterDeprecated=""; |
||
1233 | if(!$showDeprecated){ |
||
1234 | $filterDeprecated="FILTER NOT EXISTS { ?s owl:deprecated true }"; |
||
1235 | } |
||
1236 | $query = <<<EOQ |
||
1237 | SELECT DISTINCT ?s ?label ?alabel ?qualifier $fcl |
||
1238 | WHERE { |
||
1239 | { |
||
1240 | ?s skos:prefLabel ?label . |
||
1241 | FILTER ( |
||
1242 | $filtercondLabel |
||
1243 | ) |
||
1244 | } |
||
1245 | UNION |
||
1246 | { |
||
1247 | { |
||
1248 | ?s skos:altLabel ?alabel . |
||
1249 | FILTER ( |
||
1250 | $filtercondALabel |
||
1267 | |||
1268 | /** |
||
1269 | * Transforms the alphabetical list query results into an array format. |
||
1270 | * @param EasyRdf\Sparql\Result $results |
||
1271 | * @return array |
||
1272 | */ |
||
1273 | private function transformAlphabeticalListResults($results) { |
||
1309 | |||
1310 | /** |
||
1311 | * Query for concepts with a term starting with the given letter. Also special classes '0-9' (digits), |
||
1312 | * '*!' (special characters) and '*' (everything) are accepted. |
||
1313 | * @param string $letter the letter (or special class) to search for |
||
1314 | * @param string $lang language of labels |
||
1315 | * @param integer $limit limits the amount of results |
||
1316 | * @param integer $offset offsets the result set |
||
1317 | * @param array $classes |
||
1318 | * @param boolean $showDeprecated whether to include deprecated concepts in the result (default: false) |
||
1319 | * @param \EasyRdf\Resource|null $qualifier alphabetical list qualifier resource or null (default: null) |
||
1320 | */ |
||
1321 | public function queryConceptsAlphabetical($letter, $lang, $limit = null, $offset = null, $classes = null, $showDeprecated = false, $qualifier = null) { |
||
1326 | |||
1327 | /** |
||
1328 | * Creates the query used for finding out which letters should be displayed in the alphabetical index. |
||
1329 | * Note that we force the datatype of the result variable otherwise Virtuoso does not properly interpret the DISTINCT and we have duplicated results |
||
1330 | * @param string $lang language |
||
1331 | * @return string sparql query |
||
1332 | */ |
||
1333 | private function generateFirstCharactersQuery($lang, $classes) { |
||
1347 | |||
1348 | /** |
||
1349 | * Transforms the first characters query results into an array format. |
||
1350 | * @param EasyRdf\Sparql\Result $result |
||
1351 | * @return array |
||
1352 | */ |
||
1353 | private function transformFirstCharactersResults($result) { |
||
1360 | |||
1361 | /** |
||
1362 | * Query for the first characters (letter or otherwise) of the labels in the particular language. |
||
1363 | * @param string $lang language |
||
1364 | * @return array array of characters |
||
1365 | */ |
||
1366 | public function queryFirstCharacters($lang, $classes = null) { |
||
1371 | |||
1372 | /** |
||
1373 | * @param string $uri |
||
1374 | * @param string $lang |
||
1375 | * @return string sparql query string |
||
1376 | */ |
||
1377 | private function generateLabelQuery($uri, $lang) { |
||
1404 | |||
1405 | |||
1406 | /** |
||
1407 | * @param string $uri |
||
1408 | * @param string $lang |
||
1409 | * @return string sparql query string |
||
1410 | */ |
||
1411 | private function generateAllLabelsQuery($uri, $lang) { |
||
1427 | |||
1428 | /** |
||
1429 | * Query for a label (skos:prefLabel, rdfs:label, dc:title, dc11:title) of a resource. |
||
1430 | * @param string $uri |
||
1431 | * @param string $lang |
||
1432 | * @return array array of labels (key: lang, val: label), or null if resource doesn't exist |
||
1433 | */ |
||
1434 | View Code Duplication | public function queryLabel($uri, $lang) { |
|
1454 | |||
1455 | /** |
||
1456 | * Query for skos:prefLabels, skos:altLabels and skos:hiddenLabels of a resource. |
||
1457 | * @param string $uri |
||
1458 | * @param string $lang |
||
1459 | * @return array array of prefLabels, altLabels and hiddenLabels - or null if resource doesn't exist |
||
1460 | */ |
||
1461 | public function queryAllConceptLabels($uri, $lang) { |
||
1479 | |||
1480 | /** |
||
1481 | * Generates a SPARQL query to retrieve the super properties of a given property URI. |
||
1482 | * Note this must be executed in the graph where this information is available. |
||
1483 | * @param string $uri |
||
1484 | * @return string sparql query string |
||
1485 | */ |
||
1486 | private function generateSubPropertyOfQuery($uri) { |
||
1496 | |||
1497 | /** |
||
1498 | * Query the super properties of a provided property URI. |
||
1499 | * @param string $uri URI of a propertyes |
||
1500 | * @return array array super properties, or null if none exist |
||
1501 | */ |
||
1502 | View Code Duplication | public function querySuperProperties($uri) { |
|
1521 | |||
1522 | |||
1523 | /** |
||
1524 | * Generates a sparql query for queryNotation. |
||
1525 | * @param string $uri |
||
1526 | * @return string sparql query |
||
1527 | */ |
||
1528 | private function generateNotationQuery($uri) { |
||
1539 | |||
1540 | /** |
||
1541 | * Query for the notation of the concept (skos:notation) of a resource. |
||
1542 | * @param string $uri |
||
1543 | * @return string notation or null if it doesn't exist |
||
1544 | */ |
||
1545 | public function queryNotation($uri) { |
||
1555 | |||
1556 | /** |
||
1557 | * Generates a sparql query for queryProperty. |
||
1558 | * @param string $uri |
||
1559 | * @param string $prop the name of the property eg. 'skos:broader'. |
||
1560 | * @param string $lang |
||
1561 | * @param boolean $anylang if you want a label even when it isn't available in the language you requested. |
||
1562 | * @return string sparql query |
||
1563 | */ |
||
1564 | View Code Duplication | private function generatePropertyQuery($uri, $prop, $lang, $anylang) { |
|
1588 | |||
1589 | /** |
||
1590 | * Transforms the sparql query result into an array or null if the concept doesn't exist. |
||
1591 | * @param EasyRdf\Sparql\Result $result |
||
1592 | * @param string $lang |
||
1593 | * @return array array of property values (key: URI, val: label), or null if concept doesn't exist |
||
1594 | */ |
||
1595 | private function transformPropertyQueryResults($result, $lang) { |
||
1620 | |||
1621 | /** |
||
1622 | * Query a single property of a concept. |
||
1623 | * @param string $uri |
||
1624 | * @param string $prop the name of the property eg. 'skos:broader'. |
||
1625 | * @param string $lang |
||
1626 | * @param boolean $anylang if you want a label even when it isn't available in the language you requested. |
||
1627 | * @return array array of property values (key: URI, val: label), or null if concept doesn't exist |
||
1628 | */ |
||
1629 | public function queryProperty($uri, $prop, $lang, $anylang = false) { |
||
1635 | |||
1636 | /** |
||
1637 | * Query a single transitive property of a concept. |
||
1638 | * @param string $uri |
||
1639 | * @param array $props the name of the property eg. 'skos:broader'. |
||
1640 | * @param string $lang |
||
1641 | * @param integer $limit |
||
1642 | * @param boolean $anylang if you want a label even when it isn't available in the language you requested. |
||
1643 | * @return string sparql query |
||
1644 | */ |
||
1645 | private function generateTransitivePropertyQuery($uri, $props, $lang, $limit, $anylang) { |
||
1676 | |||
1677 | /** |
||
1678 | * Transforms the sparql query result object into an array. |
||
1679 | * @param EasyRdf\Sparql\Result $result |
||
1680 | * @param string $lang |
||
1681 | * @param string $fallbacklang language to use if label is not available in the preferred language |
||
1682 | * @return array of property values (key: URI, val: label), or null if concept doesn't exist |
||
1683 | */ |
||
1684 | private function transformTransitivePropertyResults($result, $lang, $fallbacklang) { |
||
1730 | |||
1731 | /** |
||
1732 | * Query a single transitive property of a concept. |
||
1733 | * @param string $uri |
||
1734 | * @param array $props the property/properties. |
||
1735 | * @param string $lang |
||
1736 | * @param string $fallbacklang language to use if label is not available in the preferred language |
||
1737 | * @param integer $limit |
||
1738 | * @param boolean $anylang if you want a label even when it isn't available in the language you requested. |
||
1739 | * @return array array of property values (key: URI, val: label), or null if concept doesn't exist |
||
1740 | */ |
||
1741 | public function queryTransitiveProperty($uri, $props, $lang, $limit, $anylang = false, $fallbacklang = '') { |
||
1746 | |||
1747 | /** |
||
1748 | * Generates the query for a concepts skos:narrowers. |
||
1749 | * @param string $uri |
||
1750 | * @param string $lang |
||
1751 | * @param string $fallback |
||
1752 | * @return string sparql query |
||
1753 | */ |
||
1754 | private function generateChildQuery($uri, $lang, $fallback, $props) { |
||
1783 | |||
1784 | /** |
||
1785 | * Transforms the sparql result object into an array. |
||
1786 | * @param EasyRdf\Sparql\Result $result |
||
1787 | * @param string $lang |
||
1788 | * @return array array of arrays describing each child concept, or null if concept doesn't exist |
||
1789 | */ |
||
1790 | private function transformNarrowerResults($result, $lang) { |
||
1827 | |||
1828 | /** |
||
1829 | * Query the narrower concepts of a concept. |
||
1830 | * @param string $uri |
||
1831 | * @param string $lang |
||
1832 | * @param string $fallback |
||
1833 | * @return array array of arrays describing each child concept, or null if concept doesn't exist |
||
1834 | */ |
||
1835 | public function queryChildren($uri, $lang, $fallback, $props) { |
||
1840 | |||
1841 | /** |
||
1842 | * Query the top concepts of a vocabulary. |
||
1843 | * @param string $conceptSchemes concept schemes whose top concepts to query for |
||
1844 | * @param string $lang language of labels |
||
1845 | * @param string $fallback language to use if label is not available in the preferred language |
||
1846 | */ |
||
1847 | public function queryTopConcepts($conceptSchemes, $lang, $fallback) { |
||
1893 | |||
1894 | /** |
||
1895 | * Generates a sparql query for finding the hierarchy for a concept. |
||
1896 | * A concept may be a top concept in multiple schemes, returned as a single whitespace-separated literal. |
||
1897 | * @param string $uri concept uri. |
||
1898 | * @param string $lang |
||
1899 | * @param string $fallback language to use if label is not available in the preferred language |
||
1900 | * @return string sparql query |
||
1901 | */ |
||
1902 | private function generateParentListQuery($uri, $lang, $fallback, $props) { |
||
1950 | |||
1951 | /** |
||
1952 | * Transforms the result into an array. |
||
1953 | * @param EasyRdf\Sparql\Result |
||
1954 | * @param string $lang |
||
1955 | * @return an array for the REST controller to encode. |
||
1956 | */ |
||
1957 | private function transformParentListResults($result, $lang) |
||
2033 | |||
2034 | /** |
||
2035 | * Query for finding the hierarchy for a concept. |
||
2036 | * @param string $uri concept uri. |
||
2037 | * @param string $lang |
||
2038 | * @param string $fallback language to use if label is not available in the preferred language |
||
2039 | * @param array $props the hierarchy property/properties to use |
||
2040 | * @return an array for the REST controller to encode. |
||
2041 | */ |
||
2042 | public function queryParentList($uri, $lang, $fallback, $props) { |
||
2047 | |||
2048 | /** |
||
2049 | * return a list of concept group instances, sorted by label |
||
2050 | * @param string $groupClass URI of concept group class |
||
2051 | * @param string $lang language of labels to return |
||
2052 | * @return string sparql query |
||
2053 | */ |
||
2054 | private function generateConceptGroupsQuery($groupClass, $lang) { |
||
2073 | |||
2074 | /** |
||
2075 | * Transforms the sparql query result into an array. |
||
2076 | * @param EasyRdf\Sparql\Result $result |
||
2077 | * @return array |
||
2078 | */ |
||
2079 | private function transformConceptGroupsResults($result) { |
||
2107 | |||
2108 | /** |
||
2109 | * return a list of concept group instances, sorted by label |
||
2110 | * @param string $groupClass URI of concept group class |
||
2111 | * @param string $lang language of labels to return |
||
2112 | * @return array Result array with group URI as key and group label as value |
||
2113 | */ |
||
2114 | public function listConceptGroups($groupClass, $lang) { |
||
2119 | |||
2120 | /** |
||
2121 | * Generates the sparql query for listConceptGroupContents |
||
2122 | * @param string $groupClass URI of concept group class |
||
2123 | * @param string $group URI of the concept group instance |
||
2124 | * @param string $lang language of labels to return |
||
2125 | * @param boolean $showDeprecated whether to include deprecated in the result |
||
2126 | * @return string sparql query |
||
2127 | */ |
||
2128 | private function generateConceptGroupContentsQuery($groupClass, $group, $lang, $showDeprecated = false) { |
||
2152 | |||
2153 | /** |
||
2154 | * Transforms the sparql query result into an array. |
||
2155 | * @param EasyRdf\Sparql\Result $result |
||
2156 | * @param string $lang language of labels to return |
||
2157 | * @return array |
||
2158 | */ |
||
2159 | private function transformConceptGroupContentsResults($result, $lang) { |
||
2193 | |||
2194 | /** |
||
2195 | * return a list of concepts in a concept group |
||
2196 | * @param string $groupClass URI of concept group class |
||
2197 | * @param string $group URI of the concept group instance |
||
2198 | * @param string $lang language of labels to return |
||
2199 | * @param boolean $showDeprecated whether to include deprecated concepts in search results |
||
2200 | * @return array Result array with concept URI as key and concept label as value |
||
2201 | */ |
||
2202 | public function listConceptGroupContents($groupClass, $group, $lang,$showDeprecated = false) { |
||
2207 | |||
2208 | /** |
||
2209 | * Generates the sparql query for queryChangeList. |
||
2210 | * @param string $lang language of labels to return. |
||
2211 | * @param int $offset offset of results to retrieve; 0 for beginning of list |
||
2212 | * @return string sparql query |
||
2213 | */ |
||
2214 | View Code Duplication | private function generateChangeListQuery($lang, $offset, $prop) { |
|
2231 | |||
2232 | /** |
||
2233 | * Transforms the sparql query result into an array. |
||
2234 | * @param EasyRdf\Sparql\Result $result |
||
2235 | * @return array |
||
2236 | */ |
||
2237 | View Code Duplication | private function transformChangeListResults($result) { |
|
2253 | |||
2254 | /** |
||
2255 | * return a list of recently changed or entirely new concepts |
||
2256 | * @param string $lang language of labels to return |
||
2257 | * @param int $offset offset of results to retrieve; 0 for beginning of list |
||
2258 | * @return array Result array |
||
2259 | */ |
||
2260 | public function queryChangeList($lang, $offset, $prop) { |
||
2265 | } |
||
2266 |
It seems like the method you are trying to call exists only in some of the possible types.
Let’s take a look at an example:
Available Fixes
Add an additional type-check:
Only allow a single type to be passed if the variable comes from a parameter: