NatLibFi / Skosmos

controller/RestController.php

Doc Comments +36 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
@@ -420,6 +427,10 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param string $label
+     * @param string $lang
+     */
     private function findLookupHits($results, $label, $lang)
     {
         $hits = array();
@@ -481,6 +492,9 @@ 
         return $hits;
     }
 
+    /**
+     * @param string $lang
+     */
     private function transformLookupResults($lang, $hits)
     {
         if (sizeof($hits) == 0) {
@@ -555,6 +569,9 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param Request $request
+     */
     private function redirectToVocabData($request) {
         $urls = $request->getVocab()->getConfig()->getDataURLs();
         if (sizeof($urls) == 0) {
@@ -580,6 +597,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
@@ -791,6 +812,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();
@@ -805,6 +832,14 @@ 
         );
     }
 
+    /**
+     * @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();
@@ -1095,6 +1130,7 @@ 
      * @param Request $request
      * @param int $offset starting index offset
      * @param int $limit maximum number of concepts to return
+     * @param string $prop
      * @return object json-ld wrapped list of changed concepts
      */
     private function changedConcepts($request, $prop, $offset, $limit)

model/Vocabulary.php

Doc Comments +11 added lines, -2 removed lines

@@ -131,7 +131,7 @@ 
      * Get the localname of a concept in the vocabulary. If the URI is not
      * in the URI space of this vocabulary, return the full URI.
      *
-     * @param $uri string full URI of concept
+     * @param string $uri string full URI of concept
      * @return string local name of concept, or original full URI if the local name cannot be determined
      */
     public function getLocalName($uri)
@@ -303,6 +303,8 @@ 
 
     /**
      * Counts the statistics of the vocabulary.
+     * @param string $array
+     * @param string $group
      * @return array of the concept/group counts
      */
     public function getStatistics($lang = '', $array=null, $group=null)
@@ -342,6 +344,7 @@ 
     /**
      * Gets the child relations of a concept and whether these children have more children.
      * @param string $uri
+     * @param string $lang
      */
     public function getConceptChildren($uri, $lang)
     {
@@ -450,6 +453,8 @@ 
     /**
      * Lists the concepts available in the concept group.
      * @param $clname
+     * @param string $glname
+     * @param string $clang
      * @return array
      */
     public function listConceptGroupContents($glname, $clang)
@@ -476,7 +481,7 @@ 
     /**
      * Returns the letters of the alphabet which have been used in this vocabulary.
      * The returned letters may also include specials such as '0-9' (digits) and '!*' (special characters).
-     * @param $clang content language
+     * @param string $clang content language
      * @return array array of letters
      */
     public function getAlphabet($clang)
@@ -511,6 +516,7 @@ 
      * Also the special tokens '0-9' (digits), '!*' (special characters) and '*'
      * (everything) are supported.
      * @param $letter letter (or special token) to search for
+     * @param string $clang
      */
     public function searchConceptsAlphabetical($letter, $limit = null, $offset = null, $clang = null)
     {
@@ -626,6 +632,9 @@ 
       return $this->getSparql()->queryChangeList($prop, $clang, $offset, $limit);
     }
 
+    /**
+     * @param string $lang
+     */
     public function getTitle($lang=null) {
       return $this->config->getTitle($lang);
     }