NatLibFi / Skosmos

model/Vocabulary.php

Doc Comments +12 added lines, -3 removed lines

@@ -121,7 +121,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)
@@ -293,6 +293,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)
@@ -332,6 +334,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)
     {
@@ -440,6 +443,8 @@ 
     /**
      * Lists the concepts available in the concept group.
      * @param $clname
+     * @param string $glname
+     * @param string $clang
      * @return array
      */
     public function listConceptGroupContents($glname, $clang)
@@ -466,7 +471,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)
@@ -501,6 +506,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)
     {
@@ -606,7 +612,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, $offset)
@@ -614,6 +620,9 @@ 
       return $this->getSparql()->queryChangeList($clang, $offset, $prop);
     }
 
+    /**
+     * @param string $lang
+     */
     public function getTitle($lang=null) {
       return $this->config->getTitle($lang);
     }

Spacing +5 added lines, -5 removed lines

@@ -104,7 +104,7 @@ 
             return $lname;
         }
         // already a full URI
-        return $this->getUriSpace() . $lname;
+        return $this->getUriSpace().$lname;
     }
 
     /**
@@ -165,7 +165,7 @@ 
                 foreach ($conceptscheme->allLiterals($prop, null) as $val) {
                     $prop = (substr($prop, 0, 5) == 'dc11:') ? str_replace('dc11:', 'dc:', $prop) : $prop;
                     if ($val->getValue() instanceof DateTime) {
-                        $val = Punic\Calendar::formatDate($val->getValue(), 'full', $lang) . ' ' . Punic\Calendar::format($val->getValue(), 'HH:mm:ss', $lang);
+                        $val = Punic\Calendar::formatDate($val->getValue(), 'full', $lang).' '.Punic\Calendar::format($val->getValue(), 'HH:mm:ss', $lang);
                     }
                     $ret[$prop][] = $val;
                 }
@@ -286,7 +286,7 @@ 
         }
         // don't know how to parse
         $rev = $parts[2];
-        $datestr = $parts[3] . ' ' . $parts[4];
+        $datestr = $parts[3].' '.$parts[4];
 
         return "$datestr (r$rev)";
     }
@@ -295,7 +295,7 @@ 
      * Counts the statistics of the vocabulary.
      * @return array of the concept/group counts
      */
-    public function getStatistics($lang = '', $array=null, $group=null)
+    public function getStatistics($lang = '', $array = null, $group = null)
     {
         $sparql = $this->getSparql();
         // find the number of concepts
@@ -614,7 +614,7 @@ 
       return $this->getSparql()->queryChangeList($clang, $offset, $prop);
     }
 
-    public function getTitle($lang=null) {
+    public function getTitle($lang = null) {
       return $this->config->getTitle($lang);
     }
 

controller/WebController.php

Doc Comments +10 added lines

@@ -235,6 +235,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";
@@ -256,6 +261,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, $fromName = null, $fromEmail = null, $fromVocab = null, $toMail = null)
     {
@@ -538,6 +544,7 @@ 
 
     /**
      * Invokes a very generic errorpage.
+     * @param string $message
      */
     public function invokeGenericErrorPage($request, $message = null)
     {
@@ -574,6 +581,9 @@ 
             );
     }
 
+    /**
+     * @param Request $request
+     */
     public function formatChangeList($request, $prop='dc:created') {
         // set language parameters for gettext
         $this->setLanguageProperties($request->getLang());

Spacing +23 added lines, -23 removed lines

@@ -37,7 +37,7 @@ 
         // specify where to look for templates and cache
         $loader = new Twig_Loader_Filesystem('view');
         // initialize Twig environment
-        $this->twig = new Twig_Environment($loader, array('cache' => $tmpDir,'auto_reload' => true));
+        $this->twig = new Twig_Environment($loader, array('cache' => $tmpDir, 'auto_reload' => true));
         $this->twig->addExtension(new Twig_Extensions_Extension_I18n());
         // used for setting the base href for the relative urls
         $this->twig->addGlobal("BaseHref", $this->getBaseHref());
@@ -60,7 +60,7 @@ 
         $this->twig->addFilter(new Twig_SimpleFilter('link_url', array($this, 'linkUrlFilter')));
 
         // register a Twig filter for generating strings from language codes with CLDR
-        $langFilter = new Twig_SimpleFilter('lang_name', function ($langcode, $lang) {
+        $langFilter = new Twig_SimpleFilter('lang_name', function($langcode, $lang) {
             return Language::getName($langcode, $lang);
         });
         $this->twig->addFilter($langFilter);
@@ -237,17 +237,17 @@ 
 
     private function createFeedbackHeaders($fromName, $fromEmail, $toMail, $sender)
     {
-        $headers = "MIME-Version: 1.0" . "\r\n";
-        $headers .= "Content-type: text/html; charset=UTF-8" . "\r\n";
+        $headers = "MIME-Version: 1.0"."\r\n";
+        $headers .= "Content-type: text/html; charset=UTF-8"."\r\n";
         if (!empty($toMail)) {
-            $headers .= "Cc: " . $this->model->getConfig()->getFeedbackAddress() . "\r\n";
+            $headers .= "Cc: ".$this->model->getConfig()->getFeedbackAddress()."\r\n";
         }
         if (!empty($fromEmail)) {
             $headers .= "Reply-To: $fromName <$fromEmail>\r\n";
         }
 
         $service = $this->model->getConfig()->getServiceName();
-        return $headers . "From: $fromName via $service <$sender>";
+        return $headers."From: $fromName via $service <$sender>";
     }
 
     /**
@@ -261,11 +261,11 @@ 
     {
         $toAddress = ($toMail) ? $toMail : $this->model->getConfig()->getFeedbackAddress();
         if ($fromVocab !== null && $fromVocab !== '') {
-            $message = 'Feedback from vocab: ' . strtoupper($fromVocab) . "<br />" . $message;
+            $message = 'Feedback from vocab: '.strtoupper($fromVocab)."<br />".$message;
         }
 
         $envelopeSender = $this->model->getConfig()->getFeedbackEnvelopeSender();
-        $subject = $this->model->getConfig()->getServiceName() . " feedback";
+        $subject = $this->model->getConfig()->getServiceName()." feedback";
         // determine the sender address of the message
         $sender = $this->model->getConfig()->getFeedbackSender();
         if (empty($sender)) $sender = $envelopeSender;
@@ -278,10 +278,10 @@ 
         $params = empty($envelopeSender) ? '' : "-f $envelopeSender";
 
         // adding some information about the user for debugging purposes.
-        $message = $message . "<br /><br /> Debugging information:"
-            . "<br />Timestamp: " . date(DATE_RFC2822)
-            . "<br />User agent: " . $request->getServerConstant('HTTP_USER_AGENT')
-            . "<br />Referer: " . $request->getServerConstant('HTTP_REFERER');
+        $message = $message."<br /><br /> Debugging information:"
+            . "<br />Timestamp: ".date(DATE_RFC2822)
+            . "<br />User agent: ".$request->getServerConstant('HTTP_USER_AGENT')
+            . "<br />Referer: ".$request->getServerConstant('HTTP_REFERER');
 
         try {
             mail($toAddress, $subject, $message, $headers, $params);
@@ -289,7 +289,7 @@ 
             header("HTTP/1.0 404 Not Found");
             $template = $this->twig->loadTemplate('error-page.twig');
             if ($this->model->getConfig()->getLogCaughtExceptions()) {
-                error_log('Caught exception: ' . $e->getMessage());
+                error_log('Caught exception: '.$e->getMessage());
             }
 
             echo $template->render(
@@ -336,7 +336,7 @@ 
         $vocids = ($vocabs !== null && $vocabs !== '') ? explode(' ', $vocabs) : null;
         $vocabObjects = array();
         if ($vocids) {
-            foreach($vocids as $vocid) {
+            foreach ($vocids as $vocid) {
                 $vocabObjects[] = $this->model->getVocabulary($vocid);
             }
         }
@@ -347,7 +347,7 @@ 
         } catch (Exception $e) {
             header("HTTP/1.0 404 Not Found");
             if ($this->model->getConfig()->getLogCaughtExceptions()) {
-                error_log('Caught exception: ' . $e->getMessage());
+                error_log('Caught exception: '.$e->getMessage());
             }
             $this->invokeGenericErrorPage($request, $e->getMessage());
             return;
@@ -363,7 +363,7 @@ 
                 'search_count' => $counts,
                 'languages' => $this->languages,
                 'search_results' => $searchResults,
-                'rest' => $parameters->getOffset()>0,
+                'rest' => $parameters->getOffset() > 0,
                 'global_search' => true,
                 'term' => $request->getQueryParamRaw('q'),
                 'lang_list' => $langList,
@@ -388,7 +388,7 @@ 
         } catch (Exception $e) {
             header("HTTP/1.0 404 Not Found");
             if ($this->model->getConfig()->getLogCaughtExceptions()) {
-                error_log('Caught exception: ' . $e->getMessage());
+                error_log('Caught exception: '.$e->getMessage());
             }
 
             echo $template->render(
@@ -409,7 +409,7 @@ 
         } catch (Exception $e) {
             header("HTTP/1.0 404 Not Found");
             if ($this->model->getConfig()->getLogCaughtExceptions()) {
-                error_log('Caught exception: ' . $e->getMessage());
+                error_log('Caught exception: '.$e->getMessage());
             }
 
             echo $template->render(
@@ -426,7 +426,7 @@ 
                 'vocab' => $vocab,
                 'search_results' => $searchResults,
                 'search_count' => $counts,
-                'rest' => $parameters->getOffset()>0,
+                'rest' => $parameters->getOffset() > 0,
                 'limit_parent' => $parameters->getParentLimit(),
                 'limit_type' =>  $request->getQueryParam('type') ? explode('+', $request->getQueryParam('type')) : null,
                 'limit_group' => $parameters->getGroupLimit(),
@@ -557,7 +557,7 @@ 
      * Loads and renders the view containing a list of recent changes in the vocabulary.
      * @param Request $request
      */
-    public function invokeChangeList($request, $prop='dc:created')
+    public function invokeChangeList($request, $prop = 'dc:created')
     {
         $bydate = $this->formatChangeList($request, $prop);
 
@@ -574,7 +574,7 @@ 
             );
     }
 
-    public function formatChangeList($request, $prop='dc:created') {
+    public function formatChangeList($request, $prop = 'dc:created') {
         // set language parameters for gettext
         $this->setLanguageProperties($request->getLang());
         $vocab = $request->getVocab();
@@ -582,9 +582,9 @@ 
         $changeList = $vocab->getChangeList($prop, $request->getContentLang(), $offset);
 
         $formatByDate = array();
-        foreach($changeList as $concept) {
+        foreach ($changeList as $concept) {
             $concept['datestring'] = Punic\Calendar::formatDate($concept['date'], 'medium', $request->getLang());
-            $formatByDate[Punic\Calendar::getMonthName($concept['date'], 'wide', $request->getLang(), true) . Punic\Calendar::format($concept['date'], ' y', $request->getLang()) ][strtolower($concept['prefLabel'])] = $concept;
+            $formatByDate[Punic\Calendar::getMonthName($concept['date'], 'wide', $request->getLang(), true).Punic\Calendar::format($concept['date'], ' y', $request->getLang())][strtolower($concept['prefLabel'])] = $concept;
         }
         return $formatByDate;
     }

controller/RestController.php

Indentation +7 added lines, -7 removed lines

@@ -575,9 +575,9 @@ 
                 $vocid = $request->getVocab()->getId();
                 return $this->returnError('404', 'Not Found', "No download source URL known for vocabulary $vocid in language $dataLang");
             }
-		} else {
+    } else {
             header("Location: " . $urls[$format]);
-		}
+    }
     }
 
     private function returnDataResults($results, $format) {
@@ -1099,15 +1099,15 @@ 
         foreach($changeList as $conceptInfo) {
             if (array_key_exists('date', $conceptInfo)) {
                 $simpleChangeList[] =  array( 'uri' => $conceptInfo['uri'],
-                                               'prefLabel' => $conceptInfo['prefLabel'],
-                                               'date' => $conceptInfo['date']->format(DateTimeInterface::ISO8601) );
+                                                'prefLabel' => $conceptInfo['prefLabel'],
+                                                'date' => $conceptInfo['date']->format(DateTimeInterface::ISO8601) );
             }
         }
         return $this->returnJson(array_merge_recursive($this->context,
                                                         array('@context' => array( '@language' => $request->getLang(),
-                                                                                     'prefLabel' => 'skos:prefLabel',
-                                                                                     'xsd' => 'http://www.w3.org/2001/XMLSchema#',
-                                                                                     'date' => array( '@id' => 'http://purl.org/dc/terms/date', '@type' => 'http://www.w3.org/2001/XMLSchema#date') )
+                                                                                      'prefLabel' => 'skos:prefLabel',
+                                                                                      'xsd' => 'http://www.w3.org/2001/XMLSchema#',
+                                                                                      'date' => array( '@id' => 'http://purl.org/dc/terms/date', '@type' => 'http://www.w3.org/2001/XMLSchema#date') )
                                                         ),
                                                         array('changeList' => $simpleChangeList)));
 

Spacing +22 added lines, -22 removed lines

@@ -25,7 +25,7 @@ 
         // wrap with JSONP callback if requested
         if (filter_input(INPUT_GET, 'callback', FILTER_SANITIZE_STRING)) {
             header("Content-type: application/javascript; charset=utf-8");
-            echo filter_input(INPUT_GET, 'callback', FILTER_UNSAFE_RAW) . "(" . json_encode($data) . ");";
+            echo filter_input(INPUT_GET, 'callback', FILTER_UNSAFE_RAW)."(".json_encode($data).");";
             return;
         }
 
@@ -88,7 +88,7 @@ 
                 'vocabularies' => 'onki:hasVocabulary',
                 'id' => 'onki:vocabularyIdentifier',
                 'uri' => '@id',
-                '@base' => $this->getBaseHref() . "rest/v1/vocabularies",
+                '@base' => $this->getBaseHref()."rest/v1/vocabularies",
             ),
             'uri' => '',
             'vocabularies' => $results,
@@ -105,7 +105,7 @@ 
         // convert to vocids array to support multi-vocabulary search
         $vocids = ($vocabs !== null && $vocabs !== '') ? explode(' ', $vocabs) : array();
         $vocabObjects = array();
-        foreach($vocids as $vocid) {
+        foreach ($vocids as $vocid) {
             $vocabObjects[] = $this->model->getVocabulary($vocid);
         }
         $parameters->setVocabularies($vocabObjects);
@@ -136,12 +136,12 @@ 
         foreach ($parameters->getAdditionalFields() as $field) {
 
             // Quick-and-dirty compactification
-            $context[$field] = 'skos:' . $field;
+            $context[$field] = 'skos:'.$field;
             foreach ($results as &$result) {
                 foreach ($result as $k => $v) {
-                    if ($k == 'skos:' . $field) {
+                    if ($k == 'skos:'.$field) {
                         $result[$field] = $v;
-                        unset($result['skos:' . $field]);
+                        unset($result['skos:'.$field]);
                     }
                 }
             }
@@ -160,7 +160,7 @@ 
         if ($request->getQueryParam('labellang')) {
             $ret['@context']['@language'] = $request->getQueryParam('labellang');
         } elseif ($request->getQueryParam('lang')) {
-            $ret['@context']['@language'] = $request->getQueryParam('lang');;
+            $ret['@context']['@language'] = $request->getQueryParam('lang'); ;
         }
         return $ret;
     }
@@ -229,7 +229,7 @@ 
                 'prefLabel' => 'skos:prefLabel',
                 'title' => 'dct:title',
                 '@language' => $request->getLang(),
-                '@base' => $this->getBaseHref() . "rest/v1/" . $vocab->getId() . "/",
+                '@base' => $this->getBaseHref()."rest/v1/".$vocab->getId()."/",
             ),
             'uri' => '',
             'id' => $vocab->getId(),
@@ -283,7 +283,7 @@ 
                 'subTypes' => array('@id' => 'void:class', '@type' => '@id'),
                 'count' => 'void:entities',
                 '@language' => $request->getLang(),
-                '@base' => $this->getBaseHref() . "rest/v1/" . $request->getVocab()->getId() . "/",
+                '@base' => $this->getBaseHref()."rest/v1/".$request->getVocab()->getId()."/",
             ),
             'uri' => '',
             'id' => $request->getVocab()->getId(),
@@ -360,7 +360,7 @@ 
                 'language' => 'void-ext:language',
                 'properties' => 'void:propertyPartition',
                 'labels' => 'void:triples',
-                '@base' => $this->getBaseHref() . "rest/v1/" . $request->getVocab()->getId() . "/",
+                '@base' => $this->getBaseHref()."rest/v1/".$request->getVocab()->getId()."/",
             ),
             'uri' => '',
             'id' => $request->getVocab()->getId(),
@@ -401,7 +401,7 @@ 
             $types[] = $type;
         }
 
-        $base = $request->getVocab() ? $this->getBaseHref() . "rest/v1/" . $request->getVocab()->getId() . "/" : $this->getBaseHref() . "rest/v1/";
+        $base = $request->getVocab() ? $this->getBaseHref()."rest/v1/".$request->getVocab()->getId()."/" : $this->getBaseHref()."rest/v1/";
 
         $ret = array_merge_recursive($this->context, array(
             '@context' => array(
@@ -564,19 +564,19 @@ 
 
         $format = $this->negotiateFormat(array_keys($urls), $request->getServerConstant('HTTP_ACCEPT'), $request->getQueryParam('format'));
         if (!$format) {
-            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: " . implode(' ', array_keys($urls)));
+            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: ".implode(' ', array_keys($urls)));
         }
         if (is_array($urls[$format])) {
             $arr = $urls[$format];
             $dataLang = $request->getLang();
             if (isset($arr[$dataLang])) {
-                header("Location: " . $arr[$dataLang]);
+                header("Location: ".$arr[$dataLang]);
             } else {
                 $vocid = $request->getVocab()->getId();
                 return $this->returnError('404', 'Not Found', "No download source URL known for vocabulary $vocid in language $dataLang");
             }
 		} else {
-            header("Location: " . $urls[$format]);
+            header("Location: ".$urls[$format]);
 		}
     }
 
@@ -639,7 +639,7 @@ 
 
         $format = $this->negotiateFormat(explode(' ', self::SUPPORTED_FORMATS), $request->getServerConstant('HTTP_ACCEPT'), $request->getQueryParam('format'));
         if (!$format) {
-            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: " . self::SUPPORTED_FORMATS);
+            return $this->returnError(406, 'Not Acceptable', "Unsupported format. Supported MIME types are: ".self::SUPPORTED_FORMATS);
         }
 
         $vocid = $vocab ? $vocab->getId() : null;
@@ -924,7 +924,7 @@ 
                         }
                     }
                     // if the main concept scheme was not found, set 'top' to the first 'tops' (sorted alphabetically on the URIs)
-                    if (! isset($results[$uri]['top'])) {
+                    if (!isset($results[$uri]['top'])) {
                         $results[$uri]['top'] = $results[$uri]['tops'][0];
                     }
                 } else {
@@ -1089,25 +1089,25 @@ 
      * @param Request $request
      * @return object json-ld wrapped list of changed concepts
      */
-    private function changed($request, $prop='dc:created')
+    private function changed($request, $prop = 'dc:created')
     {
         $vocab = $request->getVocab();
         $offset = ($request->getQueryParam('offset') && is_numeric($request->getQueryParam('offset')) && $request->getQueryParam('offset') >= 0) ? $request->getQueryParam('offset') : 0;
         $changeList = $vocab->getChangeList($prop, $request->getLang(), $offset);
 
         $simpleChangeList = array();
-        foreach($changeList as $conceptInfo) {
+        foreach ($changeList as $conceptInfo) {
             if (array_key_exists('date', $conceptInfo)) {
-                $simpleChangeList[] =  array( 'uri' => $conceptInfo['uri'],
+                $simpleChangeList[] = array('uri' => $conceptInfo['uri'],
                                                'prefLabel' => $conceptInfo['prefLabel'],
-                                               'date' => $conceptInfo['date']->format(DateTimeInterface::ISO8601) );
+                                               'date' => $conceptInfo['date']->format(DateTimeInterface::ISO8601));
             }
         }
         return $this->returnJson(array_merge_recursive($this->context,
-                                                        array('@context' => array( '@language' => $request->getLang(),
+                                                        array('@context' => array('@language' => $request->getLang(),
                                                                                      'prefLabel' => 'skos:prefLabel',
                                                                                      'xsd' => 'http://www.w3.org/2001/XMLSchema#',
-                                                                                     'date' => array( '@id' => 'http://purl.org/dc/terms/date', '@type' => 'http://www.w3.org/2001/XMLSchema#date') )
+                                                                                     'date' => array('@id' => 'http://purl.org/dc/terms/date', '@type' => 'http://www.w3.org/2001/XMLSchema#date'))
                                                         ),
                                                         array('changeList' => $simpleChangeList)));