NatLibFi / Skosmos

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/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)
     {

model/LabelSkosXL.php

Doc Comments +3 added lines

@@ -3,6 +3,9 @@
 class LabelSkosXL extends DataObject
 {
 
+    /**
+     * @param Model $model
+     */
     public function __construct($model, $resource)
     {
         parent::__construct($model, $resource);

model/ConceptPropertyValueLiteral.php

Doc Comments +5 added lines

@@ -10,6 +10,11 @@
     /** property type */
     private $type;
 
+    /**
+     * @param Model $model
+     * @param Vocabulary $vocab
+     * @param Resource $resource
+     */
     public function __construct($model, $vocab, $resource, $literal, $prop)
     {
         parent::__construct($model, $vocab, $resource);

model/Concept.php

Doc Comments +2 added lines

@@ -74,6 +74,7 @@ 
      * @param Vocabulary $vocab
      * @param EasyRdf\Resource $resource
      * @param EasyRdf\Graph $graph
+     * @param string|null $clang
      */
     public function __construct($model, $vocab, $resource, $graph, $clang)
     {
@@ -738,6 +739,7 @@ 
 
     /**
      * Gets the groups/arrays the concept belongs to.
+     * @param boolean $includeArrays
      */
     private function getCollections($includeArrays) {
         $groups = array();

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,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
@@ -408,6 +415,10 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param string $label
+     * @param string $lang
+     */
     private function findLookupHits($results, $label, $lang)
     {
         $hits = array();
@@ -469,6 +480,9 @@ 
         return $hits;
     }
 
+    /**
+     * @param string $lang
+     */
     private function transformLookupResults($lang, $hits)
     {
         if (sizeof($hits) == 0) {
@@ -540,6 +554,9 @@ 
         return $this->returnJson($ret);
     }
 
+    /**
+     * @param Request $request
+     */
     private function redirectToVocabData($request) {
         $urls = $request->getVocab()->getConfig()->getDataURLs();
         if (sizeof($urls) == 0) {
@@ -555,6 +572,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
@@ -650,6 +670,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();
@@ -665,6 +691,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();

controller/WebController.php

Doc Comments +5 added lines

@@ -278,6 +278,10 @@ 
             ));
     }
 
+    /**
+     * @param string $fromName
+     * @param string|null $fromEmail
+     */
     private function createFeedbackHeaders($fromName, $fromEmail, $toMail, $sender)
     {
         $headers = "MIME-Version: 1.0″ . '\r\n";
@@ -580,6 +584,7 @@ 
 
     /**
      * Invokes a very generic errorpage.
+     * @param string $message
      */
     public function invokeGenericErrorPage($request, $message = null)
     {

model/Vocabulary.php

Doc Comments +9 added lines

@@ -271,6 +271,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)
@@ -310,6 +312,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)
     {
@@ -418,6 +421,8 @@ 
     /**
      * Lists the concepts available in the concept group.
      * @param $clname
+     * @param string $glname
+     * @param string $clang
      * @return array
      */
     public function listConceptGroupContents($glname, $clang)
@@ -585,6 +590,7 @@ 
      * Returns a list of recently changed or entirely new concepts.
      * @param string $clang content language for the labels
      * @param string $lang UI language for the dates
+     * @param string $prop
      * @return Array
      */
     public function getChangeList($prop, $clang, $lang, $offset)
@@ -598,6 +604,9 @@ 
       return $bydate;
     }
 
+    /**
+     * @param string $lang
+     */
     public function getTitle($lang=null) {
       return $this->config->getTitle($lang);
     }

model/VocabularyConfig.php

Doc Comments +5 added lines, -3 removed lines

@@ -265,6 +265,7 @@ 
 
     /**
      * Returns skosmos:marcSourcecode value set in config.ttl.
+     * @param string $lang
      * @return string marcsource name
      */
     public function getMarcSourceCode($lang = null)
@@ -274,7 +275,7 @@ 
 
     /**
      * Returns a boolean value set in the config.ttl config.
-     * @return array array of concept class URIs (can be empty)
+     * @return string[] array of concept class URIs (can be empty)
      */
     public function getIndexClasses()
     {
@@ -283,7 +284,7 @@ 
 
     /**
      * Returns skosmos:externalProperty values set in the config.ttl config.
-     * @return array array of external property URIs (can be empty)
+     * @return string[] array of external property URIs (can be empty)
      */
     public function getExtProperties()
     {
@@ -409,6 +410,7 @@ 
 
     /**
      * Returns the vocabulary dc:type value(s) with their labels and uris, if set in the vocabulary configuration.
+     * @param string $lang
      * @return array of objects or an empty array
      */
     public function getTypes($lang = null)
@@ -429,7 +431,7 @@ 
      * Additionally, the chosen content language is inserted with the highest priority
      * and the vocab default language is inserted with the lowest priority.
      * @param string $clang
-     * @return array of language code strings
+     * @return string[] of language code strings
      */
     public function getLanguageOrder($clang)
     {