Changeset 5991

Timestamp:

02/02/12 07:01:06 (4 months ago)

Author:

vain

Message:

• moved checkTemplateExtension() and getTemplateName() to the templatemapper

Location:

trunk/core

Files:

• modulecontroller.core.php (modified) (12 diffs)
• renderer/templatemapper.php (modified) (1 diff)

trunk/core/modulecontroller.core.php

@@ -93 +93 @@
 
     /**
+     * Returns the Doctrine Entity Manager 
+     *
      * @return \Doctrine\ORM\EntityManager
      */
@@ -158 +160 @@
 
     /**
-     * Initalizes the model (active records/entities/repositories) of the module
+     * Initializes the model (active records/entities/repositories) of the module
      *
      * @param $modulename Modulname
@@ -181 +183 @@
         if(is_dir($module_models_path) === true)
         {
-           if(isset($entity) === true) # method parameter
+           if(isset($entity) === true)
            {
+               # use second parameter of method
                $entity = $module_models_path . 'entities' . DS . ucfirst($entity) . '.php';
            }
-           else # build entity filename by modulename
+           else
            {
+               # build entity filename by modulename
                $entity = $module_models_path . 'entities' . DS . ucfirst($modulename) . '.php';
            }
@@ -196 +200 @@
 
            $repos = $module_models_path . 'repositories' . DS . ucfirst($modulename) . 'Repository.php';
+           
            if(is_file($repos) === true and class_exists('Entities\\' . ucfirst($modulename), false) === false)
            {
@@ -240 +245 @@
      *
      * @param string $keyname The keyname to find in the array.
-     * @param mixed $default_one A default value, which is returned, if the keyname was not found.
-     * @param mixed $default_two A default value, which is returned, if the keyname was not found and default_one is null.
+     * @param mixed $default_one A default value returned, when keyname was not found.
+     * @param mixed $default_two A default value returned, when keyname was not found and default_one is null.
+     * @return mixed
      */
     public static function getConfigValue($keyname, $default_one = null, $default_two = null)
@@ -377 +383 @@
 
     /**
-     * Ensures the template extension is correct.
-     *
-     * @param string $template The template filename.
-     */
-    public static function checkTemplateExtension($template)
-    {
-        # get extension of template
-        $template_extension = mb_strtolower(pathinfo($template, PATHINFO_EXTENSION));
-
-        # whitelist definition for listing all allowed template filetypes
-        $allowed_extensions = array('html','php','tpl');
-
-        # check if extension is one of the allowed ones
-        if (false === in_array($template_extension, $allowed_extensions))
-        {
-            $message = 'Template Extension invalid <strong>'.$template_extension.'</strong> on <strong>'.$template.'</strong>';
-            trigger_error($message, E_USER_NOTICE);
-        }
-    }
-
-    /**
-     * Returns the Template Name
-     *
-     * @return Returns the templateName as String
-     */
-    public function getTemplateName()
-    {
-        # if the templateName was not set manually, we construct it from module/action infos
-        if(empty($this->template) === true)
-        {
-            # construct template name
-            $template = Clansuite_TargetRoute::getActionName() . '.tpl';
-            $this->setTemplate($template);
-        }
-        return $this->template;
-    }
-
-    /**
      * Sets the Render Mode
      *
@@ -426 +394 @@
     /**
      * Get the Render Mode
+     *
+     * @return string LAYOUT|NOLAYOUT
      */
     public function getRenderMode()
@@ -433 +403 @@
             $this->getView()->renderMode = 'LAYOUT';
         }
+
         return $this->getView()->renderMode;
     }
@@ -475 +446 @@
 
         # Debug display of Layout Template and Content Template
-        if(DEBUG == true)
-        {
-            #Clansuite_Debug::firebug('Layout/Wrapper Template: ' . $this->view->getLayoutTemplate() . '<br />');
-            #Clansuite_Debug::firebug('Template Name: ' . $templatename . '<br />');
-        }
+        #Clansuite_Debug::firebug('Layout/Wrapper Template: ' . $this->view->getLayoutTemplate() . '<br />');
+        #Clansuite_Debug::firebug('Template Name: ' . $templatename . '<br />');
 
         # render the content / template
@@ -542 +510 @@
     public function redirectToReferer()
     {
-        $referer = '';
         $referer = self::getHttpRequest()->getReferer();
 
@@ -554 +521 @@
             $route = Clansuite_HttpRequest::getRoute();
 
-            # we use internal rewrite style here: /module/action
-            # redirect() builds the url
-            $redirect_to = '/';
-            $redirect_to .= $route->getModuleName();
-
+            # we use internal rewrite style here: /module/action            
+            $redirect_to = '/' . $route->getModuleName();
             $submodule = $route->getSubModuleName();
+
             if(empty($submodule) === false)
             {
@@ -565 +530 @@
             }
 
+            # redirect() builds the url
             $this->redirect($redirect_to);
         }

trunk/core/renderer/templatemapper.php

@@ -40 +40 @@
  * Clansuite_View_Mapper
  *
+ * By definition a mapper sets up a communication between two independent objects.
  * Clansuite_View_Mapper is a "class action" to "template" mapper.
  * This has nothing to do with rendering, but with template selection for the view.
- * If no template was set manually, this class will help determining the template,
+ * If no template was set manually in the action of a module (class), 
+ * this class will help determining the template, 
  * by mapping the requested class and action to a template.
  */
 class Clansuite_View_Mapper
 {
+    /**
+     * Ensures the template extension is correct.
+     *
+     * @param string $template The template filename.
+     */
+    public static function checkTemplateExtension($template)
+    {
+        # get extension of template
+        $template_extension = mb_strtolower(pathinfo($template, PATHINFO_EXTENSION));
 
+        # whitelist definition for listing all allowed template filetypes
+        $allowed_extensions = array('html','php','tpl');
+
+        # check if extension is one of the allowed ones
+        if (false === in_array($template_extension, $allowed_extensions))
+        {
+            $message = 'Template Extension invalid <strong>'.$template_extension.'</strong> on <strong>'.$template.'</strong>';
+            trigger_error($message, E_USER_NOTICE);
+        }
+    }
+
+    /**
+     * Returns the Template Name
+     *
+     * @return Returns the templateName as String
+     */
+    public function getTemplateName()
+    {
+        # if the templateName was not set manually, we construct it from module/action infos
+        if(empty($this->template) === true)
+        {
+            # construct template name
+            $template = Clansuite_TargetRoute::getActionName() . '.tpl';
+             
+            $this->setTemplate($template);
+        }
+
+        return $this->template;
+    }
 }
+?>