mambax7 / smartobject

class/Dbupdater.php

Indentation +320 added lines, -321 removed lines

@@ -25,7 +25,6 @@ 
  * Contains the classes for updating database tables
  *
  * @license GNU
-
  */
 /**
  * SmartDbTable class
@@ -38,7 +37,7 @@ 
  */
 // defined('XOOPS_ROOT_PATH') || die('Restricted access');
 if (!defined('SMARTOBJECT_ROOT_PATH')) {
-    require_once XOOPS_ROOT_PATH . '/modules/smartobject/include/common.php';
+	require_once XOOPS_ROOT_PATH . '/modules/smartobject/include/common.php';
 }
 /**
  * Include the language constants for the SmartObjectDBUpdater
@@ -46,7 +45,7 @@ 
 global $xoopsConfig;
 $common_file = SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/smartdbupdater.php';
 if (!file_exists($common_file)) {
-    $common_file = SMARTOBJECT_ROOT_PATH . 'language/english/smartdbupdater.php';
+	$common_file = SMARTOBJECT_ROOT_PATH . 'language/english/smartdbupdater.php';
 }
 include $common_file;
 
@@ -62,328 +61,328 @@ 
  */
 class Dbupdater
 {
-    public $_dbTypesArray;
-
-    /**
-     * SmartobjectDbupdater constructor.
-     */
-    public function __construct()
-    {
-        $this->_dbTypesArray[XOBJ_DTYPE_TXTBOX]       = 'varchar(255)';
-        $this->_dbTypesArray[XOBJ_DTYPE_TXTAREA]      = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_INT]          = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_URL]          = 'varchar(255)';
-        $this->_dbTypesArray[XOBJ_DTYPE_EMAIL]        = 'varchar(255)';
-        $this->_dbTypesArray[XOBJ_DTYPE_ARRAY]        = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_OTHER]        = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_SOURCE]       = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_STIME]        = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_MTIME]        = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_LTIME]        = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_SIMPLE_ARRAY] = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_CURRENCY]     = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_FLOAT]        = 'float';
-        $this->_dbTypesArray[XOBJ_DTYPE_TIME_ONLY]    = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_URLLINK]      = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_FILE]         = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_IMAGE]        = 'varchar(255)';
-    }
-
-    /**
-     * Use to execute a general query
-     *
-     * @param string $query   query that will be executed
-     * @param string $goodmsg message displayed on success
-     * @param string $badmsg  message displayed on error
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function runQuery($query, $goodmsg, $badmsg)
-    {
-        global $xoopsDB;
-        $ret = $xoopsDB->query($query);
-        if (!$ret) {
-            echo "&nbsp;&nbsp;$badmsg<br>";
-
-            return false;
-        } else {
-            echo "&nbsp;&nbsp;$goodmsg<br>";
-
-            return true;
-        }
-    }
-
-    /**
-     * Use to rename a table
-     *
-     * @param string $from name of the table to rename
-     * @param string $to   new name of the renamed table
-     *
-     * @return bool true if success, false if an error occured
-     */
-    public function renameTable($from, $to)
-    {
-        global $xoopsDB;
-        $from  = $xoopsDB->prefix($from);
-        $to    = $xoopsDB->prefix($to);
-        $query = sprintf('ALTER TABLE %s RENAME %s', $from, $to);
-        $ret   = $xoopsDB->query($query);
-        if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE_ERR, $from) . '<br>';
-
-            return false;
-        } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE, $from, $to) . '<br>';
-
-            return true;
-        }
-    }
-
-    /**
-     * Use to update a table
-     *
-     * @param object $table {@link SmartDbTable} that will be updated
-     *
-     * @see DbTable
-     *
-     * @return bool true if success, false if an error occured
-     */
-    public function updateTable($table)
-    {
-        global $xoopsDB;
-        $ret = true;
-        // If table has a structure, create the table
-        if ($table->getStructure()) {
-            $ret = $table->createTable() && $ret;
-        }
-        // If table is flag for drop, drop it
-        if ($table->_flagForDrop) {
-            $ret = $table->dropTable() && $ret;
-        }
-        // If table has data, insert it
-        if ($table->getData()) {
-            $ret = $table->addData() && $ret;
-        }
-        // If table has new fields to be added, add them
-        if ($table->getNewFields()) {
-            $ret = $table->addNewFields() && $ret;
-        }
-        // If table has altered field, alter the table
-        if ($table->getAlteredFields()) {
-            $ret = $table->alterTable() && $ret;
-        }
-        // If table has updated field values, update the table
-        if ($table->getUpdatedFields()) {
-            $ret = $table->updateFieldsValues($table) && $ret;
-        }
-        // If table has dropped field, alter the table
-        if ($table->getDroppedFields()) {
-            $ret = $table->dropFields($table) && $ret;
-        }
-        //felix
-        // If table has updated field values, update the table
-        if ($table->getUpdatedWhere()) {
-            $ret = $table->UpdateWhereValues($table) && $ret;
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param $module
-     * @param $item
-     */
-    public function automaticUpgrade($module, $item)
-    {
-        if (is_array($item)) {
-            foreach ($item as $v) {
-                $this->upgradeObjectItem($module, $v);
-            }
-        } else {
-            $this->upgradeObjectItem($module, $item);
-        }
-    }
-
-    /**
-     * @param $var
-     * @return string
-     */
-    public function getFieldTypeFromVar($var)
-    {
-        $ret = isset($this->_dbTypesArray[$var['data_type']]) ? $this->_dbTypesArray[$var['data_type']] : 'text';
-
-        return $ret;
-    }
-
-    /**
-     * @param         $var
-     * @param  bool   $key
-     * @return string
-     */
-    public function getFieldDefaultFromVar($var, $key = false)
-    {
-        if ($var['value']) {
-            return $var['value'];
-        } else {
-            if (in_array($var['data_type'], [
-                XOBJ_DTYPE_INT,
-                XOBJ_DTYPE_STIME,
-                XOBJ_DTYPE_MTIME,
-                XOBJ_DTYPE_LTIME,
-                XOBJ_DTYPE_TIME_ONLY,
-                XOBJ_DTYPE_URLLINK,
-                XOBJ_DTYPE_FILE
-            ])) {
-                return '0';
-            } else {
-                return '';
-            }
-        }
-    }
-
-    /**
-     * @param $module
-     * @param $item
-     * @return bool
-     */
-    public function upgradeObjectItem($module, $item)
-    {
-        $moduleHandler = xoops_getModuleHandler($item, $module);
-        if (!$moduleHandler) {
-            return false;
-        }
-
-        $table      = new DbTable($module . '_' . $item);
-        $object     = $moduleHandler->create();
-        $objectVars = $object->getVars();
-
-        if (!$table->exists()) {
-            // table was never created, let's do it
-            $structure = '';
-            foreach ($objectVars as $key => $var) {
-                if ($var['persistent']) {
-                    $type = $this->getFieldTypeFromVar($var);
-                    if ($key == $moduleHandler->keyName) {
-                        $extra = 'auto_increment';
-                    } else {
-                        $default = $this->getFieldDefaultFromVar($var);
-                        $extra   = "default '$default'
+	public $_dbTypesArray;
+
+	/**
+	 * SmartobjectDbupdater constructor.
+	 */
+	public function __construct()
+	{
+		$this->_dbTypesArray[XOBJ_DTYPE_TXTBOX]       = 'varchar(255)';
+		$this->_dbTypesArray[XOBJ_DTYPE_TXTAREA]      = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_INT]          = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_URL]          = 'varchar(255)';
+		$this->_dbTypesArray[XOBJ_DTYPE_EMAIL]        = 'varchar(255)';
+		$this->_dbTypesArray[XOBJ_DTYPE_ARRAY]        = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_OTHER]        = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_SOURCE]       = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_STIME]        = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_MTIME]        = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_LTIME]        = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_SIMPLE_ARRAY] = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_CURRENCY]     = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_FLOAT]        = 'float';
+		$this->_dbTypesArray[XOBJ_DTYPE_TIME_ONLY]    = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_URLLINK]      = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_FILE]         = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_IMAGE]        = 'varchar(255)';
+	}
+
+	/**
+	 * Use to execute a general query
+	 *
+	 * @param string $query   query that will be executed
+	 * @param string $goodmsg message displayed on success
+	 * @param string $badmsg  message displayed on error
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function runQuery($query, $goodmsg, $badmsg)
+	{
+		global $xoopsDB;
+		$ret = $xoopsDB->query($query);
+		if (!$ret) {
+			echo "&nbsp;&nbsp;$badmsg<br>";
+
+			return false;
+		} else {
+			echo "&nbsp;&nbsp;$goodmsg<br>";
+
+			return true;
+		}
+	}
+
+	/**
+	 * Use to rename a table
+	 *
+	 * @param string $from name of the table to rename
+	 * @param string $to   new name of the renamed table
+	 *
+	 * @return bool true if success, false if an error occured
+	 */
+	public function renameTable($from, $to)
+	{
+		global $xoopsDB;
+		$from  = $xoopsDB->prefix($from);
+		$to    = $xoopsDB->prefix($to);
+		$query = sprintf('ALTER TABLE %s RENAME %s', $from, $to);
+		$ret   = $xoopsDB->query($query);
+		if (!$ret) {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE_ERR, $from) . '<br>';
+
+			return false;
+		} else {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE, $from, $to) . '<br>';
+
+			return true;
+		}
+	}
+
+	/**
+	 * Use to update a table
+	 *
+	 * @param object $table {@link SmartDbTable} that will be updated
+	 *
+	 * @see DbTable
+	 *
+	 * @return bool true if success, false if an error occured
+	 */
+	public function updateTable($table)
+	{
+		global $xoopsDB;
+		$ret = true;
+		// If table has a structure, create the table
+		if ($table->getStructure()) {
+			$ret = $table->createTable() && $ret;
+		}
+		// If table is flag for drop, drop it
+		if ($table->_flagForDrop) {
+			$ret = $table->dropTable() && $ret;
+		}
+		// If table has data, insert it
+		if ($table->getData()) {
+			$ret = $table->addData() && $ret;
+		}
+		// If table has new fields to be added, add them
+		if ($table->getNewFields()) {
+			$ret = $table->addNewFields() && $ret;
+		}
+		// If table has altered field, alter the table
+		if ($table->getAlteredFields()) {
+			$ret = $table->alterTable() && $ret;
+		}
+		// If table has updated field values, update the table
+		if ($table->getUpdatedFields()) {
+			$ret = $table->updateFieldsValues($table) && $ret;
+		}
+		// If table has dropped field, alter the table
+		if ($table->getDroppedFields()) {
+			$ret = $table->dropFields($table) && $ret;
+		}
+		//felix
+		// If table has updated field values, update the table
+		if ($table->getUpdatedWhere()) {
+			$ret = $table->UpdateWhereValues($table) && $ret;
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param $module
+	 * @param $item
+	 */
+	public function automaticUpgrade($module, $item)
+	{
+		if (is_array($item)) {
+			foreach ($item as $v) {
+				$this->upgradeObjectItem($module, $v);
+			}
+		} else {
+			$this->upgradeObjectItem($module, $item);
+		}
+	}
+
+	/**
+	 * @param $var
+	 * @return string
+	 */
+	public function getFieldTypeFromVar($var)
+	{
+		$ret = isset($this->_dbTypesArray[$var['data_type']]) ? $this->_dbTypesArray[$var['data_type']] : 'text';
+
+		return $ret;
+	}
+
+	/**
+	 * @param         $var
+	 * @param  bool   $key
+	 * @return string
+	 */
+	public function getFieldDefaultFromVar($var, $key = false)
+	{
+		if ($var['value']) {
+			return $var['value'];
+		} else {
+			if (in_array($var['data_type'], [
+				XOBJ_DTYPE_INT,
+				XOBJ_DTYPE_STIME,
+				XOBJ_DTYPE_MTIME,
+				XOBJ_DTYPE_LTIME,
+				XOBJ_DTYPE_TIME_ONLY,
+				XOBJ_DTYPE_URLLINK,
+				XOBJ_DTYPE_FILE
+			])) {
+				return '0';
+			} else {
+				return '';
+			}
+		}
+	}
+
+	/**
+	 * @param $module
+	 * @param $item
+	 * @return bool
+	 */
+	public function upgradeObjectItem($module, $item)
+	{
+		$moduleHandler = xoops_getModuleHandler($item, $module);
+		if (!$moduleHandler) {
+			return false;
+		}
+
+		$table      = new DbTable($module . '_' . $item);
+		$object     = $moduleHandler->create();
+		$objectVars = $object->getVars();
+
+		if (!$table->exists()) {
+			// table was never created, let's do it
+			$structure = '';
+			foreach ($objectVars as $key => $var) {
+				if ($var['persistent']) {
+					$type = $this->getFieldTypeFromVar($var);
+					if ($key == $moduleHandler->keyName) {
+						$extra = 'auto_increment';
+					} else {
+						$default = $this->getFieldDefaultFromVar($var);
+						$extra   = "default '$default'
 ";
-                    }
-                    $structure .= "`$key` $type not null $extra,
+					}
+					$structure .= "`$key` $type not null $extra,
 ";
-                }
-            }
-            $structure .= 'PRIMARY KEY  (`' . $moduleHandler->keyName . '`)
+				}
+			}
+			$structure .= 'PRIMARY KEY  (`' . $moduleHandler->keyName . '`)
 ';
-            $table->setStructure($structure);
-            if (!$this->updateTable($table)) {
-                /**
-                 * @todo trap the errors
-                 */
-            }
-        } else {
-            $existingFieldsArray = $table->getExistingFieldsArray();
-            foreach ($objectVars as $key => $var) {
-                if ($var['persistent']) {
-                    if (!isset($existingFieldsArray[$key])) {
-                        // the fiels does not exist, let's create it
-                        $type    = $this->getFieldTypeFromVar($var);
-                        $default = $this->getFieldDefaultFromVar($var);
-                        $table->addNewField($key, "$type not null default '$default'");
-                    } else {
-                        // if field already exists, let's check if the definition is correct
-                        $definition = strtolower($existingFieldsArray[$key]);
-                        $type       = $this->getFieldTypeFromVar($var);
-                        if ($key == $moduleHandler->keyName) {
-                            $extra = 'auto_increment';
-                        } else {
-                            $default = $this->getFieldDefaultFromVar($var, $key);
-                            $extra   = "default '$default'";
-                        }
-                        $actual_definition = "$type not null $extra";
-                        if ($definition != $actual_definition) {
-                            $table->addAlteredField($key, $actual_definition);
-                        }
-                    }
-                }
-            }
-
-            // check to see if there are some unused fields left in the table
-            foreach ($existingFieldsArray as $key => $v) {
-                if (!isset($objectVars[$key]) || !$objectVars[$key]['persistent']) {
-                    $table->addDroppedField($key);
-                }
-            }
-
-            if (!$this->updateTable($table)) {
-                /**
-                 * @todo trap the errors
-                 */
-            }
-        }
-    }
-
-    /**
-     * @param $module
-     * @return bool
-     */
-    public function moduleUpgrade(\XoopsModule $module)
-    {
-        $dirname = $module->getVar('dirname');
-
-        ob_start();
-
-        $table = new DbTable($dirname . '_meta');
-        if (!$table->exists()) {
-            $table->setStructure("
+			$table->setStructure($structure);
+			if (!$this->updateTable($table)) {
+				/**
+				 * @todo trap the errors
+				 */
+			}
+		} else {
+			$existingFieldsArray = $table->getExistingFieldsArray();
+			foreach ($objectVars as $key => $var) {
+				if ($var['persistent']) {
+					if (!isset($existingFieldsArray[$key])) {
+						// the fiels does not exist, let's create it
+						$type    = $this->getFieldTypeFromVar($var);
+						$default = $this->getFieldDefaultFromVar($var);
+						$table->addNewField($key, "$type not null default '$default'");
+					} else {
+						// if field already exists, let's check if the definition is correct
+						$definition = strtolower($existingFieldsArray[$key]);
+						$type       = $this->getFieldTypeFromVar($var);
+						if ($key == $moduleHandler->keyName) {
+							$extra = 'auto_increment';
+						} else {
+							$default = $this->getFieldDefaultFromVar($var, $key);
+							$extra   = "default '$default'";
+						}
+						$actual_definition = "$type not null $extra";
+						if ($definition != $actual_definition) {
+							$table->addAlteredField($key, $actual_definition);
+						}
+					}
+				}
+			}
+
+			// check to see if there are some unused fields left in the table
+			foreach ($existingFieldsArray as $key => $v) {
+				if (!isset($objectVars[$key]) || !$objectVars[$key]['persistent']) {
+					$table->addDroppedField($key);
+				}
+			}
+
+			if (!$this->updateTable($table)) {
+				/**
+				 * @todo trap the errors
+				 */
+			}
+		}
+	}
+
+	/**
+	 * @param $module
+	 * @return bool
+	 */
+	public function moduleUpgrade(\XoopsModule $module)
+	{
+		$dirname = $module->getVar('dirname');
+
+		ob_start();
+
+		$table = new DbTable($dirname . '_meta');
+		if (!$table->exists()) {
+			$table->setStructure("
               `metakey` varchar(50) NOT NULL default '',
               `metavalue` varchar(255) NOT NULL default '',
               PRIMARY KEY (`metakey`)");
-            $table->setData("'version',0");
-            if (!$this->updateTable($table)) {
-                /**
-                 * @todo trap the errors
-                 */
-            }
-        }
-
-        $dbVersion = Smartobject\Utility::getMeta('version', $dirname);
-        if (!$dbVersion) {
-            $dbVersion = 0;
-        }
-        $newDbVersion = constant(strtoupper($dirname . '_db_version')) ?: 0;
-        echo 'Database version: ' . $dbVersion . '<br>';
-        echo 'New database version: ' . $newDbVersion . '<br>';
-
-        if ($newDbVersion > $dbVersion) {
-            for ($i = $dbVersion + 1; $i <= $newDbVersion; ++$i) {
-                $upgrade_function = $dirname . '_db_upgrade_' . $i;
-                if (function_exists($upgrade_function)) {
-                    $upgrade_function();
-                }
-            }
-        }
-
-        echo '<code>' . _SDU_UPDATE_UPDATING_DATABASE . '<br>';
-
-        // if there is a function to execute for this DB version, let's do it
-        //$function_
-
-        $module_info = Smartobject\Utility::getModuleInfo($dirname);
-        $this->automaticUpgrade($dirname, $module_info->modinfo['object_items']);
-
-        echo '</code>';
-
-        $feedback = ob_get_clean();
-        if (method_exists($module, 'setMessage')) {
-            $module->setMessage($feedback);
-        } else {
-            echo $feedback;
-        }
-        Smartobject\Utility::setMeta('version', $newDbVersion, $dirname); //Set meta version to current
-
-        return true;
-    }
+			$table->setData("'version',0");
+			if (!$this->updateTable($table)) {
+				/**
+				 * @todo trap the errors
+				 */
+			}
+		}
+
+		$dbVersion = Smartobject\Utility::getMeta('version', $dirname);
+		if (!$dbVersion) {
+			$dbVersion = 0;
+		}
+		$newDbVersion = constant(strtoupper($dirname . '_db_version')) ?: 0;
+		echo 'Database version: ' . $dbVersion . '<br>';
+		echo 'New database version: ' . $newDbVersion . '<br>';
+
+		if ($newDbVersion > $dbVersion) {
+			for ($i = $dbVersion + 1; $i <= $newDbVersion; ++$i) {
+				$upgrade_function = $dirname . '_db_upgrade_' . $i;
+				if (function_exists($upgrade_function)) {
+					$upgrade_function();
+				}
+			}
+		}
+
+		echo '<code>' . _SDU_UPDATE_UPDATING_DATABASE . '<br>';
+
+		// if there is a function to execute for this DB version, let's do it
+		//$function_
+
+		$module_info = Smartobject\Utility::getModuleInfo($dirname);
+		$this->automaticUpgrade($dirname, $module_info->modinfo['object_items']);
+
+		echo '</code>';
+
+		$feedback = ob_get_clean();
+		if (method_exists($module, 'setMessage')) {
+			$module->setMessage($feedback);
+		} else {
+			echo $feedback;
+		}
+		Smartobject\Utility::setMeta('version', $newDbVersion, $dirname); //Set meta version to current
+
+		return true;
+	}
 }

class/Customtag.php

Indentation +221 added lines, -221 removed lines

@@ -29,225 +29,225 @@
  */
 class Customtag extends Smartobject\BaseSmartObject
 {
-    public $content = false;
-
-    /**
-     * SmartobjectCustomtag constructor.
-     */
-    public function __construct()
-    {
-        $this->quickInitVar('customtagid', XOBJ_DTYPE_INT, true);
-        $this->quickInitVar('name', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_CUSTOMTAG_NAME, _CO_SOBJECT_CUSTOMTAG_NAME_DSC);
-        $this->quickInitVar('description', XOBJ_DTYPE_TXTAREA, false, _CO_SOBJECT_CUSTOMTAG_DESCRIPTION, _CO_SOBJECT_CUSTOMTAG_DESCRIPTION_DSC);
-        $this->quickInitVar('content', XOBJ_DTYPE_TXTAREA, true, _CO_SOBJECT_CUSTOMTAG_CONTENT, _CO_SOBJECT_CUSTOMTAG_CONTENT_DSC);
-        $this->quickInitVar('language', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_CUSTOMTAG_LANGUAGE, _CO_SOBJECT_CUSTOMTAG_LANGUAGE_DSC);
-
-        $this->initNonPersistableVar('dohtml', XOBJ_DTYPE_INT, 'class', 'dohtml', '', true);
-        $this->initNonPersistableVar('doimage', XOBJ_DTYPE_INT, 'class', 'doimage', '', true);
-        $this->initNonPersistableVar('doxcode', XOBJ_DTYPE_INT, 'class', 'doxcode', '', true);
-        $this->initNonPersistableVar('dosmiley', XOBJ_DTYPE_INT, 'class', 'dosmiley', '', true);
-
-        $this->setControl('content', [
-            'name'        => 'textarea',
-            'form_editor' => 'textarea',
-            'form_rows'   => 25
-        ]);
-        $this->setControl('language', [
-            'name' => 'language',
-            'all'  => true
-        ]);
-    }
-
-    /**
-     * @param  string $key
-     * @param  string $format
-     * @return mixed
-     */
-    public function getVar($key, $format = 's')
-    {
-        if ('s' === $format && in_array($key, [])) {
-            //            return call_user_func(array($this, $key));
-            return $this->{$key}();
-        }
-
-        return parent::getVar($key, $format);
-    }
-
-    /**
-     * @return bool|mixed
-     */
-    public function render()
-    {
-        if (!$this->content) {
-            $ret           = $this->getVar('content');
-            $this->content = $ret;
-        }
-
-        return $this->content;
-    }
-
-    /**
-     * @return bool|mixed|string
-     */
-    public function renderWithPhp()
-    {
-        if (!$this->content) {
-            $ret           = $this->getVar('content');
-            $this->content = $ret;
-        } else {
-            $ret = $this->content;
-        }
-
-        // check for PHP if we are not on admin side
-        if (!defined('XOOPS_CPFUNC_LOADED') && !(false === strpos($ret, '[php]'))) {
-            $ret = str_replace('[php]', '', $ret);
-            // we have PHP code, let's evaluate
-            eval($ret);
-
-            return '';
-        }
-
-        return $this->content;
-    }
-
-    /**
-     * @return string
-     */
-    public function getXoopsCode()
-    {
-        $ret = '[customtag]' . $this->getVar('tag', 'n') . '[/customtag]';
-
-        return $ret;
-    }
-
-    /**
-     * @return string
-     */
-    public function getCloneLink()
-    {
-        $ret = '<a href="' . SMARTOBJECT_URL . 'admin/customtag.php?op=clone&customtagid=' . $this->id() . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'editcopy.png" style="vertical-align: middle;" alt="' . _CO_SOBJECT_CUSTOMTAG_CLONE . '" title="' . _CO_SOBJECT_CUSTOMTAG_CLONE . '"></a>';
-
-        return $ret;
-    }
-
-    /**
-     * @param $var
-     * @return bool
-     */
-    public function emptyString($var)
-    {
-        return (strlen($var) > 0);
-    }
-
-    /**
-     * @return mixed|string
-     */
-    public function generateTag()
-    {
-        $title = rawurlencode(strtolower($this->getVar('description', 'e')));
-        $title = xoops_substr($title, 0, 10, '');
-        // Transformation des ponctuations
-        $pattern = [
-            '/%09/', // Tab
-            '/%20/', // Space
-            '/%21/', // !
-            '/%22/', // "
-            '/%23/', // #
-            '/%25/', // %
-            '/%26/', // &
-            '/%27/', // '
-            '/%28/', // (
-            '/%29/', // )
-            '/%2C/', // ,
-            '/%2F/', // /
-            '/%3A/', // :
-            '/%3B/', // ;
-            '/%3C/', // <
-            '/%3D/', // =
-            '/%3E/', // >
-            '/%3F/', // ?
-            '/%40/', // @
-            '/%5B/', // [
-            '/%5C/', // \
-            '/%5D/', // ]
-            '/%5E/', // ^
-            '/%7B/', // {
-            '/%7C/', // |
-            '/%7D/', // }
-            '/%7E/', // ~
-            "/\./" // .
-        ];
-        $rep_pat = [
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-100',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-at-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-',
-            '-'
-        ];
-        $title   = preg_replace($pattern, $rep_pat, $title);
-
-        // Transformation des caractères accentués
-        $pattern = [
-            '/%B0/', // °
-            '/%E8/', // è
-            '/%E9/', // é
-            '/%EA/', // ê
-            '/%EB/', // ë
-            '/%E7/', // ç
-            '/%E0/', // à
-            '/%E2/', // â
-            '/%E4/', // ä
-            '/%EE/', // î
-            '/%EF/', // ï
-            '/%F9/', // ù
-            '/%FC/', // ü
-            '/%FB/', // û
-            '/%F4/', // ô
-            '/%F6/', // ö
-        ];
-        $rep_pat = ['-', 'e', 'e', 'e', 'e', 'c', 'a', 'a', 'a', 'i', 'i', 'u', 'u', 'u', 'o', 'o'];
-        $title   = preg_replace($pattern, $rep_pat, $title);
-
-        $tableau = explode('-', $title); // Transforme la chaine de caract�res en tableau
-        $tableau = array_filter($tableau, [$this, 'emptyString']); // Supprime les chaines vides du tableau
-        $title   = implode('-', $tableau); // Transforme un tableau en chaine de caract�res s�par� par un tiret
-
-        $title .= time();
-        $title = md5($title);
-
-        return $title;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getCustomtagName()
-    {
-        $ret = $this->getVar('name');
-
-        return $ret;
-    }
+	public $content = false;
+
+	/**
+	 * SmartobjectCustomtag constructor.
+	 */
+	public function __construct()
+	{
+		$this->quickInitVar('customtagid', XOBJ_DTYPE_INT, true);
+		$this->quickInitVar('name', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_CUSTOMTAG_NAME, _CO_SOBJECT_CUSTOMTAG_NAME_DSC);
+		$this->quickInitVar('description', XOBJ_DTYPE_TXTAREA, false, _CO_SOBJECT_CUSTOMTAG_DESCRIPTION, _CO_SOBJECT_CUSTOMTAG_DESCRIPTION_DSC);
+		$this->quickInitVar('content', XOBJ_DTYPE_TXTAREA, true, _CO_SOBJECT_CUSTOMTAG_CONTENT, _CO_SOBJECT_CUSTOMTAG_CONTENT_DSC);
+		$this->quickInitVar('language', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_CUSTOMTAG_LANGUAGE, _CO_SOBJECT_CUSTOMTAG_LANGUAGE_DSC);
+
+		$this->initNonPersistableVar('dohtml', XOBJ_DTYPE_INT, 'class', 'dohtml', '', true);
+		$this->initNonPersistableVar('doimage', XOBJ_DTYPE_INT, 'class', 'doimage', '', true);
+		$this->initNonPersistableVar('doxcode', XOBJ_DTYPE_INT, 'class', 'doxcode', '', true);
+		$this->initNonPersistableVar('dosmiley', XOBJ_DTYPE_INT, 'class', 'dosmiley', '', true);
+
+		$this->setControl('content', [
+			'name'        => 'textarea',
+			'form_editor' => 'textarea',
+			'form_rows'   => 25
+		]);
+		$this->setControl('language', [
+			'name' => 'language',
+			'all'  => true
+		]);
+	}
+
+	/**
+	 * @param  string $key
+	 * @param  string $format
+	 * @return mixed
+	 */
+	public function getVar($key, $format = 's')
+	{
+		if ('s' === $format && in_array($key, [])) {
+			//            return call_user_func(array($this, $key));
+			return $this->{$key}();
+		}
+
+		return parent::getVar($key, $format);
+	}
+
+	/**
+	 * @return bool|mixed
+	 */
+	public function render()
+	{
+		if (!$this->content) {
+			$ret           = $this->getVar('content');
+			$this->content = $ret;
+		}
+
+		return $this->content;
+	}
+
+	/**
+	 * @return bool|mixed|string
+	 */
+	public function renderWithPhp()
+	{
+		if (!$this->content) {
+			$ret           = $this->getVar('content');
+			$this->content = $ret;
+		} else {
+			$ret = $this->content;
+		}
+
+		// check for PHP if we are not on admin side
+		if (!defined('XOOPS_CPFUNC_LOADED') && !(false === strpos($ret, '[php]'))) {
+			$ret = str_replace('[php]', '', $ret);
+			// we have PHP code, let's evaluate
+			eval($ret);
+
+			return '';
+		}
+
+		return $this->content;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getXoopsCode()
+	{
+		$ret = '[customtag]' . $this->getVar('tag', 'n') . '[/customtag]';
+
+		return $ret;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCloneLink()
+	{
+		$ret = '<a href="' . SMARTOBJECT_URL . 'admin/customtag.php?op=clone&customtagid=' . $this->id() . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'editcopy.png" style="vertical-align: middle;" alt="' . _CO_SOBJECT_CUSTOMTAG_CLONE . '" title="' . _CO_SOBJECT_CUSTOMTAG_CLONE . '"></a>';
+
+		return $ret;
+	}
+
+	/**
+	 * @param $var
+	 * @return bool
+	 */
+	public function emptyString($var)
+	{
+		return (strlen($var) > 0);
+	}
+
+	/**
+	 * @return mixed|string
+	 */
+	public function generateTag()
+	{
+		$title = rawurlencode(strtolower($this->getVar('description', 'e')));
+		$title = xoops_substr($title, 0, 10, '');
+		// Transformation des ponctuations
+		$pattern = [
+			'/%09/', // Tab
+			'/%20/', // Space
+			'/%21/', // !
+			'/%22/', // "
+			'/%23/', // #
+			'/%25/', // %
+			'/%26/', // &
+			'/%27/', // '
+			'/%28/', // (
+			'/%29/', // )
+			'/%2C/', // ,
+			'/%2F/', // /
+			'/%3A/', // :
+			'/%3B/', // ;
+			'/%3C/', // <
+			'/%3D/', // =
+			'/%3E/', // >
+			'/%3F/', // ?
+			'/%40/', // @
+			'/%5B/', // [
+			'/%5C/', // \
+			'/%5D/', // ]
+			'/%5E/', // ^
+			'/%7B/', // {
+			'/%7C/', // |
+			'/%7D/', // }
+			'/%7E/', // ~
+			"/\./" // .
+		];
+		$rep_pat = [
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-100',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-at-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-',
+			'-'
+		];
+		$title   = preg_replace($pattern, $rep_pat, $title);
+
+		// Transformation des caractères accentués
+		$pattern = [
+			'/%B0/', // °
+			'/%E8/', // è
+			'/%E9/', // é
+			'/%EA/', // ê
+			'/%EB/', // ë
+			'/%E7/', // ç
+			'/%E0/', // à
+			'/%E2/', // â
+			'/%E4/', // ä
+			'/%EE/', // î
+			'/%EF/', // ï
+			'/%F9/', // ù
+			'/%FC/', // ü
+			'/%FB/', // û
+			'/%F4/', // ô
+			'/%F6/', // ö
+		];
+		$rep_pat = ['-', 'e', 'e', 'e', 'e', 'c', 'a', 'a', 'a', 'i', 'i', 'u', 'u', 'u', 'o', 'o'];
+		$title   = preg_replace($pattern, $rep_pat, $title);
+
+		$tableau = explode('-', $title); // Transforme la chaine de caract�res en tableau
+		$tableau = array_filter($tableau, [$this, 'emptyString']); // Supprime les chaines vides du tableau
+		$title   = implode('-', $tableau); // Transforme un tableau en chaine de caract�res s�par� par un tiret
+
+		$title .= time();
+		$title = md5($title);
+
+		return $title;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getCustomtagName()
+	{
+		$ret = $this->getVar('name');
+
+		return $ret;
+	}
 }

class/Highlighter.php

Indentation +84 added lines, -84 removed lines

@@ -24,96 +24,96 @@
 
 class Highlighter
 {
-    /**
-     * @access private
-     */
-    public $preg_keywords = '';
-    /**
-     * @access private
-     */
-    public $keywords = '';
-    /**
-     * @access private
-     */
-    public $singlewords = false;
-    /**
-     * @access private
-     */
-    public $replace_callback = null;
+	/**
+	 * @access private
+	 */
+	public $preg_keywords = '';
+	/**
+	 * @access private
+	 */
+	public $keywords = '';
+	/**
+	 * @access private
+	 */
+	public $singlewords = false;
+	/**
+	 * @access private
+	 */
+	public $replace_callback = null;
 
-    public $content;
+	public $content;
 
-    /**
-     * Main constructor
-     *
-     * This is the main constructor of keyhighlighter class. <br>
-     * It's the only public method of the class.
-     * @param string   $keywords         the keywords you want to highlight
-     * @param boolean  $singlewords      specify if it has to highlight also the single words.
-     * @param callback $replace_callback a custom callback for keyword highlight.
-     *                                   <code>
-     *                                   <?php
-     *                                   require ('keyhighlighter.class.php');
-     *
-     * function my_highlighter ($matches) {
-     *  return '<span style="font-weight: bolder; color: #FF0000;">' . $matches[0] . '</span>';
-     * }
-     *
-     * new keyhighlighter ('W3C', false, 'my_highlighter');
-     * readfile ('http://www.w3c.org/');
-     * ?>
-     * </code>
-     */
-    // public function __construct ()
-    public function __construct($keywords, $singlewords = false, $replace_callback = null)
-    {
-        $this->keywords         = $keywords;
-        $this->singlewords      = $singlewords;
-        $this->replace_callback = $replace_callback;
-    }
+	/**
+	 * Main constructor
+	 *
+	 * This is the main constructor of keyhighlighter class. <br>
+	 * It's the only public method of the class.
+	 * @param string   $keywords         the keywords you want to highlight
+	 * @param boolean  $singlewords      specify if it has to highlight also the single words.
+	 * @param callback $replace_callback a custom callback for keyword highlight.
+	 *                                   <code>
+	 *                                   <?php
+	 *                                   require ('keyhighlighter.class.php');
+	 *
+	 * function my_highlighter ($matches) {
+	 *  return '<span style="font-weight: bolder; color: #FF0000;">' . $matches[0] . '</span>';
+	 * }
+	 *
+	 * new keyhighlighter ('W3C', false, 'my_highlighter');
+	 * readfile ('http://www.w3c.org/');
+	 * ?>
+	 * </code>
+	 */
+	// public function __construct ()
+	public function __construct($keywords, $singlewords = false, $replace_callback = null)
+	{
+		$this->keywords         = $keywords;
+		$this->singlewords      = $singlewords;
+		$this->replace_callback = $replace_callback;
+	}
 
-    /**
-     * @access private
-     * @param $replace_matches
-     * @return mixed
-     */
-    public function replace($replace_matches)
-    {
-        $patterns = [];
-        if ($this->singlewords) {
-            $keywords = explode(' ', $this->preg_keywords);
-            foreach ($keywords as $keyword) {
-                $patterns[] = '/(?' . '>' . $keyword . '+)/si';
-            }
-        } else {
-            $patterns[] = '/(?' . '>' . $this->preg_keywords . '+)/si';
-        }
+	/**
+	 * @access private
+	 * @param $replace_matches
+	 * @return mixed
+	 */
+	public function replace($replace_matches)
+	{
+		$patterns = [];
+		if ($this->singlewords) {
+			$keywords = explode(' ', $this->preg_keywords);
+			foreach ($keywords as $keyword) {
+				$patterns[] = '/(?' . '>' . $keyword . '+)/si';
+			}
+		} else {
+			$patterns[] = '/(?' . '>' . $this->preg_keywords . '+)/si';
+		}
 
-        $result = $replace_matches[0];
+		$result = $replace_matches[0];
 
-        foreach ($patterns as $pattern) {
-            if (null !== $this->replace_callback) {
-                $result = preg_replace_callback($pattern, $this->replace_callback, $result);
-            } else {
-                $result = preg_replace($pattern, '<span class="highlightedkey">\\0</span>', $result);
-            }
-        }
+		foreach ($patterns as $pattern) {
+			if (null !== $this->replace_callback) {
+				$result = preg_replace_callback($pattern, $this->replace_callback, $result);
+			} else {
+				$result = preg_replace($pattern, '<span class="highlightedkey">\\0</span>', $result);
+			}
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * @access private
-     * @param $buffer
-     * @return mixed|string
-     */
-    public function highlight($buffer)
-    {
-        $buffer              = '>' . $buffer . '<';
-        $this->preg_keywords = preg_replace('/[^\w ]/si', '', $this->keywords);
-        $buffer              = preg_replace_callback("/(\>(((?" . ">[^><]+)|(?R))*)\<)/is", [&$this, 'replace'], $buffer);
-        $buffer              = substr($buffer, 1, -1);
+	/**
+	 * @access private
+	 * @param $buffer
+	 * @return mixed|string
+	 */
+	public function highlight($buffer)
+	{
+		$buffer              = '>' . $buffer . '<';
+		$this->preg_keywords = preg_replace('/[^\w ]/si', '', $this->keywords);
+		$buffer              = preg_replace_callback("/(\>(((?" . ">[^><]+)|(?R))*)\<)/is", [&$this, 'replace'], $buffer);
+		$buffer              = substr($buffer, 1, -1);
 
-        return $buffer;
-    }
+		return $buffer;
+	}
 }

class/BaseSmartObject.php

Indentation +1401 added lines, -1401 removed lines

@@ -18,31 +18,31 @@ 
 require_once XOOPS_ROOT_PATH . '/modules/smartobject/include/common.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);
 }
 
 /**
@@ -56,1399 +56,1399 @@ 
  */
 class BaseSmartObject extends \XoopsObject
 {
-    public $_image_path;
-    public $_image_url;
-
-    public $seoEnabled   = false;
-    public $titleField;
-    public $summaryField = false;
-
-    /**
-     * Reference to the handler managing this object
-     *
-     * @var PersistableObjectHandler reference to {@link SmartPersistableObjectHandler}
-     */
-    public $handler;
-
-    /**
-     * References to control objects, managing the form fields of this object
-     */
-    public $controls = [];
-
-    /**
-     * 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 PermissionHandler($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], [
-            '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 = 'XOBJ_DTYPE_TXTBOX' === $data_type ? 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 = 'notdefined' !== $default ? $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 = ('notdefined' === $default) ? 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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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', [
-                    'name'        => 'textarea',
-                    'form_editor' => 'textarea'
-                ]);
-                break;
-
-            case 'meta_description':
-                $value = 'notdefined' !== $default ? $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', [
-                    'name'        => 'textarea',
-                    'form_editor' => 'textarea'
-                ]);
-                break;
-
-            case 'short_url':
-                $value = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $default : 0;
-                $this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_COUNTER_FORM_CAPTION, '', false, true, $displayOnForm);
-                break;
-
-            case 'weight':
-                $value = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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', [
-                    '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 = [])
-    {
-        if (isset($this->controls[$var])) {
-            unset($this->controls[$var]);
-        }
-        if (is_string($options)) {
-            $options = ['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 \XoopsModules\Smartobject\Form\SmartobjectForm <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
-    ) {
+	public $_image_path;
+	public $_image_url;
+
+	public $seoEnabled   = false;
+	public $titleField;
+	public $summaryField = false;
+
+	/**
+	 * Reference to the handler managing this object
+	 *
+	 * @var PersistableObjectHandler reference to {@link SmartPersistableObjectHandler}
+	 */
+	public $handler;
+
+	/**
+	 * References to control objects, managing the form fields of this object
+	 */
+	public $controls = [];
+
+	/**
+	 * 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 PermissionHandler($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], [
+			'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 = 'XOBJ_DTYPE_TXTBOX' === $data_type ? 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 = 'notdefined' !== $default ? $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 = ('notdefined' === $default) ? 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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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', [
+					'name'        => 'textarea',
+					'form_editor' => 'textarea'
+				]);
+				break;
+
+			case 'meta_description':
+				$value = 'notdefined' !== $default ? $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', [
+					'name'        => 'textarea',
+					'form_editor' => 'textarea'
+				]);
+				break;
+
+			case 'short_url':
+				$value = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $default : 0;
+				$this->initVar($varname, XOBJ_DTYPE_INT, $value, false, null, '', false, _CO_SOBJECT_COUNTER_FORM_CAPTION, '', false, true, $displayOnForm);
+				break;
+
+			case 'weight':
+				$value = 'notdefined' !== $default ? $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 = 'notdefined' !== $default ? $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', [
+					'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 = [])
+	{
+		if (isset($this->controls[$var])) {
+			unset($this->controls[$var]);
+		}
+		if (is_string($options)) {
+			$options = ['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 \XoopsModules\Smartobject\Form\SmartobjectForm <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
+	) {
 //        require_once SMARTOBJECT_ROOT_PATH . 'class/form/smartobjectform.php';
-        $form = new Smartobject\Form\SmartobjectForm($this, $form_name, $form_caption, $form_action, null, $submit_button_caption, $cancel_js_action, $captcha);
-
-        return $form;
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        $ret  = [];
-        $vars =& $this->getVars();
-        foreach ($vars as $key => $var) {
-            $value     = $this->getVar($key);
-            $ret[$key] = $value;
-        }
-        if ('' !== $this->handler->identifierName) {
-            $controller = new ObjectController($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
+		$form = new Smartobject\Form\SmartobjectForm($this, $form_name, $form_caption, $form_action, null, $submit_button_caption, $cancel_js_action, $captcha);
+
+		return $form;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$ret  = [];
+		$vars =& $this->getVars();
+		foreach ($vars as $key => $var) {
+			$value     = $this->getVar($key);
+			$ret[$key] = $value;
+		}
+		if ('' !== $this->handler->identifierName) {
+			$controller = new ObjectController($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
 //        require_once SMARTOBJECT_ROOT_PATH . 'class/smarthighlighter.php';
-        $highlight = Smartobject\Utility::getConfig('module_search_highlighter', false, true);
-
-        if ($highlight && isset($_GET['keywords'])) {
-            $myts     = \MyTextSanitizer::getInstance();
-            $keywords = $myts->htmlSpecialChars(trim(urldecode($_GET['keywords'])));
-            $h        = new Highlighter($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 PermissionHandler($this->handler);
-        $ret                     = $smartPermissionsHandler->getGrantedGroups($group_perm, $this->id());
-
-        if (0 == count($ret)) {
-            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 ObjectController($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 ObjectController($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 ObjectController($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 ObjectController($this->handler);
-
-        return $controller->getDeleteItemLink($this, $onlyUrl, $withimage, $userSide);
-    }
-
-    /**
-     * @return string
-     */
-    public function getPrintAndMailLink()
-    {
-        $controller = new ObjectController($this->handler);
-
-        return $controller->getPrintAndMailLink($this);
-    }
-
-    /**
-     * @param $sortsel
-     * @return array|bool
-     */
-    public function getFieldsForSorting($sortsel)
-    {
-        $ret = [];
-
-        foreach ($this->vars as $key => $field_info) {
-            if ($field_info['sortby']) {
-                $ret[$key]['caption']  = $field_info['form_caption'];
-                $ret[$key]['selected'] = $key == $sortsel ? '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 ('default' === $form_editor) {
-            global $xoopsModuleConfig;
-            $form_editor = isset($xoopsModuleConfig['default_editor']) ? $xoopsModuleConfig['default_editor'] : 'textarea';
-        }
-
-        if ($editor) {
-            if (defined('XOOPS_EDITOR_IS_HTML')
-                && !in_array($form_editor, ['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   = [];
-        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'] && '0' != $cleanv && '' == $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'] && '0' != $cleanv && '' == $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 = Smartobject\Utility::getCurrency($cleanv);
-                        break;
-
-                    case XOBJ_DTYPE_FLOAT:
-                        $cleanv = Smartobject\Utility::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 = Smartobject\Utility::getHtml2text($ret);
-                        $ret = Smartobject\Utility::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 (1 == strlen($decimal_section)) {
-                        $decimal_section = '.00';
-                    } elseif (2 == strlen($decimal_section)) {
-                        $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'])
-                                  || 1 == $this->vars['doxcode']['value']) ? 1 : 0;
-
-                        $smiley = (!isset($this->vars['dosmiley']['value'])
-                                   || 1 == $this->vars['dosmiley']['value']) ? 1 : 0;
-                        $image  = (!isset($this->vars['doimage']['value'])
-                                   || 1 == $this->vars['doimage']['value']) ? 1 : 0;
-                        $br     = (!isset($this->vars['dobr']['value']) || 1 == $this->vars['dobr']['value']) ? 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'])
-                                   || 1 == $this->vars['doxcode']['value']) ? 1 : 0;
-                        $smiley = (!isset($this->vars['dosmiley']['value'])
-                                   || 1 == $this->vars['dosmiley']['value']) ? 1 : 0;
-                        $image  = (!isset($this->vars['doimage']['value'])
-                                   || 1 == $this->vars['doimage']['value']) ? 1 : 0;
-                        $br     = (!isset($this->vars['dobr']['value']) || 1 == $this->vars['dobr']['value']) ? 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      = [];
-                            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 string content of the template if $fetchOnly or nothing if !$fetchOnly
-     */
-    public function displaySingleObject(
-        $fetchOnly = false,
-        $userSide = false,
-        $actions = [],
-        $headerAsRow = true
-    ) {
+		$highlight = Smartobject\Utility::getConfig('module_search_highlighter', false, true);
+
+		if ($highlight && isset($_GET['keywords'])) {
+			$myts     = \MyTextSanitizer::getInstance();
+			$keywords = $myts->htmlSpecialChars(trim(urldecode($_GET['keywords'])));
+			$h        = new Highlighter($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 PermissionHandler($this->handler);
+		$ret                     = $smartPermissionsHandler->getGrantedGroups($group_perm, $this->id());
+
+		if (0 == count($ret)) {
+			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 ObjectController($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 ObjectController($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 ObjectController($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 ObjectController($this->handler);
+
+		return $controller->getDeleteItemLink($this, $onlyUrl, $withimage, $userSide);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getPrintAndMailLink()
+	{
+		$controller = new ObjectController($this->handler);
+
+		return $controller->getPrintAndMailLink($this);
+	}
+
+	/**
+	 * @param $sortsel
+	 * @return array|bool
+	 */
+	public function getFieldsForSorting($sortsel)
+	{
+		$ret = [];
+
+		foreach ($this->vars as $key => $field_info) {
+			if ($field_info['sortby']) {
+				$ret[$key]['caption']  = $field_info['form_caption'];
+				$ret[$key]['selected'] = $key == $sortsel ? '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 ('default' === $form_editor) {
+			global $xoopsModuleConfig;
+			$form_editor = isset($xoopsModuleConfig['default_editor']) ? $xoopsModuleConfig['default_editor'] : 'textarea';
+		}
+
+		if ($editor) {
+			if (defined('XOOPS_EDITOR_IS_HTML')
+				&& !in_array($form_editor, ['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   = [];
+		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'] && '0' != $cleanv && '' == $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'] && '0' != $cleanv && '' == $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 = Smartobject\Utility::getCurrency($cleanv);
+						break;
+
+					case XOBJ_DTYPE_FLOAT:
+						$cleanv = Smartobject\Utility::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 = Smartobject\Utility::getHtml2text($ret);
+						$ret = Smartobject\Utility::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 (1 == strlen($decimal_section)) {
+						$decimal_section = '.00';
+					} elseif (2 == strlen($decimal_section)) {
+						$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'])
+								  || 1 == $this->vars['doxcode']['value']) ? 1 : 0;
+
+						$smiley = (!isset($this->vars['dosmiley']['value'])
+								   || 1 == $this->vars['dosmiley']['value']) ? 1 : 0;
+						$image  = (!isset($this->vars['doimage']['value'])
+								   || 1 == $this->vars['doimage']['value']) ? 1 : 0;
+						$br     = (!isset($this->vars['dobr']['value']) || 1 == $this->vars['dobr']['value']) ? 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'])
+								   || 1 == $this->vars['doxcode']['value']) ? 1 : 0;
+						$smiley = (!isset($this->vars['dosmiley']['value'])
+								   || 1 == $this->vars['dosmiley']['value']) ? 1 : 0;
+						$image  = (!isset($this->vars['doimage']['value'])
+								   || 1 == $this->vars['doimage']['value']) ? 1 : 0;
+						$br     = (!isset($this->vars['dobr']['value']) || 1 == $this->vars['dobr']['value']) ? 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      = [];
+							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 string content of the template if $fetchOnly or nothing if !$fetchOnly
+	 */
+	public function displaySingleObject(
+		$fetchOnly = false,
+		$userSide = false,
+		$actions = [],
+		$headerAsRow = true
+	) {
 //        require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectsingleview.php';
-        $singleview = new SingleView($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 ObjectRow($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 = Smartobject\Helper::getInstance()->getHandler('Urllink');
-        $urllinkid                 = null !== $this->getVar($key) ? $this->getVar($key) : 0;
-        if (0 != $urllinkid) {
-            return $smartobjectLinkurlHandler->get($urllinkid);
-        } else {
-            return $smartobjectLinkurlHandler->create();
-        }
-    }
-
-    /**
-     * @param $urlLinkObj
-     * @return mixed
-     */
-    public function &storeUrlLinkObj($urlLinkObj)
-    {
-        $smartobjectLinkurlHandler = Smartobject\Helper::getInstance()->getHandler('Urllink');
-
-        return $smartobjectLinkurlHandler->insert($urlLinkObj);
-    }
-
-    /**
-     * @param $key
-     * @return mixed
-     */
-    public function getFileObj($key)
-    {
-        $smartobjectFileHandler = Smartobject\Helper::getInstance()->getHandler('File');
-        $fileid                 = null !== $this->getVar($key) ? $this->getVar($key) : 0;
-        if (0 != $fileid) {
-            return $smartobjectFileHandler->get($fileid);
-        } else {
-            return $smartobjectFileHandler->create();
-        }
-    }
-
-    /**
-     * @param $fileObj
-     * @return mixed
-     */
-    public function &storeFileObj($fileObj)
-    {
-        $smartobjectFileHandler = Smartobject\Helper::getInstance()->getHandler('File');
-
-        return $smartobjectFileHandler->insert($fileObj);
-    }
+		$singleview = new SingleView($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 ObjectRow($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 = Smartobject\Helper::getInstance()->getHandler('Urllink');
+		$urllinkid                 = null !== $this->getVar($key) ? $this->getVar($key) : 0;
+		if (0 != $urllinkid) {
+			return $smartobjectLinkurlHandler->get($urllinkid);
+		} else {
+			return $smartobjectLinkurlHandler->create();
+		}
+	}
+
+	/**
+	 * @param $urlLinkObj
+	 * @return mixed
+	 */
+	public function &storeUrlLinkObj($urlLinkObj)
+	{
+		$smartobjectLinkurlHandler = Smartobject\Helper::getInstance()->getHandler('Urllink');
+
+		return $smartobjectLinkurlHandler->insert($urlLinkObj);
+	}
+
+	/**
+	 * @param $key
+	 * @return mixed
+	 */
+	public function getFileObj($key)
+	{
+		$smartobjectFileHandler = Smartobject\Helper::getInstance()->getHandler('File');
+		$fileid                 = null !== $this->getVar($key) ? $this->getVar($key) : 0;
+		if (0 != $fileid) {
+			return $smartobjectFileHandler->get($fileid);
+		} else {
+			return $smartobjectFileHandler->create();
+		}
+	}
+
+	/**
+	 * @param $fileObj
+	 * @return mixed
+	 */
+	public function &storeFileObj($fileObj)
+	{
+		$smartobjectFileHandler = Smartobject\Helper::getInstance()->getHandler('File');
+
+		return $smartobjectFileHandler->insert($fileObj);
+	}
 }

class/ObjectsRegistry.php

Indentation +165 added lines, -165 removed lines

@@ -34,169 +34,169 @@
  */
 class ObjectsRegistry
 {
-    public $_registryArray;
-
-    /**
-     * Access the only instance of this class
-     *
-     * @return \XoopsModules\Smartobject\ObjectsRegistry
-     *
-     * @static
-     * @staticvar   object
-     */
-    public static function getInstance()
-    {
-        static $instance;
-        if (null === $instance) {
-            $instance = new static();
-        }
-
-        return $instance;
-    }
-
-    /**
-     * Adding objects to the registry
-     *
-     * @param  PersistableObjectHandler $handler  of the objects to add
-     * @param  bool|CriteriaCompo       $criteria to pass to the getObjects method of the handler (with id_as_key)
-     * @return FALSE                         if an error occured
-     */
-    public function addObjectsFromHandler(&$handler, $criteria = false)
-    {
-        if (method_exists($handler, 'getObjects')) {
-            $objects                                                                     = $handler->getObjects($criteria, true);
-            $this->_registryArray['objects'][$handler->_moduleName][$handler->_itemname] = $objects;
-
-            return $objects;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Adding objects to the registry from an item name
-     * This method will fetch the handler of the item / module and call the addObjectsFromHandler
-     *
-     * @param  string             $item       name of the item
-     * @param  bool|string        $modulename name of the module
-     * @param  bool|CriteriaCompo $criteria   to pass to the getObjects method of the handler (with id_as_key)
-     * @return FALSE              if an error occured
-     */
-    public function addObjectsFromItemName($item, $modulename = false, $criteria = false)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        $objectHandler = xoops_getModuleHandler($item, $modulename);
-
-        if (method_exists($objectHandler, 'getObjects')) {
-            $objects                                                                                 = $objectHandler->getObjects($criteria, true);
-            $this->_registryArray['objects'][$objectHandler->_moduleName][$objectHandler->_itemname] = $objects;
-
-            return $objects;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Fetching objects from the registry
-     *
-     * @param string $itemname
-     * @param string $modulename
-     *
-     * @return false|array the requested objects or FALSE if they don't exists in the registry
-     */
-    public function getObjects($itemname, $modulename)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        if (isset($this->_registryArray['objects'][$modulename][$itemname])) {
-            return $this->_registryArray['objects'][$modulename][$itemname];
-        } else {
-            // if they were not in registry, let's fetch them and add them to the reigistry
-            $moduleHandler = xoops_getModuleHandler($itemname, $modulename);
-            if (method_exists($moduleHandler, 'getObjects')) {
-                $objects = $moduleHandler->getObjects();
-            }
-            $this->_registryArray['objects'][$modulename][$itemname] = $objects;
-
-            return $objects;
-        }
-    }
-
-    /**
-     * Fetching objects from the registry, as a list: objectid => identifier
-     *
-     * @param string $itemname
-     * @param string $modulename
-     *
-     * @return false|array the requested objects or FALSE if they don't exists in the registry
-     */
-    public function getList($itemname, $modulename)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        if (isset($this->_registryArray['list'][$modulename][$itemname])) {
-            return $this->_registryArray['list'][$modulename][$itemname];
-        } else {
-            // if they were not in registry, let's fetch them and add them to the reigistry
-            $moduleHandler = xoops_getModuleHandler($itemname, $modulename);
-            if (method_exists($moduleHandler, 'getList')) {
-                $objects = $moduleHandler->getList();
-            }
-            $this->_registryArray['list'][$modulename][$itemname] = $objects;
-
-            return $objects;
-        }
-    }
-
-    /**
-     * Retreive a single object
-     *
-     * @param string $itemname
-     * @param string $key
-     *
-     * @param  bool  $modulename
-     * @return false|\XoopsObject the  requestd object or FALSE if they don't exists in the registry
-     */
-    public function getSingleObject($itemname, $key, $modulename = false)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        if (isset($this->_registryArray['objects'][$modulename][$itemname][$key])) {
-            return $this->_registryArray['objects'][$modulename][$itemname][$key];
-        } else {
-            $objectHandler = xoops_getModuleHandler($itemname, $modulename);
-            $object        = $objectHandler->get($key);
-            if (!$object->isNew()) {
-                return $object;
-            } else {
-                return false;
-            }
-        }
-    }
+	public $_registryArray;
+
+	/**
+	 * Access the only instance of this class
+	 *
+	 * @return \XoopsModules\Smartobject\ObjectsRegistry
+	 *
+	 * @static
+	 * @staticvar   object
+	 */
+	public static function getInstance()
+	{
+		static $instance;
+		if (null === $instance) {
+			$instance = new static();
+		}
+
+		return $instance;
+	}
+
+	/**
+	 * Adding objects to the registry
+	 *
+	 * @param  PersistableObjectHandler $handler  of the objects to add
+	 * @param  bool|CriteriaCompo       $criteria to pass to the getObjects method of the handler (with id_as_key)
+	 * @return FALSE                         if an error occured
+	 */
+	public function addObjectsFromHandler(&$handler, $criteria = false)
+	{
+		if (method_exists($handler, 'getObjects')) {
+			$objects                                                                     = $handler->getObjects($criteria, true);
+			$this->_registryArray['objects'][$handler->_moduleName][$handler->_itemname] = $objects;
+
+			return $objects;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Adding objects to the registry from an item name
+	 * This method will fetch the handler of the item / module and call the addObjectsFromHandler
+	 *
+	 * @param  string             $item       name of the item
+	 * @param  bool|string        $modulename name of the module
+	 * @param  bool|CriteriaCompo $criteria   to pass to the getObjects method of the handler (with id_as_key)
+	 * @return FALSE              if an error occured
+	 */
+	public function addObjectsFromItemName($item, $modulename = false, $criteria = false)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		$objectHandler = xoops_getModuleHandler($item, $modulename);
+
+		if (method_exists($objectHandler, 'getObjects')) {
+			$objects                                                                                 = $objectHandler->getObjects($criteria, true);
+			$this->_registryArray['objects'][$objectHandler->_moduleName][$objectHandler->_itemname] = $objects;
+
+			return $objects;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Fetching objects from the registry
+	 *
+	 * @param string $itemname
+	 * @param string $modulename
+	 *
+	 * @return false|array the requested objects or FALSE if they don't exists in the registry
+	 */
+	public function getObjects($itemname, $modulename)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		if (isset($this->_registryArray['objects'][$modulename][$itemname])) {
+			return $this->_registryArray['objects'][$modulename][$itemname];
+		} else {
+			// if they were not in registry, let's fetch them and add them to the reigistry
+			$moduleHandler = xoops_getModuleHandler($itemname, $modulename);
+			if (method_exists($moduleHandler, 'getObjects')) {
+				$objects = $moduleHandler->getObjects();
+			}
+			$this->_registryArray['objects'][$modulename][$itemname] = $objects;
+
+			return $objects;
+		}
+	}
+
+	/**
+	 * Fetching objects from the registry, as a list: objectid => identifier
+	 *
+	 * @param string $itemname
+	 * @param string $modulename
+	 *
+	 * @return false|array the requested objects or FALSE if they don't exists in the registry
+	 */
+	public function getList($itemname, $modulename)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		if (isset($this->_registryArray['list'][$modulename][$itemname])) {
+			return $this->_registryArray['list'][$modulename][$itemname];
+		} else {
+			// if they were not in registry, let's fetch them and add them to the reigistry
+			$moduleHandler = xoops_getModuleHandler($itemname, $modulename);
+			if (method_exists($moduleHandler, 'getList')) {
+				$objects = $moduleHandler->getList();
+			}
+			$this->_registryArray['list'][$modulename][$itemname] = $objects;
+
+			return $objects;
+		}
+	}
+
+	/**
+	 * Retreive a single object
+	 *
+	 * @param string $itemname
+	 * @param string $key
+	 *
+	 * @param  bool  $modulename
+	 * @return false|\XoopsObject the  requestd object or FALSE if they don't exists in the registry
+	 */
+	public function getSingleObject($itemname, $key, $modulename = false)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		if (isset($this->_registryArray['objects'][$modulename][$itemname][$key])) {
+			return $this->_registryArray['objects'][$modulename][$itemname][$key];
+		} else {
+			$objectHandler = xoops_getModuleHandler($itemname, $modulename);
+			$object        = $objectHandler->get($key);
+			if (!$object->isNew()) {
+				return $object;
+			} else {
+				return false;
+			}
+		}
+	}
 }

class/UrlLinkHandler.php

Indentation +8 added lines, -8 removed lines

@@ -30,12 +30,12 @@
  */
 class UrlLinkHandler extends Smartobject\PersistableObjectHandler
 {
-    /**
-     * SmartobjectUrlLinkHandler constructor.
-     * @param \XoopsDatabase $db
-     */
-    public function __construct(\XoopsDatabase $db)
-    {
-        parent::__construct($db, 'urllink', 'urllinkid', 'caption', 'desc', 'smartobject');
-    }
+	/**
+	 * SmartobjectUrlLinkHandler constructor.
+	 * @param \XoopsDatabase $db
+	 */
+	public function __construct(\XoopsDatabase $db)
+	{
+		parent::__construct($db, 'urllink', 'urllinkid', 'caption', 'desc', 'smartobject');
+	}
 }

class/PersistableObjectHandler.php

Indentation +976 added lines, -976 removed lines

@@ -29,985 +29,985 @@
 
 class PersistableObjectHandler 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 BaseSmartObject} 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 containing the events name and functions
-     *
-     * @var array
-     */
-    public $eventArray = [];
-
-    /**
-     * Array containing the permissions that this handler will manage on the objects
-     *
-     * @var array
-     */
-    public $permissionsArray = false;
-
-    public $generalSQL = false;
-
-    public $_eventHooks     = [];
-    public $_disabledEvents = [];
-
-    /**
-     * Constructor - called from child classes
-     *
-     * @param \XoopsDatabase $db           {@link XoopsDatabase}
-     * @param string         $itemname     Name of the class derived from <a href='psi_element://SmartObject'>SmartObject</a> and which this handler is handling and which this handler is handling
-     * @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 string         $summaryName
-     * @param string         $modulename
-     * @internal param string $tablename Name of the table use to store this <a href='psi_element://SmartObject'>SmartObject</a>
-     * @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;
+	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 BaseSmartObject} 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 containing the events name and functions
+	 *
+	 * @var array
+	 */
+	public $eventArray = [];
+
+	/**
+	 * Array containing the permissions that this handler will manage on the objects
+	 *
+	 * @var array
+	 */
+	public $permissionsArray = false;
+
+	public $generalSQL = false;
+
+	public $_eventHooks     = [];
+	public $_disabledEvents = [];
+
+	/**
+	 * Constructor - called from child classes
+	 *
+	 * @param \XoopsDatabase $db           {@link XoopsDatabase}
+	 * @param string         $itemname     Name of the class derived from <a href='psi_element://SmartObject'>SmartObject</a> and which this handler is handling and which this handler is handling
+	 * @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 string         $summaryName
+	 * @param string         $modulename
+	 * @internal param string $tablename Name of the table use to store this <a href='psi_element://SmartObject'>SmartObject</a>
+	 * @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->className      = $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)
-    {
+		$this->className      = $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)
+	{
 //        require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectpermission.php';
 
-        $this->permissionsArray[] = [
-            'perm_name'   => $perm_name,
-            'caption'     => $caption,
-            'description' => $description
-        ];
-    }
-
-    /**
-     * @param $criteria
-     * @param $perm_name
-     * @return bool
-     */
-    public function setGrantedObjectsCriteria($criteria, $perm_name)
-    {
-        $smartPermissionsHandler = new PermissionHandler($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\BaseSmartObject}
-     *
-     * @param bool $isNew Flag the new objects as "new"?
-     *
-     * @return Smartobject\BaseSmartObject {@link Smartobject\BaseSmartObject}
-     */
-    public function create($isNew = true)
-    {
+		$this->permissionsArray[] = [
+			'perm_name'   => $perm_name,
+			'caption'     => $caption,
+			'description' => $description
+		];
+	}
+
+	/**
+	 * @param $criteria
+	 * @param $perm_name
+	 * @return bool
+	 */
+	public function setGrantedObjectsCriteria($criteria, $perm_name)
+	{
+		$smartPermissionsHandler = new PermissionHandler($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\BaseSmartObject}
+	 *
+	 * @param bool $isNew Flag the new objects as "new"?
+	 *
+	 * @return Smartobject\BaseSmartObject {@link Smartobject\BaseSmartObject}
+	 */
+	public function create($isNew = true)
+	{
 //        $obj0 = new $this->className($this);
 
-        $obj =  new $this->className;
-
-        $obj->setImageDir($this->getImageUrl(), $this->getImagePath());
-        if (!$obj->handler) {
-            $obj->Handler = $this;
-        }
-
-        if (true === $isNew) {
-            $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)) {
-            Smartobject\Utility::mkdirAsAdmin($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 (1 != count($obj_array)) {
-            $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 null|\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   = [];
-        $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 = [];
-
-        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 = [];
-        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 = [];
-        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 ('parentid' === $id_as_key) {
-                    $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 = [];
-        if (null === $criteria) {
-            $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 (false === $groupby) {
-            list($count) = $this->db->fetchRow($result);
-
-            return $count;
-        } else {
-            $ret = [];
-            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 = [];
-            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 (false !== $checkObject) {
-            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 MetaGen($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 = [];
-        foreach ($obj->cleanVars as $k => $v) {
-            if (XOBJ_DTYPE_INT == $obj->vars[$k]['data_type']) {
-                $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 Smartobject\Utility::getModuleInfo($this->_moduleName);
-    }
-
-    /**
-     * @return bool
-     */
-    public function getModuleConfig()
-    {
-        return Smartobject\Utility::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;
-        }
-    }
+		$obj =  new $this->className;
+
+		$obj->setImageDir($this->getImageUrl(), $this->getImagePath());
+		if (!$obj->handler) {
+			$obj->Handler = $this;
+		}
+
+		if (true === $isNew) {
+			$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)) {
+			Smartobject\Utility::mkdirAsAdmin($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 (1 != count($obj_array)) {
+			$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 null|\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   = [];
+		$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 = [];
+
+		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 = [];
+		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 = [];
+		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 ('parentid' === $id_as_key) {
+					$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 = [];
+		if (null === $criteria) {
+			$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 (false === $groupby) {
+			list($count) = $this->db->fetchRow($result);
+
+			return $count;
+		} else {
+			$ret = [];
+			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 = [];
+			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 (false !== $checkObject) {
+			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 MetaGen($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 = [];
+		foreach ($obj->cleanVars as $k => $v) {
+			if (XOBJ_DTYPE_INT == $obj->vars[$k]['data_type']) {
+				$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 Smartobject\Utility::getModuleInfo($this->_moduleName);
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getModuleConfig()
+	{
+		return Smartobject\Utility::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;
+		}
+	}
 }

class/Category.php

Indentation +116 added lines, -116 removed lines

@@ -20,121 +20,121 @@
  */
 class Category extends Smartobject\SeoObject
 {
-    public $_categoryPath;
-
-    /**
-     * SmartobjectCategory constructor.
-     */
-    public function __construct()
-    {
-        $this->initVar('categoryid', XOBJ_DTYPE_INT, '', true);
-        $this->initVar('parentid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_CATEGORY_PARENTID, _CO_SOBJECT_CATEGORY_PARENTID_DSC);
-        $this->initVar('name', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_NAME, _CO_SOBJECT_CATEGORY_NAME_DSC);
-        $this->initVar('description', XOBJ_DTYPE_TXTAREA, '', false, null, '', false, _CO_SOBJECT_CATEGORY_DESCRIPTION, _CO_SOBJECT_CATEGORY_DESCRIPTION_DSC);
-        $this->initVar('image', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_IMAGE, _CO_SOBJECT_CATEGORY_IMAGE_DSC);
-
-        $this->initCommonVar('doxcode');
-
-        $this->setControl('image', ['name' => 'image']);
-        $this->setControl('parentid', ['name' => 'parentcategory']);
-        $this->setControl('description', [
-            'name'        => 'textarea',
-            'itemHandler' => false,
-            'method'      => false,
-            'module'      => false,
-            'form_editor' => 'default'
-        ]);
-
-        // call parent constructor to get SEO fields initiated
-        parent::__construct();
-    }
-
-    /**
-     * returns a specific variable for the object in a proper format
-     *
-     * @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')
-    {
-        if ('s' === $format && in_array($key, ['description', 'image'])) {
-            //            return call_user_func(array($this, $key));
-            return $this->{$key}();
-        }
-
-        return parent::getVar($key, $format);
-    }
-
-    /**
-     * @return string
-     */
-    public function description()
-    {
-        return $this->getValueFor('description', false);
-    }
-
-    /**
-     * @return bool|mixed
-     */
-    public function image()
-    {
-        $ret = $this->getVar('image', 'e');
-        if ('-1' == $ret) {
-            return false;
-        } else {
-            return $ret;
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        $this->setVar('doxcode', true);
-        global $myts;
-        $objectArray = parent::toArray();
-        if ($objectArray['image']) {
-            $objectArray['image'] = $this->getImageDir() . $objectArray['image'];
-        }
-
-        return $objectArray;
-    }
-
-    /**
-     * Create the complete path of a category
-     *
-     * @todo this could be improved as it uses multiple queries
-     * @param  bool $withAllLink make all name clickable
-     * @param  bool $currentCategory
-     * @return string complete path (breadcrumb)
-     */
-    public function getCategoryPath($withAllLink = true, $currentCategory = false)
-    {
+	public $_categoryPath;
+
+	/**
+	 * SmartobjectCategory constructor.
+	 */
+	public function __construct()
+	{
+		$this->initVar('categoryid', XOBJ_DTYPE_INT, '', true);
+		$this->initVar('parentid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_CATEGORY_PARENTID, _CO_SOBJECT_CATEGORY_PARENTID_DSC);
+		$this->initVar('name', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_NAME, _CO_SOBJECT_CATEGORY_NAME_DSC);
+		$this->initVar('description', XOBJ_DTYPE_TXTAREA, '', false, null, '', false, _CO_SOBJECT_CATEGORY_DESCRIPTION, _CO_SOBJECT_CATEGORY_DESCRIPTION_DSC);
+		$this->initVar('image', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_IMAGE, _CO_SOBJECT_CATEGORY_IMAGE_DSC);
+
+		$this->initCommonVar('doxcode');
+
+		$this->setControl('image', ['name' => 'image']);
+		$this->setControl('parentid', ['name' => 'parentcategory']);
+		$this->setControl('description', [
+			'name'        => 'textarea',
+			'itemHandler' => false,
+			'method'      => false,
+			'module'      => false,
+			'form_editor' => 'default'
+		]);
+
+		// call parent constructor to get SEO fields initiated
+		parent::__construct();
+	}
+
+	/**
+	 * returns a specific variable for the object in a proper format
+	 *
+	 * @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')
+	{
+		if ('s' === $format && in_array($key, ['description', 'image'])) {
+			//            return call_user_func(array($this, $key));
+			return $this->{$key}();
+		}
+
+		return parent::getVar($key, $format);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->getValueFor('description', false);
+	}
+
+	/**
+	 * @return bool|mixed
+	 */
+	public function image()
+	{
+		$ret = $this->getVar('image', 'e');
+		if ('-1' == $ret) {
+			return false;
+		} else {
+			return $ret;
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$this->setVar('doxcode', true);
+		global $myts;
+		$objectArray = parent::toArray();
+		if ($objectArray['image']) {
+			$objectArray['image'] = $this->getImageDir() . $objectArray['image'];
+		}
+
+		return $objectArray;
+	}
+
+	/**
+	 * Create the complete path of a category
+	 *
+	 * @todo this could be improved as it uses multiple queries
+	 * @param  bool $withAllLink make all name clickable
+	 * @param  bool $currentCategory
+	 * @return string complete path (breadcrumb)
+	 */
+	public function getCategoryPath($withAllLink = true, $currentCategory = false)
+	{
 //        require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
-        $controller = new ObjectController($this->handler);
-
-        if (!$this->_categoryPath) {
-            if ($withAllLink && !$currentCategory) {
-                $ret = $controller->getItemLink($this);
-            } else {
-                $currentCategory = false;
-                $ret             = $this->getVar('name');
-            }
-            $parentid = $this->getVar('parentid');
-            if (0 != $parentid) {
-                $parentObj = $this->handler->get($parentid);
-                if ($parentObj->isNew()) {
-                    exit;
-                }
-                $parentid = $parentObj->getVar('parentid');
-                $ret      = $parentObj->getCategoryPath($withAllLink, $currentCategory) . ' > ' . $ret;
-            }
-            $this->_categoryPath = $ret;
-        }
-
-        return $this->_categoryPath;
-    }
+		$controller = new ObjectController($this->handler);
+
+		if (!$this->_categoryPath) {
+			if ($withAllLink && !$currentCategory) {
+				$ret = $controller->getItemLink($this);
+			} else {
+				$currentCategory = false;
+				$ret             = $this->getVar('name');
+			}
+			$parentid = $this->getVar('parentid');
+			if (0 != $parentid) {
+				$parentObj = $this->handler->get($parentid);
+				if ($parentObj->isNew()) {
+					exit;
+				}
+				$parentid = $parentObj->getVar('parentid');
+				$ret      = $parentObj->getCategoryPath($withAllLink, $currentCategory) . ' > ' . $ret;
+			}
+			$this->_categoryPath = $ret;
+		}
+
+		return $this->_categoryPath;
+	}
 }

class/AddTo.php

Indentation +62 added lines, -62 removed lines

@@ -31,66 +31,66 @@
 
 class AddTo
 {
-    public $_layout;
-    public $_method;
-
-    /**
-     * Constructor of SmartAddTo
-     *
-     * @param int $layout 0=Horizontal 1 row, 1=Horizontal 2 rows, 2=Vertical with icons, 3=Vertical no icons
-     * @param int $method 0=directpage, 1=popup
-     */
-    public function __construct($layout = 0, $method = 1)
-    {
-        $layout = (int)$layout;
-        if ($layout < 0 || $layout > 3) {
-            $layout = 0;
-        }
-        $this->_layout = $layout;
-
-        $method = (int)$method;
-        if ($method < 0 || $method > 1) {
-            $method = 1;
-        }
-        $this->_method = $method;
-    }
-
-    /**
-     * @param  bool $fetchOnly
-     * @return mixed|string|void
-     */
-    public function render($fetchOnly = false)
-    {
-        global $xoTheme, $xoopsTpl;
-
-        $xoTheme->addStylesheet(SMARTOBJECT_URL . 'include/addto/addto.css');
-
-        $xoopsTpl->assign('smartobject_addto_method', $this->_method);
-        $xoopsTpl->assign('smartobject_addto_layout', $this->_layout);
-
-        $xoopsTpl->assign('smartobject_addto_url', SMARTOBJECT_URL . 'include/addto/');
-
-        if ($fetchOnly) {
-            return $xoopsTpl->fetch('db:smartobject_addto.tpl');
-        } else {
-            $xoopsTpl->display('db:smartobject_addto.tpl');
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function renderForBlock()
-    {
-        global $xoTheme;
-
-        $xoTheme->addStylesheet(SMARTOBJECT_URL . 'include/addto/addto.css');
-
-        $block                             = [];
-        $block['smartobject_addto_method'] = $this->_method;
-        $block['smartobject_addto_layout'] = $this->_layout;
-        $block['smartobject_addto_url']    = SMARTOBJECT_URL . 'include/addto/';
-
-        return $block;
-    }
+	public $_layout;
+	public $_method;
+
+	/**
+	 * Constructor of SmartAddTo
+	 *
+	 * @param int $layout 0=Horizontal 1 row, 1=Horizontal 2 rows, 2=Vertical with icons, 3=Vertical no icons
+	 * @param int $method 0=directpage, 1=popup
+	 */
+	public function __construct($layout = 0, $method = 1)
+	{
+		$layout = (int)$layout;
+		if ($layout < 0 || $layout > 3) {
+			$layout = 0;
+		}
+		$this->_layout = $layout;
+
+		$method = (int)$method;
+		if ($method < 0 || $method > 1) {
+			$method = 1;
+		}
+		$this->_method = $method;
+	}
+
+	/**
+	 * @param  bool $fetchOnly
+	 * @return mixed|string|void
+	 */
+	public function render($fetchOnly = false)
+	{
+		global $xoTheme, $xoopsTpl;
+
+		$xoTheme->addStylesheet(SMARTOBJECT_URL . 'include/addto/addto.css');
+
+		$xoopsTpl->assign('smartobject_addto_method', $this->_method);
+		$xoopsTpl->assign('smartobject_addto_layout', $this->_layout);
+
+		$xoopsTpl->assign('smartobject_addto_url', SMARTOBJECT_URL . 'include/addto/');
+
+		if ($fetchOnly) {
+			return $xoopsTpl->fetch('db:smartobject_addto.tpl');
+		} else {
+			$xoopsTpl->display('db:smartobject_addto.tpl');
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function renderForBlock()
+	{
+		global $xoTheme;
+
+		$xoTheme->addStylesheet(SMARTOBJECT_URL . 'include/addto/addto.css');
+
+		$block                             = [];
+		$block['smartobject_addto_method'] = $this->_method;
+		$block['smartobject_addto_layout'] = $this->_layout;
+		$block['smartobject_addto_url']    = SMARTOBJECT_URL . 'include/addto/';
+
+		return $block;
+	}
 }