From 1211ff664a0ec5fd8587e22335df1e62d1385e30 Mon Sep 17 00:00:00 2001
From: "Bruno P. Kinoshita" <kinow@users.noreply.github.com>
Date: Wed, 19 Dec 2018 23:26:48 +1300
Subject: [PATCH] Add phpdocs type hints

---
 controller/WebController.php   |  5 ++++-
 model/ConceptProperty.php      |  2 +-
 model/Request.php              |  3 +++
 model/Vocabulary.php           |  4 ++--
 model/sparql/GenericSparql.php | 10 +++++-----
 5 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/controller/WebController.php b/controller/WebController.php
index 312b98103..a03cdf4b2 100644
--- a/controller/WebController.php
+++ b/controller/WebController.php
@@ -206,8 +206,10 @@ public function invokeVocabularies($request)
 
     /**
      * Invokes the concept page of a single concept in a specific vocabulary.
+     *
+     * @param Request $request
      */
-    public function invokeVocabularyConcept($request)
+    public function invokeVocabularyConcept(Request $request)
     {
         $lang = $request->getLang();
         $this->setLanguageProperties($lang);
@@ -221,6 +223,7 @@ public function invokeVocabularyConcept($request)
             $this->invokeGenericErrorPage($request);
             return;
         }
+        /** @var \Twig\Template $template */
         $template = (in_array('skos:Concept', $results[0]->getType()) || in_array('skos:ConceptScheme', $results[0]->getType())) ? $this->twig->loadTemplate('concept-info.twig') : $this->twig->loadTemplate('group-contents.twig');
 
         $crumbs = $vocab->getBreadCrumbs($request->getContentLang(), $uri);
diff --git a/model/ConceptProperty.php b/model/ConceptProperty.php
index 48560e189..9e13ff794 100644
--- a/model/ConceptProperty.php
+++ b/model/ConceptProperty.php
@@ -68,7 +68,7 @@ public function getDescription()
 
     /**
      * Returns an array of the property values.
-     * @return array containing ConceptPropertyValue objects.
+     * @return ConceptMappingPropertyValue[]
      */
     public function getValues()
     {
diff --git a/model/Request.php b/model/Request.php
index 9ec507b2a..24d73ac0f 100644
--- a/model/Request.php
+++ b/model/Request.php
@@ -248,6 +248,9 @@ public function setVocab($vocabid)
 
     }
 
+    /**
+     * @return Vocabulary
+     */
     public function getVocab()
     {
         return $this->vocab;
diff --git a/model/Vocabulary.php b/model/Vocabulary.php
index a4ed92566..3f237043a 100644
--- a/model/Vocabulary.php
+++ b/model/Vocabulary.php
@@ -52,7 +52,7 @@ public function getGraph()
     /**
      * Get the SPARQL implementation for this vocabulary
      *
-     * @return Sparql SPARQL object
+     * @return GenericSparql SPARQL object
      */
     public function getSparql()
     {
@@ -381,7 +381,7 @@ public function getConceptRelateds($uri, $lang)
     /**
      * Makes a query into the sparql endpoint for a concept.
      * @param string $uri the full URI of the concept
-     * @return array
+     * @return Concept[]
      */
     public function getConceptInfo($uri, $clang)
     {
diff --git a/model/sparql/GenericSparql.php b/model/sparql/GenericSparql.php
index 6e1a09f76..f203f458b 100644
--- a/model/sparql/GenericSparql.php
+++ b/model/sparql/GenericSparql.php
@@ -82,7 +82,7 @@ protected function generateQueryPrefixes($query)
     /**
      * Execute the SPARQL query using the SPARQL client, logging it as well.
      * @param string $query SPARQL query to perform
-     * @return object query result
+     * @return Result|\EasyRdf\Graph query result
      */
     protected function query($query) {
         $queryId = sprintf("%05d", rand(0, 99999));
@@ -457,7 +457,7 @@ private function generateConceptInfoQuery($uris, $arrayClass, $vocabs) {
      * @param array $uris concept URIs
      * @param \Vocabulary[] $vocabs array of Vocabulary object
      * @param string|null $clang content language
-     * @return mixed query result graph (EasyRdf\Graph), or array of Concept objects
+     * @return Concept[] array of Concept objects
      */
     private function transformConceptInfoResults($result, $uris, $vocabs, $clang) {
         $conceptArray = array();
@@ -474,7 +474,7 @@ private function transformConceptInfoResults($result, $uris, $vocabs, $clang) {
      * @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
-     * @return \Concept[]
+     * @return \EasyRdf\Graph
      */
     public function queryConceptInfoGraph($uris, $arrayClass = null, $vocabs = array()) {
         // if just a single URI is given, put it in an array regardless
@@ -493,7 +493,7 @@ public function queryConceptInfoGraph($uris, $arrayClass = null, $vocabs = array
      * @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
-     * @return EasyRdf\Graph
+     * @return Concept[]
      */
     public function queryConceptInfo($uris, $arrayClass = null, $vocabs = array(), $clang = null) {
         // if just a single URI is given, put it in an array regardless
@@ -502,7 +502,7 @@ public function queryConceptInfo($uris, $arrayClass = null, $vocabs = array(), $
         }
         $result = $this->queryConceptInfoGraph($uris, $arrayClass, $vocabs);
         if ($result->isEmpty()) {
-            return;
+            return [];
         }
         return $this->transformConceptInfoResults($result, $uris, $vocabs, $clang);
     }