Dev: move isStandardTemplate and getTemplateList to Template model (s…

…tatic function)
LimeSurvey · Feb 7, 2015 · 2436a15 · 2436a15
1 parent 08f9589
commit 2436a15
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 57 deletions.
diff --git a/application/helpers/common_helper.php b/application/helpers/common_helper.php
@@ -174,17 +174,7 @@ function getQuestionTypeList($SelectedCode = "T", $ReturnType = "selector")
 */
 function isStandardTemplate($sTemplateName)
 {
-    return in_array($sTemplateName,array('basic',
-    'bluengrey',
-    'business_grey',
-    'citronade',
-    'clear_logo',
-    'default',
-    'eirenicon',
-    'limespired',
-    'mint_idea',
-    'sherpa',
-    'vallendar'));
+    return Template::isStandardTemplate($sTemplateName);
 }
 
 /**
@@ -304,45 +294,14 @@ function getSurveyList($returnarray=false, $surveyid=false)
 
 function getTemplateList()
 {
-    $usertemplaterootdir=Yii::app()->getConfig("usertemplaterootdir");
-    $standardtemplaterootdir=Yii::app()->getConfig("standardtemplaterootdir");
-
-    if (!$usertemplaterootdir) {die("getTemplateList() no template directory");}
-    if ($handle = opendir($standardtemplaterootdir))
-    {
-        while (false !== ($file = readdir($handle)))
-        {
-            if (!is_file("$standardtemplaterootdir/$file") && $file != "." && $file != ".." && $file!=".svn" && isStandardTemplate($file))
-            {
-                $list_of_files[$file] = $standardtemplaterootdir.DIRECTORY_SEPARATOR.$file;
-            }
-        }
-        closedir($handle);
-    }
-
-    if ($handle = opendir($usertemplaterootdir))
-    {
-        while (false !== ($file = readdir($handle)))
-        {
-            if (!is_file("$usertemplaterootdir/$file") && $file != "." && $file != ".." && $file!=".svn")
-            {
-                $list_of_files[$file] = $usertemplaterootdir.DIRECTORY_SEPARATOR.$file;
-            }
-        }
-        closedir($handle);
-    }
-    ksort($list_of_files);
-
-    return $list_of_files;
+    return Template::getTemplateList();
 }
 
 function getAdminThemeList()
 {
-    // $usertemplaterootdir=Yii::app()->getConfig("usertemplaterootdir");
     $standardtemplaterootdir=Yii::app()->getConfig("styledir");
 
-    //    if (!$usertemplaterootdir) {die("getTemplateList() no template directory");}
-    if ($handle = opendir($standardtemplaterootdir))
+    if ($standardtemplaterootdir && $handle = opendir($standardtemplaterootdir))
     {
         while (false !== ($file = readdir($handle)))
         {
@@ -354,17 +313,7 @@ function getAdminThemeList()
         closedir($handle);
     }
 
-    /*    if ($handle = opendir($usertemplaterootdir))
-    {
-    while (false !== ($file = readdir($handle)))
-    {
-    if (!is_file("$usertemplaterootdir/$file") && $file != "." && $file != ".." && $file!=".svn")
-    {
-    $list_of_files[$file] = $usertemplaterootdir.DIRECTORY_SEPARATOR.$file;
-    }
-    }
-    closedir($handle);
-    }         */
+
     ksort($list_of_files);
 
     return $list_of_files;

diff --git a/application/models/Template.php b/application/models/Template.php
@@ -88,7 +88,7 @@ public static function getTemplatePath($sTemplateName = "")
             return $aTemplatePath[$sTemplateName];
 
         $sFilteredTemplateName=self::templateNameFilter($sTemplateName);
-        if (isStandardTemplate($sFilteredTemplateName))
+        if (self::isStandardTemplate($sFilteredTemplateName))
         {
             return $aTemplatePath[$sTemplateName]=Yii::app()->getConfig("standardtemplaterootdir").DIRECTORY_SEPARATOR.$sFilteredTemplateName;
         }
@@ -111,7 +111,7 @@ public static function getTemplateURL($sTemplateName="")
             return $aTemplateUrl[$sTemplateName];
 
         $sFiteredTemplateName=self::templateNameFilter($sTemplateName);
-        if (isStandardTemplate($sFiteredTemplateName))
+        if (self::isStandardTemplate($sFiteredTemplateName))
         {
             return $aTemplateUrl[$sTemplateName]=Yii::app()->getConfig("standardtemplaterooturl").'/'.$sFiteredTemplateName;
         }
@@ -120,4 +120,66 @@ public static function getTemplateURL($sTemplateName="")
             return $aTemplateUrl[$sTemplateName]=Yii::app()->getConfig("usertemplaterooturl").'/'.$sFiteredTemplateName;
         }
     }
+
+    public static function getTemplateList()
+    {
+    $usertemplaterootdir=Yii::app()->getConfig("usertemplaterootdir");
+    $standardtemplaterootdir=Yii::app()->getConfig("standardtemplaterootdir");
+
+    $aTemplateList=array();
+
+    if ($handle = opendir($standardtemplaterootdir))
+    {
+        while (false !== ($file = readdir($handle)))
+        {
+            // Why not return directly standardTemplate list ?
+            if (!is_file("$standardtemplaterootdir/$file") && self::isStandardTemplate($file))
+            {
+                $aTemplateList[$file] = $standardtemplaterootdir.DIRECTORY_SEPARATOR.$file;
+            }
+        }
+        closedir($handle);
+    }
+
+    if ($usertemplaterootdir && $handle = opendir($usertemplaterootdir))
+    {
+        while (false !== ($file = readdir($handle)))
+        {
+            // Maybe $file[0] != "." to hide Linux hidden directory
+            if (!is_file("$usertemplaterootdir/$file") && $file != "." && $file != ".." && $file!=".svn")
+            {
+                $aTemplateList[$file] = $usertemplaterootdir.DIRECTORY_SEPARATOR.$file;
+            }
+        }
+        closedir($handle);
+    }
+    ksort($aTemplateList);
+
+    return $aTemplateList;
+    }
+
+    /**
+    * isStandardTemplate returns true if a template is a standard template
+    * This function does not check if a template actually exists
+    *
+    * @param mixed $sTemplateName template name to look for
+    * @return bool True if standard template, otherwise false
+    */
+    public static function isStandardTemplate($sTemplateName)
+    {
+        return in_array($sTemplateName,array(
+            'basic',
+            'bluengrey',
+            'business_grey',
+            'citronade',
+            'clear_logo',
+            'default',
+            'eirenicon',
+            'limespired',
+            'mint_idea',
+            'sherpa',
+            'vallendar',
+            )
+        );
+    }
 }