NatLibFi / Skosmos

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/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();

model/ConceptMappingPropertyValue.php

Doc Comments +2 added lines

@@ -169,6 +169,8 @@
 
     /**
      * Return the mapping as a JSKOS-compatible array.
+     * @param string $lang
+     * @param string $hrefLink
      * @return array
      */
     public function asJskos($queryExVocabs = true, $lang = null, $hrefLink = null)

model/VocabularyConfig.php

Doc Comments +4 added lines, -2 removed lines

@@ -266,6 +266,7 @@ 
 
     /**
      * Returns skosmos:marcSourcecode value set in config.ttl.
+     * @param string $lang
      * @return string marcsource name
      */
     public function getMarcSourceCode($lang = null)
@@ -275,7 +276,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()
     {
@@ -284,7 +285,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()
     {
@@ -410,6 +411,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)

controller/Controller.php

Doc Comments +2 added lines, -1 removed lines

@@ -23,6 +23,7 @@ 
 
     /**
      * Initializes the Model object.
+     * @param Model $model
      */
     public function __construct($model)
     {
@@ -290,7 +291,7 @@ 
      * Sends HTTP headers. Simply calls PHP built-in header function. But being
      * a function here, it can easily be tested/mocked.
      *
-     * @param $header string header to be sent
+     * @param string $header string header to be sent
      */
     protected function sendHeader($header)
     {

model/sparql/GenericSparql.php

Doc Comments +9 added lines, -5 removed lines

@@ -152,7 +152,7 @@ 
 
     /**
      * Returns the graph instance
-     * @return object EasyRDF graph instance.
+     * @return string|null EasyRDF graph instance.
      */
     public function getGraph() {
         return $this->graph;
@@ -287,6 +287,7 @@ 
     /**
      * Counts the number of concepts in a easyRDF graph with a specific language.
      * @param array $langs Languages to query for
+     * @param string[] $classes
      * @return Array containing count of concepts for each language and property.
      */
     public function countLangConcepts($langs, $classes = null) {
@@ -471,7 +472,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 \EasyRdf\Graph
      */
     public function queryConceptInfoGraph($uris, $arrayClass = null, $vocabs = array()) {
@@ -487,7 +488,7 @@ 
 
     /**
      * Returns information (as an array of Concept objects) for one or more concept URIs
-     * @param mixed $uris concept URI (string) or array of URIs
+     * @param string $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[] $vocabs vocabularies to target
      * @param string|null $clang content language
@@ -705,7 +706,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) {
@@ -887,6 +888,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)
@@ -1161,6 +1163,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) {
@@ -1328,6 +1331,7 @@ 
     /**
      * Query for the first characters (letter or otherwise) of the labels in the particular language.
      * @param string $lang language
+     * @param string[] $classes
      * @return array array of characters
      */
     public function queryFirstCharacters($lang, $classes = null) {
@@ -1650,7 +1654,7 @@ 
     /**
      * Query a single transitive property of a concept.
      * @param string $uri
-     * @param array $props the property/properties.
+     * @param string[] $props the property/properties.
      * @param string $lang
      * @param string $fallbacklang language to use if label is not available in the preferred language
      * @param integer $limit

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);
     }

controller/WebController.php

Doc Comments +7 added lines

@@ -234,6 +234,11 @@ 
             ));
     }
 
+    /**
+     * @param string $fromName
+     * @param string|null $fromEmail
+     * @param string $sender
+     */
     private function createFeedbackHeaders($fromName, $fromEmail, $toMail, $sender)
     {
         $headers = "MIME-Version: 1.0" . "\r\n";
@@ -255,6 +260,7 @@ 
      * @param string $fromName senders own name.
      * @param string $fromEmail senders email address.
      * @param string $fromVocab which vocabulary is the feedback related to.
+     * @param string $toMail
      */
     public function sendFeedback($request, $message, $messageSubject, $fromName = null, $fromEmail = null, $fromVocab = null, $toMail = null)
     {
@@ -534,6 +540,7 @@ 
 
     /**
      * Invokes a very generic errorpage.
+     * @param string $message
      */
     public function invokeGenericErrorPage($request, $message = null)
     {