NatLibFi / Skosmos

model/Model.php

Doc Comments +1 added lines, -1 removed lines

@@ -523,7 +523,7 @@
      * Get the label for a resource, preferring 1. the given language 2. configured languages 3. any language.
      * @param EasyRdf_Resource $res resource whose label to return
      * @param string $lang preferred language
-     * @return EasyRdf_Literal label as an EasyRdf_Literal object, or null if not found
+     * @return string label as an EasyRdf_Literal object, or null if not found
      */
     public function getResourceLabel($res, $lang)
     {

model/VocabularyCategory.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
  */
 class VocabularyCategory extends DataObject
 {
+    /**
+     * @param Model $model
+     */
     public function __construct($model, $resource)
     {
         if (!($model instanceof Model)) {

model/GlobalConfig.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
         }
     }
     
+    /**
+     * @param string $name
+     */
     private function getConstant($name, $default)
     {
         if (defined($name) && constant($name)) {

model/Concept.php

Doc Comments +2 added lines

@@ -55,6 +55,7 @@ 
      * @param Vocabulary $vocab
      * @param EasyRdf_Resource $resource
      * @param EasyRdf_Graph $graph
+     * @param string|null $clang
      */
     public function __construct($model, $vocab, $resource, $graph, $clang)
     {
@@ -512,6 +513,7 @@ 
 
     /**
      * Gets the groups/arrays the concept belongs to.
+     * @param boolean $includeArrays
      */
     public function getReverseResources($includeArrays) {
         $groups = array();

model/sparql/GenericSparql.php

Doc Comments +5 added lines, -3 removed lines

@@ -429,7 +429,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 \Concept[]
      */
     public function queryConceptInfoGraph($uris, $arrayClass = null, $vocabs = array()) {
@@ -649,7 +649,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) {
@@ -829,6 +829,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)
@@ -1094,6 +1095,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) {
@@ -1406,7 +1408,7 @@ 
     /**
      * Query a single transitive property of a concept.
      * @param string $uri
-     * @param string $prop the name of the property eg. 'skos:broader'.
+     * @param string $props the name of the property eg. 'skos:broader'.
      * @param string $lang
      * @param integer $limit
      * @param boolean $anylang if you want a label even when it isn't available in the language you requested.

controller/RestController.php

Doc Comments +34 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,9 @@ 
         return $parameters;    
     }
 
+    /**
+     * @param Request $request
+     */
     private function transformSearchResults($request, $results)
     {
         // before serializing to JSON, get rid of the Vocabulary object that came with each resource
@@ -391,6 +397,10 @@ 
         return $this->returnJson($ret);
     }
     
+    /**
+     * @param string $label
+     * @param string $lang
+     */
     private function findLookupHits($results, $label, $lang)
     {
         $hits = array();
@@ -452,6 +462,10 @@ 
         return $hits;   
     }
     
+    /**
+     * @param string $lang
+     * @param string $label
+     */
     private function transformLookupResults($lang, $hits, $label)
     {
         if (sizeof($hits) == 0) {
@@ -521,6 +535,9 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param Request $request
+     */
     private function redirectToVocabData($request) {
         $urls = $request->getVocab()->getConfig()->getDataURLs();
         if (sizeof($urls) == 0) {
@@ -536,6 +553,9 @@ 
         header("Location: " . $urls[$format]);
     }
     
+    /**
+     * @param string $format
+     */
     private function returnDataResults($results, $format) {
         if ($format == 'application/ld+json' || $format == 'application/json') {
             // further compact JSON-LD document using a context
@@ -626,6 +646,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();
@@ -641,6 +667,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();

model/SkosmosTurtleParser.php

Doc Comments +1 added lines

@@ -55,6 +55,7 @@
 
     /**
      * Steps back, restoring the previous character or statement read() to the input buffer.
+     * @param string $chars
      */
     protected function unread($chars)
     {