init files

classes/class.smarty.frontend.php

@@ -0,0 +1,158 @@
+<?php
+/**
+ * This file contains the frontend class for smarty wrapper plugin.
+ *
+ * @package Plugin
+ * @subpackage SmartyWrapper
+ * @version $Rev: 128 $
+ * @since 2.0.2
+ * @author Ortwin Pinke <o.pinke@conlite.org>
+ * @copyright (c) 2018, conlite.org
+ * @license http://www.gnu.de/documents/gpl.en.html GPL v3 (english version)
+ * @license http://www.gnu.de/documents/gpl.de.html GPL v3 (deutsche Version)
+ * @link http://www.conlite.org ConLite.org
+ * 
+ * $Id: class.smarty.frontend.php 128 2019-07-03 11:58:28Z oldperl $
+ */
+/**
+ * This file contains the frontend class for smarty wrapper plugin.
+ *
+ * @package Plugin
+ * @subpackage SmartyWrapper
+ * @author Andreas Dieter
+ * @copyright four for business AG <www.4fb.de>
+ */
+defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
+
+/**
+ * Wrapper class for Integration of smarty.
+ *
+ * @package Plugin
+ * @subpackage SmartyWrapper
+ */
+class cSmartyFrontend {
+
+    /**
+     * The smarty Object
+     *
+     * @var Smarty
+     */
+    protected static $oSmarty;
+
+    /**
+     * static flag to simulate singleton behaviour
+     *
+     * @var bool
+     */
+    public static $bSmartyInstanciated = false;
+
+    /**
+     * static default paths
+     *
+     * @var array
+     */
+    protected static $aDefaultPaths = array();
+
+    /**
+     * constructor
+     *
+     * @param array &$aCfg contenido cfg array
+     * @param array &$aClientCfg contenido client cfg array of the specific
+     *        client
+     * @throws cException
+     * @throws cInvalidArgumentException if the given configurations are not an
+     *         array
+     */
+    public function __construct(&$aCfg, &$aClientCfg, $bSanityCheck = false) {
+        // check if already instanciated
+        if (isset(self::$bSmartyInstanciated) && self::$bSmartyInstanciated) {
+            throw new Exception("cSmartyFrontend class is intended to be used as singleton. Do not instanciate multiple times.");
+        }
+
+        if (!is_array($aCfg)) {
+            throw new Exception(__CLASS__ . " " . __FUNCTION__ . " Parameter 1 invalid.");
+        }
+
+        if (!is_array($aClientCfg)) {
+            throw new Exception(__CLASS__ . " " . __FUNCTION__ . " Parameter 2 invalid.");
+        }
+
+        self::$oSmarty = new cSmartyWrapper();
+        self::$aDefaultPaths = array(
+            'template_dir' => $aClientCfg['template']['path'],
+            'cache_dir' => $aClientCfg['cache']['path'] . 'templates_c',
+            'compile_dir' => $aClientCfg['cache']['path'] . 'templates_c'
+        );
+
+        // check the template directory and create new one if it not exists
+        if (!is_dir(self::$aDefaultPaths['compile_dir'])) {
+            mkdir(self::$aDefaultPaths['compile_dir'], 0777);
+        }
+
+        // check if folders exist and rights ok if needed
+        if ($bSanityCheck) {
+            foreach (self::$aDefaultPaths as $key => $value) {
+                if (!file_exists($value)) {
+                    throw new Exception(sprintf("Class %s Error: Folder %s does not exist. Please create.", __CLASS__, $value));
+                }
+                if ($key == 'cache' || $key == 'compile_dir') {
+                    if (!is_writable($value)) {
+                        throw new Exception(sprintf("Class %s Error: Folder %s is not writable. Please check for sufficient rights.", __CLASS__, $value));
+                    }
+                }
+            }
+        }
+
+        self::resetPaths();
+        self::$bSmartyInstanciated = true;
+    }
+
+    /**
+     * prevent users from cloning instance
+     *
+     * @throws cException if this function is called
+     */
+    public function __clone() {
+        throw new Exception("cSmartyFrontend class is intended to be used as singleton. Do not clone.");
+    }
+
+    /**
+     * destructor
+     * set cSmarty::bSmartyInstanciated to false
+     */
+    public function __destruct() {
+        self::$bSmartyInstanciated = false;
+    }
+
+    /**
+     * static function to provide the smart object
+     *
+     * @param boolean $bResetTemplate true if the template values shall all be
+     *        resetted
+     * @throws cException if singleton has not been instantiated yet
+     * @return cSmartyWrapper
+     */
+    public static function getInstance($bResetTemplate = false) {
+        if (!isset(self::$oSmarty)) {
+            // @TODO find a smart way to instanciate smarty object on demand
+            throw new Exception("Smarty singleton not instantiated yet.");
+        }
+        if ($bResetTemplate) {
+            self::$oSmarty = new cSmartyWrapper();
+            self::resetPaths();
+        }
+        return self::$oSmarty;
+    }
+
+    /**
+     * sets the default paths again
+     */
+    public static function resetPaths() {
+        self::$oSmarty->setTemplateDir(self::$aDefaultPaths['template_dir']);
+        self::$oSmarty->setCacheDir(self::$aDefaultPaths['cache_dir']);
+        self::$oSmarty->setCompileDir(self::$aDefaultPaths['compile_dir']);
+    }
+
+}
+
+?>