NatLibFi / Skosmos

model/sparql/GenericSparql.php

Doc Comments +10 added lines, -6 removed lines

@@ -262,8 +262,8 @@ 
 	
     /**
     * Used to generate the BIND + FILTER part related to the languages
-    * @param $varnameInput the name of the variable from which to extract the language
-    * @param $varnameOutput the name of the variable that will contain the language tag
+    * @param string $varnameInput the name of the variable from which to extract the language
+    * @param string $varnameOutput the name of the variable that will contain the language tag
     * @param array $values languages to use in the FILTER
     * @return string part of the sparql query dealing wit the languages 
     */
@@ -312,6 +312,7 @@ 
     /**
      * Counts the number of concepts in a easyRDF graph with a specific language.
      * @param array $langs Languages to query for
+     * @param string[] $classes
      * @return Array containing count of concepts for each language and property.
      */
     public function countLangConcepts($langs, $classes = null) {
@@ -496,7 +497,7 @@ 
      * Returns information (as a graph) for one or more concept URIs
      * @param mixed $uris concept URI (string) or array of URIs
      * @param string|null $arrayClass the URI for thesaurus array class, or null if not used
-     * @param \Vocabulary[]|null $vocabs vocabularies to target
+     * @param Vocabulary[] $vocabs vocabularies to target
      * @return \EasyRdf\Graph
      */
     public function queryConceptInfoGraph($uris, $arrayClass = null, $vocabs = array()) {
@@ -512,7 +513,7 @@ 
 
     /**
      * Returns information (as an array of Concept objects) for one or more concept URIs
-     * @param mixed $uris concept URI (string) or array of URIs
+     * @param string $uris concept URI (string) or array of URIs
      * @param string|null $arrayClass the URI for thesaurus array class, or null if not used
      * @param \Vocabulary[] $vocabs vocabularies to target
      * @param string|null $clang content language
@@ -727,7 +728,7 @@ 
 
     /**
      * Generate a VALUES clause for limiting the targeted graphs.
-     * @param Vocabulary[]|null $vocabs array of Vocabulary objects to target
+     * @param Vocabulary[] $vocabs array of Vocabulary objects to target
      * @return string VALUES clause, or "" if not necessary to limit
      */
     protected function formatValuesGraph($vocabs) {
@@ -907,6 +908,7 @@ 
      * @param string $searchLang language code used for matching labels (null means any language)
      * @param string[] $props properties to target e.g. array('skos:prefLabel','skos:altLabel')
      * @param boolean $unique restrict results to unique concepts (default: false)
+     * @param string $filterGraph
      * @return string sparql query
      */
     protected function generateConceptSearchQueryInner($term, $lang, $searchLang, $props, $unique, $filterGraph)
@@ -1181,6 +1183,7 @@ 
     /**
      * Generates sparql query clauses used for creating the alphabetical index.
      * @param string $letter the letter (or special class) to search for
+     * @param string $lang
      * @return array of sparql query clause strings
      */
     private function formatFilterConditions($letter, $lang) {
@@ -1348,6 +1351,7 @@ 
     /**
      * Query for the first characters (letter or otherwise) of the labels in the particular language.
      * @param string $lang language
+     * @param string[] $classes
      * @return array array of characters
      */
     public function queryFirstCharacters($lang, $classes = null) {
@@ -1670,7 +1674,7 @@ 
     /**
      * Query a single transitive property of a concept.
      * @param string $uri
-     * @param array $props the property/properties.
+     * @param string[] $props the property/properties.
      * @param string $lang
      * @param string $fallbacklang language to use if label is not available in the preferred language
      * @param integer $limit

Indentation +17 added lines, -17 removed lines

@@ -64,7 +64,7 @@ 
      *
      * @param string $query
      * @return string
-    */
+     */
     protected function generateQueryPrefixes($query)
     {
         // Check for undefined prefixes
@@ -261,25 +261,25 @@ 
     }
 	
     /**
-    * Used to generate the BIND + FILTER part related to the languages
-    * @param $varnameInput the name of the variable from which to extract the language
-    * @param $varnameOutput the name of the variable that will contain the language tag
-    * @param array $values languages to use in the FILTER
-    * @return string part of the sparql query dealing wit the languages 
-    */
+     * Used to generate the BIND + FILTER part related to the languages
+     * @param $varnameInput the name of the variable from which to extract the language
+     * @param $varnameOutput the name of the variable that will contain the language tag
+     * @param array $values languages to use in the FILTER
+     * @return string part of the sparql query dealing wit the languages 
+     */
     protected function formatValuesFilterAndBind($varnameInput, $varnameOutput, $values) {
-    	  $queryPart = "BIND(lang($varnameInput) AS $varnameOutput)";
-	      $first = true;
+        $queryPart = "BIND(lang($varnameInput) AS $varnameOutput)";
+        $first = true;
 
-	      $queryPart .= "FILTER(" ;
+        $queryPart .= "FILTER(" ;
         foreach ($values as $val) {
             if($first != true){
               $queryPart .= ' || ';
             }
-	      $first = false;
+        $first = false;
             $queryPart .= "$varnameOutput = '$val'";
         }
-	      $queryPart .= ")";
+        $queryPart .= ")";
 
         return $queryPart;
     }
@@ -1832,7 +1832,7 @@ 
 
     /**
      * Generates a sparql query for finding the hierarchy for a concept.
-	 * A concept may be a top concept in multiple schemes, returned as a single whitespace-separated literal.
+     * A concept may be a top concept in multiple schemes, returned as a single whitespace-separated literal.
      * @param string $uri concept uri.
      * @param string $lang
      * @param string $fallback language to use if label is not available in the preferred language
@@ -1909,10 +1909,10 @@ 
                 $ret[$uri]['exact'] = $row->exact->getUri();
             }
             if (isset($row->tops)) {
-               $topConceptsList=explode(" ", $row->tops->getValue());
-               // sort to garantee an alphabetical ordering of the URI
-               sort($topConceptsList);
-               $ret[$uri]['tops'] = $topConceptsList;
+                $topConceptsList=explode(" ", $row->tops->getValue());
+                // sort to garantee an alphabetical ordering of the URI
+                sort($topConceptsList);
+                $ret[$uri]['tops'] = $topConceptsList;
             }
             if (isset($row->children)) {
                 if (!isset($ret[$uri]['narrower'])) {

Spacing +54 added lines, -54 removed lines

@@ -87,11 +87,11 @@ 
     protected function query($query) {
         $queryId = sprintf("%05d", rand(0, 99999));
         $logger = $this->model->getLogger();
-        $logger->info("[qid $queryId] SPARQL query:\n" . $this->generateQueryPrefixes($query) . "\n$query\n");
+        $logger->info("[qid $queryId] SPARQL query:\n".$this->generateQueryPrefixes($query)."\n$query\n");
         $starttime = microtime(true);
         $result = $this->client->query($query);
         $elapsed = intval(round((microtime(true) - $starttime) * 1000));
-        if(method_exists($result, 'numRows')) {
+        if (method_exists($result, 'numRows')) {
             $numRows = $result->numRows();
             $logger->info("[qid $queryId] result: $numRows rows returned in $elapsed ms");
         } else { // graph result
@@ -107,20 +107,20 @@ 
      * @param Vocabulary[]|null $vocabs
      * @return string
      */
-    protected function generateFromClause($vocabs=null) {
+    protected function generateFromClause($vocabs = null) {
         $graphs = array();
         $clause = '';
         if (!$vocabs) {
             return $this->graph !== '?graph' && $this->graph !== NULL ? "FROM <$this->graph>" : '';
         }
-        foreach($vocabs as $vocab) {
+        foreach ($vocabs as $vocab) {
             $graph = $vocab->getGraph();
             if (!in_array($graph, $graphs)) {
                 array_push($graphs, $graph);
             }
         }
         foreach ($graphs as $graph) {
-            if($graph !== NULL)
+            if ($graph !== NULL)
                 $clause .= "FROM NAMED <$graph> "; 
         }
         return $clause;
@@ -271,9 +271,9 @@ 
     	  $queryPart = "BIND(lang($varnameInput) AS $varnameOutput)";
 	      $first = true;
 
-	      $queryPart .= "FILTER(" ;
+	      $queryPart .= "FILTER(";
         foreach ($values as $val) {
-            if($first != true){
+            if ($first != true) {
               $queryPart .= ' || ';
             }
 	      $first = false;
@@ -687,9 +687,9 @@ 
                 $conceptscheme['title'] = $row->title->getValue();
             }
             // add dct:subject and their labels in the result
-            if(isset($row->domain) && isset($row->domainLabel)){
-                $conceptscheme['subject']['uri']=$row->domain->getURI();
-                $conceptscheme['subject']['prefLabel']=$row->domainLabel->getValue();
+            if (isset($row->domain) && isset($row->domainLabel)) {
+                $conceptscheme['subject']['uri'] = $row->domain->getURI();
+                $conceptscheme['subject']['prefLabel'] = $row->domainLabel->getValue();
             }
 
             $ret[$row->cs->getURI()] = $conceptscheme;
@@ -752,7 +752,7 @@ 
         foreach ($graphs as $graph) {
           $values[] = "<$graph>";
         }
-        return "FILTER (?graph IN (" . implode(',', $values) . "))";
+        return "FILTER (?graph IN (".implode(',', $values)."))";
     }
 
     /**
@@ -762,16 +762,16 @@ 
      * @return string sparql query clauses
      */
     protected function formatLimitAndOffset($limit, $offset) {
-        $limit = ($limit) ? 'LIMIT ' . $limit : '';
-        $offset = ($offset) ? 'OFFSET ' . $offset : '';
+        $limit = ($limit) ? 'LIMIT '.$limit : '';
+        $offset = ($offset) ? 'OFFSET '.$offset : '';
         // eliminating whitespace and line changes when the conditions aren't needed.
         $limitandoffset = '';
         if ($limit && $offset) {
-            $limitandoffset = "\n" . $limit . "\n" . $offset;
+            $limitandoffset = "\n".$limit."\n".$offset;
         } elseif ($limit) {
-            $limitandoffset = "\n" . $limit;
+            $limitandoffset = "\n".$limit;
         } elseif ($offset) {
-            $limitandoffset = "\n" . $offset;
+            $limitandoffset = "\n".$offset;
         }
 
         return $limitandoffset;
@@ -923,14 +923,14 @@ 
         // if search language and UI/display language differ, must also consider case where there is no prefLabel in
         // the display language; in that case, should use the label with the same language as the matched label
         $labelcondFallback = ($searchLang != $lang) ?
-          "OPTIONAL { # in case previous OPTIONAL block gives no labels\n" .
+          "OPTIONAL { # in case previous OPTIONAL block gives no labels\n".
           "?s skos:prefLabel ?label . FILTER (LANGMATCHES(LANG(?label), LANG(?match))) }" : "";
           
         //  Including the labels if there is no query term given.
         if ($rawterm === '') {
           $labelClause = "?s skos:prefLabel ?label .";
-          $labelClause = ($lang) ? $labelClause . " FILTER (LANGMATCHES(LANG(?label), '$lang'))" : $labelClause . "";
-          return $labelClause . " BIND(?label AS ?match)";
+          $labelClause = ($lang) ? $labelClause." FILTER (LANGMATCHES(LANG(?label), '$lang'))" : $labelClause."";
+          return $labelClause." BIND(?label AS ?match)";
         }
 
         /*
@@ -994,20 +994,20 @@ 
         $schemecond = '';
         if (!empty($schemes)) {
             $conditions = array();
-            foreach($schemes as $scheme) {
+            foreach ($schemes as $scheme) {
                 $conditions[] = "{?s skos:inScheme <$scheme>}";
             }
-            $schemecond = '{'.implode(" UNION ",$conditions).'}';
+            $schemecond = '{'.implode(" UNION ", $conditions).'}';
         }
-        $filterDeprecated="";
+        $filterDeprecated = "";
         //show or hide deprecated concepts
-        if(!$showDeprecated){
-            $filterDeprecated="FILTER NOT EXISTS { ?s owl:deprecated true }";
+        if (!$showDeprecated) {
+            $filterDeprecated = "FILTER NOT EXISTS { ?s owl:deprecated true }";
         }
         // extra conditions for parent and group, if specified
-        $parentcond = ($params->getParentLimit()) ? "?s skos:broader+ <" . $params->getParentLimit() . "> ." : "";
-        $groupcond = ($params->getGroupLimit()) ? "<" . $params->getGroupLimit() . "> skos:member ?s ." : "";
-        $pgcond = $parentcond . $groupcond;
+        $parentcond = ($params->getParentLimit()) ? "?s skos:broader+ <".$params->getParentLimit()."> ." : "";
+        $groupcond = ($params->getGroupLimit()) ? "<".$params->getGroupLimit()."> skos:member ?s ." : "";
+        $pgcond = $parentcond.$groupcond;
 
         $orderextra = $this->isDefaultEndpoint() ? $this->graph : '';
 
@@ -1080,9 +1080,9 @@ 
             $hit['type'][] = $this->shortenUri($typeuri);
         }
 
-        if(!empty($fields)) {
+        if (!empty($fields)) {
             foreach ($fields as $prop) {
-                $propname = $prop . 's';
+                $propname = $prop.'s';
                 if (isset($row->$propname)) {
                     foreach (explode("\n", $row->$propname->getValue()) as $line) {
                         $rdata = str_getcsv($line, ',', '"', '"');
@@ -1097,7 +1097,7 @@ 
                             $propvals = $rdata[2];
                         }
 
-                        $hit['skos:' . $prop][] = $propvals;
+                        $hit['skos:'.$prop][] = $propvals;
                     }
                 }
             }
@@ -1173,7 +1173,7 @@ 
      * @return array query result object
      */
     public function queryConcepts($vocabs, $fields = null, $unique = false, $params, $showDeprecated = false) {
-        $query = $this->generateConceptSearchQuery($fields, $unique, $params,$showDeprecated);
+        $query = $this->generateConceptSearchQuery($fields, $unique, $params, $showDeprecated);
         $results = $this->query($query);
         return $this->transformConceptSearchResults($results, $vocabs, $fields);
     }
@@ -1227,9 +1227,9 @@ 
         $conditions = $this->formatFilterConditions($letter, $lang);
         $filtercondLabel = $conditions['filterpref'];
         $filtercondALabel = $conditions['filteralt'];
-        $filterDeprecated="";
-        if(!$showDeprecated){
-            $filterDeprecated="FILTER NOT EXISTS { ?s owl:deprecated true }";
+        $filterDeprecated = "";
+        if (!$showDeprecated) {
+            $filterDeprecated = "FILTER NOT EXISTS { ?s owl:deprecated true }";
         }
         $query = <<<EOQ
 SELECT DISTINCT ?s ?label ?alabel $fcl
@@ -1305,8 +1305,8 @@ 
      * @param array $classes
      * @param boolean $showDeprecated whether to include deprecated concepts in the result (default: false)
      */
-    public function queryConceptsAlphabetical($letter, $lang, $limit = null, $offset = null, $classes = null,$showDeprecated = false) {
-        $query = $this->generateAlphabeticalListQuery($letter, $lang, $limit, $offset, $classes,$showDeprecated);
+    public function queryConceptsAlphabetical($letter, $lang, $limit = null, $offset = null, $classes = null, $showDeprecated = false) {
+        $query = $this->generateAlphabeticalListQuery($letter, $lang, $limit, $offset, $classes, $showDeprecated);
         $results = $this->query($query);
         return $this->transformAlphabeticalListResults($results);
     }
@@ -1640,7 +1640,7 @@ 
                 if (!isset($row->label) || $row->label->getLang() === $lang) {
                     $ret[$row->object->getUri()] = $val;
                 } elseif ($row->label->getLang() === $fallbacklang) {
-                    $val['label'] .= ' (' . $row->label->getLang() . ')';
+                    $val['label'] .= ' ('.$row->label->getLang().')';
                     $ret[$row->object->getUri()] = $val;
                 }
             }
@@ -1736,10 +1736,10 @@ 
 
             $label = null;
             if (isset($row->label)) {
-                if ($row->label->getLang() == $lang || strpos($row->label->getLang(), $lang . "-") == 0) {
+                if ($row->label->getLang() == $lang || strpos($row->label->getLang(), $lang."-") == 0) {
                     $label = $row->label->getValue();
                 } else {
-                    $label = $row->label->getValue() . " (" . $row->label->getLang() . ")";
+                    $label = $row->label->getValue()." (".$row->label->getLang().")";
                 }
 
             }
@@ -1815,8 +1815,8 @@ 
         foreach ($result as $row) {
             if (isset($row->top) && isset($row->label)) {
                 $label = $row->label->getValue();
-                if ($row->label->getLang() && $row->label->getLang() !== $lang && strpos($row->label->getLang(), $lang . "-") !== 0) {
-                    $label .= ' (' . $row->label->getLang() . ')';
+                if ($row->label->getLang() && $row->label->getLang() !== $lang && strpos($row->label->getLang(), $lang."-") !== 0) {
+                    $label .= ' ('.$row->label->getLang().')';
                 }
                 $top = array('uri' => $row->top->getUri(), 'topConceptOf' => $row->topuri->getUri(), 'label' => $label, 'hasChildren' => filter_var($row->children->getValue(), FILTER_VALIDATE_BOOLEAN));
                 if (isset($row->notation)) {
@@ -1909,7 +1909,7 @@ 
                 $ret[$uri]['exact'] = $row->exact->getUri();
             }
             if (isset($row->tops)) {
-               $topConceptsList=explode(" ", $row->tops->getValue());
+               $topConceptsList = explode(" ", $row->tops->getValue());
                // sort to garantee an alphabetical ordering of the URI
                sort($topConceptsList);
                $ret[$uri]['tops'] = $topConceptsList;
@@ -1922,8 +1922,8 @@ 
                 $label = null;
                 if (isset($row->childlabel)) {
                     $label = $row->childlabel->getValue();
-                    if ($row->childlabel->getLang() !== $lang && strpos($row->childlabel->getLang(), $lang . "-") !== 0) {
-                        $label .= " (" . $row->childlabel->getLang() . ")";
+                    if ($row->childlabel->getLang() !== $lang && strpos($row->childlabel->getLang(), $lang."-") !== 0) {
+                        $label .= " (".$row->childlabel->getLang().")";
                     }
 
                 }
@@ -1944,8 +1944,8 @@ 
             }
             if (isset($row->label)) {
                 $preflabel = $row->label->getValue();
-                if ($row->label->getLang() && $row->label->getLang() !== $lang && strpos($row->label->getLang(), $lang . "-") !== 0) {
-                    $preflabel .= ' (' . $row->label->getLang() . ')';
+                if ($row->label->getLang() && $row->label->getLang() !== $lang && strpos($row->label->getLang(), $lang."-") !== 0) {
+                    $preflabel .= ' ('.$row->label->getLang().')';
                 }
 
                 $ret[$uri]['prefLabel'] = $preflabel;
@@ -2066,9 +2066,9 @@ 
      */
     private function generateConceptGroupContentsQuery($groupClass, $group, $lang, $showDeprecated = false) {
         $fcl = $this->generateFromClause();
-        $filterDeprecated="";
-        if(!$showDeprecated){
-            $filterDeprecated="  FILTER NOT EXISTS { ?conc owl:deprecated true }";
+        $filterDeprecated = "";
+        if (!$showDeprecated) {
+            $filterDeprecated = "  FILTER NOT EXISTS { ?conc owl:deprecated true }";
         }
         $query = <<<EOQ
 SELECT ?conc ?super ?label ?members ?type ?notation $fcl
@@ -2107,10 +2107,10 @@ 
                     'type' => array($row->type->shorten()),
                 );
                 if (isset($row->label)) {
-                    if ($row->label->getLang() == $lang || strpos($row->label->getLang(), $lang . "-") == 0) {
+                    if ($row->label->getLang() == $lang || strpos($row->label->getLang(), $lang."-") == 0) {
                         $values[$row->conc->getURI()]['prefLabel'] = $row->label->getValue();
                     } else {
-                        $values[$row->conc->getURI()]['prefLabel'] = $row->label->getValue() . " (" . $row->label->getLang() . ")";
+                        $values[$row->conc->getURI()]['prefLabel'] = $row->label->getValue()." (".$row->label->getLang().")";
                     }
 
                 }
@@ -2138,8 +2138,8 @@ 
      * @param boolean $showDeprecated whether to include deprecated concepts in search results
      * @return array Result array with concept URI as key and concept label as value
      */
-    public function listConceptGroupContents($groupClass, $group, $lang,$showDeprecated = false) {
-        $query = $this->generateConceptGroupContentsQuery($groupClass, $group, $lang,$showDeprecated);
+    public function listConceptGroupContents($groupClass, $group, $lang, $showDeprecated = false) {
+        $query = $this->generateConceptGroupContentsQuery($groupClass, $group, $lang, $showDeprecated);
         $result = $this->query($query);
         return $this->transformConceptGroupContentsResults($result, $lang);
     }
@@ -2152,7 +2152,7 @@ 
      */
     private function generateChangeListQuery($lang, $offset, $prop) {
         $fcl = $this->generateFromClause();
-        $offset = ($offset) ? 'OFFSET ' . $offset : '';
+        $offset = ($offset) ? 'OFFSET '.$offset : '';
 
         $query = <<<EOQ
 SELECT DISTINCT ?concept ?date ?label $fcl