NatLibFi / Skosmos

controller/WebController.php

Doc Comments +8 added lines, -1 removed lines

@@ -214,7 +214,7 @@ 
      *
      * @param Concept $concept
      * @param Vocabulary $vocab
-     * @return DateTime|null
+     * @return DateTime
      */
     protected function getModifiedDate(Concept $concept, Vocabulary $vocab)
     {
@@ -361,6 +361,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";
@@ -382,6 +387,7 @@ 
      * @param string $fromName senders own name.
      * @param string $fromEmail senders email adress.
      * @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)
     {
@@ -662,6 +668,7 @@ 
 
     /**
      * Invokes a very generic errorpage.
+     * @param string $message
      */
     public function invokeGenericErrorPage($request, $message = null)
     {

Spacing +20 added lines, -20 removed lines

@@ -42,7 +42,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());
@@ -65,7 +65,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);
@@ -363,17 +363,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>";
     }
 
     /**
@@ -387,11 +387,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;
@@ -404,10 +404,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);
@@ -415,7 +415,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(
@@ -462,7 +462,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);
             }
         }
@@ -473,7 +473,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;
@@ -489,7 +489,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,
@@ -514,7 +514,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(
@@ -535,7 +535,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(
@@ -552,7 +552,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(),
@@ -681,7 +681,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')
     {
         // set language parameters for gettext
         $this->setLanguageProperties($request->getLang());