mambax7 / smartobject

class/form/elements/smartformyesnoelement.php

Indentation +9 added lines, -9 removed lines

@@ -11,13 +11,13 @@
  */
 class SmartFormYesnoElement extends XoopsFormRadioYN
 {
-    /**
-     * SmartFormYesnoElement constructor.
-     * @param string $object
-     * @param string $key
-     */
-    public function __construct($object, $key)
-    {
-        parent::__construct($object->vars[$key]['form_caption'], $key, $object->getVar($key, 'e'));
-    }
+	/**
+	 * SmartFormYesnoElement constructor.
+	 * @param string $object
+	 * @param string $key
+	 */
+	public function __construct($object, $key)
+	{
+		parent::__construct($object->vars[$key]['form_caption'], $key, $object->getVar($key, 'e'));
+	}
 }

class/basedurl.php

Indentation +24 added lines, -24 removed lines

@@ -36,29 +36,29 @@
  */
 class SmartobjectBasedUrl extends SmartObject
 {
-    /**
-     * SmartobjectBasedUrl constructor.
-     */
-    public function __construct()
-    {
-        $this->quickInitVar('caption', XOBJ_DTYPE_TXTBOX, false);
-        $this->quickInitVar('description', XOBJ_DTYPE_TXTBOX, false);
-        $this->quickInitVar('url', XOBJ_DTYPE_TXTBOX, false);
-    }
+	/**
+	 * SmartobjectBasedUrl constructor.
+	 */
+	public function __construct()
+	{
+		$this->quickInitVar('caption', XOBJ_DTYPE_TXTBOX, false);
+		$this->quickInitVar('description', XOBJ_DTYPE_TXTBOX, false);
+		$this->quickInitVar('url', XOBJ_DTYPE_TXTBOX, false);
+	}
 
-    /**
-     * @param  string $key
-     * @param  string $format
-     * @return mixed
-     */
-    public function getVar($key, $format = 'e')
-    {
-        if (0 === strpos($key, 'url_')) {
-            return parent::getVar('url', $format);
-        } elseif (0 === strpos($key, 'caption_')) {
-            return parent::getVar('caption', $format);
-        } else {
-            return parent::getVar($key, $format);
-        }
-    }
+	/**
+	 * @param  string $key
+	 * @param  string $format
+	 * @return mixed
+	 */
+	public function getVar($key, $format = 'e')
+	{
+		if (0 === strpos($key, 'url_')) {
+			return parent::getVar('url', $format);
+		} elseif (0 === strpos($key, 'caption_')) {
+			return parent::getVar('caption', $format);
+		} else {
+			return parent::getVar($key, $format);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
 
 // defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartobject.php';
 
 /**
  * Class SmartobjectBasedUrl

class/smartprinterfriendly.php

Indentation +51 added lines, -51 removed lines

@@ -15,65 +15,65 @@
  */
 class SmartPrinterFriendly
 {
-    public $_title;
-    public $_dsc;
-    public $_content;
-    public $_tpl;
-    public $_pageTitle = false;
-    public $_width     = 680;
+	public $_title;
+	public $_dsc;
+	public $_content;
+	public $_tpl;
+	public $_pageTitle = false;
+	public $_width     = 680;
 
-    /**
-     * SmartPrinterFriendly constructor.
-     * @param      $content
-     * @param bool $title
-     * @param bool $dsc
-     */
-    public function __construct($content, $title = false, $dsc = false)
-    {
-        $this->_title   = $title;
-        $this->_dsc     = $dsc;
-        $this->_content = $content;
-    }
+	/**
+	 * SmartPrinterFriendly constructor.
+	 * @param      $content
+	 * @param bool $title
+	 * @param bool $dsc
+	 */
+	public function __construct($content, $title = false, $dsc = false)
+	{
+		$this->_title   = $title;
+		$this->_dsc     = $dsc;
+		$this->_content = $content;
+	}
 
-    public function render()
-    {
-        /**
-         * @todo move the output to a template
-         * @todo make the output XHTML compliant
-         */
+	public function render()
+	{
+		/**
+		 * @todo move the output to a template
+		 * @todo make the output XHTML compliant
+		 */
 
-        include_once XOOPS_ROOT_PATH . '/class/template.php';
+		include_once XOOPS_ROOT_PATH . '/class/template.php';
 
-        $this->_tpl = new XoopsTpl();
+		$this->_tpl = new XoopsTpl();
 
-        $this->_tpl->assign('smartobject_print_pageTitle', $this->_pageTitle ?: $this->_title);
-        $this->_tpl->assign('smartobject_print_title', $this->_title);
-        $this->_tpl->assign('smartobject_print_dsc', $this->_dsc);
-        $this->_tpl->assign('smartobject_print_content', $this->_content);
-        $this->_tpl->assign('smartobject_print_width', $this->_width);
+		$this->_tpl->assign('smartobject_print_pageTitle', $this->_pageTitle ?: $this->_title);
+		$this->_tpl->assign('smartobject_print_title', $this->_title);
+		$this->_tpl->assign('smartobject_print_dsc', $this->_dsc);
+		$this->_tpl->assign('smartobject_print_content', $this->_content);
+		$this->_tpl->assign('smartobject_print_width', $this->_width);
 
-        $current_urls = smart_getCurrentUrls();
-        $current_url  = $current_urls['full'];
+		$current_urls = smart_getCurrentUrls();
+		$current_url  = $current_urls['full'];
 
-        $this->_tpl->assign('smartobject_print_currenturl', $current_url);
-        $this->_tpl->assign('smartobject_print_url', $this->url);
+		$this->_tpl->assign('smartobject_print_currenturl', $current_url);
+		$this->_tpl->assign('smartobject_print_url', $this->url);
 
-        $this->_tpl->display('db:smartobject_print.tpl');
-    }
+		$this->_tpl->display('db:smartobject_print.tpl');
+	}
 
-    /**
-     * @param $text
-     */
-    public function setPageTitle($text)
-    {
-        $this->_pageTitle = $text;
-    }
+	/**
+	 * @param $text
+	 */
+	public function setPageTitle($text)
+	{
+		$this->_pageTitle = $text;
+	}
 
-    /**
-     * @param $width
-     */
-    public function setWidth($width)
-    {
-        $this->_width = $width;
-    }
+	/**
+	 * @param $width
+	 */
+	public function setWidth($width)
+	{
+		$this->_width = $width;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
          * @todo make the output XHTML compliant
          */
 
-        include_once XOOPS_ROOT_PATH . '/class/template.php';
+        include_once XOOPS_ROOT_PATH.'/class/template.php';
 
         $this->_tpl = new XoopsTpl();
 

class/smartplugins.php

Indentation +115 added lines, -115 removed lines

@@ -5,68 +5,68 @@ 
  */
 class SmartPlugin
 {
-    public $_infoArray;
-
-    /**
-     * SmartPlugin constructor.
-     * @param $array
-     */
-    public function __construct($array)
-    {
-        $this->_infoArray = $array;
-    }
-
-    /**
-     * @param $item
-     * @return bool
-     */
-    public function getItemInfo($item)
-    {
-        if (isset($this->_infoArray['items'][$item])) {
-            return $this->_infoArray['items'][$item];
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getItemList()
-    {
-        $itemsArray = $this->_infoArray['items'];
-        foreach ($itemsArray as $k => $v) {
-            $ret[$k] = $v['caption'];
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @return bool|int|string
-     */
-    public function getItem()
-    {
-        $ret = false;
-        foreach ($this->_infoArray['items'] as $k => $v) {
-            $search_str = str_replace('%u', '', $v['url']);
-            if (strpos($_SERVER['PHP_SELF'] . '?' . $_SERVER['QUERY_STRING'], $search_str) > 0) {
-                $ret = $k;
-                break;
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param $item
-     * @return mixed
-     */
-    public function getItemIdForItem($item)
-    {
-        return $_REQUEST[$this->_infoArray['items'][$item]['request']];
-    }
+	public $_infoArray;
+
+	/**
+	 * SmartPlugin constructor.
+	 * @param $array
+	 */
+	public function __construct($array)
+	{
+		$this->_infoArray = $array;
+	}
+
+	/**
+	 * @param $item
+	 * @return bool
+	 */
+	public function getItemInfo($item)
+	{
+		if (isset($this->_infoArray['items'][$item])) {
+			return $this->_infoArray['items'][$item];
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getItemList()
+	{
+		$itemsArray = $this->_infoArray['items'];
+		foreach ($itemsArray as $k => $v) {
+			$ret[$k] = $v['caption'];
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @return bool|int|string
+	 */
+	public function getItem()
+	{
+		$ret = false;
+		foreach ($this->_infoArray['items'] as $k => $v) {
+			$search_str = str_replace('%u', '', $v['url']);
+			if (strpos($_SERVER['PHP_SELF'] . '?' . $_SERVER['QUERY_STRING'], $search_str) > 0) {
+				$ret = $k;
+				break;
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param $item
+	 * @return mixed
+	 */
+	public function getItemIdForItem($item)
+	{
+		return $_REQUEST[$this->_infoArray['items'][$item]['request']];
+	}
 }
 
 /**
@@ -74,57 +74,57 @@ 
  */
 class SmartPluginHandler
 {
-    public $pluginPatterns = false;
-
-    /**
-     * @param $dirname
-     * @return bool|SmartPlugin
-     */
-    public function getPlugin($dirname)
-    {
-        $pluginName = SMARTOBJECT_ROOT_PATH . 'plugins/' . $dirname . '.php';
-        if (file_exists($pluginName)) {
-            include_once($pluginName);
-            $function = 'smartobject_plugin_' . $dirname;
-            if (function_exists($function)) {
-                $array = $function();
-                $ret   = new SmartPlugin($array);
-
-                return $ret;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * @return array
-     */
-    public function getPluginsArray()
-    {
-        include_once(XOOPS_ROOT_PATH . '/class/xoopslists.php');
-
-        $moduleHandler = xoops_getHandler('module');
-        $criteria       = new CriteriaCompo();
-        $criteria->add(new Criteria('isactive', 1));
-        $tempModulesObj = $moduleHandler->getObjects($criteria);
-        $modulesObj     = array();
-        foreach ($tempModulesObj as $moduleObj) {
-            $modulesObj[$moduleObj->getVar('dirname')] = $moduleObj;
-        }
-
-        $aFiles = XoopsLists::getFileListAsArray(SMARTOBJECT_ROOT_PATH . 'plugins/');
-        $ret    = array();
-        foreach ($aFiles as $file) {
-            if (substr($file, strlen($file) - 4, 4) === '.php') {
-                $pluginName                = str_replace('.php', '', $file);
-                $module_xoops_version_file = XOOPS_ROOT_PATH . "/modules/$pluginName/xoops_version.php";
-                if (file_exists($module_xoops_version_file) && isset($modulesObj[$pluginName])) {
-                    $ret[$pluginName] = $modulesObj[$pluginName]->getVar('name');
-                }
-            }
-        }
-
-        return $ret;
-    }
+	public $pluginPatterns = false;
+
+	/**
+	 * @param $dirname
+	 * @return bool|SmartPlugin
+	 */
+	public function getPlugin($dirname)
+	{
+		$pluginName = SMARTOBJECT_ROOT_PATH . 'plugins/' . $dirname . '.php';
+		if (file_exists($pluginName)) {
+			include_once($pluginName);
+			$function = 'smartobject_plugin_' . $dirname;
+			if (function_exists($function)) {
+				$array = $function();
+				$ret   = new SmartPlugin($array);
+
+				return $ret;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getPluginsArray()
+	{
+		include_once(XOOPS_ROOT_PATH . '/class/xoopslists.php');
+
+		$moduleHandler = xoops_getHandler('module');
+		$criteria       = new CriteriaCompo();
+		$criteria->add(new Criteria('isactive', 1));
+		$tempModulesObj = $moduleHandler->getObjects($criteria);
+		$modulesObj     = array();
+		foreach ($tempModulesObj as $moduleObj) {
+			$modulesObj[$moduleObj->getVar('dirname')] = $moduleObj;
+		}
+
+		$aFiles = XoopsLists::getFileListAsArray(SMARTOBJECT_ROOT_PATH . 'plugins/');
+		$ret    = array();
+		foreach ($aFiles as $file) {
+			if (substr($file, strlen($file) - 4, 4) === '.php') {
+				$pluginName                = str_replace('.php', '', $file);
+				$module_xoops_version_file = XOOPS_ROOT_PATH . "/modules/$pluginName/xoops_version.php";
+				if (file_exists($module_xoops_version_file) && isset($modulesObj[$pluginName])) {
+					$ret[$pluginName] = $modulesObj[$pluginName]->getVar('name');
+				}
+			}
+		}
+
+		return $ret;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -50,7 +50,7 @@ 
         $ret = false;
         foreach ($this->_infoArray['items'] as $k => $v) {
             $search_str = str_replace('%u', '', $v['url']);
-            if (strpos($_SERVER['PHP_SELF'] . '?' . $_SERVER['QUERY_STRING'], $search_str) > 0) {
+            if (strpos($_SERVER['PHP_SELF'].'?'.$_SERVER['QUERY_STRING'], $search_str) > 0) {
                 $ret = $k;
                 break;
             }
@@ -82,10 +82,10 @@ 
      */
     public function getPlugin($dirname)
     {
-        $pluginName = SMARTOBJECT_ROOT_PATH . 'plugins/' . $dirname . '.php';
+        $pluginName = SMARTOBJECT_ROOT_PATH.'plugins/'.$dirname.'.php';
         if (file_exists($pluginName)) {
             include_once($pluginName);
-            $function = 'smartobject_plugin_' . $dirname;
+            $function = 'smartobject_plugin_'.$dirname;
             if (function_exists($function)) {
                 $array = $function();
                 $ret   = new SmartPlugin($array);
@@ -102,7 +102,7 @@ 
      */
     public function getPluginsArray()
     {
-        include_once(XOOPS_ROOT_PATH . '/class/xoopslists.php');
+        include_once(XOOPS_ROOT_PATH.'/class/xoopslists.php');
 
         $moduleHandler = xoops_getHandler('module');
         $criteria       = new CriteriaCompo();
@@ -113,12 +113,12 @@ 
             $modulesObj[$moduleObj->getVar('dirname')] = $moduleObj;
         }
 
-        $aFiles = XoopsLists::getFileListAsArray(SMARTOBJECT_ROOT_PATH . 'plugins/');
+        $aFiles = XoopsLists::getFileListAsArray(SMARTOBJECT_ROOT_PATH.'plugins/');
         $ret    = array();
         foreach ($aFiles as $file) {
             if (substr($file, strlen($file) - 4, 4) === '.php') {
                 $pluginName                = str_replace('.php', '', $file);
-                $module_xoops_version_file = XOOPS_ROOT_PATH . "/modules/$pluginName/xoops_version.php";
+                $module_xoops_version_file = XOOPS_ROOT_PATH."/modules/$pluginName/xoops_version.php";
                 if (file_exists($module_xoops_version_file) && isset($modulesObj[$pluginName])) {
                     $ret[$pluginName] = $modulesObj[$pluginName]->getVar('name');
                 }

xoops_version.php

Indentation +5 added lines, -5 removed lines

@@ -43,8 +43,8 @@ 
 $modversion['min_xoops']           = '2.5.8';
 $modversion['min_admin']           = '1.1';
 $modversion['min_db']              = array(
-    'mysql'  => '5.0.7',
-    'mysqli' => '5.0.7'
+	'mysql'  => '5.0.7',
+	'mysqli' => '5.0.7'
 );
 
 // ---
@@ -74,10 +74,10 @@ 
 global $xoopsConfig;
 $common_file = XOOPS_ROOT_PATH . '/modules/smartobject/language/' . $xoopsConfig['language'] . '/common.php';
 if (file_exists($common_file)) {
-    $flag_common = true;
-    include_once $common_file;
+	$flag_common = true;
+	include_once $common_file;
 } else {
-    include_once(XOOPS_ROOT_PATH . '/modules/smartobject/language/english/common.php');
+	include_once(XOOPS_ROOT_PATH . '/modules/smartobject/language/english/common.php');
 }
 // -----
 

Spacing +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
 //about
 $modversion['module_status']       = 'RC 1';
 $modversion['release_date']        = '2016/03/28';
-$modversion['release_file']        = XOOPS_URL . '/modules/' . $modversion['dirname'] . '/docs/changelog.txt';
+$modversion['release_file']        = XOOPS_URL.'/modules/'.$modversion['dirname'].'/docs/changelog.txt';
 $modversion['module_website_url']  = 'www.xoops.org';
 $modversion['module_website_name'] = 'XOOPS';
 $modversion['min_php']             = '5.5';
@@ -72,12 +72,12 @@ 
 // ----- BUG: not read other language file -----
 //include_once(XOOPS_ROOT_PATH.'/modules/smartobject/language/english/common.php');
 global $xoopsConfig;
-$common_file = XOOPS_ROOT_PATH . '/modules/smartobject/language/' . $xoopsConfig['language'] . '/common.php';
+$common_file = XOOPS_ROOT_PATH.'/modules/smartobject/language/'.$xoopsConfig['language'].'/common.php';
 if (file_exists($common_file)) {
     $flag_common = true;
     include_once $common_file;
 } else {
-    include_once(XOOPS_ROOT_PATH . '/modules/smartobject/language/english/common.php');
+    include_once(XOOPS_ROOT_PATH.'/modules/smartobject/language/english/common.php');
 }
 // -----
 

include/captcha/config.php

Indentation +16 added lines, -16 removed lines

@@ -12,29 +12,29 @@
  */
 
 $config = array(
-    'mode'       => 'image',
-    'name'       => 'xoopscaptcha',
-    'skipmember' => true,                    // Skip CAPTCHA check for members
-    'maxattempt' => 100,                    // Maximum attempts for each session
+	'mode'       => 'image',
+	'name'       => 'xoopscaptcha',
+	'skipmember' => true,                    // Skip CAPTCHA check for members
+	'maxattempt' => 100,                    // Maximum attempts for each session
 
-    'num_chars'       => 4,                        // Maximum characters
+	'num_chars'       => 4,                        // Maximum characters
 
-    // For image mode, based on DuGris' SecurityImage
-    'rootpath'        => __DIR__,        // __Absolute__ Path to the root of fonts and backgrounds
-    'imagepath'       => 'uploads/captcha',        // Path to temporary image files, __relative__ to XOOPS_ROOT_PATH
-    'imageurl'        => 'modules/smartobject/include/captcha/scripts/img.php',        // Path to the script for creating image, __relative__ to XOOPS_ROOT_PATH
-    'casesensitive'   => false,                    // Characters in image mode is case-sensitive
-    'fontsize_min'    => 12,                    // Minimum font-size
-    'fontsize_max'    => 12,                    // Maximum font-size
-    'background_type' => 0,                        // Background type in image mode: 0 - bar; 1 - circle; 2 - line; 3 - rectangle; 4 - ellipse; 5 - polygon; 100 - generated from files
-    'background_num'  => 50,                        // Number of background images to generate
-    'polygon_point'   => 3
+	// For image mode, based on DuGris' SecurityImage
+	'rootpath'        => __DIR__,        // __Absolute__ Path to the root of fonts and backgrounds
+	'imagepath'       => 'uploads/captcha',        // Path to temporary image files, __relative__ to XOOPS_ROOT_PATH
+	'imageurl'        => 'modules/smartobject/include/captcha/scripts/img.php',        // Path to the script for creating image, __relative__ to XOOPS_ROOT_PATH
+	'casesensitive'   => false,                    // Characters in image mode is case-sensitive
+	'fontsize_min'    => 12,                    // Minimum font-size
+	'fontsize_max'    => 12,                    // Maximum font-size
+	'background_type' => 0,                        // Background type in image mode: 0 - bar; 1 - circle; 2 - line; 3 - rectangle; 4 - ellipse; 5 - polygon; 100 - generated from files
+	'background_num'  => 50,                        // Number of background images to generate
+	'polygon_point'   => 3
 );
 
 $language = preg_replace("/[^a-z0-9_\-]/i", '', $GLOBALS['xoopsConfig']['language']);
 
 if (!@include_once __DIR__ . "/language/{$language}.php") {
-    require_once __DIR__ . '/language/english.php';
+	require_once __DIR__ . '/language/english.php';
 }
 
 return $config;

Spacing +13 added lines, -13 removed lines

@@ -14,27 +14,27 @@
 $config = array(
     'mode'       => 'image',
     'name'       => 'xoopscaptcha',
-    'skipmember' => true,                    // Skip CAPTCHA check for members
-    'maxattempt' => 100,                    // Maximum attempts for each session
+    'skipmember' => true, // Skip CAPTCHA check for members
+    'maxattempt' => 100, // Maximum attempts for each session
 
-    'num_chars'       => 4,                        // Maximum characters
+    'num_chars'       => 4, // Maximum characters
 
     // For image mode, based on DuGris' SecurityImage
-    'rootpath'        => __DIR__,        // __Absolute__ Path to the root of fonts and backgrounds
-    'imagepath'       => 'uploads/captcha',        // Path to temporary image files, __relative__ to XOOPS_ROOT_PATH
-    'imageurl'        => 'modules/smartobject/include/captcha/scripts/img.php',        // Path to the script for creating image, __relative__ to XOOPS_ROOT_PATH
-    'casesensitive'   => false,                    // Characters in image mode is case-sensitive
-    'fontsize_min'    => 12,                    // Minimum font-size
-    'fontsize_max'    => 12,                    // Maximum font-size
-    'background_type' => 0,                        // Background type in image mode: 0 - bar; 1 - circle; 2 - line; 3 - rectangle; 4 - ellipse; 5 - polygon; 100 - generated from files
-    'background_num'  => 50,                        // Number of background images to generate
+    'rootpath'        => __DIR__, // __Absolute__ Path to the root of fonts and backgrounds
+    'imagepath'       => 'uploads/captcha', // Path to temporary image files, __relative__ to XOOPS_ROOT_PATH
+    'imageurl'        => 'modules/smartobject/include/captcha/scripts/img.php', // Path to the script for creating image, __relative__ to XOOPS_ROOT_PATH
+    'casesensitive'   => false, // Characters in image mode is case-sensitive
+    'fontsize_min'    => 12, // Minimum font-size
+    'fontsize_max'    => 12, // Maximum font-size
+    'background_type' => 0, // Background type in image mode: 0 - bar; 1 - circle; 2 - line; 3 - rectangle; 4 - ellipse; 5 - polygon; 100 - generated from files
+    'background_num'  => 50, // Number of background images to generate
     'polygon_point'   => 3
 );
 
 $language = preg_replace("/[^a-z0-9_\-]/i", '', $GLOBALS['xoopsConfig']['language']);
 
-if (!@include_once __DIR__ . "/language/{$language}.php") {
-    require_once __DIR__ . '/language/english.php';
+if (!@include_once __DIR__."/language/{$language}.php") {
+    require_once __DIR__.'/language/english.php';
 }
 
 return $config;

class/smartobject.php

Doc Comments +9 added lines, -9 removed lines

@@ -165,7 +165,7 @@ 
     }
 
     /**
-     * @param        $key
+     * @param        string $key
      * @param        $data_type
      * @param bool   $itemName
      * @param string $form_caption
@@ -193,7 +193,7 @@ 
      * @param bool   $required     set to TRUE if this variable needs to have a value set before storing the object in the table
      * @param string $form_caption caption of this variable in a {@link SmartobjectForm} and title of a column in a  {@link SmartObjectTable}
      * @param string $form_dsc     description of this variable in a {@link SmartobjectForm}
-     * @param mixed  $value        default value of this variable
+     * @param string|false  $value        default value of this variable
      */
     public function quickInitVar($key, $data_type, $required = false, $form_caption = '', $form_dsc = '', $value = null)
     {
@@ -202,7 +202,7 @@ 
     }
 
     /**
-     * @param        $varname
+     * @param        string $varname
      * @param bool   $displayOnForm
      * @param string $default
      */
@@ -458,7 +458,7 @@ 
     /**
      * add an error
      *
-     * @param      $err_str
+     * @param      string $err_str
      * @param bool $prefix
      * @internal param string $value error to add
      * @access   public
@@ -720,8 +720,8 @@ 
 
     /**
      * @param $key
-     * @param $info
-     * @param $value
+     * @param string $info
+     * @param boolean $value
      */
     public function setVarInfo($key, $info, $value)
     {
@@ -729,7 +729,7 @@ 
     }
 
     /**
-     * @param         $key
+     * @param         string $key
      * @param  bool   $editor
      * @return string
      */
@@ -906,7 +906,7 @@ 
      * @access public
      * @param  string $key    key of the object's variable to be returned
      * @param  string $format format to use for the output
-     * @return mixed  formatted value of the variable
+     * @return string  formatted value of the variable
      */
     public function getVar($key, $format = 's')
     {
@@ -1209,7 +1209,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      */
     public function hideFieldFromForm($key)
     {

Indentation +1360 added lines, -1360 removed lines

@@ -17,31 +17,31 @@ 
 include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
 
 if (!defined('XOBJ_DTYPE_SIMPLE_ARRAY')) {
-    define('XOBJ_DTYPE_SIMPLE_ARRAY', 101);
+	define('XOBJ_DTYPE_SIMPLE_ARRAY', 101);
 }
 if (!defined('XOBJ_DTYPE_CURRENCY')) {
-    define('XOBJ_DTYPE_CURRENCY', 200);
+	define('XOBJ_DTYPE_CURRENCY', 200);
 }
 if (!defined('XOBJ_DTYPE_FLOAT')) {
-    define('XOBJ_DTYPE_FLOAT', 201);
+	define('XOBJ_DTYPE_FLOAT', 201);
 }
 if (!defined('XOBJ_DTYPE_TIME_ONLY')) {
-    define('XOBJ_DTYPE_TIME_ONLY', 202);
+	define('XOBJ_DTYPE_TIME_ONLY', 202);
 }
 if (!defined('XOBJ_DTYPE_URLLINK')) {
-    define('XOBJ_DTYPE_URLLINK', 203);
+	define('XOBJ_DTYPE_URLLINK', 203);
 }
 if (!defined('XOBJ_DTYPE_FILE')) {
-    define('XOBJ_DTYPE_FILE', 204);
+	define('XOBJ_DTYPE_FILE', 204);
 }
 if (!defined('XOBJ_DTYPE_IMAGE')) {
-    define('XOBJ_DTYPE_IMAGE', 205);
+	define('XOBJ_DTYPE_IMAGE', 205);
 }
 if (!defined('XOBJ_DTYPE_FORM_SECTION')) {
-    define('XOBJ_DTYPE_FORM_SECTION', 210);
+	define('XOBJ_DTYPE_FORM_SECTION', 210);
 }
 if (!defined('XOBJ_DTYPE_FORM_SECTION_CLOSE')) {
-    define('XOBJ_DTYPE_FORM_SECTION_CLOSE', 211);
+	define('XOBJ_DTYPE_FORM_SECTION_CLOSE', 211);
 }
 
 /**
@@ -55,1355 +55,1355 @@ 
  */
 class SmartObject extends XoopsObject
 {
-    public $_image_path;
-    public $_image_url;
-
-    public $seoEnabled   = false;
-    public $titleField;
-    public $summaryField = false;
-
-    /**
-     * Reference to the handler managing this object
-     *
-     * @var SmartPersistableObjectHandler reference to {@link SmartPersistableObjectHandler}
-     */
-    public $handler;
-
-    /**
-     * References to control objects, managing the form fields of this object
-     */
-    public $controls = array();
-
-    /**
-     * SmartObject constructor.
-     * @param $handler
-     */
-    public function __construct($handler)
-    {
-        $this->handler = $handler;
-    }
-
-    /**
-     * Checks if the user has a specific access on this object
-     *
-     * @param $perm_name
-     * @return bool: TRUE if user has access, false if not
-     * @internal param string $gperm_name name of the permission to test
-     */
-    public function accessGranted($perm_name)
-    {
-        $smartPermissionsHandler = new SmartobjectPermissionHandler($this->handler);
-
-        return $smartPermissionsHandler->accessGranted($perm_name, $this->id());
-    }
-
-    /**
-     * @param      $section_name
-     * @param bool $value
-     * @param bool $hide
-     */
-    public function addFormSection($section_name, $value = false, $hide = false)
-    {
-        $this->initVar($section_name, XOBJ_DTYPE_FORM_SECTION, $value, false, null, '', false, '', '', false, false, true);
-        $this->vars[$section_name]['hide'] = $hide;
-    }
-
-    /**
-     * @param $section_name
-     */
-    public function closeSection($section_name)
-    {
-        $this->initVar('close_section_' . $section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
-    }
-
-    /**
-     *
-     * @param string $key           key of this field. This needs to be the name of the field in the related database table
-     * @param int    $data_type     set to one of XOBJ_DTYPE_XXX constants (set to XOBJ_DTYPE_OTHER if no data type ckecking nor text sanitizing is required)
-     * @param mixed  $value         default value of this variable
-     * @param bool   $required      set to TRUE if this variable needs to have a value set before storing the object in the table
-     * @param int    $maxlength     maximum length of this variable, for XOBJ_DTYPE_TXTBOX type only
-     * @param string $options       does this data have any select options?
-     * @param bool   $multilingual  is this field needs to support multilingual features (NOT YET IMPLEMENTED...)
-     * @param string $form_caption  caption of this variable in a {@link SmartobjectForm} and title of a column in a  {@link SmartObjectTable}
-     * @param string $form_dsc      description of this variable in a {@link SmartobjectForm}
-     * @param bool   $sortby        set to TRUE to make this field used to sort objects in SmartObjectTable
-     * @param bool   $persistent    set to FALSE if this field is not to be saved in the database
-     * @param bool   $displayOnForm
-     */
-    public function initVar($key, $data_type, $value = null, $required = false, $maxlength = null, $options = '', $multilingual = false, $form_caption = '', $form_dsc = '', $sortby = false,
-                            $persistent = true, $displayOnForm = true
-    ) {
-        //url_ is reserved for files.
-        if (0 === strpos($key, 'url_')) {
-            trigger_error("Cannot use variable starting with 'url_'.");
-        }
-        parent::initVar($key, $data_type, $value, $required, $maxlength, $options);
-        if ($this->handler && (!$form_caption || $form_caption === '')) {
-            $dyn_form_caption = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key);
-            if (defined($dyn_form_caption)) {
-                $form_caption = constant($dyn_form_caption);
-            }
-        }
-        if ($this->handler && (!$form_dsc || $form_dsc === '')) {
-            $dyn_form_dsc = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key . '_DSC');
-            if (defined($dyn_form_dsc)) {
-                $form_dsc = constant($dyn_form_dsc);
-            }
-        }
-
-        $this->vars[$key] = array_merge($this->vars[$key], array(
-            'multilingual'        => $multilingual,
-            'form_caption'        => $form_caption,
-            'form_dsc'            => $form_dsc,
-            'sortby'              => $sortby,
-            'persistent'          => $persistent,
-            'displayOnForm'       => $displayOnForm,
-            'displayOnSingleView' => true,
-            'readonly'            => false
-        ));
-    }
-
-    /**
-     * @param        $key
-     * @param        $data_type
-     * @param bool   $itemName
-     * @param string $form_caption
-     * @param bool   $sortby
-     * @param string $value
-     * @param bool   $displayOnForm
-     * @param bool   $required
-     */
-    public function initNonPersistableVar($key, $data_type, $itemName = false, $form_caption = '', $sortby = false, $value = '', $displayOnForm = false, $required = false)
-    {
-        $this->initVar($key, $data_type, $value, $required, null, '', false, $form_caption, '', $sortby, false, $displayOnForm);
-        $this->vars[$key]['itemName'] = $itemName;
-    }
-
-    /**
-     * Quickly initiate a var
-     *
-     * Since many vars do have the same config, let's use this method with some of these configuration as a convention ;-)
-     *
-     * - $maxlength = 0 unless $data_type is a TEXTBOX, then $maxlength will be 255
-     * - all other vars are NULL or '' depending of the parameter
-     *
-     * @param string $key          key of this field. This needs to be the name of the field in the related database table
-     * @param int    $data_type    set to one of XOBJ_DTYPE_XXX constants (set to XOBJ_DTYPE_OTHER if no data type ckecking nor text sanitizing is required)
-     * @param bool   $required     set to TRUE if this variable needs to have a value set before storing the object in the table
-     * @param string $form_caption caption of this variable in a {@link SmartobjectForm} and title of a column in a  {@link SmartObjectTable}
-     * @param string $form_dsc     description of this variable in a {@link SmartobjectForm}
-     * @param mixed  $value        default value of this variable
-     */
-    public function quickInitVar($key, $data_type, $required = false, $form_caption = '', $form_dsc = '', $value = null)
-    {
-        $maxlength = $data_type === 'XOBJ_DTYPE_TXTBOX' ? 255 : null;
-        $this->initVar($key, $data_type, $value, $required, $maxlength, '', false, $form_caption, $form_dsc, false, true, true);
-    }
-
-    /**
-     * @param        $varname
-     * @param bool   $displayOnForm
-     * @param string $default
-     */
-    public function initCommonVar($varname, $displayOnForm = true, $default = 'notdefined')
-    {
-        switch ($varname) {
-            case 'dohtml':
-                $value = $default !== 'notdefined' ? $default : true;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOHTML_FORM_CAPTION, '', false, true, $displayOnForm);
-                $this->setControl($varname, 'yesno');
-                break;
-
-            case 'dobr':
-                $value = ($default === 'notdefined') ? true : $default;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOBR_FORM_CAPTION, '', false, true, $displayOnForm);
-                $this->setControl($varname, 'yesno');
-                break;
-
-            case 'doimage':
-                $value = $default !== 'notdefined' ? $default : true;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOIMAGE_FORM_CAPTION, '', false, true, $displayOnForm);
-                $this->setControl($varname, 'yesno');
-                break;
-
-            case 'dosmiley':
-                $value = $default !== 'notdefined' ? $default : true;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOSMILEY_FORM_CAPTION, '', false, true, $displayOnForm);
-                $this->setControl($varname, 'yesno');
-                break;
-
-            case 'doxcode':
-                $value = $default !== 'notdefined' ? $default : true;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOXCODE_FORM_CAPTION, '', false, true, $displayOnForm);
-                $this->setControl($varname, 'yesno');
-                break;
-
-            case 'meta_keywords':
-                $value = $default !== 'notdefined' ? $default : '';
-                $this->initVar($varname, XOBJ_DTYPE_TXTAREA, $value, false, null, '', false, _CO_SOBJECT_META_KEYWORDS, _CO_SOBJECT_META_KEYWORDS_DSC, false, true, $displayOnForm);
-                $this->setControl('meta_keywords', array(
-                    'name'        => 'textarea',
-                    'form_editor' => 'textarea'
-                ));
-                break;
-
-            case 'meta_description':
-                $value = $default !== 'notdefined' ? $default : '';
-                $this->initVar($varname, XOBJ_DTYPE_TXTAREA, $value, false, null, '', false, _CO_SOBJECT_META_DESCRIPTION, _CO_SOBJECT_META_DESCRIPTION_DSC, false, true, $displayOnForm);
-                $this->setControl('meta_description', array(
-                    'name'        => 'textarea',
-                    'form_editor' => 'textarea'
-                ));
-                break;
-
-            case 'short_url':
-                $value = $default !== 'notdefined' ? $default : '';
-                $this->initVar($varname, XOBJ_DTYPE_TXTBOX, $value, false, null, '', false, _CO_SOBJECT_SHORT_URL, _CO_SOBJECT_SHORT_URL_DSC, false, true, $displayOnForm);
-                break;
-
-            case 'hierarchy_path':
-                $value = $default !== 'notdefined' ? $default : '';
-                $this->initVar($varname, XOBJ_DTYPE_ARRAY, $value, false, null, '', false, _CO_SOBJECT_HIERARCHY_PATH, _CO_SOBJECT_HIERARCHY_PATH_DSC, false, true, $displayOnForm);
-                break;
-
-            case 'counter':
-                $value = $default !== 'notdefined' ? $default : 0;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_COUNTER_FORM_CAPTION, '', false, true, $displayOnForm);
-                break;
-
-            case 'weight':
-                $value = $default !== 'notdefined' ? $default : 0;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_WEIGHT_FORM_CAPTION, '', true, true, $displayOnForm);
-                break;
-            case 'custom_css':
-                $value = $default !== 'notdefined' ? $default : '';
-                $this->initVar($varname, XOBJ_DTYPE_TXTAREA, $value, false, null, '', false, _CO_SOBJECT_CUSTOM_CSS, _CO_SOBJECT_CUSTOM_CSS_DSC, false, true, $displayOnForm);
-                $this->setControl('custom_css', array(
-                    'name'        => 'textarea',
-                    'form_editor' => 'textarea'
-                ));
-                break;
-        }
-        $this->hideFieldFromSingleView($varname);
-    }
-
-    /**
-     * Set control information for an instance variable
-     *
-     * The $options parameter can be a string or an array. Using a string
-     * is the quickest way:
-     *
-     * $this->setControl('date', 'date_time');
-     *
-     * This will create a date and time selectbox for the 'date' var on the
-     * form to edit or create this item.
-     *
-     * Here are the currently supported controls:
-     *
-     *      - color
-     *      - country
-     *      - date_time
-     *      - date
-     *      - email
-     *      - group
-     *      - group_multi
-     *      - image
-     *      - imageupload
-     *      - label
-     *      - language
-     *      - parentcategory
-     *      - password
-     *      - select_multi
-     *      - select
-     *      - text
-     *      - textarea
-     *      - theme
-     *      - theme_multi
-     *      - timezone
-     *      - user
-     *      - user_multi
-     *      - yesno
-     *
-     * Now, using an array as $options, you can customize what information to
-     * use in the control. For example, if one needs to display a select box for
-     * the user to choose the status of an item. We only need to tell SmartObject
-     * what method to execute within what handler to retreive the options of the
-     * selectbox.
-     *
-     * $this->setControl('status', array('name' => false,
-     *                                   'itemHandler' => 'item',
-     *                                   'method' => 'getStatus',
-     *                                   'module' => 'smartshop'));
-     *
-     * In this example, the array elements are the following:
-     *      - name: false, as we don't need to set a special control here.
-     *               we will use the default control related to the object type (defined in initVar)
-     *      - itemHandler: name of the object for which we will use the handler
-     *      - method: name of the method of this handler that we will execute
-     *      - module: name of the module from wich the handler is
-     *
-     * So in this example, SmartObject will create a selectbox for the variable 'status' and it will
-     * populate this selectbox with the result from SmartshopItemHandler::getStatus()
-     *
-     * Another example of the use of $options as an array is for TextArea:
-     *
-     * $this->setControl('body', array('name' => 'textarea',
-     *                                   'form_editor' => 'default'));
-     *
-     * In this example, SmartObject will create a TextArea for the variable 'body'. And it will use
-     * the 'default' editor, providing it is defined in the module
-     * preferences: $xoopsModuleConfig['default_editor']
-     *
-     * Of course, you can force the use of a specific editor:
-     *
-     * $this->setControl('body', array('name' => 'textarea',
-     *                                   'form_editor' => 'koivi'));
-     *
-     * Here is a list of supported editor:
-     *      - tiny: TinyEditor
-     *      - dhtmltextarea: XOOPS DHTML Area
-     *      - fckeditor: FCKEditor
-     *      - inbetween: InBetween
-     *      - koivi: Koivi
-     *      - spaw: Spaw WYSIWYG Editor
-     *      - htmlarea: HTMLArea
-     *      - textarea: basic textarea with no options
-     *
-     * @param string $var     name of the variable for which we want to set a control
-     * @param array  $options
-     */
-    public function setControl($var, $options = array())
-    {
-        if (isset($this->controls[$var])) {
-            unset($this->controls[$var]);
-        }
-        if (is_string($options)) {
-            $options = array('name' => $options);
-        }
-        $this->controls[$var] = $options;
-    }
-
-    /**
-     * Get control information for an instance variable
-     *
-     * @param  string     $var
-     * @return bool|mixed
-     */
-    public function getControl($var)
-    {
-        return isset($this->controls[$var]) ? $this->controls[$var] : false;
-    }
-
-    /**
-     * Create the form for this object
-     *
-     * @param         $form_caption
-     * @param         $form_name
-     * @param  bool   $form_action
-     * @param  string $submit_button_caption
-     * @param  bool   $cancel_js_action
-     * @param  bool   $captcha
-     * @return a      <a href='psi_element://SmartobjectForm'>SmartobjectForm</a> object for this object
-     *                                      object for this object
-     * @see SmartObjectForm::SmartObjectForm()
-     */
-    public function getForm($form_caption, $form_name, $form_action = false, $submit_button_caption = _CO_SOBJECT_SUBMIT, $cancel_js_action = false, $captcha = false)
-    {
-        include_once SMARTOBJECT_ROOT_PATH . 'class/form/smartobjectform.php';
-        $form = new SmartobjectForm($this, $form_name, $form_caption, $form_action, null, $submit_button_caption, $cancel_js_action, $captcha);
-
-        return $form;
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        $ret  = array();
-        $vars =& $this->getVars();
-        foreach ($vars as $key => $var) {
-            $value     = $this->getVar($key);
-            $ret[$key] = $value;
-        }
-        if ($this->handler->identifierName !== '') {
-            $controller = new SmartObjectController($this->handler);
-            /**
-             * Addition of some automatic value
-             */
-            $ret['itemLink']         = $controller->getItemLink($this);
-            $ret['itemUrl']          = $controller->getItemLink($this, true);
-            $ret['editItemLink']     = $controller->getEditItemLink($this, false, true);
-            $ret['deleteItemLink']   = $controller->getDeleteItemLink($this, false, true);
-            $ret['printAndMailLink'] = $controller->getPrintAndMailLink($this);
-        }
-
-        // Hightlighting searched words
-        include_once(SMARTOBJECT_ROOT_PATH . 'class/smarthighlighter.php');
-        $highlight = smart_getConfig('module_search_highlighter', false, true);
-
-        if ($highlight && isset($_GET['keywords'])) {
-            $myts     = MyTextSanitizer::getInstance();
-            $keywords = $myts->htmlSpecialChars(trim(urldecode($_GET['keywords'])));
-            $h        = new SmartHighlighter($keywords, true, 'smart_highlighter');
-            foreach ($this->handler->highlightFields as $field) {
-                $ret[$field] = $h->highlight($ret[$field]);
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * add an error
-     *
-     * @param      $err_str
-     * @param bool $prefix
-     * @internal param string $value error to add
-     * @access   public
-     */
-    public function setErrors($err_str, $prefix = false)
-    {
-        if (is_array($err_str)) {
-            foreach ($err_str as $str) {
-                $this->setErrors($str, $prefix);
-            }
-        } else {
-            if ($prefix) {
-                $err_str = '[' . $prefix . '] ' . $err_str;
-            }
-            parent::setErrors($err_str);
-        }
-    }
-
-    /**
-     * @param      $field
-     * @param bool $required
-     */
-    public function setFieldAsRequired($field, $required = true)
-    {
-        if (is_array($field)) {
-            foreach ($field as $v) {
-                $this->doSetFieldAsRequired($v, $required);
-            }
-        } else {
-            $this->doSetFieldAsRequired($field, $required);
-        }
-    }
-
-    /**
-     * @param $field
-     */
-    public function setFieldForSorting($field)
-    {
-        if (is_array($field)) {
-            foreach ($field as $v) {
-                $this->doSetFieldForSorting($v);
-            }
-        } else {
-            $this->doSetFieldForSorting($field);
-        }
-    }
-
-    /**
-     * @return bool
-     */
-    public function hasError()
-    {
-        return count($this->_errors) > 0;
-    }
-
-    /**
-     * @param $url
-     * @param $path
-     */
-    public function setImageDir($url, $path)
-    {
-        $this->_image_url  = $url;
-        $this->_image_path = $path;
-    }
-
-    /**
-     * Retreive the group that have been granted access to a specific permission for this object
-     *
-     * @param $group_perm
-     * @return string $group_perm name of the permission
-     */
-    public function getGroupPerm($group_perm)
-    {
-        if (!$this->handler->getPermissions()) {
-            $this->setError("Trying to access a permission that does not exists for thisobject's handler");
-
-            return false;
-        }
-
-        $smartPermissionsHandler = new SmartobjectPermissionHandler($this->handler);
-        $ret                     = $smartPermissionsHandler->getGrantedGroups($group_perm, $this->id());
-
-        if (count($ret) == 0) {
-            return false;
-        } else {
-            return $ret;
-        }
-    }
-
-    /**
-     * @param  bool  $path
-     * @return mixed
-     */
-    public function getImageDir($path = false)
-    {
-        if ($path) {
-            return $this->_image_path;
-        } else {
-            return $this->_image_url;
-        }
-    }
-
-    /**
-     * @param  bool  $path
-     * @return mixed
-     */
-    public function getUploadDir($path = false)
-    {
-        if ($path) {
-            return $this->_image_path;
-        } else {
-            return $this->_image_url;
-        }
-    }
-
-    /**
-     * @param  string $key
-     * @param  string $info
-     * @return array
-     */
-    public function getVarInfo($key = '', $info = '')
-    {
-        if (isset($this->vars[$key][$info])) {
-            return $this->vars[$key][$info];
-        } elseif ($info === '' && isset($this->vars[$key])) {
-            return $this->vars[$key];
-        } else {
-            return $this->vars;
-        }
-    }
-
-    /**
-     * Get the id of the object
-     *
-     * @return int id of this object
-     */
-    public function id()
-    {
-        return $this->getVar($this->handler->keyName, 'e');
-    }
-
-    /**
-     * Return the value of the title field of this object
-     *
-     * @param  string $format
-     * @return string
-     */
-    public function title($format = 's')
-    {
-        return $this->getVar($this->handler->identifierName, $format);
-    }
-
-    /**
-     * Return the value of the title field of this object
-     *
-     * @return string
-     */
-    public function summary()
-    {
-        if ($this->handler->summaryName) {
-            return $this->getVar($this->handler->summaryName);
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Retreive the object admin side link, displayijng a SingleView page
-     *
-     * @param  bool   $onlyUrl wether or not to return a simple URL or a full <a> link
-     * @return string user side link to the object
-     */
-    public function getAdminViewItemLink($onlyUrl = false)
-    {
-        $controller = new SmartObjectController($this->handler);
-
-        return $controller->getAdminViewItemLink($this, $onlyUrl);
-    }
-
-    /**
-     * Retreive the object user side link
-     *
-     * @param  bool   $onlyUrl wether or not to return a simple URL or a full <a> link
-     * @return string user side link to the object
-     */
-    public function getItemLink($onlyUrl = false)
-    {
-        $controller = new SmartObjectController($this->handler);
-
-        return $controller->getItemLink($this, $onlyUrl);
-    }
-
-    /**
-     * @param  bool   $onlyUrl
-     * @param  bool   $withimage
-     * @param  bool   $userSide
-     * @return string
-     */
-    public function getEditItemLink($onlyUrl = false, $withimage = true, $userSide = false)
-    {
-        $controller = new SmartObjectController($this->handler);
-
-        return $controller->getEditItemLink($this, $onlyUrl, $withimage, $userSide);
-    }
-
-    /**
-     * @param  bool   $onlyUrl
-     * @param  bool   $withimage
-     * @param  bool   $userSide
-     * @return string
-     */
-    public function getDeleteItemLink($onlyUrl = false, $withimage = false, $userSide = false)
-    {
-        $controller = new SmartObjectController($this->handler);
-
-        return $controller->getDeleteItemLink($this, $onlyUrl, $withimage, $userSide);
-    }
-
-    /**
-     * @return string
-     */
-    public function getPrintAndMailLink()
-    {
-        $controller = new SmartObjectController($this->handler);
-
-        return $controller->getPrintAndMailLink($this);
-    }
-
-    /**
-     * @param $sortsel
-     * @return array|bool
-     */
-    public function getFieldsForSorting($sortsel)
-    {
-        $ret = array();
-
-        foreach ($this->vars as $key => $field_info) {
-            if ($field_info['sortby']) {
-                $ret[$key]['caption']  = $field_info['form_caption'];
-                $ret[$key]['selected'] = $key == $sortsel ? "selected='selected'" : '';
-            }
-        }
-
-        if (count($ret) > 0) {
-            return $ret;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * @param $key
-     * @param $newType
-     */
-    public function setType($key, $newType)
-    {
-        $this->vars[$key]['data_type'] = $newType;
-    }
-
-    /**
-     * @param $key
-     * @param $info
-     * @param $value
-     */
-    public function setVarInfo($key, $info, $value)
-    {
-        $this->vars[$key][$info] = $value;
-    }
-
-    /**
-     * @param         $key
-     * @param  bool   $editor
-     * @return string
-     */
-    public function getValueFor($key, $editor = true)
-    {
-        global $xoopsModuleConfig;
-
-        $ret  = $this->getVar($key, 'n');
-        $myts = MyTextSanitizer::getInstance();
-
-        $control     = isset($this->controls[$key]) ? $this->controls[$key] : false;
-        $form_editor = isset($control['form_editor']) ? $control['form_editor'] : 'textarea';
-
-        $html     = isset($this->vars['dohtml']) ? $this->getVar('dohtml') : true;
-        $smiley   = true;
-        $xcode    = true;
-        $image    = true;
-        $br       = isset($this->vars['dobr']) ? $this->getVar('dobr') : true;
-        $formatML = true;
-
-        if ($form_editor === 'default') {
-            global $xoopsModuleConfig;
-            $form_editor = isset($xoopsModuleConfig['default_editor']) ? $xoopsModuleConfig['default_editor'] : 'textarea';
-        }
-
-        if ($editor) {
-            if (defined('XOOPS_EDITOR_IS_HTML') && !in_array($form_editor, array('formtextarea', 'textarea', 'dhtmltextarea'))) {
-                $br       = false;
-                $formatML = !$editor;
-            } else {
-                return htmlspecialchars($ret, ENT_QUOTES);
-            }
-        }
-
-        if (method_exists($myts, 'formatForML')) {
-            return $myts->displayTarea($ret, $html, $smiley, $xcode, $image, $br, $formatML);
-        } else {
-            return $myts->displayTarea($ret, $html, $smiley, $xcode, $image, $br);
-        }
-    }
-
-    /**
-     * clean values of all variables of the object for storage.
-     * also add slashes whereever needed
-     *
-     * We had to put this method in the SmartObject because the XOBJ_DTYPE_ARRAY does not work properly
-     * at least on PHP 5.1. So we have created a new type XOBJ_DTYPE_SIMPLE_ARRAY to handle 1 level array
-     * as a string separated by |
-     *
-     * @return bool true if successful
-     * @access public
-     */
-    public function cleanVars()
-    {
-        $ts              = MyTextSanitizer::getInstance();
-        $existing_errors = $this->getErrors();
-        $this->_errors   = array();
-        foreach ($this->vars as $k => $v) {
-            $cleanv = $v['value'];
-            if (!$v['changed']) {
-            } else {
-                $cleanv = is_string($cleanv) ? trim($cleanv) : $cleanv;
-                switch ($v['data_type']) {
-                    case XOBJ_DTYPE_TXTBOX:
-                        if ($v['required'] && $cleanv != '0' && $cleanv == '') {
-                            $this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
-                            continue 2;
-                        }
-                        if (isset($v['maxlength']) && strlen($cleanv) > (int)$v['maxlength']) {
-                            $this->setErrors(sprintf(_XOBJ_ERR_SHORTERTHAN, $k, (int)$v['maxlength']));
-                            continue 2;
-                        }
-                        if (!$v['not_gpc']) {
-                            $cleanv = $ts->stripSlashesGPC($ts->censorString($cleanv));
-                        } else {
-                            $cleanv = $ts->censorString($cleanv);
-                        }
-                        break;
-                    case XOBJ_DTYPE_TXTAREA:
-                        if ($v['required'] && $cleanv != '0' && $cleanv == '') {
-                            $this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
-                            continue 2;
-                        }
-                        if (!$v['not_gpc']) {
-                            $cleanv = $ts->stripSlashesGPC($ts->censorString($cleanv));
-                        } else {
-                            $cleanv = $ts->censorString($cleanv);
-                        }
-                        break;
-                    case XOBJ_DTYPE_SOURCE:
-                        if (!$v['not_gpc']) {
-                            $cleanv = $ts->stripSlashesGPC($cleanv);
-                        } else {
-                            $cleanv = $cleanv;
-                        }
-                        break;
-                    case XOBJ_DTYPE_INT:
-                    case XOBJ_DTYPE_TIME_ONLY:
-                        $cleanv = (int)$cleanv;
-                        break;
-
-                    case XOBJ_DTYPE_CURRENCY:
-                        $cleanv = smart_currency($cleanv);
-                        break;
-
-                    case XOBJ_DTYPE_FLOAT:
-                        $cleanv = smart_float($cleanv);
-                        break;
-
-                    case XOBJ_DTYPE_EMAIL:
-                        if ($v['required'] && $cleanv === '') {
-                            $this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
-                            continue 2;
-                        }
-                        if ($cleanv !== '' && !preg_match("/^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+([\.][a-z0-9-]+)+$/i", $cleanv)) {
-                            $this->setErrors('Invalid Email');
-                            continue 2;
-                        }
-                        if (!$v['not_gpc']) {
-                            $cleanv = $ts->stripSlashesGPC($cleanv);
-                        }
-                        break;
-                    case XOBJ_DTYPE_URL:
-                        if ($v['required'] && $cleanv === '') {
-                            $this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
-                            continue 2;
-                        }
-                        if ($cleanv !== '' && !preg_match("/^http[s]*:\/\//i", $cleanv)) {
-                            $cleanv = 'http://' . $cleanv;
-                        }
-                        if (!$v['not_gpc']) {
-                            $cleanv =& $ts->stripSlashesGPC($cleanv);
-                        }
-                        break;
-                    case XOBJ_DTYPE_SIMPLE_ARRAY:
-                        $cleanv = implode('|', $cleanv);
-                        break;
-                    case XOBJ_DTYPE_ARRAY:
-                        $cleanv = serialize($cleanv);
-                        break;
-                    case XOBJ_DTYPE_STIME:
-                    case XOBJ_DTYPE_MTIME:
-                    case XOBJ_DTYPE_LTIME:
-                        $cleanv = !is_string($cleanv) ? (int)$cleanv : strtotime($cleanv);
-                        if (!($cleanv > 0)) {
-                            $cleanv = strtotime($cleanv);
-                        }
-                        break;
-                    default:
-                        break;
-                }
-            }
-            $this->cleanVars[$k] =& $cleanv;
-            unset($cleanv);
-        }
-        if (count($this->_errors) > 0) {
-            $this->_errors = array_merge($existing_errors, $this->_errors);
-
-            return false;
-        }
-        $this->_errors = array_merge($existing_errors, $this->_errors);
-        $this->unsetDirty();
-
-        return true;
-    }
-
-    /**
-     * returns a specific variable for the object in a proper format
-     *
-     * We had to put this method in the SmartObject because the XOBJ_DTYPE_ARRAY does not work properly
-     * at least on PHP 5.1. So we have created a new type XOBJ_DTYPE_SIMPLE_ARRAY to handle 1 level array
-     * as a string separated by |
-     *
-     * @access public
-     * @param  string $key    key of the object's variable to be returned
-     * @param  string $format format to use for the output
-     * @return mixed  formatted value of the variable
-     */
-    public function getVar($key, $format = 's')
-    {
-        global $myts;
-
-        $ret = $this->vars[$key]['value'];
-
-        switch ($this->vars[$key]['data_type']) {
-
-            case XOBJ_DTYPE_TXTBOX:
-                switch (strtolower($format)) {
-                    case 's':
-                    case 'show':
-                        // ML Hack by marcan
-                        $ts  = MyTextSanitizer::getInstance();
-                        $ret = $ts->htmlSpecialChars($ret);
-
-                        if (method_exists($myts, 'formatForML')) {
-                            return $ts->formatForML($ret);
-                        } else {
-                            return $ret;
-                        }
-                        break 1;
-                    // End of ML Hack by marcan
-
-                    case 'clean':
-                        $ts = MyTextSanitizer::getInstance();
-
-                        $ret = smart_html2text($ret);
-                        $ret = smart_purifyText($ret);
-
-                        if (method_exists($myts, 'formatForML')) {
-                            return $ts->formatForML($ret);
-                        } else {
-                            return $ret;
-                        }
-                        break 1;
-                    // End of ML Hack by marcan
-
-                    case 'e':
-                    case 'edit':
-                        $ts = MyTextSanitizer::getInstance();
-
-                        return $ts->htmlSpecialChars($ret);
-                        break 1;
-                    case 'p':
-                    case 'preview':
-                    case 'f':
-                    case 'formpreview':
-                        $ts = MyTextSanitizer::getInstance();
-
-                        return $ts->htmlSpecialChars($ts->stripSlashesGPC($ret));
-                        break 1;
-                    case 'n':
-                    case 'none':
-                    default:
-                        break 1;
-                }
-                break;
-            case XOBJ_DTYPE_LTIME:
-                switch (strtolower($format)) {
-                    case 's':
-                    case 'show':
-                    case 'p':
-                    case 'preview':
-                    case 'f':
-                    case 'formpreview':
-                        $ret = formatTimestamp($ret, _DATESTRING);
-
-                        return $ret;
-                        break 1;
-                    case 'n':
-                    case 'none':
-                    case 'e':
-                    case 'edit':
-                        break 1;
-                    default:
-                        break 1;
-                }
-                break;
-            case XOBJ_DTYPE_STIME:
-                switch (strtolower($format)) {
-                    case 's':
-                    case 'show':
-                    case 'p':
-                    case 'preview':
-                    case 'f':
-                    case 'formpreview':
-                        $ret = formatTimestamp($ret, _SHORTDATESTRING);
-
-                        return $ret;
-                        break 1;
-                    case 'n':
-                    case 'none':
-                    case 'e':
-                    case 'edit':
-                        break 1;
-                    default:
-                        break 1;
-                }
-                break;
-            case XOBJ_DTYPE_TIME_ONLY:
-                switch (strtolower($format)) {
-                    case 's':
-                    case 'show':
-                    case 'p':
-                    case 'preview':
-                    case 'f':
-                    case 'formpreview':
-                        $ret = formatTimestamp($ret, 'G:i');
-
-                        return $ret;
-                        break 1;
-                    case 'n':
-                    case 'none':
-                    case 'e':
-                    case 'edit':
-                        break 1;
-                    default:
-                        break 1;
-                }
-                break;
-
-            case XOBJ_DTYPE_CURRENCY:
-                $decimal_section_original = strstr($ret, '.');
-                $decimal_section          = $decimal_section_original;
-                if ($decimal_section) {
-                    if (strlen($decimal_section) == 1) {
-                        $decimal_section = '.00';
-                    } elseif (strlen($decimal_section) == 2) {
-                        $decimal_section .= '0';
-                    }
-                    $ret = str_replace($decimal_section_original, $decimal_section, $ret);
-                } else {
-                    $ret .= '.00';
-                }
-                break;
-
-            case XOBJ_DTYPE_TXTAREA:
-                switch (strtolower($format)) {
-                    case 's':
-                    case 'show':
-                        $ts   = MyTextSanitizer::getInstance();
-                        $html = !empty($this->vars['dohtml']['value']) ? 1 : 0;
-
-                        $xcode = (!isset($this->vars['doxcode']['value']) || $this->vars['doxcode']['value'] == 1) ? 1 : 0;
-
-                        $smiley = (!isset($this->vars['dosmiley']['value']) || $this->vars['dosmiley']['value'] == 1) ? 1 : 0;
-                        $image  = (!isset($this->vars['doimage']['value']) || $this->vars['doimage']['value'] == 1) ? 1 : 0;
-                        $br     = (!isset($this->vars['dobr']['value']) || $this->vars['dobr']['value'] == 1) ? 1 : 0;
-
-                        /**
-                         * Hack by marcan <INBOX> for SCSPRO
-                         * Setting mastop as the main editor
-                         */
-                        if (defined('XOOPS_EDITOR_IS_HTML')) {
-                            $br = false;
-                        }
-                        /**
-                         * Hack by marcan <INBOX> for SCSPRO
-                         * Setting mastop as the main editor
-                         */
-
-                        return $ts->displayTarea($ret, $html, $smiley, $xcode, $image, $br);
-                        break 1;
-                    case 'e':
-                    case 'edit':
-                        return htmlspecialchars($ret, ENT_QUOTES);
-                        break 1;
-                    case 'p':
-                    case 'preview':
-                        $ts     = MyTextSanitizer::getInstance();
-                        $html   = !empty($this->vars['dohtml']['value']) ? 1 : 0;
-                        $xcode  = (!isset($this->vars['doxcode']['value']) || $this->vars['doxcode']['value'] == 1) ? 1 : 0;
-                        $smiley = (!isset($this->vars['dosmiley']['value']) || $this->vars['dosmiley']['value'] == 1) ? 1 : 0;
-                        $image  = (!isset($this->vars['doimage']['value']) || $this->vars['doimage']['value'] == 1) ? 1 : 0;
-                        $br     = (!isset($this->vars['dobr']['value']) || $this->vars['dobr']['value'] == 1) ? 1 : 0;
-
-                        return $ts->previewTarea($ret, $html, $smiley, $xcode, $image, $br);
-                        break 1;
-                    case 'f':
-                    case 'formpreview':
-                        $ts = MyTextSanitizer::getInstance();
-
-                        return htmlspecialchars($ts->stripSlashesGPC($ret), ENT_QUOTES);
-                        break 1;
-                    case 'n':
-                    case 'none':
-                    default:
-                        break 1;
-                }
-                break;
-            case XOBJ_DTYPE_SIMPLE_ARRAY:
-                $ret =& explode('|', $ret);
-                break;
-            case XOBJ_DTYPE_ARRAY:
-                $ret =& unserialize($ret);
-                break;
-            case XOBJ_DTYPE_SOURCE:
-                switch (strtolower($format)) {
-                    case 's':
-                    case 'show':
-                        break 1;
-                    case 'e':
-                    case 'edit':
-                        return htmlspecialchars($ret, ENT_QUOTES);
-                        break 1;
-                    case 'p':
-                    case 'preview':
-                        $ts = MyTextSanitizer::getInstance();
-
-                        return $ts->stripSlashesGPC($ret);
-                        break 1;
-                    case 'f':
-                    case 'formpreview':
-                        $ts = MyTextSanitizer::getInstance();
-
-                        return htmlspecialchars($ts->stripSlashesGPC($ret), ENT_QUOTES);
-                        break 1;
-                    case 'n':
-                    case 'none':
-                    default:
-                        break 1;
-                }
-                break;
-            default:
-                if ($this->vars[$key]['options'] !== '' && $ret != '') {
-                    switch (strtolower($format)) {
-                        case 's':
-                        case 'show':
-                            $selected = explode('|', $ret);
-                            $options  = explode('|', $this->vars[$key]['options']);
-                            $i        = 1;
-                            $ret      = array();
-                            foreach ($options as $op) {
-                                if (in_array($i, $selected)) {
-                                    $ret[] = $op;
-                                }
-                                ++$i;
-                            }
-
-                            return implode(', ', $ret);
-                        case 'e':
-                        case 'edit':
-                            $ret = explode('|', $ret);
-                            break 1;
-                        default:
-                            break 1;
-                    }
-                }
-                break;
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param $key
-     */
-    public function doMakeFieldreadOnly($key)
-    {
-        if (isset($this->vars[$key])) {
-            $this->vars[$key]['readonly']      = true;
-            $this->vars[$key]['displayOnForm'] = true;
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function makeFieldReadOnly($key)
-    {
-        if (is_array($key)) {
-            foreach ($key as $v) {
-                $this->doMakeFieldreadOnly($v);
-            }
-        } else {
-            $this->doMakeFieldreadOnly($key);
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function doHideFieldFromForm($key)
-    {
-        if (isset($this->vars[$key])) {
-            $this->vars[$key]['displayOnForm'] = false;
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function doHideFieldFromSingleView($key)
-    {
-        if (isset($this->vars[$key])) {
-            $this->vars[$key]['displayOnSingleView'] = false;
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function hideFieldFromForm($key)
-    {
-        if (is_array($key)) {
-            foreach ($key as $v) {
-                $this->doHideFieldFromForm($v);
-            }
-        } else {
-            $this->doHideFieldFromForm($key);
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function hideFieldFromSingleView($key)
-    {
-        if (is_array($key)) {
-            foreach ($key as $v) {
-                $this->doHideFieldFromSingleView($v);
-            }
-        } else {
-            $this->doHideFieldFromSingleView($key);
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function doShowFieldOnForm($key)
-    {
-        if (isset($this->vars[$key])) {
-            $this->vars[$key]['displayOnForm'] = true;
-        }
-    }
-
-    /**
-     * Display an automatic SingleView of the object, based on the displayOnSingleView param of each vars
-     *
-     * @param  bool    $fetchOnly   if set to TRUE, then the content will be return, if set to FALSE, the content will be outputed
-     * @param  bool    $userSide    for futur use, to do something different on the user side
-     * @param  array   $actions
-     * @param  bool    $headerAsRow
-     * @return content of the template if $fetchOnly or nothing if !$fetchOnly
-     */
-    public function displaySingleObject($fetchOnly = false, $userSide = false, $actions = array(), $headerAsRow = true)
-    {
-        include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectsingleview.php';
-        $singleview = new SmartObjectSingleView($this, $userSide, $actions, $headerAsRow);
-        // add all fields mark as displayOnSingleView except the keyid
-        foreach ($this->vars as $key => $var) {
-            if ($key != $this->handler->keyName && $var['displayOnSingleView']) {
-                $is_header = ($key == $this->handler->identifierName);
-                $singleview->addRow(new SmartObjectRow($key, false, $is_header));
-            }
-        }
-
-        if ($fetchOnly) {
-            $ret = $singleview->render($fetchOnly);
-
-            return $ret;
-        } else {
-            $singleview->render($fetchOnly);
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function doDisplayFieldOnSingleView($key)
-    {
-        if (isset($this->vars[$key])) {
-            $this->vars[$key]['displayOnSingleView'] = true;
-        }
-    }
-
-    /**
-     * @param      $field
-     * @param bool $required
-     */
-    public function doSetFieldAsRequired($field, $required = true)
-    {
-        $this->setVarInfo($field, 'required', $required);
-    }
-
-    /**
-     * @param $field
-     */
-    public function doSetFieldForSorting($field)
-    {
-        $this->setVarInfo($field, 'sortby', true);
-    }
-
-    /**
-     * @param $key
-     */
-    public function showFieldOnForm($key)
-    {
-        if (is_array($key)) {
-            foreach ($key as $v) {
-                $this->doShowFieldOnForm($v);
-            }
-        } else {
-            $this->doShowFieldOnForm($key);
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function displayFieldOnSingleView($key)
-    {
-        if (is_array($key)) {
-            foreach ($key as $v) {
-                $this->doDisplayFieldOnSingleView($v);
-            }
-        } else {
-            $this->doDisplayFieldOnSingleView($key);
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function doSetAdvancedFormFields($key)
-    {
-        if (isset($this->vars[$key])) {
-            $this->vars[$key]['advancedform'] = true;
-        }
-    }
-
-    /**
-     * @param $key
-     */
-    public function setAdvancedFormFields($key)
-    {
-        if (is_array($key)) {
-            foreach ($key as $v) {
-                $this->doSetAdvancedFormFields($v);
-            }
-        } else {
-            $this->doSetAdvancedFormFields($key);
-        }
-    }
-
-    /**
-     * @param $key
-     * @return mixed
-     */
-    public function getUrlLinkObj($key)
-    {
-        $smartobjectLinkurlHandler = xoops_getModuleHandler('urllink', 'smartobject');
-        $urllinkid                 = $this->getVar($key) !== null ? $this->getVar($key) : 0;
-        if ($urllinkid != 0) {
-            return $smartobjectLinkurlHandler->get($urllinkid);
-        } else {
-            return $smartobjectLinkurlHandler->create();
-        }
-    }
-
-    /**
-     * @param $urlLinkObj
-     * @return mixed
-     */
-    public function &storeUrlLinkObj($urlLinkObj)
-    {
-        $smartobjectLinkurlHandler = xoops_getModuleHandler('urllink', 'smartobject');
-
-        return $smartobjectLinkurlHandler->insert($urlLinkObj);
-    }
-
-    /**
-     * @param $key
-     * @return mixed
-     */
-    public function getFileObj($key)
-    {
-        $smartobjectFileHandler = xoops_getModuleHandler('file', 'smartobject');
-        $fileid                 = $this->getVar($key) !== null ? $this->getVar($key) : 0;
-        if ($fileid != 0) {
-            return $smartobjectFileHandler->get($fileid);
-        } else {
-            return $smartobjectFileHandler->create();
-        }
-    }
-
-    /**
-     * @param $fileObj
-     * @return mixed
-     */
-    public function &storeFileObj($fileObj)
-    {
-        $smartobjectFileHandler = xoops_getModuleHandler('file', 'smartobject');
-
-        return $smartobjectFileHandler->insert($fileObj);
-    }
+	public $_image_path;
+	public $_image_url;
+
+	public $seoEnabled   = false;
+	public $titleField;
+	public $summaryField = false;
+
+	/**
+	 * Reference to the handler managing this object
+	 *
+	 * @var SmartPersistableObjectHandler reference to {@link SmartPersistableObjectHandler}
+	 */
+	public $handler;
+
+	/**
+	 * References to control objects, managing the form fields of this object
+	 */
+	public $controls = array();
+
+	/**
+	 * SmartObject constructor.
+	 * @param $handler
+	 */
+	public function __construct($handler)
+	{
+		$this->handler = $handler;
+	}
+
+	/**
+	 * Checks if the user has a specific access on this object
+	 *
+	 * @param $perm_name
+	 * @return bool: TRUE if user has access, false if not
+	 * @internal param string $gperm_name name of the permission to test
+	 */
+	public function accessGranted($perm_name)
+	{
+		$smartPermissionsHandler = new SmartobjectPermissionHandler($this->handler);
+
+		return $smartPermissionsHandler->accessGranted($perm_name, $this->id());
+	}
+
+	/**
+	 * @param      $section_name
+	 * @param bool $value
+	 * @param bool $hide
+	 */
+	public function addFormSection($section_name, $value = false, $hide = false)
+	{
+		$this->initVar($section_name, XOBJ_DTYPE_FORM_SECTION, $value, false, null, '', false, '', '', false, false, true);
+		$this->vars[$section_name]['hide'] = $hide;
+	}
+
+	/**
+	 * @param $section_name
+	 */
+	public function closeSection($section_name)
+	{
+		$this->initVar('close_section_' . $section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
+	}
+
+	/**
+	 *
+	 * @param string $key           key of this field. This needs to be the name of the field in the related database table
+	 * @param int    $data_type     set to one of XOBJ_DTYPE_XXX constants (set to XOBJ_DTYPE_OTHER if no data type ckecking nor text sanitizing is required)
+	 * @param mixed  $value         default value of this variable
+	 * @param bool   $required      set to TRUE if this variable needs to have a value set before storing the object in the table
+	 * @param int    $maxlength     maximum length of this variable, for XOBJ_DTYPE_TXTBOX type only
+	 * @param string $options       does this data have any select options?
+	 * @param bool   $multilingual  is this field needs to support multilingual features (NOT YET IMPLEMENTED...)
+	 * @param string $form_caption  caption of this variable in a {@link SmartobjectForm} and title of a column in a  {@link SmartObjectTable}
+	 * @param string $form_dsc      description of this variable in a {@link SmartobjectForm}
+	 * @param bool   $sortby        set to TRUE to make this field used to sort objects in SmartObjectTable
+	 * @param bool   $persistent    set to FALSE if this field is not to be saved in the database
+	 * @param bool   $displayOnForm
+	 */
+	public function initVar($key, $data_type, $value = null, $required = false, $maxlength = null, $options = '', $multilingual = false, $form_caption = '', $form_dsc = '', $sortby = false,
+							$persistent = true, $displayOnForm = true
+	) {
+		//url_ is reserved for files.
+		if (0 === strpos($key, 'url_')) {
+			trigger_error("Cannot use variable starting with 'url_'.");
+		}
+		parent::initVar($key, $data_type, $value, $required, $maxlength, $options);
+		if ($this->handler && (!$form_caption || $form_caption === '')) {
+			$dyn_form_caption = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key);
+			if (defined($dyn_form_caption)) {
+				$form_caption = constant($dyn_form_caption);
+			}
+		}
+		if ($this->handler && (!$form_dsc || $form_dsc === '')) {
+			$dyn_form_dsc = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key . '_DSC');
+			if (defined($dyn_form_dsc)) {
+				$form_dsc = constant($dyn_form_dsc);
+			}
+		}
+
+		$this->vars[$key] = array_merge($this->vars[$key], array(
+			'multilingual'        => $multilingual,
+			'form_caption'        => $form_caption,
+			'form_dsc'            => $form_dsc,
+			'sortby'              => $sortby,
+			'persistent'          => $persistent,
+			'displayOnForm'       => $displayOnForm,
+			'displayOnSingleView' => true,
+			'readonly'            => false
+		));
+	}
+
+	/**
+	 * @param        $key
+	 * @param        $data_type
+	 * @param bool   $itemName
+	 * @param string $form_caption
+	 * @param bool   $sortby
+	 * @param string $value
+	 * @param bool   $displayOnForm
+	 * @param bool   $required
+	 */
+	public function initNonPersistableVar($key, $data_type, $itemName = false, $form_caption = '', $sortby = false, $value = '', $displayOnForm = false, $required = false)
+	{
+		$this->initVar($key, $data_type, $value, $required, null, '', false, $form_caption, '', $sortby, false, $displayOnForm);
+		$this->vars[$key]['itemName'] = $itemName;
+	}
+
+	/**
+	 * Quickly initiate a var
+	 *
+	 * Since many vars do have the same config, let's use this method with some of these configuration as a convention ;-)
+	 *
+	 * - $maxlength = 0 unless $data_type is a TEXTBOX, then $maxlength will be 255
+	 * - all other vars are NULL or '' depending of the parameter
+	 *
+	 * @param string $key          key of this field. This needs to be the name of the field in the related database table
+	 * @param int    $data_type    set to one of XOBJ_DTYPE_XXX constants (set to XOBJ_DTYPE_OTHER if no data type ckecking nor text sanitizing is required)
+	 * @param bool   $required     set to TRUE if this variable needs to have a value set before storing the object in the table
+	 * @param string $form_caption caption of this variable in a {@link SmartobjectForm} and title of a column in a  {@link SmartObjectTable}
+	 * @param string $form_dsc     description of this variable in a {@link SmartobjectForm}
+	 * @param mixed  $value        default value of this variable
+	 */
+	public function quickInitVar($key, $data_type, $required = false, $form_caption = '', $form_dsc = '', $value = null)
+	{
+		$maxlength = $data_type === 'XOBJ_DTYPE_TXTBOX' ? 255 : null;
+		$this->initVar($key, $data_type, $value, $required, $maxlength, '', false, $form_caption, $form_dsc, false, true, true);
+	}
+
+	/**
+	 * @param        $varname
+	 * @param bool   $displayOnForm
+	 * @param string $default
+	 */
+	public function initCommonVar($varname, $displayOnForm = true, $default = 'notdefined')
+	{
+		switch ($varname) {
+			case 'dohtml':
+				$value = $default !== 'notdefined' ? $default : true;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOHTML_FORM_CAPTION, '', false, true, $displayOnForm);
+				$this->setControl($varname, 'yesno');
+				break;
+
+			case 'dobr':
+				$value = ($default === 'notdefined') ? true : $default;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOBR_FORM_CAPTION, '', false, true, $displayOnForm);
+				$this->setControl($varname, 'yesno');
+				break;
+
+			case 'doimage':
+				$value = $default !== 'notdefined' ? $default : true;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOIMAGE_FORM_CAPTION, '', false, true, $displayOnForm);
+				$this->setControl($varname, 'yesno');
+				break;
+
+			case 'dosmiley':
+				$value = $default !== 'notdefined' ? $default : true;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOSMILEY_FORM_CAPTION, '', false, true, $displayOnForm);
+				$this->setControl($varname, 'yesno');
+				break;
+
+			case 'doxcode':
+				$value = $default !== 'notdefined' ? $default : true;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_DOXCODE_FORM_CAPTION, '', false, true, $displayOnForm);
+				$this->setControl($varname, 'yesno');
+				break;
+
+			case 'meta_keywords':
+				$value = $default !== 'notdefined' ? $default : '';
+				$this->initVar($varname, XOBJ_DTYPE_TXTAREA, $value, false, null, '', false, _CO_SOBJECT_META_KEYWORDS, _CO_SOBJECT_META_KEYWORDS_DSC, false, true, $displayOnForm);
+				$this->setControl('meta_keywords', array(
+					'name'        => 'textarea',
+					'form_editor' => 'textarea'
+				));
+				break;
+
+			case 'meta_description':
+				$value = $default !== 'notdefined' ? $default : '';
+				$this->initVar($varname, XOBJ_DTYPE_TXTAREA, $value, false, null, '', false, _CO_SOBJECT_META_DESCRIPTION, _CO_SOBJECT_META_DESCRIPTION_DSC, false, true, $displayOnForm);
+				$this->setControl('meta_description', array(
+					'name'        => 'textarea',
+					'form_editor' => 'textarea'
+				));
+				break;
+
+			case 'short_url':
+				$value = $default !== 'notdefined' ? $default : '';
+				$this->initVar($varname, XOBJ_DTYPE_TXTBOX, $value, false, null, '', false, _CO_SOBJECT_SHORT_URL, _CO_SOBJECT_SHORT_URL_DSC, false, true, $displayOnForm);
+				break;
+
+			case 'hierarchy_path':
+				$value = $default !== 'notdefined' ? $default : '';
+				$this->initVar($varname, XOBJ_DTYPE_ARRAY, $value, false, null, '', false, _CO_SOBJECT_HIERARCHY_PATH, _CO_SOBJECT_HIERARCHY_PATH_DSC, false, true, $displayOnForm);
+				break;
+
+			case 'counter':
+				$value = $default !== 'notdefined' ? $default : 0;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_COUNTER_FORM_CAPTION, '', false, true, $displayOnForm);
+				break;
+
+			case 'weight':
+				$value = $default !== 'notdefined' ? $default : 0;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_WEIGHT_FORM_CAPTION, '', true, true, $displayOnForm);
+				break;
+			case 'custom_css':
+				$value = $default !== 'notdefined' ? $default : '';
+				$this->initVar($varname, XOBJ_DTYPE_TXTAREA, $value, false, null, '', false, _CO_SOBJECT_CUSTOM_CSS, _CO_SOBJECT_CUSTOM_CSS_DSC, false, true, $displayOnForm);
+				$this->setControl('custom_css', array(
+					'name'        => 'textarea',
+					'form_editor' => 'textarea'
+				));
+				break;
+		}
+		$this->hideFieldFromSingleView($varname);
+	}
+
+	/**
+	 * Set control information for an instance variable
+	 *
+	 * The $options parameter can be a string or an array. Using a string
+	 * is the quickest way:
+	 *
+	 * $this->setControl('date', 'date_time');
+	 *
+	 * This will create a date and time selectbox for the 'date' var on the
+	 * form to edit or create this item.
+	 *
+	 * Here are the currently supported controls:
+	 *
+	 *      - color
+	 *      - country
+	 *      - date_time
+	 *      - date
+	 *      - email
+	 *      - group
+	 *      - group_multi
+	 *      - image
+	 *      - imageupload
+	 *      - label
+	 *      - language
+	 *      - parentcategory
+	 *      - password
+	 *      - select_multi
+	 *      - select
+	 *      - text
+	 *      - textarea
+	 *      - theme
+	 *      - theme_multi
+	 *      - timezone
+	 *      - user
+	 *      - user_multi
+	 *      - yesno
+	 *
+	 * Now, using an array as $options, you can customize what information to
+	 * use in the control. For example, if one needs to display a select box for
+	 * the user to choose the status of an item. We only need to tell SmartObject
+	 * what method to execute within what handler to retreive the options of the
+	 * selectbox.
+	 *
+	 * $this->setControl('status', array('name' => false,
+	 *                                   'itemHandler' => 'item',
+	 *                                   'method' => 'getStatus',
+	 *                                   'module' => 'smartshop'));
+	 *
+	 * In this example, the array elements are the following:
+	 *      - name: false, as we don't need to set a special control here.
+	 *               we will use the default control related to the object type (defined in initVar)
+	 *      - itemHandler: name of the object for which we will use the handler
+	 *      - method: name of the method of this handler that we will execute
+	 *      - module: name of the module from wich the handler is
+	 *
+	 * So in this example, SmartObject will create a selectbox for the variable 'status' and it will
+	 * populate this selectbox with the result from SmartshopItemHandler::getStatus()
+	 *
+	 * Another example of the use of $options as an array is for TextArea:
+	 *
+	 * $this->setControl('body', array('name' => 'textarea',
+	 *                                   'form_editor' => 'default'));
+	 *
+	 * In this example, SmartObject will create a TextArea for the variable 'body'. And it will use
+	 * the 'default' editor, providing it is defined in the module
+	 * preferences: $xoopsModuleConfig['default_editor']
+	 *
+	 * Of course, you can force the use of a specific editor:
+	 *
+	 * $this->setControl('body', array('name' => 'textarea',
+	 *                                   'form_editor' => 'koivi'));
+	 *
+	 * Here is a list of supported editor:
+	 *      - tiny: TinyEditor
+	 *      - dhtmltextarea: XOOPS DHTML Area
+	 *      - fckeditor: FCKEditor
+	 *      - inbetween: InBetween
+	 *      - koivi: Koivi
+	 *      - spaw: Spaw WYSIWYG Editor
+	 *      - htmlarea: HTMLArea
+	 *      - textarea: basic textarea with no options
+	 *
+	 * @param string $var     name of the variable for which we want to set a control
+	 * @param array  $options
+	 */
+	public function setControl($var, $options = array())
+	{
+		if (isset($this->controls[$var])) {
+			unset($this->controls[$var]);
+		}
+		if (is_string($options)) {
+			$options = array('name' => $options);
+		}
+		$this->controls[$var] = $options;
+	}
+
+	/**
+	 * Get control information for an instance variable
+	 *
+	 * @param  string     $var
+	 * @return bool|mixed
+	 */
+	public function getControl($var)
+	{
+		return isset($this->controls[$var]) ? $this->controls[$var] : false;
+	}
+
+	/**
+	 * Create the form for this object
+	 *
+	 * @param         $form_caption
+	 * @param         $form_name
+	 * @param  bool   $form_action
+	 * @param  string $submit_button_caption
+	 * @param  bool   $cancel_js_action
+	 * @param  bool   $captcha
+	 * @return a      <a href='psi_element://SmartobjectForm'>SmartobjectForm</a> object for this object
+	 *                                      object for this object
+	 * @see SmartObjectForm::SmartObjectForm()
+	 */
+	public function getForm($form_caption, $form_name, $form_action = false, $submit_button_caption = _CO_SOBJECT_SUBMIT, $cancel_js_action = false, $captcha = false)
+	{
+		include_once SMARTOBJECT_ROOT_PATH . 'class/form/smartobjectform.php';
+		$form = new SmartobjectForm($this, $form_name, $form_caption, $form_action, null, $submit_button_caption, $cancel_js_action, $captcha);
+
+		return $form;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$ret  = array();
+		$vars =& $this->getVars();
+		foreach ($vars as $key => $var) {
+			$value     = $this->getVar($key);
+			$ret[$key] = $value;
+		}
+		if ($this->handler->identifierName !== '') {
+			$controller = new SmartObjectController($this->handler);
+			/**
+			 * Addition of some automatic value
+			 */
+			$ret['itemLink']         = $controller->getItemLink($this);
+			$ret['itemUrl']          = $controller->getItemLink($this, true);
+			$ret['editItemLink']     = $controller->getEditItemLink($this, false, true);
+			$ret['deleteItemLink']   = $controller->getDeleteItemLink($this, false, true);
+			$ret['printAndMailLink'] = $controller->getPrintAndMailLink($this);
+		}
+
+		// Hightlighting searched words
+		include_once(SMARTOBJECT_ROOT_PATH . 'class/smarthighlighter.php');
+		$highlight = smart_getConfig('module_search_highlighter', false, true);
+
+		if ($highlight && isset($_GET['keywords'])) {
+			$myts     = MyTextSanitizer::getInstance();
+			$keywords = $myts->htmlSpecialChars(trim(urldecode($_GET['keywords'])));
+			$h        = new SmartHighlighter($keywords, true, 'smart_highlighter');
+			foreach ($this->handler->highlightFields as $field) {
+				$ret[$field] = $h->highlight($ret[$field]);
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * add an error
+	 *
+	 * @param      $err_str
+	 * @param bool $prefix
+	 * @internal param string $value error to add
+	 * @access   public
+	 */
+	public function setErrors($err_str, $prefix = false)
+	{
+		if (is_array($err_str)) {
+			foreach ($err_str as $str) {
+				$this->setErrors($str, $prefix);
+			}
+		} else {
+			if ($prefix) {
+				$err_str = '[' . $prefix . '] ' . $err_str;
+			}
+			parent::setErrors($err_str);
+		}
+	}
+
+	/**
+	 * @param      $field
+	 * @param bool $required
+	 */
+	public function setFieldAsRequired($field, $required = true)
+	{
+		if (is_array($field)) {
+			foreach ($field as $v) {
+				$this->doSetFieldAsRequired($v, $required);
+			}
+		} else {
+			$this->doSetFieldAsRequired($field, $required);
+		}
+	}
+
+	/**
+	 * @param $field
+	 */
+	public function setFieldForSorting($field)
+	{
+		if (is_array($field)) {
+			foreach ($field as $v) {
+				$this->doSetFieldForSorting($v);
+			}
+		} else {
+			$this->doSetFieldForSorting($field);
+		}
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function hasError()
+	{
+		return count($this->_errors) > 0;
+	}
+
+	/**
+	 * @param $url
+	 * @param $path
+	 */
+	public function setImageDir($url, $path)
+	{
+		$this->_image_url  = $url;
+		$this->_image_path = $path;
+	}
+
+	/**
+	 * Retreive the group that have been granted access to a specific permission for this object
+	 *
+	 * @param $group_perm
+	 * @return string $group_perm name of the permission
+	 */
+	public function getGroupPerm($group_perm)
+	{
+		if (!$this->handler->getPermissions()) {
+			$this->setError("Trying to access a permission that does not exists for thisobject's handler");
+
+			return false;
+		}
+
+		$smartPermissionsHandler = new SmartobjectPermissionHandler($this->handler);
+		$ret                     = $smartPermissionsHandler->getGrantedGroups($group_perm, $this->id());
+
+		if (count($ret) == 0) {
+			return false;
+		} else {
+			return $ret;
+		}
+	}
+
+	/**
+	 * @param  bool  $path
+	 * @return mixed
+	 */
+	public function getImageDir($path = false)
+	{
+		if ($path) {
+			return $this->_image_path;
+		} else {
+			return $this->_image_url;
+		}
+	}
+
+	/**
+	 * @param  bool  $path
+	 * @return mixed
+	 */
+	public function getUploadDir($path = false)
+	{
+		if ($path) {
+			return $this->_image_path;
+		} else {
+			return $this->_image_url;
+		}
+	}
+
+	/**
+	 * @param  string $key
+	 * @param  string $info
+	 * @return array
+	 */
+	public function getVarInfo($key = '', $info = '')
+	{
+		if (isset($this->vars[$key][$info])) {
+			return $this->vars[$key][$info];
+		} elseif ($info === '' && isset($this->vars[$key])) {
+			return $this->vars[$key];
+		} else {
+			return $this->vars;
+		}
+	}
+
+	/**
+	 * Get the id of the object
+	 *
+	 * @return int id of this object
+	 */
+	public function id()
+	{
+		return $this->getVar($this->handler->keyName, 'e');
+	}
+
+	/**
+	 * Return the value of the title field of this object
+	 *
+	 * @param  string $format
+	 * @return string
+	 */
+	public function title($format = 's')
+	{
+		return $this->getVar($this->handler->identifierName, $format);
+	}
+
+	/**
+	 * Return the value of the title field of this object
+	 *
+	 * @return string
+	 */
+	public function summary()
+	{
+		if ($this->handler->summaryName) {
+			return $this->getVar($this->handler->summaryName);
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Retreive the object admin side link, displayijng a SingleView page
+	 *
+	 * @param  bool   $onlyUrl wether or not to return a simple URL or a full <a> link
+	 * @return string user side link to the object
+	 */
+	public function getAdminViewItemLink($onlyUrl = false)
+	{
+		$controller = new SmartObjectController($this->handler);
+
+		return $controller->getAdminViewItemLink($this, $onlyUrl);
+	}
+
+	/**
+	 * Retreive the object user side link
+	 *
+	 * @param  bool   $onlyUrl wether or not to return a simple URL or a full <a> link
+	 * @return string user side link to the object
+	 */
+	public function getItemLink($onlyUrl = false)
+	{
+		$controller = new SmartObjectController($this->handler);
+
+		return $controller->getItemLink($this, $onlyUrl);
+	}
+
+	/**
+	 * @param  bool   $onlyUrl
+	 * @param  bool   $withimage
+	 * @param  bool   $userSide
+	 * @return string
+	 */
+	public function getEditItemLink($onlyUrl = false, $withimage = true, $userSide = false)
+	{
+		$controller = new SmartObjectController($this->handler);
+
+		return $controller->getEditItemLink($this, $onlyUrl, $withimage, $userSide);
+	}
+
+	/**
+	 * @param  bool   $onlyUrl
+	 * @param  bool   $withimage
+	 * @param  bool   $userSide
+	 * @return string
+	 */
+	public function getDeleteItemLink($onlyUrl = false, $withimage = false, $userSide = false)
+	{
+		$controller = new SmartObjectController($this->handler);
+
+		return $controller->getDeleteItemLink($this, $onlyUrl, $withimage, $userSide);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getPrintAndMailLink()
+	{
+		$controller = new SmartObjectController($this->handler);
+
+		return $controller->getPrintAndMailLink($this);
+	}
+
+	/**
+	 * @param $sortsel
+	 * @return array|bool
+	 */
+	public function getFieldsForSorting($sortsel)
+	{
+		$ret = array();
+
+		foreach ($this->vars as $key => $field_info) {
+			if ($field_info['sortby']) {
+				$ret[$key]['caption']  = $field_info['form_caption'];
+				$ret[$key]['selected'] = $key == $sortsel ? "selected='selected'" : '';
+			}
+		}
+
+		if (count($ret) > 0) {
+			return $ret;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * @param $key
+	 * @param $newType
+	 */
+	public function setType($key, $newType)
+	{
+		$this->vars[$key]['data_type'] = $newType;
+	}
+
+	/**
+	 * @param $key
+	 * @param $info
+	 * @param $value
+	 */
+	public function setVarInfo($key, $info, $value)
+	{
+		$this->vars[$key][$info] = $value;
+	}
+
+	/**
+	 * @param         $key
+	 * @param  bool   $editor
+	 * @return string
+	 */
+	public function getValueFor($key, $editor = true)
+	{
+		global $xoopsModuleConfig;
+
+		$ret  = $this->getVar($key, 'n');
+		$myts = MyTextSanitizer::getInstance();
+
+		$control     = isset($this->controls[$key]) ? $this->controls[$key] : false;
+		$form_editor = isset($control['form_editor']) ? $control['form_editor'] : 'textarea';
+
+		$html     = isset($this->vars['dohtml']) ? $this->getVar('dohtml') : true;
+		$smiley   = true;
+		$xcode    = true;
+		$image    = true;
+		$br       = isset($this->vars['dobr']) ? $this->getVar('dobr') : true;
+		$formatML = true;
+
+		if ($form_editor === 'default') {
+			global $xoopsModuleConfig;
+			$form_editor = isset($xoopsModuleConfig['default_editor']) ? $xoopsModuleConfig['default_editor'] : 'textarea';
+		}
+
+		if ($editor) {
+			if (defined('XOOPS_EDITOR_IS_HTML') && !in_array($form_editor, array('formtextarea', 'textarea', 'dhtmltextarea'))) {
+				$br       = false;
+				$formatML = !$editor;
+			} else {
+				return htmlspecialchars($ret, ENT_QUOTES);
+			}
+		}
+
+		if (method_exists($myts, 'formatForML')) {
+			return $myts->displayTarea($ret, $html, $smiley, $xcode, $image, $br, $formatML);
+		} else {
+			return $myts->displayTarea($ret, $html, $smiley, $xcode, $image, $br);
+		}
+	}
+
+	/**
+	 * clean values of all variables of the object for storage.
+	 * also add slashes whereever needed
+	 *
+	 * We had to put this method in the SmartObject because the XOBJ_DTYPE_ARRAY does not work properly
+	 * at least on PHP 5.1. So we have created a new type XOBJ_DTYPE_SIMPLE_ARRAY to handle 1 level array
+	 * as a string separated by |
+	 *
+	 * @return bool true if successful
+	 * @access public
+	 */
+	public function cleanVars()
+	{
+		$ts              = MyTextSanitizer::getInstance();
+		$existing_errors = $this->getErrors();
+		$this->_errors   = array();
+		foreach ($this->vars as $k => $v) {
+			$cleanv = $v['value'];
+			if (!$v['changed']) {
+			} else {
+				$cleanv = is_string($cleanv) ? trim($cleanv) : $cleanv;
+				switch ($v['data_type']) {
+					case XOBJ_DTYPE_TXTBOX:
+						if ($v['required'] && $cleanv != '0' && $cleanv == '') {
+							$this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
+							continue 2;
+						}
+						if (isset($v['maxlength']) && strlen($cleanv) > (int)$v['maxlength']) {
+							$this->setErrors(sprintf(_XOBJ_ERR_SHORTERTHAN, $k, (int)$v['maxlength']));
+							continue 2;
+						}
+						if (!$v['not_gpc']) {
+							$cleanv = $ts->stripSlashesGPC($ts->censorString($cleanv));
+						} else {
+							$cleanv = $ts->censorString($cleanv);
+						}
+						break;
+					case XOBJ_DTYPE_TXTAREA:
+						if ($v['required'] && $cleanv != '0' && $cleanv == '') {
+							$this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
+							continue 2;
+						}
+						if (!$v['not_gpc']) {
+							$cleanv = $ts->stripSlashesGPC($ts->censorString($cleanv));
+						} else {
+							$cleanv = $ts->censorString($cleanv);
+						}
+						break;
+					case XOBJ_DTYPE_SOURCE:
+						if (!$v['not_gpc']) {
+							$cleanv = $ts->stripSlashesGPC($cleanv);
+						} else {
+							$cleanv = $cleanv;
+						}
+						break;
+					case XOBJ_DTYPE_INT:
+					case XOBJ_DTYPE_TIME_ONLY:
+						$cleanv = (int)$cleanv;
+						break;
+
+					case XOBJ_DTYPE_CURRENCY:
+						$cleanv = smart_currency($cleanv);
+						break;
+
+					case XOBJ_DTYPE_FLOAT:
+						$cleanv = smart_float($cleanv);
+						break;
+
+					case XOBJ_DTYPE_EMAIL:
+						if ($v['required'] && $cleanv === '') {
+							$this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
+							continue 2;
+						}
+						if ($cleanv !== '' && !preg_match("/^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+([\.][a-z0-9-]+)+$/i", $cleanv)) {
+							$this->setErrors('Invalid Email');
+							continue 2;
+						}
+						if (!$v['not_gpc']) {
+							$cleanv = $ts->stripSlashesGPC($cleanv);
+						}
+						break;
+					case XOBJ_DTYPE_URL:
+						if ($v['required'] && $cleanv === '') {
+							$this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
+							continue 2;
+						}
+						if ($cleanv !== '' && !preg_match("/^http[s]*:\/\//i", $cleanv)) {
+							$cleanv = 'http://' . $cleanv;
+						}
+						if (!$v['not_gpc']) {
+							$cleanv =& $ts->stripSlashesGPC($cleanv);
+						}
+						break;
+					case XOBJ_DTYPE_SIMPLE_ARRAY:
+						$cleanv = implode('|', $cleanv);
+						break;
+					case XOBJ_DTYPE_ARRAY:
+						$cleanv = serialize($cleanv);
+						break;
+					case XOBJ_DTYPE_STIME:
+					case XOBJ_DTYPE_MTIME:
+					case XOBJ_DTYPE_LTIME:
+						$cleanv = !is_string($cleanv) ? (int)$cleanv : strtotime($cleanv);
+						if (!($cleanv > 0)) {
+							$cleanv = strtotime($cleanv);
+						}
+						break;
+					default:
+						break;
+				}
+			}
+			$this->cleanVars[$k] =& $cleanv;
+			unset($cleanv);
+		}
+		if (count($this->_errors) > 0) {
+			$this->_errors = array_merge($existing_errors, $this->_errors);
+
+			return false;
+		}
+		$this->_errors = array_merge($existing_errors, $this->_errors);
+		$this->unsetDirty();
+
+		return true;
+	}
+
+	/**
+	 * returns a specific variable for the object in a proper format
+	 *
+	 * We had to put this method in the SmartObject because the XOBJ_DTYPE_ARRAY does not work properly
+	 * at least on PHP 5.1. So we have created a new type XOBJ_DTYPE_SIMPLE_ARRAY to handle 1 level array
+	 * as a string separated by |
+	 *
+	 * @access public
+	 * @param  string $key    key of the object's variable to be returned
+	 * @param  string $format format to use for the output
+	 * @return mixed  formatted value of the variable
+	 */
+	public function getVar($key, $format = 's')
+	{
+		global $myts;
+
+		$ret = $this->vars[$key]['value'];
+
+		switch ($this->vars[$key]['data_type']) {
+
+			case XOBJ_DTYPE_TXTBOX:
+				switch (strtolower($format)) {
+					case 's':
+					case 'show':
+						// ML Hack by marcan
+						$ts  = MyTextSanitizer::getInstance();
+						$ret = $ts->htmlSpecialChars($ret);
+
+						if (method_exists($myts, 'formatForML')) {
+							return $ts->formatForML($ret);
+						} else {
+							return $ret;
+						}
+						break 1;
+					// End of ML Hack by marcan
+
+					case 'clean':
+						$ts = MyTextSanitizer::getInstance();
+
+						$ret = smart_html2text($ret);
+						$ret = smart_purifyText($ret);
+
+						if (method_exists($myts, 'formatForML')) {
+							return $ts->formatForML($ret);
+						} else {
+							return $ret;
+						}
+						break 1;
+					// End of ML Hack by marcan
+
+					case 'e':
+					case 'edit':
+						$ts = MyTextSanitizer::getInstance();
+
+						return $ts->htmlSpecialChars($ret);
+						break 1;
+					case 'p':
+					case 'preview':
+					case 'f':
+					case 'formpreview':
+						$ts = MyTextSanitizer::getInstance();
+
+						return $ts->htmlSpecialChars($ts->stripSlashesGPC($ret));
+						break 1;
+					case 'n':
+					case 'none':
+					default:
+						break 1;
+				}
+				break;
+			case XOBJ_DTYPE_LTIME:
+				switch (strtolower($format)) {
+					case 's':
+					case 'show':
+					case 'p':
+					case 'preview':
+					case 'f':
+					case 'formpreview':
+						$ret = formatTimestamp($ret, _DATESTRING);
+
+						return $ret;
+						break 1;
+					case 'n':
+					case 'none':
+					case 'e':
+					case 'edit':
+						break 1;
+					default:
+						break 1;
+				}
+				break;
+			case XOBJ_DTYPE_STIME:
+				switch (strtolower($format)) {
+					case 's':
+					case 'show':
+					case 'p':
+					case 'preview':
+					case 'f':
+					case 'formpreview':
+						$ret = formatTimestamp($ret, _SHORTDATESTRING);
+
+						return $ret;
+						break 1;
+					case 'n':
+					case 'none':
+					case 'e':
+					case 'edit':
+						break 1;
+					default:
+						break 1;
+				}
+				break;
+			case XOBJ_DTYPE_TIME_ONLY:
+				switch (strtolower($format)) {
+					case 's':
+					case 'show':
+					case 'p':
+					case 'preview':
+					case 'f':
+					case 'formpreview':
+						$ret = formatTimestamp($ret, 'G:i');
+
+						return $ret;
+						break 1;
+					case 'n':
+					case 'none':
+					case 'e':
+					case 'edit':
+						break 1;
+					default:
+						break 1;
+				}
+				break;
+
+			case XOBJ_DTYPE_CURRENCY:
+				$decimal_section_original = strstr($ret, '.');
+				$decimal_section          = $decimal_section_original;
+				if ($decimal_section) {
+					if (strlen($decimal_section) == 1) {
+						$decimal_section = '.00';
+					} elseif (strlen($decimal_section) == 2) {
+						$decimal_section .= '0';
+					}
+					$ret = str_replace($decimal_section_original, $decimal_section, $ret);
+				} else {
+					$ret .= '.00';
+				}
+				break;
+
+			case XOBJ_DTYPE_TXTAREA:
+				switch (strtolower($format)) {
+					case 's':
+					case 'show':
+						$ts   = MyTextSanitizer::getInstance();
+						$html = !empty($this->vars['dohtml']['value']) ? 1 : 0;
+
+						$xcode = (!isset($this->vars['doxcode']['value']) || $this->vars['doxcode']['value'] == 1) ? 1 : 0;
+
+						$smiley = (!isset($this->vars['dosmiley']['value']) || $this->vars['dosmiley']['value'] == 1) ? 1 : 0;
+						$image  = (!isset($this->vars['doimage']['value']) || $this->vars['doimage']['value'] == 1) ? 1 : 0;
+						$br     = (!isset($this->vars['dobr']['value']) || $this->vars['dobr']['value'] == 1) ? 1 : 0;
+
+						/**
+						 * Hack by marcan <INBOX> for SCSPRO
+						 * Setting mastop as the main editor
+						 */
+						if (defined('XOOPS_EDITOR_IS_HTML')) {
+							$br = false;
+						}
+						/**
+						 * Hack by marcan <INBOX> for SCSPRO
+						 * Setting mastop as the main editor
+						 */
+
+						return $ts->displayTarea($ret, $html, $smiley, $xcode, $image, $br);
+						break 1;
+					case 'e':
+					case 'edit':
+						return htmlspecialchars($ret, ENT_QUOTES);
+						break 1;
+					case 'p':
+					case 'preview':
+						$ts     = MyTextSanitizer::getInstance();
+						$html   = !empty($this->vars['dohtml']['value']) ? 1 : 0;
+						$xcode  = (!isset($this->vars['doxcode']['value']) || $this->vars['doxcode']['value'] == 1) ? 1 : 0;
+						$smiley = (!isset($this->vars['dosmiley']['value']) || $this->vars['dosmiley']['value'] == 1) ? 1 : 0;
+						$image  = (!isset($this->vars['doimage']['value']) || $this->vars['doimage']['value'] == 1) ? 1 : 0;
+						$br     = (!isset($this->vars['dobr']['value']) || $this->vars['dobr']['value'] == 1) ? 1 : 0;
+
+						return $ts->previewTarea($ret, $html, $smiley, $xcode, $image, $br);
+						break 1;
+					case 'f':
+					case 'formpreview':
+						$ts = MyTextSanitizer::getInstance();
+
+						return htmlspecialchars($ts->stripSlashesGPC($ret), ENT_QUOTES);
+						break 1;
+					case 'n':
+					case 'none':
+					default:
+						break 1;
+				}
+				break;
+			case XOBJ_DTYPE_SIMPLE_ARRAY:
+				$ret =& explode('|', $ret);
+				break;
+			case XOBJ_DTYPE_ARRAY:
+				$ret =& unserialize($ret);
+				break;
+			case XOBJ_DTYPE_SOURCE:
+				switch (strtolower($format)) {
+					case 's':
+					case 'show':
+						break 1;
+					case 'e':
+					case 'edit':
+						return htmlspecialchars($ret, ENT_QUOTES);
+						break 1;
+					case 'p':
+					case 'preview':
+						$ts = MyTextSanitizer::getInstance();
+
+						return $ts->stripSlashesGPC($ret);
+						break 1;
+					case 'f':
+					case 'formpreview':
+						$ts = MyTextSanitizer::getInstance();
+
+						return htmlspecialchars($ts->stripSlashesGPC($ret), ENT_QUOTES);
+						break 1;
+					case 'n':
+					case 'none':
+					default:
+						break 1;
+				}
+				break;
+			default:
+				if ($this->vars[$key]['options'] !== '' && $ret != '') {
+					switch (strtolower($format)) {
+						case 's':
+						case 'show':
+							$selected = explode('|', $ret);
+							$options  = explode('|', $this->vars[$key]['options']);
+							$i        = 1;
+							$ret      = array();
+							foreach ($options as $op) {
+								if (in_array($i, $selected)) {
+									$ret[] = $op;
+								}
+								++$i;
+							}
+
+							return implode(', ', $ret);
+						case 'e':
+						case 'edit':
+							$ret = explode('|', $ret);
+							break 1;
+						default:
+							break 1;
+					}
+				}
+				break;
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function doMakeFieldreadOnly($key)
+	{
+		if (isset($this->vars[$key])) {
+			$this->vars[$key]['readonly']      = true;
+			$this->vars[$key]['displayOnForm'] = true;
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function makeFieldReadOnly($key)
+	{
+		if (is_array($key)) {
+			foreach ($key as $v) {
+				$this->doMakeFieldreadOnly($v);
+			}
+		} else {
+			$this->doMakeFieldreadOnly($key);
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function doHideFieldFromForm($key)
+	{
+		if (isset($this->vars[$key])) {
+			$this->vars[$key]['displayOnForm'] = false;
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function doHideFieldFromSingleView($key)
+	{
+		if (isset($this->vars[$key])) {
+			$this->vars[$key]['displayOnSingleView'] = false;
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function hideFieldFromForm($key)
+	{
+		if (is_array($key)) {
+			foreach ($key as $v) {
+				$this->doHideFieldFromForm($v);
+			}
+		} else {
+			$this->doHideFieldFromForm($key);
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function hideFieldFromSingleView($key)
+	{
+		if (is_array($key)) {
+			foreach ($key as $v) {
+				$this->doHideFieldFromSingleView($v);
+			}
+		} else {
+			$this->doHideFieldFromSingleView($key);
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function doShowFieldOnForm($key)
+	{
+		if (isset($this->vars[$key])) {
+			$this->vars[$key]['displayOnForm'] = true;
+		}
+	}
+
+	/**
+	 * Display an automatic SingleView of the object, based on the displayOnSingleView param of each vars
+	 *
+	 * @param  bool    $fetchOnly   if set to TRUE, then the content will be return, if set to FALSE, the content will be outputed
+	 * @param  bool    $userSide    for futur use, to do something different on the user side
+	 * @param  array   $actions
+	 * @param  bool    $headerAsRow
+	 * @return content of the template if $fetchOnly or nothing if !$fetchOnly
+	 */
+	public function displaySingleObject($fetchOnly = false, $userSide = false, $actions = array(), $headerAsRow = true)
+	{
+		include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectsingleview.php';
+		$singleview = new SmartObjectSingleView($this, $userSide, $actions, $headerAsRow);
+		// add all fields mark as displayOnSingleView except the keyid
+		foreach ($this->vars as $key => $var) {
+			if ($key != $this->handler->keyName && $var['displayOnSingleView']) {
+				$is_header = ($key == $this->handler->identifierName);
+				$singleview->addRow(new SmartObjectRow($key, false, $is_header));
+			}
+		}
+
+		if ($fetchOnly) {
+			$ret = $singleview->render($fetchOnly);
+
+			return $ret;
+		} else {
+			$singleview->render($fetchOnly);
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function doDisplayFieldOnSingleView($key)
+	{
+		if (isset($this->vars[$key])) {
+			$this->vars[$key]['displayOnSingleView'] = true;
+		}
+	}
+
+	/**
+	 * @param      $field
+	 * @param bool $required
+	 */
+	public function doSetFieldAsRequired($field, $required = true)
+	{
+		$this->setVarInfo($field, 'required', $required);
+	}
+
+	/**
+	 * @param $field
+	 */
+	public function doSetFieldForSorting($field)
+	{
+		$this->setVarInfo($field, 'sortby', true);
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function showFieldOnForm($key)
+	{
+		if (is_array($key)) {
+			foreach ($key as $v) {
+				$this->doShowFieldOnForm($v);
+			}
+		} else {
+			$this->doShowFieldOnForm($key);
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function displayFieldOnSingleView($key)
+	{
+		if (is_array($key)) {
+			foreach ($key as $v) {
+				$this->doDisplayFieldOnSingleView($v);
+			}
+		} else {
+			$this->doDisplayFieldOnSingleView($key);
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function doSetAdvancedFormFields($key)
+	{
+		if (isset($this->vars[$key])) {
+			$this->vars[$key]['advancedform'] = true;
+		}
+	}
+
+	/**
+	 * @param $key
+	 */
+	public function setAdvancedFormFields($key)
+	{
+		if (is_array($key)) {
+			foreach ($key as $v) {
+				$this->doSetAdvancedFormFields($v);
+			}
+		} else {
+			$this->doSetAdvancedFormFields($key);
+		}
+	}
+
+	/**
+	 * @param $key
+	 * @return mixed
+	 */
+	public function getUrlLinkObj($key)
+	{
+		$smartobjectLinkurlHandler = xoops_getModuleHandler('urllink', 'smartobject');
+		$urllinkid                 = $this->getVar($key) !== null ? $this->getVar($key) : 0;
+		if ($urllinkid != 0) {
+			return $smartobjectLinkurlHandler->get($urllinkid);
+		} else {
+			return $smartobjectLinkurlHandler->create();
+		}
+	}
+
+	/**
+	 * @param $urlLinkObj
+	 * @return mixed
+	 */
+	public function &storeUrlLinkObj($urlLinkObj)
+	{
+		$smartobjectLinkurlHandler = xoops_getModuleHandler('urllink', 'smartobject');
+
+		return $smartobjectLinkurlHandler->insert($urlLinkObj);
+	}
+
+	/**
+	 * @param $key
+	 * @return mixed
+	 */
+	public function getFileObj($key)
+	{
+		$smartobjectFileHandler = xoops_getModuleHandler('file', 'smartobject');
+		$fileid                 = $this->getVar($key) !== null ? $this->getVar($key) : 0;
+		if ($fileid != 0) {
+			return $smartobjectFileHandler->get($fileid);
+		} else {
+			return $smartobjectFileHandler->create();
+		}
+	}
+
+	/**
+	 * @param $fileObj
+	 * @return mixed
+	 */
+	public function &storeFileObj($fileObj)
+	{
+		$smartobjectFileHandler = xoops_getModuleHandler('file', 'smartobject');
+
+		return $smartobjectFileHandler->insert($fileObj);
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -12,9 +12,9 @@ 
 
 // defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/include/common.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/include/common.php';
 
-include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
+include_once SMARTOBJECT_ROOT_PATH.'class/smartobjectcontroller.php';
 
 if (!defined('XOBJ_DTYPE_SIMPLE_ARRAY')) {
     define('XOBJ_DTYPE_SIMPLE_ARRAY', 101);
@@ -113,7 +113,7 @@ 
      */
     public function closeSection($section_name)
     {
-        $this->initVar('close_section_' . $section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
+        $this->initVar('close_section_'.$section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
     }
 
     /**
@@ -140,13 +140,13 @@ 
         }
         parent::initVar($key, $data_type, $value, $required, $maxlength, $options);
         if ($this->handler && (!$form_caption || $form_caption === '')) {
-            $dyn_form_caption = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key);
+            $dyn_form_caption = strtoupper('_CO_'.$this->handler->_moduleName.'_'.$this->handler->_itemname.'_'.$key);
             if (defined($dyn_form_caption)) {
                 $form_caption = constant($dyn_form_caption);
             }
         }
         if ($this->handler && (!$form_dsc || $form_dsc === '')) {
-            $dyn_form_dsc = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key . '_DSC');
+            $dyn_form_dsc = strtoupper('_CO_'.$this->handler->_moduleName.'_'.$this->handler->_itemname.'_'.$key.'_DSC');
             if (defined($dyn_form_dsc)) {
                 $form_dsc = constant($dyn_form_dsc);
             }
@@ -410,7 +410,7 @@ 
      */
     public function getForm($form_caption, $form_name, $form_action = false, $submit_button_caption = _CO_SOBJECT_SUBMIT, $cancel_js_action = false, $captcha = false)
     {
-        include_once SMARTOBJECT_ROOT_PATH . 'class/form/smartobjectform.php';
+        include_once SMARTOBJECT_ROOT_PATH.'class/form/smartobjectform.php';
         $form = new SmartobjectForm($this, $form_name, $form_caption, $form_action, null, $submit_button_caption, $cancel_js_action, $captcha);
 
         return $form;
@@ -422,7 +422,7 @@ 
     public function toArray()
     {
         $ret  = array();
-        $vars =& $this->getVars();
+        $vars = & $this->getVars();
         foreach ($vars as $key => $var) {
             $value     = $this->getVar($key);
             $ret[$key] = $value;
@@ -440,7 +440,7 @@ 
         }
 
         // Hightlighting searched words
-        include_once(SMARTOBJECT_ROOT_PATH . 'class/smarthighlighter.php');
+        include_once(SMARTOBJECT_ROOT_PATH.'class/smarthighlighter.php');
         $highlight = smart_getConfig('module_search_highlighter', false, true);
 
         if ($highlight && isset($_GET['keywords'])) {
@@ -471,7 +471,7 @@ 
             }
         } else {
             if ($prefix) {
-                $err_str = '[' . $prefix . '] ' . $err_str;
+                $err_str = '['.$prefix.'] '.$err_str;
             }
             parent::setErrors($err_str);
         }
@@ -798,8 +798,8 @@ 
                             $this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
                             continue 2;
                         }
-                        if (isset($v['maxlength']) && strlen($cleanv) > (int)$v['maxlength']) {
-                            $this->setErrors(sprintf(_XOBJ_ERR_SHORTERTHAN, $k, (int)$v['maxlength']));
+                        if (isset($v['maxlength']) && strlen($cleanv) > (int) $v['maxlength']) {
+                            $this->setErrors(sprintf(_XOBJ_ERR_SHORTERTHAN, $k, (int) $v['maxlength']));
                             continue 2;
                         }
                         if (!$v['not_gpc']) {
@@ -828,7 +828,7 @@ 
                         break;
                     case XOBJ_DTYPE_INT:
                     case XOBJ_DTYPE_TIME_ONLY:
-                        $cleanv = (int)$cleanv;
+                        $cleanv = (int) $cleanv;
                         break;
 
                     case XOBJ_DTYPE_CURRENCY:
@@ -858,10 +858,10 @@ 
                             continue 2;
                         }
                         if ($cleanv !== '' && !preg_match("/^http[s]*:\/\//i", $cleanv)) {
-                            $cleanv = 'http://' . $cleanv;
+                            $cleanv = 'http://'.$cleanv;
                         }
                         if (!$v['not_gpc']) {
-                            $cleanv =& $ts->stripSlashesGPC($cleanv);
+                            $cleanv = & $ts->stripSlashesGPC($cleanv);
                         }
                         break;
                     case XOBJ_DTYPE_SIMPLE_ARRAY:
@@ -873,7 +873,7 @@ 
                     case XOBJ_DTYPE_STIME:
                     case XOBJ_DTYPE_MTIME:
                     case XOBJ_DTYPE_LTIME:
-                        $cleanv = !is_string($cleanv) ? (int)$cleanv : strtotime($cleanv);
+                        $cleanv = !is_string($cleanv) ? (int) $cleanv : strtotime($cleanv);
                         if (!($cleanv > 0)) {
                             $cleanv = strtotime($cleanv);
                         }
@@ -882,7 +882,7 @@ 
                         break;
                 }
             }
-            $this->cleanVars[$k] =& $cleanv;
+            $this->cleanVars[$k] = & $cleanv;
             unset($cleanv);
         }
         if (count($this->_errors) > 0) {
@@ -1100,10 +1100,10 @@ 
                 }
                 break;
             case XOBJ_DTYPE_SIMPLE_ARRAY:
-                $ret =& explode('|', $ret);
+                $ret = & explode('|', $ret);
                 break;
             case XOBJ_DTYPE_ARRAY:
-                $ret =& unserialize($ret);
+                $ret = & unserialize($ret);
                 break;
             case XOBJ_DTYPE_SOURCE:
                 switch (strtolower($format)) {
@@ -1257,7 +1257,7 @@ 
      */
     public function displaySingleObject($fetchOnly = false, $userSide = false, $actions = array(), $headerAsRow = true)
     {
-        include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectsingleview.php';
+        include_once SMARTOBJECT_ROOT_PATH.'class/smartobjectsingleview.php';
         $singleview = new SmartObjectSingleView($this, $userSide, $actions, $headerAsRow);
         // add all fields mark as displayOnSingleView except the keyid
         foreach ($this->vars as $key => $var) {

class/smartobjectcontroller.php

Doc Comments +6 added lines, -6 removed lines

@@ -123,9 +123,9 @@ 
 
     /**
      * @param        $smartObj
-     * @param        $objectid
-     * @param        $created_success_msg
-     * @param        $modified_success_msg
+     * @param        integer $objectid
+     * @param        string $created_success_msg
+     * @param        string $modified_success_msg
      * @param  bool  $redirect_page
      * @param  bool  $debug
      * @return mixed
@@ -289,7 +289,7 @@ 
      * @param  bool   $confirm_msg
      * @param  string $op
      * @param  bool   $userSide
-     * @return bool
+     * @return boolean|null
      * @internal param string $redir_page redirect page after deleting the object
      */
     public function handleObjectDeletion($confirm_msg = false, $op = 'del', $userSide = false)
@@ -443,7 +443,7 @@ 
     }
 
     /**
-     * @param         $smartObj
+     * @param         SmartMlObject $smartObj
      * @param  bool   $onlyUrl
      * @param  bool   $withimage
      * @return string
@@ -533,7 +533,7 @@ 
     }
 
     /**
-     * @param $smartObj
+     * @param SmartObject $smartObj
      * @return string
      */
     public function getPrintAndMailLink($smartObj)

Indentation +544 added lines, -544 removed lines

@@ -31,548 +31,548 @@
  */
 class SmartObjectController
 {
-    public $handler;
-
-    /**
-     * SmartObjectController constructor.
-     * @param $handler
-     */
-    public function __construct($handler)
-    {
-        $this->handler = $handler;
-    }
-
-    /**
-     * @param $smartObj
-     */
-    public function postDataToObject(&$smartObj)
-    {
-        foreach (array_keys($smartObj->vars) as $key) {
-            switch ($smartObj->vars[$key]['data_type']) {
-                case XOBJ_DTYPE_IMAGE:
-                    if (isset($_POST['url_' . $key]) && $_POST['url_' . $key] !== '') {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
-                        $smartObj->setVar($key, $_POST['url_' . $key]);
-                        if (file_exists($oldFile)) {
-                            unlink($oldFile);
-                        }
-                    }
-                    if (isset($_POST['delete_' . $key]) && $_POST['delete_' . $key] == '1') {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
-                        $smartObj->setVar($key, '');
-                        if (file_exists($oldFile)) {
-                            unlink($oldFile);
-                        }
-                    }
-                    break;
-
-                case XOBJ_DTYPE_URLLINK:
-                    $linkObj = $smartObj->getUrlLinkObj($key);
-                    $linkObj->setVar('caption', $_POST['caption_' . $key]);
-                    $linkObj->setVar('description', $_POST['desc_' . $key]);
-                    $linkObj->setVar('target', $_POST['target_' . $key]);
-                    $linkObj->setVar('url', $_POST['url_' . $key]);
-                    if ($linkObj->getVar('url') !== '') {
-                        $smartObj->storeUrlLinkObj($linkObj);
-                    }
-                    //todo: catch errors
-                    $smartObj->setVar($key, $linkObj->getVar('urllinkid'));
-                    break;
-
-                case XOBJ_DTYPE_FILE:
-                    if (!isset($_FILES['upload_' . $key]['name']) || $_FILES['upload_' . $key]['name'] === '') {
-                        $fileObj = $smartObj->getFileObj($key);
-                        $fileObj->setVar('caption', $_POST['caption_' . $key]);
-                        $fileObj->setVar('description', $_POST['desc_' . $key]);
-                        $fileObj->setVar('url', $_POST['url_' . $key]);
-                        if (!($fileObj->getVar('url') === '' && $fileObj->getVar('url') === '' && $fileObj->getVar('url') === '')) {
-                            $res = $smartObj->storeFileObj($fileObj);
-                            if ($res) {
-                                $smartObj->setVar($key, $fileObj->getVar('fileid'));
-                            } else {
-                                //error setted, but no error message (to be improved)
-                                $smartObj->setErrors($fileObj->getErrors());
-                            }
-                        }
-                    }
-                    break;
-
-                case XOBJ_DTYPE_STIME:
-                case XOBJ_DTYPE_MTIME:
-                case XOBJ_DTYPE_LTIME:
-                    // check if this field's value is available in the POST array
-                    if (is_array($_POST[$key]) && isset($_POST[$key]['date'])) {
-                        $value = strtotime($_POST[$key]['date']) + $_POST[$key]['time'];
-                    } else {
-                        $value = strtotime($_POST[$key]);
-                        //if strtotime returns false, the value is already a time stamp
-                        if (!$value) {
-                            $value = (int)$_POST[$key];
-                        }
-                    }
-                    $smartObj->setVar($key, $value);
-
-                    break;
-
-                default:
-                    $smartObj->setVar($key, $_POST[$key]);
-                    break;
-            }
-        }
-    }
-
-    /**
-     * @param        $smartObj
-     * @param        $objectid
-     * @param        $created_success_msg
-     * @param        $modified_success_msg
-     * @param  bool  $redirect_page
-     * @param  bool  $debug
-     * @return mixed
-     */
-    public function doStoreFromDefaultForm(&$smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page = false, $debug = false)
-    {
-        global $smart_previous_page;
-
-        $this->postDataToObject($smartObj);
-
-        if ($smartObj->isNew()) {
-            $redirect_msg = $created_success_msg;
-        } else {
-            $redirect_msg = $modified_success_msg;
-        }
-
-        // Check if there were uploaded files
-        if (isset($_POST['smart_upload_image']) || isset($_POST['smart_upload_file'])) {
-            include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartuploader.php';
-            $uploaderObj = new SmartUploader($smartObj->getImageDir(true), $this->handler->_allowedMimeTypes, $this->handler->_maxFileSize, $this->handler->_maxWidth, $this->handler->_maxHeight);
-            foreach ($_FILES as $name => $file_array) {
-                if (isset($file_array['name']) && $file_array['name'] !== '' && in_array(str_replace('upload_', '', $name), array_keys($smartObj->vars))) {
-                    if ($uploaderObj->fetchMedia($name)) {
-                        $uploaderObj->setTargetFileName(time() . '_' . $uploaderObj->getMediaName());
-                        if ($uploaderObj->upload()) {
-                            // Find the related field in the SmartObject
-                            $related_field   = str_replace('upload_', '', $name);
-                            $uploadedArray[] = $related_field;
-                            //si c'est un fichier Rich
-                            if ($smartObj->vars[$related_field]['data_type'] === XOBJ_DTYPE_FILE) {
-                                $object_fileurl = $smartObj->getUploadDir();
-                                $fileObj        = $smartObj->getFileObj($related_field);
-                                $fileObj->setVar('url', $object_fileurl . $uploaderObj->getSavedFileName());
-                                $fileObj->setVar('caption', $_POST['caption_' . $related_field]);
-                                $fileObj->setVar('description', $_POST['desc_' . $related_field]);
-                                $smartObj->storeFileObj($fileObj);
-                                //todo: catch errors
-                                $smartObj->setVar($related_field, $fileObj->getVar('fileid'));
-                            } else {
-                                $old_file = $smartObj->getUploadDir(true) . $smartObj->getVar($related_field);
-                                unlink($old_file);
-                                $smartObj->setVar($related_field, $uploaderObj->getSavedFileName());
-                            }
-                        } else {
-                            $smartObj->setErrors($uploaderObj->getErrors(false));
-                        }
-                    } else {
-                        $smartObj->setErrors($uploaderObj->getErrors(false));
-                    }
-                }
-            }
-        }
-
-        if ($debug) {
-            $storeResult = $this->handler->insertD($smartObj);
-        } else {
-            $storeResult = $this->handler->insert($smartObj);
-        }
-
-        if ($storeResult) {
-            if ($this->handler->getPermissions()) {
-                $smartPermissionsHandler = new SmartobjectPermissionHandler($this->handler);
-                $smartPermissionsHandler->storeAllPermissionsForId($smartObj->id());
-            }
-        }
-
-        if ($redirect_page === null) {
-            return $smartObj;
-        } else {
-            if (!$storeResult) {
-                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
-            }
-
-            $redirect_page = $redirect_page ?: smart_get_page_before_form();
-
-            redirect_header($redirect_page, 2, $redirect_msg);
-        }
-    }
-
-    /**
-     * Store the object in the database autmatically from a form sending POST data
-     *
-     * @param  string      $created_success_msg  message to display if new object was created
-     * @param  string      $modified_success_msg message to display if object was successfully edited
-     * @param  bool|string $redirect_page        redirect page, if not set, then we backup once
-     * @param  bool        $debug
-     * @param  bool        $x_param
-     * @return bool
-     * @internal param string $created_redir_page redirect page after creating the object
-     * @internal param string $modified_redir_page redirect page after editing the object
-     * @internal param bool $exit if set to TRUE then the script ends
-     */
-    public function storeFromDefaultForm($created_success_msg, $modified_success_msg, $redirect_page = false, $debug = false, $x_param = false)
-    {
-        $objectid = isset($_POST[$this->handler->keyName]) ? (int)$_POST[$this->handler->keyName] : 0;
-        if ($debug) {
-            if ($x_param) {
-                $smartObj = $this->handler->getD($objectid, true, $x_param);
-            } else {
-                $smartObj = $this->handler->getD($objectid);
-            }
-        } else {
-            if ($x_param) {
-                $smartObj = $this->handler->get($objectid, true, false, false, $x_param);
-            } else {
-                $smartObj = $this->handler->get($objectid);
-            }
-        }
-
-        // if handler is the Multilanguage handler, we will need to treat this for multilanguage
-        if (is_subclass_of($this->handler, 'smartpersistablemlobjecthandler')) {
-            if ($smartObj->isNew()) {
-                // This is a new object. We need to store the meta data and then the language data
-                // First, we will get rid of the multilanguage data to only store the meta data
-                $smartObj->stripMultilanguageFields();
-                $newObject = $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);
-                /**
-                 * @todo we need to trap potential errors here
-                 */
-
-                // ok, the meta daa is stored. Let's recreate the object and then
-                // get rid of anything not multilanguage
-                unset($smartObj);
-                $smartObj = $this->handler->get($objectid);
-                $smartObj->stripNonMultilanguageFields();
-
-                $smartObj->setVar($this->handler->keyName, $newObject->getVar($this->handler->keyName));
-                $this->handler->changeTableNameForML();
-                $ret = $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);
-
-                return $ret;
-            }
-        } else {
-            return $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);
-        }
-    }
-
-    /**
-     * @return bool
-     */
-    public function storeSmartObjectD()
-    {
-        return $this->storeSmartObject(true);
-    }
-
-    /**
-     * @param  bool $debug
-     * @param  bool $xparam
-     * @return bool
-     */
-    public function storeSmartObject($debug = false, $xparam = false)
-    {
-        $ret = $this->storeFromDefaultForm('', '', null, $debug, $xparam);
-
-        return $ret;
-    }
-
-    /**
-     * Handles deletion of an object which keyid is passed as a GET param
-     *
-     * @param  bool   $confirm_msg
-     * @param  string $op
-     * @param  bool   $userSide
-     * @return bool
-     * @internal param string $redir_page redirect page after deleting the object
-     */
-    public function handleObjectDeletion($confirm_msg = false, $op = 'del', $userSide = false)
-    {
-        global $smart_previous_page;
-
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
-        $smartObj = $this->handler->get($objectid);
-
-        if ($smartObj->isNew()) {
-            redirect_header('javascript:history.go(-1)', 3, _CO_SOBJECT_NOT_SELECTED);
-        }
-
-        $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
-        if ($confirm) {
-            if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
-                exit;
-            }
-
-            redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
-        } else {
-            // no confirm: show deletion condition
-
-            xoops_cp_header();
-
-            if (!$confirm_msg) {
-                $confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
-            }
-
-            xoops_confirm(array('op' => $op, $this->handler->keyName => $smartObj->getVar($this->handler->keyName), 'confirm' => 1, 'redirect_page' => $smart_previous_page), xoops_getenv('PHP_SELF'),
-                          sprintf($confirm_msg, $smartObj->getVar($this->handler->identifierName)), _CO_SOBJECT_DELETE);
-
-            xoops_cp_footer();
-        }
-        exit();
-    }
-
-    /**
-     * @param bool   $confirm_msg
-     * @param string $op
-     */
-    public function handleObjectDeletionFromUserSide($confirm_msg = false, $op = 'del')
-    {
-        global $smart_previous_page, $xoopsTpl;
-
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
-        $smartObj = $this->handler->get($objectid);
-
-        if ($smartObj->isNew()) {
-            redirect_header('javascript:history.go(-1)', 3, _CO_SOBJECT_NOT_SELECTED);
-        }
-
-        $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
-        if ($confirm) {
-            if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
-                exit;
-            }
-
-            redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
-        } else {
-            // no confirm: show deletion condition
-            if (!$confirm_msg) {
-                $confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
-            }
-
-            ob_start();
-            xoops_confirm(array('op' => $op, $this->handler->keyName => $smartObj->getVar($this->handler->keyName), 'confirm' => 1, 'redirect_page' => $smart_previous_page), xoops_getenv('PHP_SELF'),
-                          sprintf($confirm_msg, $smartObj->getVar($this->handler->identifierName)), _CO_SOBJECT_DELETE);
-            $smartobjectDeleteConfirm = ob_get_clean();
-            $xoopsTpl->assign('smartobject_delete_confirm', $smartobjectDeleteConfirm);
-        }
-    }
-
-    /**
-     * Retreive the object admin side link for a {@link SmartObjectSingleView} page
-     *
-     * @param  SmartObject $smartObj  reference to the object from which we want the user side link
-     * @param  bool   $onlyUrl   wether or not to return a simple URL or a full <a> link
-     * @param  bool   $withimage
-     * @return string admin side link to the object
-     */
-    public function getAdminViewItemLink(SmartObject $smartObj, $onlyUrl = false, $withimage = false)
-    {
-        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=view&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        if ($onlyUrl) {
-            return $ret;
-        } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "viewmag.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_ADMIN_VIEW .
-                   "'  title='" .
-                   _CO_SOBJECT_ADMIN_VIEW .
-                   "'/></a>";
-        }
-
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
-    }
-
-    /**
-     * Retreive the object user side link
-     *
-     * @param  SmartObject $smartObj reference to the object from which we want the user side link
-     * @param  bool   $onlyUrl  wether or not to return a simple URL or a full <a> link
-     * @return string user side link to the object
-     */
-    public function getItemLink(SmartObject $smartObj, $onlyUrl = false)
-    {
-        $seoMode       = smart_getModuleModeSEO($this->handler->_moduleName);
-        $seoModuleName = smart_getModuleNameForSEO($this->handler->_moduleName);
-
-        /**
-         * $seoIncludeId feature is not finished yet, so let's put it always to true
-         */
-        //$seoIncludeId = smart_getModuleIncludeIdSEO($this->handler->_moduleName);
-        $seoIncludeId = true;
-
-        if ($seoMode === 'rewrite') {
-            $ret = XOOPS_URL .
-                   '/' .
-                   $seoModuleName .
-                   '.' .
-                   $this->handler->_itemname .
-                   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
-                   '/' .
-                   $smartObj->getVar('short_url') .
-                   '.html';
-        } elseif ($seoMode === 'pathinfo') {
-            $ret = SMARTOBJECT_URL .
-                   'seo.php/' .
-                   $seoModuleName .
-                   '.' .
-                   $this->handler->_itemname .
-                   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
-                   '/' .
-                   $smartObj->getVar('short_url') .
-                   '.html';
-        } else {
-            $ret = $this->handler->_moduleUrl . $this->handler->_page . '?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        }
-
-        if (!$onlyUrl) {
-            $ret = "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param         $smartObj
-     * @param  bool   $onlyUrl
-     * @param  bool   $withimage
-     * @return string
-     */
-    public function getEditLanguageLink($smartObj, $onlyUrl = false, $withimage = true)
-    {
-        $ret = $this->handler->_moduleUrl .
-               'admin/' .
-               $this->handler->_page .
-               '?op=mod&' .
-               $this->handler->keyName .
-               '=' .
-               $smartObj->getVar($this->handler->keyName) .
-               '&language=' .
-               $smartObj->getVar('language');
-        if ($onlyUrl) {
-            return $ret;
-        } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "wizard.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_LANGUAGE_MODIFY .
-                   "'  title='" .
-                   _CO_SOBJECT_LANGUAGE_MODIFY .
-                   "'/></a>";
-        }
-
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
-    }
-
-    /**
-     * @param         $smartObj
-     * @param  bool   $onlyUrl
-     * @param  bool   $withimage
-     * @param  bool   $userSide
-     * @return string
-     */
-    public function getEditItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
-    {
-        $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        if ($onlyUrl) {
-            return $ret;
-        } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "edit.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_MODIFY .
-                   "'  title='" .
-                   _CO_SOBJECT_MODIFY .
-                   "'/></a>";
-        }
-
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
-    }
-
-    /**
-     * @param         $smartObj
-     * @param  bool   $onlyUrl
-     * @param  bool   $withimage
-     * @param  bool   $userSide
-     * @return string
-     */
-    public function getDeleteItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
-    {
-        $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=del&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        if ($onlyUrl) {
-            return $ret;
-        } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "editdelete.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_DELETE .
-                   "'  title='" .
-                   _CO_SOBJECT_DELETE .
-                   "'/></a>";
-        }
-
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
-    }
-
-    /**
-     * @param $smartObj
-     * @return string
-     */
-    public function getPrintAndMailLink($smartObj)
-    {
-        global $xoopsConfig;
-
-        $printlink = $this->handler->_moduleUrl . 'print.php?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        $js        = "javascript:openWithSelfMain('" . $printlink . "', 'smartpopup', 700, 519);";
-        $printlink = '<a href="' . $js . '"><img  src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'fileprint.png" alt="" style="vertical-align: middle;"/></a>';
-
-        $smartModule = smart_getModuleInfo($smartObj->handler->_moduleName);
-        $link        = smart_getCurrentPage();
-        $mid         = $smartModule->getVar('mid');
-        $friendlink  = "<a href=\"javascript:openWithSelfMain('" .
-                       SMARTOBJECT_URL .
-                       'sendlink.php?link=' .
-                       $link .
-                       '&amp;mid=' .
-                       $mid .
-                       "', ',',',',',','sendmessage', 674, 500);\"><img src=\"" .
-                       SMARTOBJECT_IMAGES_ACTIONS_URL .
-                       "mail_send.png\"  alt=\"" .
-                       _CO_SOBJECT_EMAIL .
-                       "\" title=\"" .
-                       _CO_SOBJECT_EMAIL .
-                       "\" style=\"vertical-align: middle;\"/></a>";
-
-        $ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';
-
-        return $ret;
-    }
-
-    /**
-     * @return string
-     */
-    public function getModuleItemString()
-    {
-        $ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;
-
-        return $ret;
-    }
+	public $handler;
+
+	/**
+	 * SmartObjectController constructor.
+	 * @param $handler
+	 */
+	public function __construct($handler)
+	{
+		$this->handler = $handler;
+	}
+
+	/**
+	 * @param $smartObj
+	 */
+	public function postDataToObject(&$smartObj)
+	{
+		foreach (array_keys($smartObj->vars) as $key) {
+			switch ($smartObj->vars[$key]['data_type']) {
+				case XOBJ_DTYPE_IMAGE:
+					if (isset($_POST['url_' . $key]) && $_POST['url_' . $key] !== '') {
+						$oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
+						$smartObj->setVar($key, $_POST['url_' . $key]);
+						if (file_exists($oldFile)) {
+							unlink($oldFile);
+						}
+					}
+					if (isset($_POST['delete_' . $key]) && $_POST['delete_' . $key] == '1') {
+						$oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
+						$smartObj->setVar($key, '');
+						if (file_exists($oldFile)) {
+							unlink($oldFile);
+						}
+					}
+					break;
+
+				case XOBJ_DTYPE_URLLINK:
+					$linkObj = $smartObj->getUrlLinkObj($key);
+					$linkObj->setVar('caption', $_POST['caption_' . $key]);
+					$linkObj->setVar('description', $_POST['desc_' . $key]);
+					$linkObj->setVar('target', $_POST['target_' . $key]);
+					$linkObj->setVar('url', $_POST['url_' . $key]);
+					if ($linkObj->getVar('url') !== '') {
+						$smartObj->storeUrlLinkObj($linkObj);
+					}
+					//todo: catch errors
+					$smartObj->setVar($key, $linkObj->getVar('urllinkid'));
+					break;
+
+				case XOBJ_DTYPE_FILE:
+					if (!isset($_FILES['upload_' . $key]['name']) || $_FILES['upload_' . $key]['name'] === '') {
+						$fileObj = $smartObj->getFileObj($key);
+						$fileObj->setVar('caption', $_POST['caption_' . $key]);
+						$fileObj->setVar('description', $_POST['desc_' . $key]);
+						$fileObj->setVar('url', $_POST['url_' . $key]);
+						if (!($fileObj->getVar('url') === '' && $fileObj->getVar('url') === '' && $fileObj->getVar('url') === '')) {
+							$res = $smartObj->storeFileObj($fileObj);
+							if ($res) {
+								$smartObj->setVar($key, $fileObj->getVar('fileid'));
+							} else {
+								//error setted, but no error message (to be improved)
+								$smartObj->setErrors($fileObj->getErrors());
+							}
+						}
+					}
+					break;
+
+				case XOBJ_DTYPE_STIME:
+				case XOBJ_DTYPE_MTIME:
+				case XOBJ_DTYPE_LTIME:
+					// check if this field's value is available in the POST array
+					if (is_array($_POST[$key]) && isset($_POST[$key]['date'])) {
+						$value = strtotime($_POST[$key]['date']) + $_POST[$key]['time'];
+					} else {
+						$value = strtotime($_POST[$key]);
+						//if strtotime returns false, the value is already a time stamp
+						if (!$value) {
+							$value = (int)$_POST[$key];
+						}
+					}
+					$smartObj->setVar($key, $value);
+
+					break;
+
+				default:
+					$smartObj->setVar($key, $_POST[$key]);
+					break;
+			}
+		}
+	}
+
+	/**
+	 * @param        $smartObj
+	 * @param        $objectid
+	 * @param        $created_success_msg
+	 * @param        $modified_success_msg
+	 * @param  bool  $redirect_page
+	 * @param  bool  $debug
+	 * @return mixed
+	 */
+	public function doStoreFromDefaultForm(&$smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page = false, $debug = false)
+	{
+		global $smart_previous_page;
+
+		$this->postDataToObject($smartObj);
+
+		if ($smartObj->isNew()) {
+			$redirect_msg = $created_success_msg;
+		} else {
+			$redirect_msg = $modified_success_msg;
+		}
+
+		// Check if there were uploaded files
+		if (isset($_POST['smart_upload_image']) || isset($_POST['smart_upload_file'])) {
+			include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartuploader.php';
+			$uploaderObj = new SmartUploader($smartObj->getImageDir(true), $this->handler->_allowedMimeTypes, $this->handler->_maxFileSize, $this->handler->_maxWidth, $this->handler->_maxHeight);
+			foreach ($_FILES as $name => $file_array) {
+				if (isset($file_array['name']) && $file_array['name'] !== '' && in_array(str_replace('upload_', '', $name), array_keys($smartObj->vars))) {
+					if ($uploaderObj->fetchMedia($name)) {
+						$uploaderObj->setTargetFileName(time() . '_' . $uploaderObj->getMediaName());
+						if ($uploaderObj->upload()) {
+							// Find the related field in the SmartObject
+							$related_field   = str_replace('upload_', '', $name);
+							$uploadedArray[] = $related_field;
+							//si c'est un fichier Rich
+							if ($smartObj->vars[$related_field]['data_type'] === XOBJ_DTYPE_FILE) {
+								$object_fileurl = $smartObj->getUploadDir();
+								$fileObj        = $smartObj->getFileObj($related_field);
+								$fileObj->setVar('url', $object_fileurl . $uploaderObj->getSavedFileName());
+								$fileObj->setVar('caption', $_POST['caption_' . $related_field]);
+								$fileObj->setVar('description', $_POST['desc_' . $related_field]);
+								$smartObj->storeFileObj($fileObj);
+								//todo: catch errors
+								$smartObj->setVar($related_field, $fileObj->getVar('fileid'));
+							} else {
+								$old_file = $smartObj->getUploadDir(true) . $smartObj->getVar($related_field);
+								unlink($old_file);
+								$smartObj->setVar($related_field, $uploaderObj->getSavedFileName());
+							}
+						} else {
+							$smartObj->setErrors($uploaderObj->getErrors(false));
+						}
+					} else {
+						$smartObj->setErrors($uploaderObj->getErrors(false));
+					}
+				}
+			}
+		}
+
+		if ($debug) {
+			$storeResult = $this->handler->insertD($smartObj);
+		} else {
+			$storeResult = $this->handler->insert($smartObj);
+		}
+
+		if ($storeResult) {
+			if ($this->handler->getPermissions()) {
+				$smartPermissionsHandler = new SmartobjectPermissionHandler($this->handler);
+				$smartPermissionsHandler->storeAllPermissionsForId($smartObj->id());
+			}
+		}
+
+		if ($redirect_page === null) {
+			return $smartObj;
+		} else {
+			if (!$storeResult) {
+				redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
+			}
+
+			$redirect_page = $redirect_page ?: smart_get_page_before_form();
+
+			redirect_header($redirect_page, 2, $redirect_msg);
+		}
+	}
+
+	/**
+	 * Store the object in the database autmatically from a form sending POST data
+	 *
+	 * @param  string      $created_success_msg  message to display if new object was created
+	 * @param  string      $modified_success_msg message to display if object was successfully edited
+	 * @param  bool|string $redirect_page        redirect page, if not set, then we backup once
+	 * @param  bool        $debug
+	 * @param  bool        $x_param
+	 * @return bool
+	 * @internal param string $created_redir_page redirect page after creating the object
+	 * @internal param string $modified_redir_page redirect page after editing the object
+	 * @internal param bool $exit if set to TRUE then the script ends
+	 */
+	public function storeFromDefaultForm($created_success_msg, $modified_success_msg, $redirect_page = false, $debug = false, $x_param = false)
+	{
+		$objectid = isset($_POST[$this->handler->keyName]) ? (int)$_POST[$this->handler->keyName] : 0;
+		if ($debug) {
+			if ($x_param) {
+				$smartObj = $this->handler->getD($objectid, true, $x_param);
+			} else {
+				$smartObj = $this->handler->getD($objectid);
+			}
+		} else {
+			if ($x_param) {
+				$smartObj = $this->handler->get($objectid, true, false, false, $x_param);
+			} else {
+				$smartObj = $this->handler->get($objectid);
+			}
+		}
+
+		// if handler is the Multilanguage handler, we will need to treat this for multilanguage
+		if (is_subclass_of($this->handler, 'smartpersistablemlobjecthandler')) {
+			if ($smartObj->isNew()) {
+				// This is a new object. We need to store the meta data and then the language data
+				// First, we will get rid of the multilanguage data to only store the meta data
+				$smartObj->stripMultilanguageFields();
+				$newObject = $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);
+				/**
+				 * @todo we need to trap potential errors here
+				 */
+
+				// ok, the meta daa is stored. Let's recreate the object and then
+				// get rid of anything not multilanguage
+				unset($smartObj);
+				$smartObj = $this->handler->get($objectid);
+				$smartObj->stripNonMultilanguageFields();
+
+				$smartObj->setVar($this->handler->keyName, $newObject->getVar($this->handler->keyName));
+				$this->handler->changeTableNameForML();
+				$ret = $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);
+
+				return $ret;
+			}
+		} else {
+			return $this->doStoreFromDefaultForm($smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page, $debug);
+		}
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function storeSmartObjectD()
+	{
+		return $this->storeSmartObject(true);
+	}
+
+	/**
+	 * @param  bool $debug
+	 * @param  bool $xparam
+	 * @return bool
+	 */
+	public function storeSmartObject($debug = false, $xparam = false)
+	{
+		$ret = $this->storeFromDefaultForm('', '', null, $debug, $xparam);
+
+		return $ret;
+	}
+
+	/**
+	 * Handles deletion of an object which keyid is passed as a GET param
+	 *
+	 * @param  bool   $confirm_msg
+	 * @param  string $op
+	 * @param  bool   $userSide
+	 * @return bool
+	 * @internal param string $redir_page redirect page after deleting the object
+	 */
+	public function handleObjectDeletion($confirm_msg = false, $op = 'del', $userSide = false)
+	{
+		global $smart_previous_page;
+
+		$objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+		$smartObj = $this->handler->get($objectid);
+
+		if ($smartObj->isNew()) {
+			redirect_header('javascript:history.go(-1)', 3, _CO_SOBJECT_NOT_SELECTED);
+		}
+
+		$confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
+		if ($confirm) {
+			if (!$this->handler->delete($smartObj)) {
+				redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+				exit;
+			}
+
+			redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
+		} else {
+			// no confirm: show deletion condition
+
+			xoops_cp_header();
+
+			if (!$confirm_msg) {
+				$confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
+			}
+
+			xoops_confirm(array('op' => $op, $this->handler->keyName => $smartObj->getVar($this->handler->keyName), 'confirm' => 1, 'redirect_page' => $smart_previous_page), xoops_getenv('PHP_SELF'),
+						  sprintf($confirm_msg, $smartObj->getVar($this->handler->identifierName)), _CO_SOBJECT_DELETE);
+
+			xoops_cp_footer();
+		}
+		exit();
+	}
+
+	/**
+	 * @param bool   $confirm_msg
+	 * @param string $op
+	 */
+	public function handleObjectDeletionFromUserSide($confirm_msg = false, $op = 'del')
+	{
+		global $smart_previous_page, $xoopsTpl;
+
+		$objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+		$smartObj = $this->handler->get($objectid);
+
+		if ($smartObj->isNew()) {
+			redirect_header('javascript:history.go(-1)', 3, _CO_SOBJECT_NOT_SELECTED);
+		}
+
+		$confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
+		if ($confirm) {
+			if (!$this->handler->delete($smartObj)) {
+				redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+				exit;
+			}
+
+			redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
+		} else {
+			// no confirm: show deletion condition
+			if (!$confirm_msg) {
+				$confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
+			}
+
+			ob_start();
+			xoops_confirm(array('op' => $op, $this->handler->keyName => $smartObj->getVar($this->handler->keyName), 'confirm' => 1, 'redirect_page' => $smart_previous_page), xoops_getenv('PHP_SELF'),
+						  sprintf($confirm_msg, $smartObj->getVar($this->handler->identifierName)), _CO_SOBJECT_DELETE);
+			$smartobjectDeleteConfirm = ob_get_clean();
+			$xoopsTpl->assign('smartobject_delete_confirm', $smartobjectDeleteConfirm);
+		}
+	}
+
+	/**
+	 * Retreive the object admin side link for a {@link SmartObjectSingleView} page
+	 *
+	 * @param  SmartObject $smartObj  reference to the object from which we want the user side link
+	 * @param  bool   $onlyUrl   wether or not to return a simple URL or a full <a> link
+	 * @param  bool   $withimage
+	 * @return string admin side link to the object
+	 */
+	public function getAdminViewItemLink(SmartObject $smartObj, $onlyUrl = false, $withimage = false)
+	{
+		$ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=view&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+		if ($onlyUrl) {
+			return $ret;
+		} elseif ($withimage) {
+			return "<a href='" .
+				   $ret .
+				   "'><img src='" .
+				   SMARTOBJECT_IMAGES_ACTIONS_URL .
+				   "viewmag.png' style='vertical-align: middle;' alt='" .
+				   _CO_SOBJECT_ADMIN_VIEW .
+				   "'  title='" .
+				   _CO_SOBJECT_ADMIN_VIEW .
+				   "'/></a>";
+		}
+
+		return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+	}
+
+	/**
+	 * Retreive the object user side link
+	 *
+	 * @param  SmartObject $smartObj reference to the object from which we want the user side link
+	 * @param  bool   $onlyUrl  wether or not to return a simple URL or a full <a> link
+	 * @return string user side link to the object
+	 */
+	public function getItemLink(SmartObject $smartObj, $onlyUrl = false)
+	{
+		$seoMode       = smart_getModuleModeSEO($this->handler->_moduleName);
+		$seoModuleName = smart_getModuleNameForSEO($this->handler->_moduleName);
+
+		/**
+		 * $seoIncludeId feature is not finished yet, so let's put it always to true
+		 */
+		//$seoIncludeId = smart_getModuleIncludeIdSEO($this->handler->_moduleName);
+		$seoIncludeId = true;
+
+		if ($seoMode === 'rewrite') {
+			$ret = XOOPS_URL .
+				   '/' .
+				   $seoModuleName .
+				   '.' .
+				   $this->handler->_itemname .
+				   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
+				   '/' .
+				   $smartObj->getVar('short_url') .
+				   '.html';
+		} elseif ($seoMode === 'pathinfo') {
+			$ret = SMARTOBJECT_URL .
+				   'seo.php/' .
+				   $seoModuleName .
+				   '.' .
+				   $this->handler->_itemname .
+				   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
+				   '/' .
+				   $smartObj->getVar('short_url') .
+				   '.html';
+		} else {
+			$ret = $this->handler->_moduleUrl . $this->handler->_page . '?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+		}
+
+		if (!$onlyUrl) {
+			$ret = "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param         $smartObj
+	 * @param  bool   $onlyUrl
+	 * @param  bool   $withimage
+	 * @return string
+	 */
+	public function getEditLanguageLink($smartObj, $onlyUrl = false, $withimage = true)
+	{
+		$ret = $this->handler->_moduleUrl .
+			   'admin/' .
+			   $this->handler->_page .
+			   '?op=mod&' .
+			   $this->handler->keyName .
+			   '=' .
+			   $smartObj->getVar($this->handler->keyName) .
+			   '&language=' .
+			   $smartObj->getVar('language');
+		if ($onlyUrl) {
+			return $ret;
+		} elseif ($withimage) {
+			return "<a href='" .
+				   $ret .
+				   "'><img src='" .
+				   SMARTOBJECT_IMAGES_ACTIONS_URL .
+				   "wizard.png' style='vertical-align: middle;' alt='" .
+				   _CO_SOBJECT_LANGUAGE_MODIFY .
+				   "'  title='" .
+				   _CO_SOBJECT_LANGUAGE_MODIFY .
+				   "'/></a>";
+		}
+
+		return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+	}
+
+	/**
+	 * @param         $smartObj
+	 * @param  bool   $onlyUrl
+	 * @param  bool   $withimage
+	 * @param  bool   $userSide
+	 * @return string
+	 */
+	public function getEditItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
+	{
+		$admin_side = $userSide ? '' : 'admin/';
+		$ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+		if ($onlyUrl) {
+			return $ret;
+		} elseif ($withimage) {
+			return "<a href='" .
+				   $ret .
+				   "'><img src='" .
+				   SMARTOBJECT_IMAGES_ACTIONS_URL .
+				   "edit.png' style='vertical-align: middle;' alt='" .
+				   _CO_SOBJECT_MODIFY .
+				   "'  title='" .
+				   _CO_SOBJECT_MODIFY .
+				   "'/></a>";
+		}
+
+		return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+	}
+
+	/**
+	 * @param         $smartObj
+	 * @param  bool   $onlyUrl
+	 * @param  bool   $withimage
+	 * @param  bool   $userSide
+	 * @return string
+	 */
+	public function getDeleteItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
+	{
+		$admin_side = $userSide ? '' : 'admin/';
+		$ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=del&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+		if ($onlyUrl) {
+			return $ret;
+		} elseif ($withimage) {
+			return "<a href='" .
+				   $ret .
+				   "'><img src='" .
+				   SMARTOBJECT_IMAGES_ACTIONS_URL .
+				   "editdelete.png' style='vertical-align: middle;' alt='" .
+				   _CO_SOBJECT_DELETE .
+				   "'  title='" .
+				   _CO_SOBJECT_DELETE .
+				   "'/></a>";
+		}
+
+		return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+	}
+
+	/**
+	 * @param $smartObj
+	 * @return string
+	 */
+	public function getPrintAndMailLink($smartObj)
+	{
+		global $xoopsConfig;
+
+		$printlink = $this->handler->_moduleUrl . 'print.php?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+		$js        = "javascript:openWithSelfMain('" . $printlink . "', 'smartpopup', 700, 519);";
+		$printlink = '<a href="' . $js . '"><img  src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'fileprint.png" alt="" style="vertical-align: middle;"/></a>';
+
+		$smartModule = smart_getModuleInfo($smartObj->handler->_moduleName);
+		$link        = smart_getCurrentPage();
+		$mid         = $smartModule->getVar('mid');
+		$friendlink  = "<a href=\"javascript:openWithSelfMain('" .
+					   SMARTOBJECT_URL .
+					   'sendlink.php?link=' .
+					   $link .
+					   '&amp;mid=' .
+					   $mid .
+					   "', ',',',',',','sendmessage', 674, 500);\"><img src=\"" .
+					   SMARTOBJECT_IMAGES_ACTIONS_URL .
+					   "mail_send.png\"  alt=\"" .
+					   _CO_SOBJECT_EMAIL .
+					   "\" title=\"" .
+					   _CO_SOBJECT_EMAIL .
+					   "\" style=\"vertical-align: middle;\"/></a>";
+
+		$ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';
+
+		return $ret;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getModuleItemString()
+	{
+		$ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;
+
+		return $ret;
+	}
 }

Spacing +110 added lines, -110 removed lines

@@ -23,8 +23,8 @@ 
  * @credit  Jan Keller Pedersen <mithrandir@xoops.org> - IDG Danmark A/S <www.idg.dk>
  * @link    http://smartfactory.ca The SmartFactory
  */
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobjecthandler.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartobject.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartobjecthandler.php';
 
 /**
  * Class SmartObjectController
@@ -50,15 +50,15 @@ 
         foreach (array_keys($smartObj->vars) as $key) {
             switch ($smartObj->vars[$key]['data_type']) {
                 case XOBJ_DTYPE_IMAGE:
-                    if (isset($_POST['url_' . $key]) && $_POST['url_' . $key] !== '') {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
-                        $smartObj->setVar($key, $_POST['url_' . $key]);
+                    if (isset($_POST['url_'.$key]) && $_POST['url_'.$key] !== '') {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
+                        $smartObj->setVar($key, $_POST['url_'.$key]);
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
                         }
                     }
-                    if (isset($_POST['delete_' . $key]) && $_POST['delete_' . $key] == '1') {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
+                    if (isset($_POST['delete_'.$key]) && $_POST['delete_'.$key] == '1') {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
                         $smartObj->setVar($key, '');
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
@@ -68,10 +68,10 @@ 
 
                 case XOBJ_DTYPE_URLLINK:
                     $linkObj = $smartObj->getUrlLinkObj($key);
-                    $linkObj->setVar('caption', $_POST['caption_' . $key]);
-                    $linkObj->setVar('description', $_POST['desc_' . $key]);
-                    $linkObj->setVar('target', $_POST['target_' . $key]);
-                    $linkObj->setVar('url', $_POST['url_' . $key]);
+                    $linkObj->setVar('caption', $_POST['caption_'.$key]);
+                    $linkObj->setVar('description', $_POST['desc_'.$key]);
+                    $linkObj->setVar('target', $_POST['target_'.$key]);
+                    $linkObj->setVar('url', $_POST['url_'.$key]);
                     if ($linkObj->getVar('url') !== '') {
                         $smartObj->storeUrlLinkObj($linkObj);
                     }
@@ -80,11 +80,11 @@ 
                     break;
 
                 case XOBJ_DTYPE_FILE:
-                    if (!isset($_FILES['upload_' . $key]['name']) || $_FILES['upload_' . $key]['name'] === '') {
+                    if (!isset($_FILES['upload_'.$key]['name']) || $_FILES['upload_'.$key]['name'] === '') {
                         $fileObj = $smartObj->getFileObj($key);
-                        $fileObj->setVar('caption', $_POST['caption_' . $key]);
-                        $fileObj->setVar('description', $_POST['desc_' . $key]);
-                        $fileObj->setVar('url', $_POST['url_' . $key]);
+                        $fileObj->setVar('caption', $_POST['caption_'.$key]);
+                        $fileObj->setVar('description', $_POST['desc_'.$key]);
+                        $fileObj->setVar('url', $_POST['url_'.$key]);
                         if (!($fileObj->getVar('url') === '' && $fileObj->getVar('url') === '' && $fileObj->getVar('url') === '')) {
                             $res = $smartObj->storeFileObj($fileObj);
                             if ($res) {
@@ -107,7 +107,7 @@ 
                         $value = strtotime($_POST[$key]);
                         //if strtotime returns false, the value is already a time stamp
                         if (!$value) {
-                            $value = (int)$_POST[$key];
+                            $value = (int) $_POST[$key];
                         }
                     }
                     $smartObj->setVar($key, $value);
@@ -144,12 +144,12 @@ 
 
         // Check if there were uploaded files
         if (isset($_POST['smart_upload_image']) || isset($_POST['smart_upload_file'])) {
-            include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartuploader.php';
+            include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartuploader.php';
             $uploaderObj = new SmartUploader($smartObj->getImageDir(true), $this->handler->_allowedMimeTypes, $this->handler->_maxFileSize, $this->handler->_maxWidth, $this->handler->_maxHeight);
             foreach ($_FILES as $name => $file_array) {
                 if (isset($file_array['name']) && $file_array['name'] !== '' && in_array(str_replace('upload_', '', $name), array_keys($smartObj->vars))) {
                     if ($uploaderObj->fetchMedia($name)) {
-                        $uploaderObj->setTargetFileName(time() . '_' . $uploaderObj->getMediaName());
+                        $uploaderObj->setTargetFileName(time().'_'.$uploaderObj->getMediaName());
                         if ($uploaderObj->upload()) {
                             // Find the related field in the SmartObject
                             $related_field   = str_replace('upload_', '', $name);
@@ -158,14 +158,14 @@ 
                             if ($smartObj->vars[$related_field]['data_type'] === XOBJ_DTYPE_FILE) {
                                 $object_fileurl = $smartObj->getUploadDir();
                                 $fileObj        = $smartObj->getFileObj($related_field);
-                                $fileObj->setVar('url', $object_fileurl . $uploaderObj->getSavedFileName());
-                                $fileObj->setVar('caption', $_POST['caption_' . $related_field]);
-                                $fileObj->setVar('description', $_POST['desc_' . $related_field]);
+                                $fileObj->setVar('url', $object_fileurl.$uploaderObj->getSavedFileName());
+                                $fileObj->setVar('caption', $_POST['caption_'.$related_field]);
+                                $fileObj->setVar('description', $_POST['desc_'.$related_field]);
                                 $smartObj->storeFileObj($fileObj);
                                 //todo: catch errors
                                 $smartObj->setVar($related_field, $fileObj->getVar('fileid'));
                             } else {
-                                $old_file = $smartObj->getUploadDir(true) . $smartObj->getVar($related_field);
+                                $old_file = $smartObj->getUploadDir(true).$smartObj->getVar($related_field);
                                 unlink($old_file);
                                 $smartObj->setVar($related_field, $uploaderObj->getSavedFileName());
                             }
@@ -196,7 +196,7 @@ 
             return $smartObj;
         } else {
             if (!$storeResult) {
-                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR.$smartObj->getHtmlErrors());
             }
 
             $redirect_page = $redirect_page ?: smart_get_page_before_form();
@@ -220,7 +220,7 @@ 
      */
     public function storeFromDefaultForm($created_success_msg, $modified_success_msg, $redirect_page = false, $debug = false, $x_param = false)
     {
-        $objectid = isset($_POST[$this->handler->keyName]) ? (int)$_POST[$this->handler->keyName] : 0;
+        $objectid = isset($_POST[$this->handler->keyName]) ? (int) $_POST[$this->handler->keyName] : 0;
         if ($debug) {
             if ($x_param) {
                 $smartObj = $this->handler->getD($objectid, true, $x_param);
@@ -296,7 +296,7 @@ 
     {
         global $smart_previous_page;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -306,7 +306,7 @@ 
         $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
                 exit;
             }
 
@@ -336,7 +336,7 @@ 
     {
         global $smart_previous_page, $xoopsTpl;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -346,7 +346,7 @@ 
         $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
                 exit;
             }
 
@@ -375,22 +375,22 @@ 
      */
     public function getAdminViewItemLink(SmartObject $smartObj, $onlyUrl = false, $withimage = false)
     {
-        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=view&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret = $this->handler->_moduleUrl.'admin/'.$this->handler->_page.'?op=view&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "viewmag.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_ADMIN_VIEW .
-                   "'  title='" .
-                   _CO_SOBJECT_ADMIN_VIEW .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "viewmag.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_ADMIN_VIEW.
+                   "'  title='".
+                   _CO_SOBJECT_ADMIN_VIEW.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -412,31 +412,31 @@ 
         $seoIncludeId = true;
 
         if ($seoMode === 'rewrite') {
-            $ret = XOOPS_URL .
-                   '/' .
-                   $seoModuleName .
-                   '.' .
-                   $this->handler->_itemname .
-                   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
-                   '/' .
-                   $smartObj->getVar('short_url') .
+            $ret = XOOPS_URL.
+                   '/'.
+                   $seoModuleName.
+                   '.'.
+                   $this->handler->_itemname.
+                   ($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').
+                   '/'.
+                   $smartObj->getVar('short_url').
                    '.html';
         } elseif ($seoMode === 'pathinfo') {
-            $ret = SMARTOBJECT_URL .
-                   'seo.php/' .
-                   $seoModuleName .
-                   '.' .
-                   $this->handler->_itemname .
-                   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
-                   '/' .
-                   $smartObj->getVar('short_url') .
+            $ret = SMARTOBJECT_URL.
+                   'seo.php/'.
+                   $seoModuleName.
+                   '.'.
+                   $this->handler->_itemname.
+                   ($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').
+                   '/'.
+                   $smartObj->getVar('short_url').
                    '.html';
         } else {
-            $ret = $this->handler->_moduleUrl . $this->handler->_page . '?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+            $ret = $this->handler->_moduleUrl.$this->handler->_page.'?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         }
 
         if (!$onlyUrl) {
-            $ret = "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+            $ret = "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
         }
 
         return $ret;
@@ -450,30 +450,30 @@ 
      */
     public function getEditLanguageLink($smartObj, $onlyUrl = false, $withimage = true)
     {
-        $ret = $this->handler->_moduleUrl .
-               'admin/' .
-               $this->handler->_page .
-               '?op=mod&' .
-               $this->handler->keyName .
-               '=' .
-               $smartObj->getVar($this->handler->keyName) .
-               '&language=' .
+        $ret = $this->handler->_moduleUrl.
+               'admin/'.
+               $this->handler->_page.
+               '?op=mod&'.
+               $this->handler->keyName.
+               '='.
+               $smartObj->getVar($this->handler->keyName).
+               '&language='.
                $smartObj->getVar('language');
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "wizard.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_LANGUAGE_MODIFY .
-                   "'  title='" .
-                   _CO_SOBJECT_LANGUAGE_MODIFY .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "wizard.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_LANGUAGE_MODIFY.
+                   "'  title='".
+                   _CO_SOBJECT_LANGUAGE_MODIFY.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -486,22 +486,22 @@ 
     public function getEditItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=mod&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "edit.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_MODIFY .
-                   "'  title='" .
-                   _CO_SOBJECT_MODIFY .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "edit.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_MODIFY.
+                   "'  title='".
+                   _CO_SOBJECT_MODIFY.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -514,22 +514,22 @@ 
     public function getDeleteItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=del&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=del&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "editdelete.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_DELETE .
-                   "'  title='" .
-                   _CO_SOBJECT_DELETE .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "editdelete.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_DELETE.
+                   "'  title='".
+                   _CO_SOBJECT_DELETE.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -540,28 +540,28 @@ 
     {
         global $xoopsConfig;
 
-        $printlink = $this->handler->_moduleUrl . 'print.php?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        $js        = "javascript:openWithSelfMain('" . $printlink . "', 'smartpopup', 700, 519);";
-        $printlink = '<a href="' . $js . '"><img  src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'fileprint.png" alt="" style="vertical-align: middle;"/></a>';
+        $printlink = $this->handler->_moduleUrl.'print.php?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
+        $js        = "javascript:openWithSelfMain('".$printlink."', 'smartpopup', 700, 519);";
+        $printlink = '<a href="'.$js.'"><img  src="'.SMARTOBJECT_IMAGES_ACTIONS_URL.'fileprint.png" alt="" style="vertical-align: middle;"/></a>';
 
         $smartModule = smart_getModuleInfo($smartObj->handler->_moduleName);
         $link        = smart_getCurrentPage();
         $mid         = $smartModule->getVar('mid');
-        $friendlink  = "<a href=\"javascript:openWithSelfMain('" .
-                       SMARTOBJECT_URL .
-                       'sendlink.php?link=' .
-                       $link .
-                       '&amp;mid=' .
-                       $mid .
-                       "', ',',',',',','sendmessage', 674, 500);\"><img src=\"" .
-                       SMARTOBJECT_IMAGES_ACTIONS_URL .
-                       "mail_send.png\"  alt=\"" .
-                       _CO_SOBJECT_EMAIL .
-                       "\" title=\"" .
-                       _CO_SOBJECT_EMAIL .
+        $friendlink  = "<a href=\"javascript:openWithSelfMain('".
+                       SMARTOBJECT_URL.
+                       'sendlink.php?link='.
+                       $link.
+                       '&amp;mid='.
+                       $mid.
+                       "', ',',',',',','sendmessage', 674, 500);\"><img src=\"".
+                       SMARTOBJECT_IMAGES_ACTIONS_URL.
+                       "mail_send.png\"  alt=\"".
+                       _CO_SOBJECT_EMAIL.
+                       "\" title=\"".
+                       _CO_SOBJECT_EMAIL.
                        "\" style=\"vertical-align: middle;\"/></a>";
 
-        $ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';
+        $ret = '<span id="smartobject_print_button">'.$printlink.'&nbsp;</span>'.'<span id="smartobject_mail_button">'.$friendlink.'</span>';
 
         return $ret;
     }
@@ -571,7 +571,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;
+        $ret = $this->handler->_moduleName.'_'.$this->handler->_itemname;
 
         return $ret;
     }

class/smartobjecthandler.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,10 +132,10 @@ 
      *
      * @param XoopsDatabase $db           {@link XoopsDatabase}
      *                                           object
-     * @param                      $itemname
+     * @param                      string $itemname
      * @param string               $keyname      Name of the table key that uniquely identify each {@link SmartObject}
      * @param string               $idenfierName Name of the field which properly identify the {@link SmartObject}
-     * @param                      $summaryName
+     * @param                      string $summaryName
      * @param                      $modulename
      * @internal param string $tablename Name of the table use to store this <a href='psi_element://SmartObject'>SmartObject</a>
      * @internal param Name $string of the class derived from <a href='psi_element://SmartObject'>SmartObject</a> and which this handler is handling and which this handler is handling
@@ -191,7 +191,7 @@ 
 
     /**
      * @param $criteria
-     * @param $perm_name
+     * @param boolean $perm_name
      * @return bool
      */
     public function setGrantedObjectsCriteria(&$criteria, $perm_name)
@@ -375,7 +375,7 @@ 
     }
 
     /**
-     * @param        $sql
+     * @param        string $sql
      * @param        $criteria
      * @param  bool  $force
      * @param  bool  $debug

Indentation +966 added lines, -966 removed lines

@@ -25,970 +25,970 @@
  */
 class SmartPersistableObjectHandler extends XoopsObjectHandler
 {
-    public $_itemname;
-
-    /**
-     * Name of the table use to store this {@link SmartObject}
-     *
-     * Note that the name of the table needs to be free of the database prefix.
-     * For example "smartsection_categories"
-     * @var string
-     */
-    public $table;
-
-    /**
-     * Name of the table key that uniquely identify each {@link SmartObject}
-     *
-     * For example: "categoryid"
-     * @var string
-     */
-    public $keyName;
-
-    /**
-     * Name of the class derived from {@link SmartObject} and which this handler is handling
-     *
-     * Note that this string needs to be lowercase
-     *
-     * For example: "smartsectioncategory"
-     * @var string
-     */
-    public $className;
-
-    /**
-     * Name of the field which properly identify the {@link SmartObject}
-     *
-     * For example: "name" (this will be the category's name)
-     * @var string
-     */
-    public $identifierName;
-
-    /**
-     * Name of the field which will be use as a summary for the object
-     *
-     * For example: "summary"
-     * @var string
-     */
-    public $summaryName;
-
-    /**
-     * Page name use to basically manage and display the {@link SmartObject}
-     *
-     * This page needs to be the same in user side and admin side
-     *
-     * For example category.php - we will deduct smartsection/category.php as well as smartsection/admin/category.php
-     * @todo this could probably be automatically deducted from the class name - for example, the class SmartsectionCategory will have "category.php" as it's managing page
-     * @var string
-     */
-    public $_page;
-
-    /**
-     * Full path of the module using this {@link SmartObject}
-     *
-     * <code>XOOPS_URL . "/modules/smartsection/"</code>
-     * @todo this could probably be automatically deducted from the class name as it is always prefixed with the module name
-     * @var string
-     */
-    public $_modulePath;
-
-    public $_moduleUrl;
-
-    public $_moduleName;
-
-    public $_uploadUrl;
-
-    public $_uploadPath;
-
-    public $_allowedMimeTypes = 0;
-
-    public $_maxFileSize = 1000000;
-
-    public $_maxWidth = 500;
-
-    public $_maxHeight = 500;
-
-    public $highlightFields = array();
-
-    /**
-     * Array containing the events name and functions
-     *
-     * @var array
-     */
-    public $eventArray = array();
-
-    /**
-     * Array containing the permissions that this handler will manage on the objects
-     *
-     * @var array
-     */
-    public $permissionsArray = false;
-
-    public $generalSQL = false;
-
-    public $_eventHooks     = array();
-    public $_disabledEvents = array();
-
-    /**
-     * Constructor - called from child classes
-     *
-     * @param XoopsDatabase $db           {@link XoopsDatabase}
-     *                                           object
-     * @param                      $itemname
-     * @param string               $keyname      Name of the table key that uniquely identify each {@link SmartObject}
-     * @param string               $idenfierName Name of the field which properly identify the {@link SmartObject}
-     * @param                      $summaryName
-     * @param                      $modulename
-     * @internal param string $tablename Name of the table use to store this <a href='psi_element://SmartObject'>SmartObject</a>
-     * @internal param Name $string of the class derived from <a href='psi_element://SmartObject'>SmartObject</a> and which this handler is handling and which this handler is handling
-     * @internal param string $page Page name use to basically manage and display the <a href='psi_element://SmartObject'>SmartObject</a>
-     * @internal param string $moduleName name of the module
-     */
-    public function __construct(XoopsDatabase $db, $itemname, $keyname, $idenfierName, $summaryName, $modulename)
-    {
-        parent::__construct($db);
-
-        $this->_itemname      = $itemname;
-        $this->_moduleName    = $modulename;
-        $this->table          = $db->prefix($modulename . '_' . $itemname);
-        $this->keyName        = $keyname;
-        $this->className      = ucfirst($modulename) . ucfirst($itemname);
-        $this->identifierName = $idenfierName;
-        $this->summaryName    = $summaryName;
-        $this->_page          = $itemname . '.php';
-        $this->_modulePath    = XOOPS_ROOT_PATH . '/modules/' . $this->_moduleName . '/';
-        $this->_moduleUrl     = XOOPS_URL . '/modules/' . $this->_moduleName . '/';
-        $this->_uploadPath    = XOOPS_UPLOAD_PATH . '/' . $this->_moduleName . '/';
-        $this->_uploadUrl     = XOOPS_UPLOAD_URL . '/' . $this->_moduleName . '/';
-    }
-
-    /**
-     * @param $event
-     * @param $method
-     */
-    public function addEventHook($event, $method)
-    {
-        $this->_eventHooks[$event] = $method;
-    }
-
-    /**
-     * Add a permission that this handler will manage for its objects
-     *
-     * Example: $this->addPermission('view', _AM_SSHOP_CAT_PERM_READ, _AM_SSHOP_CAT_PERM_READ_DSC);
-     *
-     * @param string      $perm_name   name of the permission
-     * @param string      $caption     caption of the control that will be displayed in the form
-     * @param bool|string $description description of the control that will be displayed in the form
-     */
-    public function addPermission($perm_name, $caption, $description = false)
-    {
-        include_once(SMARTOBJECT_ROOT_PATH . 'class/smartobjectpermission.php');
-
-        $this->permissionsArray[] = array(
-            'perm_name'   => $perm_name,
-            'caption'     => $caption,
-            'description' => $description
-        );
-    }
-
-    /**
-     * @param $criteria
-     * @param $perm_name
-     * @return bool
-     */
-    public function setGrantedObjectsCriteria(&$criteria, $perm_name)
-    {
-        $smartPermissionsHandler = new SmartobjectPermissionHandler($this);
-        $grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
-        if (count($grantedItems) > 0) {
-            $criteria->add(new Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
-
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * @param bool $_uploadPath
-     * @param bool $_allowedMimeTypes
-     * @param bool $_maxFileSize
-     * @param bool $_maxWidth
-     * @param bool $_maxHeight
-     */
-    public function setUploaderConfig($_uploadPath = false, $_allowedMimeTypes = false, $_maxFileSize = false, $_maxWidth = false, $_maxHeight = false)
-    {
-        $this->_uploadPath       = $_uploadPath ?: $this->_uploadPath;
-        $this->_allowedMimeTypes = $_allowedMimeTypes ?: $this->_allowedMimeTypes;
-        $this->_maxFileSize      = $_maxFileSize ?: $this->_maxFileSize;
-        $this->_maxWidth         = $_maxWidth ?: $this->_maxWidth;
-        $this->_maxHeight        = $_maxHeight ?: $this->_maxHeight;
-    }
-
-    /**
-     * create a new {@link SmartObject}
-     *
-     * @param bool $isNew Flag the new objects as "new"?
-     *
-     * @return SmartObject {@link SmartObject}
-     */
-    public function create($isNew = true)
-    {
-        $obj = new $this->className($this);
-        $obj->setImageDir($this->getImageUrl(), $this->getImagePath());
-        if (!$obj->handler) {
-            $obj->handler =& $this;
-        }
-
-        if ($isNew === true) {
-            $obj->setNew();
-        }
-
-        return $obj;
-    }
-
-    /**
-     * @return string
-     */
-    public function getImageUrl()
-    {
-        return $this->_uploadUrl . $this->_itemname . '/';
-    }
-
-    /**
-     * @return string
-     */
-    public function getImagePath()
-    {
-        $dir = $this->_uploadPath . $this->_itemname;
-        if (!file_exists($dir)) {
-            smart_admin_mkdir($dir);
-        }
-
-        return $dir . '/';
-    }
-
-    /**
-     * retrieve a {@link SmartObject}
-     *
-     * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
-     * @param  bool  $as_object whether to return an object or an array
-     * @param  bool  $debug
-     * @param  bool  $criteria
-     * @return mixed reference to the <a href='psi_element://SmartObject'>SmartObject</a>, FALSE if failed
-     *                         FALSE if failed
-     */
-    public function get($id, $as_object = true, $debug = false, $criteria = false)
-    {
-        if (!$criteria) {
-            $criteria = new CriteriaCompo();
-        }
-        if (is_array($this->keyName)) {
-            for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                /**
-                 * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
-                 * Is the fact that we removed the (int)() represents a security risk ?
-                 */
-                //$criteria->add(new Criteria($this->keyName[$i], ($id[$i]), '=', $this->_itemname));
-                $criteria->add(new Criteria($this->keyName[$i], $id[$i], '=', $this->_itemname));
-            }
-        } else {
-            //$criteria = new Criteria($this->keyName, (int)($id), '=', $this->_itemname);
-            /**
-             * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
-             * Is the fact that we removed the (int)() represents a security risk ?
-             */
-            $criteria->add(new Criteria($this->keyName, $id, '=', $this->_itemname));
-        }
-        $criteria->setLimit(1);
-        if ($debug) {
-            $obj_array = $this->getObjectsD($criteria, false, $as_object);
-        } else {
-            $obj_array = $this->getObjects($criteria, false, $as_object);
-            //patch: weird bug of indexing by id even if id_as_key = false;
-            if (!isset($obj_array[0]) && is_object($obj_array[$id])) {
-                $obj_array[0] = $obj_array[$id];
-                unset($obj_array[$id]);
-                $obj_array[0]->unsetNew();
-            }
-        }
-
-        if (count($obj_array) != 1) {
-            $obj = $this->create();
-
-            return $obj;
-        }
-
-        return $obj_array[0];
-    }
-
-    /**
-     * retrieve a {@link SmartObject}
-     *
-     * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
-     * @param  bool  $as_object whether to return an object or an array
-     * @return mixed reference to the {@link SmartObject}, FALSE if failed
-     */
-    public function &getD($id, $as_object = true)
-    {
-        return $this->get($id, $as_object, true);
-    }
-
-    /**
-     * retrieve objects from the database
-     *
-     * @param CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
-     * @param bool   $id_as_key use the ID as key for the array?
-     * @param bool   $as_object return an array of objects?
-     *
-     * @param  bool  $sql
-     * @param  bool  $debug
-     * @return array
-     */
-    public function getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $sql = false, $debug = false)
-    {
-        $ret   = array();
-        $limit = $start = 0;
-
-        if ($this->generalSQL) {
-            $sql = $this->generalSQL;
-        } elseif (!$sql) {
-            $sql = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname;
-        }
-
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
-            }
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-        if ($debug) {
-            xoops_debug($sql);
-        }
-
-        $result = $this->db->query($sql, $limit, $start);
-        if (!$result) {
-            return $ret;
-        }
-
-        return $this->convertResultSet($result, $id_as_key, $as_object);
-    }
-
-    /**
-     * @param        $sql
-     * @param        $criteria
-     * @param  bool  $force
-     * @param  bool  $debug
-     * @return array
-     */
-    public function query($sql, $criteria, $force = false, $debug = false)
-    {
-        $ret = array();
-
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->groupby) {
-                $sql .= $criteria->getGroupby();
-            }
-            if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
-            }
-        }
-        if ($debug) {
-            xoops_debug($sql);
-        }
-
-        if ($force) {
-            $result = $this->db->queryF($sql);
-        } else {
-            $result = $this->db->query($sql);
-        }
-
-        if (!$result) {
-            return $ret;
-        }
-
-        while (false !== ($myrow = $this->db->fetchArray($result))) {
-            $ret[] = $myrow;
-        }
-
-        return $ret;
-    }
-
-    /**
-     * retrieve objects with debug mode - so will show the query
-     *
-     * @param CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
-     * @param bool   $id_as_key use the ID as key for the array?
-     * @param bool   $as_object return an array of objects?
-     *
-     * @param  bool  $sql
-     * @return array
-     */
-    public function getObjectsD(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $sql = false)
-    {
-        return $this->getObjects($criteria, $id_as_key, $as_object, $sql, true);
-    }
-
-    /**
-     * @param $arrayObjects
-     * @return array|bool
-     */
-    public function getObjectsAsArray($arrayObjects)
-    {
-        $ret = array();
-        foreach ($arrayObjects as $key => $object) {
-            $ret[$key] = $object->toArray();
-        }
-        if (count($ret > 0)) {
-            return $ret;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Convert a database resultset to a returnable array
-     *
-     * @param object $result    database resultset
-     * @param bool   $id_as_key - should NOT be used with joint keys
-     * @param bool   $as_object
-     *
-     * @return array
-     */
-    public function convertResultSet($result, $id_as_key = false, $as_object = true)
-    {
-        $ret = array();
-        while (false !== ($myrow = $this->db->fetchArray($result))) {
-            $obj = $this->create(false);
-            $obj->assignVars($myrow);
-            if (!$id_as_key) {
-                if ($as_object) {
-                    $ret[] =& $obj;
-                } else {
-                    $ret[] = $obj->toArray();
-                }
-            } else {
-                if ($as_object) {
-                    $value =& $obj;
-                } else {
-                    $value = $obj->toArray();
-                }
-                if ($id_as_key === 'parentid') {
-                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] =& $value;
-                } else {
-                    $ret[$obj->getVar($this->keyName)] = $value;
-                }
-            }
-            unset($obj);
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param  null  $criteria
-     * @param  int   $limit
-     * @param  int   $start
-     * @return array
-     */
-    public function getListD($criteria = null, $limit = 0, $start = 0)
-    {
-        return $this->getList($criteria, $limit, $start, true);
-    }
-
-    /**
-     * Retrieve a list of objects as arrays - DON'T USE WITH JOINT KEYS
-     *
-     * @param CriteriaElement $criteria {@link CriteriaElement} conditions to be met
-     * @param int    $limit    Max number of objects to fetch
-     * @param int    $start    Which record to start at
-     *
-     * @param  bool  $debug
-     * @return array
-     */
-    public function getList(CriteriaElement $criteria = null, $limit = 0, $start = 0, $debug = false)
-    {
-        $ret = array();
-        if ($criteria === null) {
-            $criteria = new CriteriaCompo();
-        }
-
-        if ($criteria->getSort() === '') {
-            $criteria->setSort($this->getIdentifierName());
-        }
-
-        $sql = 'SELECT ' . (is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
-        if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->getIdentifierName();
-        }
-        $sql .= ' FROM ' . $this->table . ' AS ' . $this->_itemname;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
-            }
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-
-        if ($debug) {
-            xoops_debug($sql);
-        }
-
-        $result = $this->db->query($sql, $limit, $start);
-        if (!$result) {
-            return $ret;
-        }
-
-        $myts = MyTextSanitizer::getInstance();
-        while (false !== ($myrow = $this->db->fetchArray($result))) {
-            //identifiers should be textboxes, so sanitize them like that
-            $ret[$myrow[$this->keyName]] = empty($this->identifierName) ? 1 : $myts->displayTarea($myrow[$this->identifierName]);
-        }
-
-        return $ret;
-    }
-
-    /**
-     * count objects matching a condition
-     *
-     * @param  CriteriaElement $criteria {@link CriteriaElement} to match
-     * @return int    count of objects
-     */
-    public function getCount(CriteriaElement $criteria = null)
-    {
-        $field   = '';
-        $groupby = false;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            if ($criteria->groupby !== '') {
-                $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
-            }
-        }
-        /**
-         * if we have a generalSQL, lets used this one.
-         * This needs to be improved...
-         */
-        if ($this->generalSQL) {
-            $sql = $this->generalSQL;
-            $sql = str_replace('SELECT *', 'SELECT COUNT(*)', $sql);
-        } else {
-            $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table . ' AS ' . $this->_itemname;
-        }
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->groupby !== '') {
-                $sql .= $criteria->getGroupby();
-            }
-        }
-
-        $result = $this->db->query($sql);
-        if (!$result) {
-            return 0;
-        }
-        if ($groupby === false) {
-            list($count) = $this->db->fetchRow($result);
-
-            return $count;
-        } else {
-            $ret = array();
-            while (false !== (list($id, $count) = $this->db->fetchRow($result))) {
-                $ret[$id] = $count;
-            }
-
-            return $ret;
-        }
-    }
-
-    /**
-     * delete an object from the database
-     *
-     * @param  XoopsObject $obj   reference to the object to delete
-     * @param  bool        $force
-     * @return bool        FALSE if failed.
-     */
-    public function delete(XoopsObject $obj, $force = false)
-    {
-        $eventResult = $this->executeEvent('beforeDelete', $obj);
-        if (!$eventResult) {
-            $obj->setErrors('An error occured during the BeforeDelete event');
-
-            return false;
-        }
-
-        if (is_array($this->keyName)) {
-            $clause = array();
-            for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
-            }
-            $whereclause = implode(' AND ', $clause);
-        } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
-        }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
-        if (false !== $force) {
-            $result = $this->db->queryF($sql);
-        } else {
-            $result = $this->db->query($sql);
-        }
-        if (!$result) {
-            return false;
-        }
-
-        $eventResult = $this->executeEvent('afterDelete', $obj);
-        if (!$eventResult) {
-            $obj->setErrors('An error occured during the AfterDelete event');
-
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * @param $event
-     */
-    public function disableEvent($event)
-    {
-        if (is_array($event)) {
-            foreach ($event as $v) {
-                $this->_disabledEvents[] = $v;
-            }
-        } else {
-            $this->_disabledEvents[] = $event;
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function getPermissions()
-    {
-        return $this->permissionsArray;
-    }
-
-    /**
-     * insert a new object in the database
-     *
-     * @param  XoopsObject $obj         reference to the object
-     * @param  bool        $force       whether to force the query execution despite security settings
-     * @param  bool        $checkObject check if the object is dirty and clean the attributes
-     * @param  bool        $debug
-     * @return bool        FALSE if failed, TRUE if already present and unchanged or successful
-     */
-    public function insert(XoopsObject $obj, $force = false, $checkObject = true, $debug = false)
-    {
-        if ($checkObject !== false) {
-            if (!is_object($obj)) {
-                return false;
-            }
-            /**
-             * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
-             */
-            if (!is_a($obj, $this->className)) {
-                $obj->setError(get_class($obj) . ' Differs from ' . $this->className);
-
-                return false;
-            }
-            if (!$obj->isDirty()) {
-                $obj->setErrors('Not dirty'); //will usually not be outputted as errors are not displayed when the method returns true, but it can be helpful when troubleshooting code - Mith
-
-                return true;
-            }
-        }
-
-        if ($obj->seoEnabled) {
-            // Auto create meta tags if empty
-            $smartobjectMetagen = new SmartMetagen($obj->title(), $obj->getVar('meta_keywords'), $obj->summary());
-
-            if (!$obj->getVar('meta_keywords') || !$obj->getVar('meta_description')) {
-                if (!$obj->meta_keywords()) {
-                    $obj->setVar('meta_keywords', $smartobjectMetagen->_keywords);
-                }
-
-                if (!$obj->meta_description()) {
-                    $obj->setVar('meta_description', $smartobjectMetagen->_meta_description);
-                }
-            }
-
-            // Auto create short_url if empty
-            if (!$obj->short_url()) {
-                $obj->setVar('short_url', $smartobjectMetagen->generateSeoTitle($obj->title('n'), false));
-            }
-        }
-
-        $eventResult = $this->executeEvent('beforeSave', $obj);
-        if (!$eventResult) {
-            $obj->setErrors('An error occured during the BeforeSave event');
-
-            return false;
-        }
-
-        if ($obj->isNew()) {
-            $eventResult = $this->executeEvent('beforeInsert', $obj);
-            if (!$eventResult) {
-                $obj->setErrors('An error occured during the BeforeInsert event');
-
-                return false;
-            }
-        } else {
-            $eventResult = $this->executeEvent('beforeUpdate', $obj);
-            if (!$eventResult) {
-                $obj->setErrors('An error occured during the BeforeUpdate event');
-
-                return false;
-            }
-        }
-        if (!$obj->cleanVars()) {
-            $obj->setErrors('Variables were not cleaned properly.');
-
-            return false;
-        }
-        $fieldsToStoreInDB = array();
-        foreach ($obj->cleanVars as $k => $v) {
-            if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
-                $cleanvars[$k] = (int)$v;
-            } elseif (is_array($v)) {
-                $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
-            } else {
-                $cleanvars[$k] = $this->db->quoteString($v);
-            }
-            if ($obj->vars[$k]['persistent']) {
-                $fieldsToStoreInDB[$k] = $cleanvars[$k];
-            }
-        }
-        if ($obj->isNew()) {
-            if (!is_array($this->keyName)) {
-                if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
-                }
-            }
-
-            $sql = 'INSERT INTO ' . $this->table . ' (' . implode(',', array_keys($fieldsToStoreInDB)) . ') VALUES (' . implode(',', array_values($fieldsToStoreInDB)) . ')';
-        } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
-            foreach ($fieldsToStoreInDB as $key => $value) {
-                if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
-                    continue;
-                }
-                if (isset($notfirst)) {
-                    $sql .= ',';
-                }
-                $sql .= ' ' . $key . ' = ' . $value;
-                $notfirst = true;
-            }
-            if (is_array($this->keyName)) {
-                $whereclause = '';
-                for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                    if ($i > 0) {
-                        $whereclause .= ' AND ';
-                    }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
-                }
-            } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
-            }
-            $sql .= ' WHERE ' . $whereclause;
-        }
-
-        if ($debug) {
-            xoops_debug($sql);
-        }
-
-        if (false != $force) {
-            $result = $this->db->queryF($sql);
-        } else {
-            $result = $this->db->query($sql);
-        }
-
-        if (!$result) {
-            $obj->setErrors($this->db->error());
-
-            return false;
-        }
-
-        if ($obj->isNew() && !is_array($this->keyName)) {
-            $obj->assignVar($this->keyName, $this->db->getInsertId());
-        }
-        $eventResult = $this->executeEvent('afterSave', $obj);
-        if (!$eventResult) {
-            $obj->setErrors('An error occured during the AfterSave event');
-
-            return false;
-        }
-
-        if ($obj->isNew()) {
-            $obj->unsetNew();
-            $eventResult = $this->executeEvent('afterInsert', $obj);
-            if (!$eventResult) {
-                $obj->setErrors('An error occured during the AfterInsert event');
-
-                return false;
-            }
-        } else {
-            $eventResult = $this->executeEvent('afterUpdate', $obj);
-            if (!$eventResult) {
-                $obj->setErrors('An error occured during the AfterUpdate event');
-
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * @param       $obj
-     * @param  bool $force
-     * @param  bool $checkObject
-     * @param  bool $debug
-     * @return bool
-     */
-    public function insertD($obj, $force = false, $checkObject = true, $debug = false)
-    {
-        return $this->insert($obj, $force, $checkObject, true);
-    }
-
-    /**
-     * Change a value for objects with a certain criteria
-     *
-     * @param string $fieldname  Name of the field
-     * @param string $fieldvalue Value to write
-     * @param CriteriaElement $criteria   {@link CriteriaElement}
-     *
-     * @param  bool $force
-     * @return bool
-     */
-    public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = null, $force = false)
-    {
-        $set_clause = $fieldname . ' = ';
-        if (is_numeric($fieldvalue)) {
-            $set_clause .= $fieldvalue;
-        } elseif (is_array($fieldvalue)) {
-            $set_clause .= $this->db->quoteString(implode(',', $fieldvalue));
-        } else {
-            $set_clause .= $this->db->quoteString($fieldvalue);
-        }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-        }
-        if (false != $force) {
-            $result = $this->db->queryF($sql);
-        } else {
-            $result = $this->db->query($sql);
-        }
-        if (!$result) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * delete all objects meeting the conditions
-     *
-     * @param  CriteriaElement $criteria {@link CriteriaElement} with conditions to meet
-     * @return bool
-     */
-
-    public function deleteAll(CriteriaElement $criteria = null)
-    {
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
-            if (!$this->db->query($sql)) {
-                return false;
-            }
-            $rows = $this->db->getAffectedRows();
-
-            return $rows > 0 ? $rows : true;
-        }
-
-        return false;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getModuleInfo()
-    {
-        return smart_getModuleInfo($this->_moduleName);
-    }
-
-    /**
-     * @return bool
-     */
-    public function getModuleConfig()
-    {
-        return smart_getModuleConfig($this->_moduleName);
-    }
-
-    /**
-     * @return string
-     */
-    public function getModuleItemString()
-    {
-        $ret = $this->_moduleName . '_' . $this->_itemname;
-
-        return $ret;
-    }
-
-    /**
-     * @param $object
-     */
-    public function updateCounter($object)
-    {
-        if (isset($object->vars['counter'])) {
-            $new_counter = $object->getVar('counter') + 1;
-            $sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
-            $this->query($sql, null, true);
-        }
-    }
-
-    /**
-     * Execute the function associated with an event
-     * This method will check if the function is available
-     *
-     * @param  string $event           name of the event
-     * @param         $executeEventObj
-     * @return mixed  result of the execution of the function or FALSE if the function was not executed
-     * @internal param object $obj $object on which is performed the event
-     */
-    public function executeEvent($event, &$executeEventObj)
-    {
-        if (!in_array($event, $this->_disabledEvents)) {
-            if (method_exists($this, $event)) {
-                $ret = $this->$event($executeEventObj);
-            } else {
-                // check to see if there is a hook for this event
-                if (isset($this->_eventHooks[$event])) {
-                    $method = $this->_eventHooks[$event];
-                    // check to see if the method specified by this hook exists
-                    if (method_exists($this, $method)) {
-                        $ret = $this->$method($executeEventObj);
-                    }
-                }
-                $ret = true;
-            }
-
-            return $ret;
-        }
-
-        return true;
-    }
-
-    /**
-     * @param  bool   $withprefix
-     * @return string
-     */
-    public function getIdentifierName($withprefix = true)
-    {
-        if ($withprefix) {
-            return $this->_itemname . '.' . $this->identifierName;
-        } else {
-            return $this->identifierName;
-        }
-    }
+	public $_itemname;
+
+	/**
+	 * Name of the table use to store this {@link SmartObject}
+	 *
+	 * Note that the name of the table needs to be free of the database prefix.
+	 * For example "smartsection_categories"
+	 * @var string
+	 */
+	public $table;
+
+	/**
+	 * Name of the table key that uniquely identify each {@link SmartObject}
+	 *
+	 * For example: "categoryid"
+	 * @var string
+	 */
+	public $keyName;
+
+	/**
+	 * Name of the class derived from {@link SmartObject} and which this handler is handling
+	 *
+	 * Note that this string needs to be lowercase
+	 *
+	 * For example: "smartsectioncategory"
+	 * @var string
+	 */
+	public $className;
+
+	/**
+	 * Name of the field which properly identify the {@link SmartObject}
+	 *
+	 * For example: "name" (this will be the category's name)
+	 * @var string
+	 */
+	public $identifierName;
+
+	/**
+	 * Name of the field which will be use as a summary for the object
+	 *
+	 * For example: "summary"
+	 * @var string
+	 */
+	public $summaryName;
+
+	/**
+	 * Page name use to basically manage and display the {@link SmartObject}
+	 *
+	 * This page needs to be the same in user side and admin side
+	 *
+	 * For example category.php - we will deduct smartsection/category.php as well as smartsection/admin/category.php
+	 * @todo this could probably be automatically deducted from the class name - for example, the class SmartsectionCategory will have "category.php" as it's managing page
+	 * @var string
+	 */
+	public $_page;
+
+	/**
+	 * Full path of the module using this {@link SmartObject}
+	 *
+	 * <code>XOOPS_URL . "/modules/smartsection/"</code>
+	 * @todo this could probably be automatically deducted from the class name as it is always prefixed with the module name
+	 * @var string
+	 */
+	public $_modulePath;
+
+	public $_moduleUrl;
+
+	public $_moduleName;
+
+	public $_uploadUrl;
+
+	public $_uploadPath;
+
+	public $_allowedMimeTypes = 0;
+
+	public $_maxFileSize = 1000000;
+
+	public $_maxWidth = 500;
+
+	public $_maxHeight = 500;
+
+	public $highlightFields = array();
+
+	/**
+	 * Array containing the events name and functions
+	 *
+	 * @var array
+	 */
+	public $eventArray = array();
+
+	/**
+	 * Array containing the permissions that this handler will manage on the objects
+	 *
+	 * @var array
+	 */
+	public $permissionsArray = false;
+
+	public $generalSQL = false;
+
+	public $_eventHooks     = array();
+	public $_disabledEvents = array();
+
+	/**
+	 * Constructor - called from child classes
+	 *
+	 * @param XoopsDatabase $db           {@link XoopsDatabase}
+	 *                                           object
+	 * @param                      $itemname
+	 * @param string               $keyname      Name of the table key that uniquely identify each {@link SmartObject}
+	 * @param string               $idenfierName Name of the field which properly identify the {@link SmartObject}
+	 * @param                      $summaryName
+	 * @param                      $modulename
+	 * @internal param string $tablename Name of the table use to store this <a href='psi_element://SmartObject'>SmartObject</a>
+	 * @internal param Name $string of the class derived from <a href='psi_element://SmartObject'>SmartObject</a> and which this handler is handling and which this handler is handling
+	 * @internal param string $page Page name use to basically manage and display the <a href='psi_element://SmartObject'>SmartObject</a>
+	 * @internal param string $moduleName name of the module
+	 */
+	public function __construct(XoopsDatabase $db, $itemname, $keyname, $idenfierName, $summaryName, $modulename)
+	{
+		parent::__construct($db);
+
+		$this->_itemname      = $itemname;
+		$this->_moduleName    = $modulename;
+		$this->table          = $db->prefix($modulename . '_' . $itemname);
+		$this->keyName        = $keyname;
+		$this->className      = ucfirst($modulename) . ucfirst($itemname);
+		$this->identifierName = $idenfierName;
+		$this->summaryName    = $summaryName;
+		$this->_page          = $itemname . '.php';
+		$this->_modulePath    = XOOPS_ROOT_PATH . '/modules/' . $this->_moduleName . '/';
+		$this->_moduleUrl     = XOOPS_URL . '/modules/' . $this->_moduleName . '/';
+		$this->_uploadPath    = XOOPS_UPLOAD_PATH . '/' . $this->_moduleName . '/';
+		$this->_uploadUrl     = XOOPS_UPLOAD_URL . '/' . $this->_moduleName . '/';
+	}
+
+	/**
+	 * @param $event
+	 * @param $method
+	 */
+	public function addEventHook($event, $method)
+	{
+		$this->_eventHooks[$event] = $method;
+	}
+
+	/**
+	 * Add a permission that this handler will manage for its objects
+	 *
+	 * Example: $this->addPermission('view', _AM_SSHOP_CAT_PERM_READ, _AM_SSHOP_CAT_PERM_READ_DSC);
+	 *
+	 * @param string      $perm_name   name of the permission
+	 * @param string      $caption     caption of the control that will be displayed in the form
+	 * @param bool|string $description description of the control that will be displayed in the form
+	 */
+	public function addPermission($perm_name, $caption, $description = false)
+	{
+		include_once(SMARTOBJECT_ROOT_PATH . 'class/smartobjectpermission.php');
+
+		$this->permissionsArray[] = array(
+			'perm_name'   => $perm_name,
+			'caption'     => $caption,
+			'description' => $description
+		);
+	}
+
+	/**
+	 * @param $criteria
+	 * @param $perm_name
+	 * @return bool
+	 */
+	public function setGrantedObjectsCriteria(&$criteria, $perm_name)
+	{
+		$smartPermissionsHandler = new SmartobjectPermissionHandler($this);
+		$grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
+		if (count($grantedItems) > 0) {
+			$criteria->add(new Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
+
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * @param bool $_uploadPath
+	 * @param bool $_allowedMimeTypes
+	 * @param bool $_maxFileSize
+	 * @param bool $_maxWidth
+	 * @param bool $_maxHeight
+	 */
+	public function setUploaderConfig($_uploadPath = false, $_allowedMimeTypes = false, $_maxFileSize = false, $_maxWidth = false, $_maxHeight = false)
+	{
+		$this->_uploadPath       = $_uploadPath ?: $this->_uploadPath;
+		$this->_allowedMimeTypes = $_allowedMimeTypes ?: $this->_allowedMimeTypes;
+		$this->_maxFileSize      = $_maxFileSize ?: $this->_maxFileSize;
+		$this->_maxWidth         = $_maxWidth ?: $this->_maxWidth;
+		$this->_maxHeight        = $_maxHeight ?: $this->_maxHeight;
+	}
+
+	/**
+	 * create a new {@link SmartObject}
+	 *
+	 * @param bool $isNew Flag the new objects as "new"?
+	 *
+	 * @return SmartObject {@link SmartObject}
+	 */
+	public function create($isNew = true)
+	{
+		$obj = new $this->className($this);
+		$obj->setImageDir($this->getImageUrl(), $this->getImagePath());
+		if (!$obj->handler) {
+			$obj->handler =& $this;
+		}
+
+		if ($isNew === true) {
+			$obj->setNew();
+		}
+
+		return $obj;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getImageUrl()
+	{
+		return $this->_uploadUrl . $this->_itemname . '/';
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getImagePath()
+	{
+		$dir = $this->_uploadPath . $this->_itemname;
+		if (!file_exists($dir)) {
+			smart_admin_mkdir($dir);
+		}
+
+		return $dir . '/';
+	}
+
+	/**
+	 * retrieve a {@link SmartObject}
+	 *
+	 * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
+	 * @param  bool  $as_object whether to return an object or an array
+	 * @param  bool  $debug
+	 * @param  bool  $criteria
+	 * @return mixed reference to the <a href='psi_element://SmartObject'>SmartObject</a>, FALSE if failed
+	 *                         FALSE if failed
+	 */
+	public function get($id, $as_object = true, $debug = false, $criteria = false)
+	{
+		if (!$criteria) {
+			$criteria = new CriteriaCompo();
+		}
+		if (is_array($this->keyName)) {
+			for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
+				/**
+				 * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
+				 * Is the fact that we removed the (int)() represents a security risk ?
+				 */
+				//$criteria->add(new Criteria($this->keyName[$i], ($id[$i]), '=', $this->_itemname));
+				$criteria->add(new Criteria($this->keyName[$i], $id[$i], '=', $this->_itemname));
+			}
+		} else {
+			//$criteria = new Criteria($this->keyName, (int)($id), '=', $this->_itemname);
+			/**
+			 * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
+			 * Is the fact that we removed the (int)() represents a security risk ?
+			 */
+			$criteria->add(new Criteria($this->keyName, $id, '=', $this->_itemname));
+		}
+		$criteria->setLimit(1);
+		if ($debug) {
+			$obj_array = $this->getObjectsD($criteria, false, $as_object);
+		} else {
+			$obj_array = $this->getObjects($criteria, false, $as_object);
+			//patch: weird bug of indexing by id even if id_as_key = false;
+			if (!isset($obj_array[0]) && is_object($obj_array[$id])) {
+				$obj_array[0] = $obj_array[$id];
+				unset($obj_array[$id]);
+				$obj_array[0]->unsetNew();
+			}
+		}
+
+		if (count($obj_array) != 1) {
+			$obj = $this->create();
+
+			return $obj;
+		}
+
+		return $obj_array[0];
+	}
+
+	/**
+	 * retrieve a {@link SmartObject}
+	 *
+	 * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
+	 * @param  bool  $as_object whether to return an object or an array
+	 * @return mixed reference to the {@link SmartObject}, FALSE if failed
+	 */
+	public function &getD($id, $as_object = true)
+	{
+		return $this->get($id, $as_object, true);
+	}
+
+	/**
+	 * retrieve objects from the database
+	 *
+	 * @param CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
+	 * @param bool   $id_as_key use the ID as key for the array?
+	 * @param bool   $as_object return an array of objects?
+	 *
+	 * @param  bool  $sql
+	 * @param  bool  $debug
+	 * @return array
+	 */
+	public function getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $sql = false, $debug = false)
+	{
+		$ret   = array();
+		$limit = $start = 0;
+
+		if ($this->generalSQL) {
+			$sql = $this->generalSQL;
+		} elseif (!$sql) {
+			$sql = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname;
+		}
+
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->getSort() !== '') {
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+			}
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+		if ($debug) {
+			xoops_debug($sql);
+		}
+
+		$result = $this->db->query($sql, $limit, $start);
+		if (!$result) {
+			return $ret;
+		}
+
+		return $this->convertResultSet($result, $id_as_key, $as_object);
+	}
+
+	/**
+	 * @param        $sql
+	 * @param        $criteria
+	 * @param  bool  $force
+	 * @param  bool  $debug
+	 * @return array
+	 */
+	public function query($sql, $criteria, $force = false, $debug = false)
+	{
+		$ret = array();
+
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->groupby) {
+				$sql .= $criteria->getGroupby();
+			}
+			if ($criteria->getSort() !== '') {
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+			}
+		}
+		if ($debug) {
+			xoops_debug($sql);
+		}
+
+		if ($force) {
+			$result = $this->db->queryF($sql);
+		} else {
+			$result = $this->db->query($sql);
+		}
+
+		if (!$result) {
+			return $ret;
+		}
+
+		while (false !== ($myrow = $this->db->fetchArray($result))) {
+			$ret[] = $myrow;
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * retrieve objects with debug mode - so will show the query
+	 *
+	 * @param CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
+	 * @param bool   $id_as_key use the ID as key for the array?
+	 * @param bool   $as_object return an array of objects?
+	 *
+	 * @param  bool  $sql
+	 * @return array
+	 */
+	public function getObjectsD(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $sql = false)
+	{
+		return $this->getObjects($criteria, $id_as_key, $as_object, $sql, true);
+	}
+
+	/**
+	 * @param $arrayObjects
+	 * @return array|bool
+	 */
+	public function getObjectsAsArray($arrayObjects)
+	{
+		$ret = array();
+		foreach ($arrayObjects as $key => $object) {
+			$ret[$key] = $object->toArray();
+		}
+		if (count($ret > 0)) {
+			return $ret;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Convert a database resultset to a returnable array
+	 *
+	 * @param object $result    database resultset
+	 * @param bool   $id_as_key - should NOT be used with joint keys
+	 * @param bool   $as_object
+	 *
+	 * @return array
+	 */
+	public function convertResultSet($result, $id_as_key = false, $as_object = true)
+	{
+		$ret = array();
+		while (false !== ($myrow = $this->db->fetchArray($result))) {
+			$obj = $this->create(false);
+			$obj->assignVars($myrow);
+			if (!$id_as_key) {
+				if ($as_object) {
+					$ret[] =& $obj;
+				} else {
+					$ret[] = $obj->toArray();
+				}
+			} else {
+				if ($as_object) {
+					$value =& $obj;
+				} else {
+					$value = $obj->toArray();
+				}
+				if ($id_as_key === 'parentid') {
+					$ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] =& $value;
+				} else {
+					$ret[$obj->getVar($this->keyName)] = $value;
+				}
+			}
+			unset($obj);
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param  null  $criteria
+	 * @param  int   $limit
+	 * @param  int   $start
+	 * @return array
+	 */
+	public function getListD($criteria = null, $limit = 0, $start = 0)
+	{
+		return $this->getList($criteria, $limit, $start, true);
+	}
+
+	/**
+	 * Retrieve a list of objects as arrays - DON'T USE WITH JOINT KEYS
+	 *
+	 * @param CriteriaElement $criteria {@link CriteriaElement} conditions to be met
+	 * @param int    $limit    Max number of objects to fetch
+	 * @param int    $start    Which record to start at
+	 *
+	 * @param  bool  $debug
+	 * @return array
+	 */
+	public function getList(CriteriaElement $criteria = null, $limit = 0, $start = 0, $debug = false)
+	{
+		$ret = array();
+		if ($criteria === null) {
+			$criteria = new CriteriaCompo();
+		}
+
+		if ($criteria->getSort() === '') {
+			$criteria->setSort($this->getIdentifierName());
+		}
+
+		$sql = 'SELECT ' . (is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
+		if (!empty($this->identifierName)) {
+			$sql .= ', ' . $this->getIdentifierName();
+		}
+		$sql .= ' FROM ' . $this->table . ' AS ' . $this->_itemname;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->getSort() !== '') {
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+			}
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+
+		if ($debug) {
+			xoops_debug($sql);
+		}
+
+		$result = $this->db->query($sql, $limit, $start);
+		if (!$result) {
+			return $ret;
+		}
+
+		$myts = MyTextSanitizer::getInstance();
+		while (false !== ($myrow = $this->db->fetchArray($result))) {
+			//identifiers should be textboxes, so sanitize them like that
+			$ret[$myrow[$this->keyName]] = empty($this->identifierName) ? 1 : $myts->displayTarea($myrow[$this->identifierName]);
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * count objects matching a condition
+	 *
+	 * @param  CriteriaElement $criteria {@link CriteriaElement} to match
+	 * @return int    count of objects
+	 */
+	public function getCount(CriteriaElement $criteria = null)
+	{
+		$field   = '';
+		$groupby = false;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			if ($criteria->groupby !== '') {
+				$groupby = true;
+				$field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+			}
+		}
+		/**
+		 * if we have a generalSQL, lets used this one.
+		 * This needs to be improved...
+		 */
+		if ($this->generalSQL) {
+			$sql = $this->generalSQL;
+			$sql = str_replace('SELECT *', 'SELECT COUNT(*)', $sql);
+		} else {
+			$sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table . ' AS ' . $this->_itemname;
+		}
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->groupby !== '') {
+				$sql .= $criteria->getGroupby();
+			}
+		}
+
+		$result = $this->db->query($sql);
+		if (!$result) {
+			return 0;
+		}
+		if ($groupby === false) {
+			list($count) = $this->db->fetchRow($result);
+
+			return $count;
+		} else {
+			$ret = array();
+			while (false !== (list($id, $count) = $this->db->fetchRow($result))) {
+				$ret[$id] = $count;
+			}
+
+			return $ret;
+		}
+	}
+
+	/**
+	 * delete an object from the database
+	 *
+	 * @param  XoopsObject $obj   reference to the object to delete
+	 * @param  bool        $force
+	 * @return bool        FALSE if failed.
+	 */
+	public function delete(XoopsObject $obj, $force = false)
+	{
+		$eventResult = $this->executeEvent('beforeDelete', $obj);
+		if (!$eventResult) {
+			$obj->setErrors('An error occured during the BeforeDelete event');
+
+			return false;
+		}
+
+		if (is_array($this->keyName)) {
+			$clause = array();
+			for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
+				$clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+			}
+			$whereclause = implode(' AND ', $clause);
+		} else {
+			$whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+		}
+		$sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+		if (false !== $force) {
+			$result = $this->db->queryF($sql);
+		} else {
+			$result = $this->db->query($sql);
+		}
+		if (!$result) {
+			return false;
+		}
+
+		$eventResult = $this->executeEvent('afterDelete', $obj);
+		if (!$eventResult) {
+			$obj->setErrors('An error occured during the AfterDelete event');
+
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param $event
+	 */
+	public function disableEvent($event)
+	{
+		if (is_array($event)) {
+			foreach ($event as $v) {
+				$this->_disabledEvents[] = $v;
+			}
+		} else {
+			$this->_disabledEvents[] = $event;
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getPermissions()
+	{
+		return $this->permissionsArray;
+	}
+
+	/**
+	 * insert a new object in the database
+	 *
+	 * @param  XoopsObject $obj         reference to the object
+	 * @param  bool        $force       whether to force the query execution despite security settings
+	 * @param  bool        $checkObject check if the object is dirty and clean the attributes
+	 * @param  bool        $debug
+	 * @return bool        FALSE if failed, TRUE if already present and unchanged or successful
+	 */
+	public function insert(XoopsObject $obj, $force = false, $checkObject = true, $debug = false)
+	{
+		if ($checkObject !== false) {
+			if (!is_object($obj)) {
+				return false;
+			}
+			/**
+			 * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
+			 */
+			if (!is_a($obj, $this->className)) {
+				$obj->setError(get_class($obj) . ' Differs from ' . $this->className);
+
+				return false;
+			}
+			if (!$obj->isDirty()) {
+				$obj->setErrors('Not dirty'); //will usually not be outputted as errors are not displayed when the method returns true, but it can be helpful when troubleshooting code - Mith
+
+				return true;
+			}
+		}
+
+		if ($obj->seoEnabled) {
+			// Auto create meta tags if empty
+			$smartobjectMetagen = new SmartMetagen($obj->title(), $obj->getVar('meta_keywords'), $obj->summary());
+
+			if (!$obj->getVar('meta_keywords') || !$obj->getVar('meta_description')) {
+				if (!$obj->meta_keywords()) {
+					$obj->setVar('meta_keywords', $smartobjectMetagen->_keywords);
+				}
+
+				if (!$obj->meta_description()) {
+					$obj->setVar('meta_description', $smartobjectMetagen->_meta_description);
+				}
+			}
+
+			// Auto create short_url if empty
+			if (!$obj->short_url()) {
+				$obj->setVar('short_url', $smartobjectMetagen->generateSeoTitle($obj->title('n'), false));
+			}
+		}
+
+		$eventResult = $this->executeEvent('beforeSave', $obj);
+		if (!$eventResult) {
+			$obj->setErrors('An error occured during the BeforeSave event');
+
+			return false;
+		}
+
+		if ($obj->isNew()) {
+			$eventResult = $this->executeEvent('beforeInsert', $obj);
+			if (!$eventResult) {
+				$obj->setErrors('An error occured during the BeforeInsert event');
+
+				return false;
+			}
+		} else {
+			$eventResult = $this->executeEvent('beforeUpdate', $obj);
+			if (!$eventResult) {
+				$obj->setErrors('An error occured during the BeforeUpdate event');
+
+				return false;
+			}
+		}
+		if (!$obj->cleanVars()) {
+			$obj->setErrors('Variables were not cleaned properly.');
+
+			return false;
+		}
+		$fieldsToStoreInDB = array();
+		foreach ($obj->cleanVars as $k => $v) {
+			if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
+				$cleanvars[$k] = (int)$v;
+			} elseif (is_array($v)) {
+				$cleanvars[$k] = $this->db->quoteString(implode(',', $v));
+			} else {
+				$cleanvars[$k] = $this->db->quoteString($v);
+			}
+			if ($obj->vars[$k]['persistent']) {
+				$fieldsToStoreInDB[$k] = $cleanvars[$k];
+			}
+		}
+		if ($obj->isNew()) {
+			if (!is_array($this->keyName)) {
+				if ($cleanvars[$this->keyName] < 1) {
+					$cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+				}
+			}
+
+			$sql = 'INSERT INTO ' . $this->table . ' (' . implode(',', array_keys($fieldsToStoreInDB)) . ') VALUES (' . implode(',', array_values($fieldsToStoreInDB)) . ')';
+		} else {
+			$sql = 'UPDATE ' . $this->table . ' SET';
+			foreach ($fieldsToStoreInDB as $key => $value) {
+				if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
+					continue;
+				}
+				if (isset($notfirst)) {
+					$sql .= ',';
+				}
+				$sql .= ' ' . $key . ' = ' . $value;
+				$notfirst = true;
+			}
+			if (is_array($this->keyName)) {
+				$whereclause = '';
+				for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
+					if ($i > 0) {
+						$whereclause .= ' AND ';
+					}
+					$whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+				}
+			} else {
+				$whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+			}
+			$sql .= ' WHERE ' . $whereclause;
+		}
+
+		if ($debug) {
+			xoops_debug($sql);
+		}
+
+		if (false != $force) {
+			$result = $this->db->queryF($sql);
+		} else {
+			$result = $this->db->query($sql);
+		}
+
+		if (!$result) {
+			$obj->setErrors($this->db->error());
+
+			return false;
+		}
+
+		if ($obj->isNew() && !is_array($this->keyName)) {
+			$obj->assignVar($this->keyName, $this->db->getInsertId());
+		}
+		$eventResult = $this->executeEvent('afterSave', $obj);
+		if (!$eventResult) {
+			$obj->setErrors('An error occured during the AfterSave event');
+
+			return false;
+		}
+
+		if ($obj->isNew()) {
+			$obj->unsetNew();
+			$eventResult = $this->executeEvent('afterInsert', $obj);
+			if (!$eventResult) {
+				$obj->setErrors('An error occured during the AfterInsert event');
+
+				return false;
+			}
+		} else {
+			$eventResult = $this->executeEvent('afterUpdate', $obj);
+			if (!$eventResult) {
+				$obj->setErrors('An error occured during the AfterUpdate event');
+
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param       $obj
+	 * @param  bool $force
+	 * @param  bool $checkObject
+	 * @param  bool $debug
+	 * @return bool
+	 */
+	public function insertD($obj, $force = false, $checkObject = true, $debug = false)
+	{
+		return $this->insert($obj, $force, $checkObject, true);
+	}
+
+	/**
+	 * Change a value for objects with a certain criteria
+	 *
+	 * @param string $fieldname  Name of the field
+	 * @param string $fieldvalue Value to write
+	 * @param CriteriaElement $criteria   {@link CriteriaElement}
+	 *
+	 * @param  bool $force
+	 * @return bool
+	 */
+	public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = null, $force = false)
+	{
+		$set_clause = $fieldname . ' = ';
+		if (is_numeric($fieldvalue)) {
+			$set_clause .= $fieldvalue;
+		} elseif (is_array($fieldvalue)) {
+			$set_clause .= $this->db->quoteString(implode(',', $fieldvalue));
+		} else {
+			$set_clause .= $this->db->quoteString($fieldvalue);
+		}
+		$sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+		}
+		if (false != $force) {
+			$result = $this->db->queryF($sql);
+		} else {
+			$result = $this->db->query($sql);
+		}
+		if (!$result) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * delete all objects meeting the conditions
+	 *
+	 * @param  CriteriaElement $criteria {@link CriteriaElement} with conditions to meet
+	 * @return bool
+	 */
+
+	public function deleteAll(CriteriaElement $criteria = null)
+	{
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql = 'DELETE FROM ' . $this->table;
+			$sql .= ' ' . $criteria->renderWhere();
+			if (!$this->db->query($sql)) {
+				return false;
+			}
+			$rows = $this->db->getAffectedRows();
+
+			return $rows > 0 ? $rows : true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getModuleInfo()
+	{
+		return smart_getModuleInfo($this->_moduleName);
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getModuleConfig()
+	{
+		return smart_getModuleConfig($this->_moduleName);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getModuleItemString()
+	{
+		$ret = $this->_moduleName . '_' . $this->_itemname;
+
+		return $ret;
+	}
+
+	/**
+	 * @param $object
+	 */
+	public function updateCounter($object)
+	{
+		if (isset($object->vars['counter'])) {
+			$new_counter = $object->getVar('counter') + 1;
+			$sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
+			$this->query($sql, null, true);
+		}
+	}
+
+	/**
+	 * Execute the function associated with an event
+	 * This method will check if the function is available
+	 *
+	 * @param  string $event           name of the event
+	 * @param         $executeEventObj
+	 * @return mixed  result of the execution of the function or FALSE if the function was not executed
+	 * @internal param object $obj $object on which is performed the event
+	 */
+	public function executeEvent($event, &$executeEventObj)
+	{
+		if (!in_array($event, $this->_disabledEvents)) {
+			if (method_exists($this, $event)) {
+				$ret = $this->$event($executeEventObj);
+			} else {
+				// check to see if there is a hook for this event
+				if (isset($this->_eventHooks[$event])) {
+					$method = $this->_eventHooks[$event];
+					// check to see if the method specified by this hook exists
+					if (method_exists($this, $method)) {
+						$ret = $this->$method($executeEventObj);
+					}
+				}
+				$ret = true;
+			}
+
+			return $ret;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param  bool   $withprefix
+	 * @return string
+	 */
+	public function getIdentifierName($withprefix = true)
+	{
+		if ($withprefix) {
+			return $this->_itemname . '.' . $this->identifierName;
+		} else {
+			return $this->identifierName;
+		}
+	}
 }

Spacing +49 added lines, -49 removed lines

@@ -148,16 +148,16 @@ 
 
         $this->_itemname      = $itemname;
         $this->_moduleName    = $modulename;
-        $this->table          = $db->prefix($modulename . '_' . $itemname);
+        $this->table          = $db->prefix($modulename.'_'.$itemname);
         $this->keyName        = $keyname;
-        $this->className      = ucfirst($modulename) . ucfirst($itemname);
+        $this->className      = ucfirst($modulename).ucfirst($itemname);
         $this->identifierName = $idenfierName;
         $this->summaryName    = $summaryName;
-        $this->_page          = $itemname . '.php';
-        $this->_modulePath    = XOOPS_ROOT_PATH . '/modules/' . $this->_moduleName . '/';
-        $this->_moduleUrl     = XOOPS_URL . '/modules/' . $this->_moduleName . '/';
-        $this->_uploadPath    = XOOPS_UPLOAD_PATH . '/' . $this->_moduleName . '/';
-        $this->_uploadUrl     = XOOPS_UPLOAD_URL . '/' . $this->_moduleName . '/';
+        $this->_page          = $itemname.'.php';
+        $this->_modulePath    = XOOPS_ROOT_PATH.'/modules/'.$this->_moduleName.'/';
+        $this->_moduleUrl     = XOOPS_URL.'/modules/'.$this->_moduleName.'/';
+        $this->_uploadPath    = XOOPS_UPLOAD_PATH.'/'.$this->_moduleName.'/';
+        $this->_uploadUrl     = XOOPS_UPLOAD_URL.'/'.$this->_moduleName.'/';
     }
 
     /**
@@ -180,7 +180,7 @@ 
      */
     public function addPermission($perm_name, $caption, $description = false)
     {
-        include_once(SMARTOBJECT_ROOT_PATH . 'class/smartobjectpermission.php');
+        include_once(SMARTOBJECT_ROOT_PATH.'class/smartobjectpermission.php');
 
         $this->permissionsArray[] = array(
             'perm_name'   => $perm_name,
@@ -199,7 +199,7 @@ 
         $smartPermissionsHandler = new SmartobjectPermissionHandler($this);
         $grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
         if (count($grantedItems) > 0) {
-            $criteria->add(new Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
+            $criteria->add(new Criteria($this->keyName, '('.implode(', ', $grantedItems).')', 'IN'));
 
             return true;
         } else {
@@ -235,7 +235,7 @@ 
         $obj = new $this->className($this);
         $obj->setImageDir($this->getImageUrl(), $this->getImagePath());
         if (!$obj->handler) {
-            $obj->handler =& $this;
+            $obj->handler = & $this;
         }
 
         if ($isNew === true) {
@@ -250,7 +250,7 @@ 
      */
     public function getImageUrl()
     {
-        return $this->_uploadUrl . $this->_itemname . '/';
+        return $this->_uploadUrl.$this->_itemname.'/';
     }
 
     /**
@@ -258,12 +258,12 @@ 
      */
     public function getImagePath()
     {
-        $dir = $this->_uploadPath . $this->_itemname;
+        $dir = $this->_uploadPath.$this->_itemname;
         if (!file_exists($dir)) {
             smart_admin_mkdir($dir);
         }
 
-        return $dir . '/';
+        return $dir.'/';
     }
 
     /**
@@ -351,13 +351,13 @@ 
         if ($this->generalSQL) {
             $sql = $this->generalSQL;
         } elseif (!$sql) {
-            $sql = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT * FROM '.$this->table.' AS '.$this->_itemname;
         }
 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -386,12 +386,12 @@ 
         $ret = array();
 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby) {
                 $sql .= $criteria->getGroupby();
             }
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
         }
         if ($debug) {
@@ -464,18 +464,18 @@ 
             $obj->assignVars($myrow);
             if (!$id_as_key) {
                 if ($as_object) {
-                    $ret[] =& $obj;
+                    $ret[] = & $obj;
                 } else {
                     $ret[] = $obj->toArray();
                 }
             } else {
                 if ($as_object) {
-                    $value =& $obj;
+                    $value = & $obj;
                 } else {
                     $value = $obj->toArray();
                 }
                 if ($id_as_key === 'parentid') {
-                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] =& $value;
+                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] = & $value;
                 } else {
                     $ret[$obj->getVar($this->keyName)] = $value;
                 }
@@ -518,15 +518,15 @@ 
             $criteria->setSort($this->getIdentifierName());
         }
 
-        $sql = 'SELECT ' . (is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
+        $sql = 'SELECT '.(is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
         if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->getIdentifierName();
+            $sql .= ', '.$this->getIdentifierName();
         }
-        $sql .= ' FROM ' . $this->table . ' AS ' . $this->_itemname;
+        $sql .= ' FROM '.$this->table.' AS '.$this->_itemname;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -563,7 +563,7 @@ 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
             if ($criteria->groupby !== '') {
                 $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+                $field   = $criteria->groupby.', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
             }
         }
         /**
@@ -574,10 +574,10 @@ 
             $sql = $this->generalSQL;
             $sql = str_replace('SELECT *', 'SELECT COUNT(*)', $sql);
         } else {
-            $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table.' AS '.$this->_itemname;
         }
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby !== '') {
                 $sql .= $criteria->getGroupby();
             }
@@ -620,13 +620,13 @@ 
         if (is_array($this->keyName)) {
             $clause = array();
             for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                $clause[] = $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
             }
             $whereclause = implode(' AND ', $clause);
         } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+            $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
         }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+        $sql = 'DELETE FROM '.$this->table.' WHERE '.$whereclause;
         if (false !== $force) {
             $result = $this->db->queryF($sql);
         } else {
@@ -687,7 +687,7 @@ 
              * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
              */
             if (!is_a($obj, $this->className)) {
-                $obj->setError(get_class($obj) . ' Differs from ' . $this->className);
+                $obj->setError(get_class($obj).' Differs from '.$this->className);
 
                 return false;
             }
@@ -748,7 +748,7 @@ 
         $fieldsToStoreInDB = array();
         foreach ($obj->cleanVars as $k => $v) {
             if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
-                $cleanvars[$k] = (int)$v;
+                $cleanvars[$k] = (int) $v;
             } elseif (is_array($v)) {
                 $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
             } else {
@@ -761,13 +761,13 @@ 
         if ($obj->isNew()) {
             if (!is_array($this->keyName)) {
                 if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+                    $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq');
                 }
             }
 
-            $sql = 'INSERT INTO ' . $this->table . ' (' . implode(',', array_keys($fieldsToStoreInDB)) . ') VALUES (' . implode(',', array_values($fieldsToStoreInDB)) . ')';
+            $sql = 'INSERT INTO '.$this->table.' ('.implode(',', array_keys($fieldsToStoreInDB)).') VALUES ('.implode(',', array_values($fieldsToStoreInDB)).')';
         } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
+            $sql = 'UPDATE '.$this->table.' SET';
             foreach ($fieldsToStoreInDB as $key => $value) {
                 if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
                     continue;
@@ -775,7 +775,7 @@ 
                 if (isset($notfirst)) {
                     $sql .= ',';
                 }
-                $sql .= ' ' . $key . ' = ' . $value;
+                $sql .= ' '.$key.' = '.$value;
                 $notfirst = true;
             }
             if (is_array($this->keyName)) {
@@ -784,12 +784,12 @@ 
                     if ($i > 0) {
                         $whereclause .= ' AND ';
                     }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                    $whereclause .= $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
                 }
             } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+                $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
             }
-            $sql .= ' WHERE ' . $whereclause;
+            $sql .= ' WHERE '.$whereclause;
         }
 
         if ($debug) {
@@ -862,7 +862,7 @@ 
      */
     public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = null, $force = false)
     {
-        $set_clause = $fieldname . ' = ';
+        $set_clause = $fieldname.' = ';
         if (is_numeric($fieldvalue)) {
             $set_clause .= $fieldvalue;
         } elseif (is_array($fieldvalue)) {
@@ -870,9 +870,9 @@ 
         } else {
             $set_clause .= $this->db->quoteString($fieldvalue);
         }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+        $sql = 'UPDATE '.$this->table.' SET '.$set_clause;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
         }
         if (false != $force) {
             $result = $this->db->queryF($sql);
@@ -896,8 +896,8 @@ 
     public function deleteAll(CriteriaElement $criteria = null)
     {
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql = 'DELETE FROM '.$this->table;
+            $sql .= ' '.$criteria->renderWhere();
             if (!$this->db->query($sql)) {
                 return false;
             }
@@ -930,7 +930,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->_moduleName . '_' . $this->_itemname;
+        $ret = $this->_moduleName.'_'.$this->_itemname;
 
         return $ret;
     }
@@ -942,7 +942,7 @@ 
     {
         if (isset($object->vars['counter'])) {
             $new_counter = $object->getVar('counter') + 1;
-            $sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
+            $sql         = 'UPDATE '.$this->table.' SET counter='.$new_counter.' WHERE '.$this->keyName.'='.$object->id();
             $this->query($sql, null, true);
         }
     }
@@ -986,7 +986,7 @@ 
     public function getIdentifierName($withprefix = true)
     {
         if ($withprefix) {
-            return $this->_itemname . '.' . $this->identifierName;
+            return $this->_itemname.'.'.$this->identifierName;
         } else {
             return $this->identifierName;
         }