NatLibFi / Skosmos

controller/RestController.php

Doc Comments +35 added lines

@@ -97,6 +97,9 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param Request $request
+     */
     private function constructSearchParameters($request)
     {
         $parameters = new ConceptSearchParameters($request, $this->model->getConfig(), true);
@@ -112,6 +115,10 @@ 
         return $parameters;
     }
 
+    /**
+     * @param Request $request
+     * @param ConceptSearchParameters $parameters
+     */
     private function transformSearchResults($request, $results, $parameters)
     {
         // before serializing to JSON, get rid of the Vocabulary object that came with each resource
@@ -407,6 +414,10 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param string $label
+     * @param string $lang
+     */
     private function findLookupHits($results, $label, $lang)
     {
         $hits = array();
@@ -468,6 +479,9 @@ 
         return $hits;
     }
 
+    /**
+     * @param string $lang
+     */
     private function transformLookupResults($lang, $hits)
     {
         if (sizeof($hits) == 0) {
@@ -539,6 +553,9 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param Request $request
+     */
     private function redirectToVocabData($request) {
         $urls = $request->getVocab()->getConfig()->getDataURLs();
         if (sizeof($urls) == 0) {
@@ -564,6 +581,10 @@ 
 		}
     }
 
+    /**
+     * @param string $results
+     * @param string $format
+     */
     private function returnDataResults($results, $format) {
         if ($format == 'application/ld+json' || $format == 'application/json') {
             // further compact JSON-LD document using a context
@@ -693,6 +714,12 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param string $uri
+     * @param string $lang
+     * @param string $propname
+     * @param string $propuri
+     */
     private function transformPropertyResults($uri, $lang, $objects, $propname, $propuri)
     {
         $results = array();
@@ -708,6 +735,14 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $uri
+     * @param string $lang
+     * @param string $tpropname
+     * @param string $tpropuri
+     * @param string $dpropname
+     * @param string $dpropuri
+     */
     private function transformTransitivePropertyResults($uri, $lang, $objects, $tpropname, $tpropuri, $dpropname, $dpropuri)
     {
         $results = array();

Indentation +10 added lines, -10 removed lines

@@ -550,18 +550,18 @@
         if (!$format) {
             return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: " . implode(' ', array_keys($urls)));
         }
-		if (is_array($urls[$format])) {
-			$arr = $urls[$format];
-			$dataLang = $request->getLang();
-			if (isset($arr[$dataLang])) {
+    if (is_array($urls[$format])) {
+      $arr = $urls[$format];
+      $dataLang = $request->getLang();
+      if (isset($arr[$dataLang])) {
                 header("Location: " . $arr[$dataLang]);
-			} else {
-				$vocid = $request->getVocab()->getId();
-				return $this->returnError('404', 'Not Found', "No download source URL known for vocabulary $vocid in language $dataLang");
-			}
-		} else {
+      } else {
+        $vocid = $request->getVocab()->getId();
+        return $this->returnError('404', 'Not Found', "No download source URL known for vocabulary $vocid in language $dataLang");
+      }
+    } else {
             header("Location: " . $urls[$format]);
-		}
+    }
     }
 
     private function returnDataResults($results, $format) {

Spacing +16 added lines, -16 removed lines

@@ -25,7 +25,7 @@ 
         // wrap with JSONP callback if requested
         if (filter_input(INPUT_GET, 'callback', FILTER_SANITIZE_STRING)) {
             header("Content-type: application/javascript; charset=utf-8");
-            echo filter_input(INPUT_GET, 'callback', FILTER_UNSAFE_RAW) . "(" . json_encode($data) . ");";
+            echo filter_input(INPUT_GET, 'callback', FILTER_UNSAFE_RAW)."(".json_encode($data).");";
             return;
         }
 
@@ -88,7 +88,7 @@ 
                 'vocabularies' => 'onki:hasVocabulary',
                 'id' => 'onki:vocabularyIdentifier',
                 'uri' => '@id',
-                '@base' => $this->getBaseHref() . "rest/v1/vocabularies",
+                '@base' => $this->getBaseHref()."rest/v1/vocabularies",
             ),
             'uri' => '',
             'vocabularies' => $results,
@@ -105,7 +105,7 @@ 
         // convert to vocids array to support multi-vocabulary search
         $vocids = ($vocabs !== null && $vocabs !== '') ? explode(' ', $vocabs) : array();
         $vocabObjects = array();
-        foreach($vocids as $vocid) {
+        foreach ($vocids as $vocid) {
             $vocabObjects[] = $this->model->getVocabulary($vocid);
         }
         $parameters->setVocabularies($vocabObjects);
@@ -136,12 +136,12 @@ 
         foreach ($parameters->getAdditionalFields() as $field) {
 
             // Quick-and-dirty compactification
-            $context[$field] = 'skos:' . $field;
+            $context[$field] = 'skos:'.$field;
             foreach ($results as &$result) {
                 foreach ($result as $k => $v) {
-                    if ($k == 'skos:' . $field) {
+                    if ($k == 'skos:'.$field) {
                         $result[$field] = $v;
-                        unset($result['skos:' . $field]);
+                        unset($result['skos:'.$field]);
                     }
                 }
             }
@@ -160,7 +160,7 @@ 
         if ($request->getQueryParam('labellang')) {
             $ret['@context']['@language'] = $request->getQueryParam('labellang');
         } elseif ($request->getQueryParam('lang')) {
-            $ret['@context']['@language'] = $request->getQueryParam('lang');;
+            $ret['@context']['@language'] = $request->getQueryParam('lang'); ;
         }
         return $ret;
     }
@@ -226,7 +226,7 @@ 
                 'prefLabel' => 'skos:prefLabel',
                 'title' => 'dct:title',
                 '@language' => $request->getLang(),
-                '@base' => $this->getBaseHref() . "rest/v1/" . $vocab->getId() . "/",
+                '@base' => $this->getBaseHref()."rest/v1/".$vocab->getId()."/",
             ),
             'uri' => '',
             'id' => $vocab->getId(),
@@ -277,7 +277,7 @@ 
                 'subTypes' => array('@id' => 'void:class', '@type' => '@id'),
                 'count' => 'void:entities',
                 '@language' => $request->getLang(),
-                '@base' => $this->getBaseHref() . "rest/v1/" . $request->getVocab()->getId() . "/",
+                '@base' => $this->getBaseHref()."rest/v1/".$request->getVocab()->getId()."/",
             ),
             'uri' => '',
             'id' => $request->getVocab()->getId(),
@@ -351,7 +351,7 @@ 
                 'language' => 'void-ext:language',
                 'properties' => 'void:propertyPartition',
                 'labels' => 'void:triples',
-                '@base' => $this->getBaseHref() . "rest/v1/" . $request->getVocab()->getId() . "/",
+                '@base' => $this->getBaseHref()."rest/v1/".$request->getVocab()->getId()."/",
             ),
             'uri' => '',
             'id' => $request->getVocab()->getId(),
@@ -388,7 +388,7 @@ 
             $types[] = $type;
         }
 
-        $base = $request->getVocab() ? $this->getBaseHref() . "rest/v1/" . $request->getVocab()->getId() . "/" : $this->getBaseHref() . "rest/v1/";
+        $base = $request->getVocab() ? $this->getBaseHref()."rest/v1/".$request->getVocab()->getId()."/" : $this->getBaseHref()."rest/v1/";
 
         $ret = array_merge_recursive($this->context, array(
             '@context' => array(
@@ -548,19 +548,19 @@ 
 
         $format = $this->negotiateFormat(array_keys($urls), $request->getServerConstant('HTTP_ACCEPT'), $request->getQueryParam('format'));
         if (!$format) {
-            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: " . implode(' ', array_keys($urls)));
+            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: ".implode(' ', array_keys($urls)));
         }
 		if (is_array($urls[$format])) {
 			$arr = $urls[$format];
 			$dataLang = $request->getLang();
 			if (isset($arr[$dataLang])) {
-                header("Location: " . $arr[$dataLang]);
+                header("Location: ".$arr[$dataLang]);
 			} else {
 				$vocid = $request->getVocab()->getId();
 				return $this->returnError('404', 'Not Found', "No download source URL known for vocabulary $vocid in language $dataLang");
 			}
 		} else {
-            header("Location: " . $urls[$format]);
+            header("Location: ".$urls[$format]);
 		}
     }
 
@@ -620,7 +620,7 @@ 
 
         $format = $this->negotiateFormat(explode(' ', self::SUPPORTED_FORMATS), $request->getServerConstant('HTTP_ACCEPT'), $request->getQueryParam('format'));
         if (!$format) {
-            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: " . self::SUPPORTED_FORMATS);
+            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: ".self::SUPPORTED_FORMATS);
         }
 
         $vocid = $vocab ? $vocab->getId() : null;
@@ -814,7 +814,7 @@ 
                         }
                     }
                     // if the main concept scheme was not found, set 'top' to the first 'tops' (sorted alphabetically on the URIs)
-                    if (! isset($results[$uri]['top'])) {
+                    if (!isset($results[$uri]['top'])) {
                         $results[$uri]['top'] = $results[$uri]['tops'][0];
                     }
                 } else {