mambax7 / smartobject

class/Form/Elements/SmartFormUploadElement.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,8 +19,8 @@
 class SmartFormUploadElement extends \XoopsFormFile
 {
     /**
-     * @param $object
-     * @param $key
+     * @param string $object
+     * @param string $key
      */
     public function SmartFormFileElement($object, $key)
     {

Indentation +18 added lines, -18 removed lines

@@ -18,25 +18,25 @@
  */
 class SmartFormUploadElement extends \XoopsFormFile
 {
-    /**
-     * @param $object
-     * @param $key
-     */
-    public function SmartFormFileElement($object, $key)
-    {
-        parent::__construct(_CO_SOBJECT_UPLOAD, $key, isset($object->vars[$key]['form_maxfilesize']) ? $object->vars[$key]['form_maxfilesize'] : 0);
-        $this->setExtra(' size=50');
-    }
+	/**
+	 * @param $object
+	 * @param $key
+	 */
+	public function SmartFormFileElement($object, $key)
+	{
+		parent::__construct(_CO_SOBJECT_UPLOAD, $key, isset($object->vars[$key]['form_maxfilesize']) ? $object->vars[$key]['form_maxfilesize'] : 0);
+		$this->setExtra(' size=50');
+	}
 
-    /**
-     * prepare HTML for output
-     *
-     * @return string HTML
-     */
-    public function render()
-    {
-        return "<input type='hidden' name='MAX_FILE_SIZE' value='" . $this->getMaxFileSize() . "'>
+	/**
+	 * prepare HTML for output
+	 *
+	 * @return string HTML
+	 */
+	public function render()
+	{
+		return "<input type='hidden' name='MAX_FILE_SIZE' value='" . $this->getMaxFileSize() . "'>
                 <input type='file' name='" . $this->getName() . "' id='" . $this->getName() . "'" . $this->getExtra() . ">
                 <input type='hidden' name='smart_upload_file[]' id='smart_upload_file[]' value='" . $this->getName() . "'>";
-    }
+	}
 }

class/SmartDbTable.php

Doc Comments +1 added lines, -1 removed lines

@@ -164,7 +164,7 @@
     }
 
     /**
-     * @param $field
+     * @param string $field
      * @return bool
      */
     public function fieldExists($field)

Indentation +499 added lines, -500 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;
 
@@ -55,501 +54,501 @@ 
  */
 class SmartDbTable
 {
-    /**
-     * @var string $_name name of the table
-     */
-    public $_name;
-    /**
-     * @var string $_structure structure of the table
-     */
-    public $_structure;
-
-    /**
-     * @var array $_data containing valued of each records to be added
-     */
-    public $_data;
-
-    /**
-     * @var array $_alteredFields containing fields to be altered
-     */
-    public $_alteredFields;
-
-    /**
-     * @var array $_newFields containing new fields to be added
-     */
-    public $_newFields;
-
-    /**
-     * @var array $_droppedFields containing fields to be dropped
-     */
-    public $_droppedFields;
-
-    /**
-     * @var array $_flagForDrop flag table to drop it
-     */
-    public $_flagForDrop = false;
-
-    /**
-     * @var array $_updatedFields containing fields which values will be updated
-     */
-    public $_updatedFields;
-
-    /**
-     * @var array $_updatedFields containing fields which values will be updated
-     */ //felix
-    public $_updatedWhere;
-
-    public $_existingFieldsArray = false;
-
-    /**
-     * Constructor
-     *
-     * @param string $name name of the table
-     *
-     */
-    public function __construct($name)
-    {
-        $this->_name = $name;
-        $this->_data = [];
-    }
-
-    /**
-     * Return the table name, prefixed with site table prefix
-     *
-     * @return string table name
-     *
-     */
-    public function name()
-    {
-        global $xoopsDB;
-
-        return $xoopsDB->prefix($this->_name);
-    }
-
-    /**
-     * Checks if the table already exists in the database
-     *
-     * @return bool TRUE if it exists, FALSE if not
-     *
-     */
-    public function exists()
-    {
-        return smart_TableExists($this->_name);
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getExistingFieldsArray()
-    {
-        global $xoopsDB;
-        $result = $xoopsDB->query('SHOW COLUMNS FROM ' . $this->name());
-        while (false !== ($existing_field = $xoopsDB->fetchArray($result))) {
-            $fields[$existing_field['Field']] = $existing_field['Type'];
-            if ('YES' !== $existing_field['Null']) {
-                $fields[$existing_field['Field']] .= ' NOT NULL';
-            }
-            if ($existing_field['Extra']) {
-                $fields[$existing_field['Field']] .= ' ' . $existing_field['Extra'];
-            }
-            if (!(null === $existing_field['Default'])
-                && ($existing_field['Default']
-                    || '' === $existing_field['Default']
-                    || 0 == $existing_field['Default'])) {
-                $fields[$existing_field['Field']] .= " default '" . $existing_field['Default'] . "'";
-            }
-        }
-
-        return $fields;
-    }
-
-    /**
-     * @param $field
-     * @return bool
-     */
-    public function fieldExists($field)
-    {
-        $existingFields = $this->getExistingFieldsArray();
-
-        return isset($existingFields[$field]);
-    }
-
-    /**
-     * Set the table structure
-     *
-     * Example:
-     *
-     *      $table->setStructure("`transactionid` int(11) NOT NULL auto_increment,
-     *                `date` int(11) NOT NULL default '0',
-     *                `status` int(1) NOT NULL default '-1',
-     *                `itemid` int(11) NOT NULL default '0',
-     *                `uid` int(11) NOT NULL default '0',
-     *                `price` float NOT NULL default '0',
-     *                `currency` varchar(100) NOT NULL default '',
-     *                PRIMARY KEY  (`transactionid`)");
-     *
-     * @param string $structure table structure
-     *
-     */
-    public function setStructure($structure)
-    {
-        $this->_structure = $structure;
-    }
-
-    /**
-     * Return the table structure
-     *
-     * @return string table structure
-     *
-     */
-    public function getStructure()
-    {
-        return sprintf($this->_structure, $this->name());
-    }
-
-    /**
-     * Add values of a record to be added
-     *
-     * @param string $data values of a record
-     *
-     */
-    public function setData($data)
-    {
-        $this->_data[] = $data;
-    }
-
-    /**
-     * Get the data array
-     *
-     * @return array containing the records values to be added
-     *
-     */
-    public function getData()
-    {
-        return $this->_data;
-    }
-
-    /**
-     * Use to insert data in a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function addData()
-    {
-        global $xoopsDB;
-        foreach ($this->getData() as $data) {
-            $query = sprintf('INSERT INTO %s VALUES (%s)', $this->name(), $data);
-            $ret   = $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA_ERR, $this->name()) . '<br>';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA, $this->name()) . '<br>';
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Add a field to be added
-     *
-     * @param string $name       name of the field
-     * @param string $properties properties of the field
-     * @param bool   $newname
-     * @param bool   $showerror
-     */
-    public function addAlteredField($name, $properties, $newname = false, $showerror = true)
-    {
-        $field['name']          = $name;
-        $field['properties']    = $properties;
-        $field['showerror']     = $showerror;
-        $field['newname']       = $newname;
-        $this->_alteredFields[] = $field;
-    }
-    /**
-     * Invert values 0 to 1 and 1 to 0
-     *
-     * @param string $name name of the field
-     * @param        $newValue
-     * @param        $oldValue
-     * @internal param string $old old propertie
-     * @internal param string $new new propertie
-     */ //felix
-    public function addUpdatedWhere($name, $newValue, $oldValue)
-    {
-        $field['name']         = $name;
-        $field['value']        = $newValue;
-        $field['where']        = $oldValue;
-        $this->_updatedWhere[] = $field;
-    }
-
-    /**
-     * Add new field of a record to be added
-     *
-     * @param string $name       name of the field
-     * @param string $properties properties of the field
-     *
-     */
-    public function addNewField($name, $properties)
-    {
-        $field['name']       = $name;
-        $field['properties'] = $properties;
-        $this->_newFields[]  = $field;
-    }
-
-    /**
-     * Get fields that need to be altered
-     *
-     * @return array fields that need to be altered
-     *
-     */
-    public function getAlteredFields()
-    {
-        return $this->_alteredFields;
-    }
-
-    /**
-     * Add field for which the value will be updated
-     *
-     * @param string $name  name of the field
-     * @param string $value value to be set
-     *
-     */
-    public function addUpdatedField($name, $value)
-    {
-        $field['name']          = $name;
-        $field['value']         = $value;
-        $this->_updatedFields[] = $field;
-    }
-
-    /**
-     * Get new fields to be added
-     *
-     * @return array fields to be added
-     *
-     */
-    public function getNewFields()
-    {
-        return $this->_newFields;
-    }
-
-    /**
-     * Get fields which values need to be updated
-     *
-     * @return array fields which values need to be updated
-     *
-     */
-    public function getUpdatedFields()
-    {
-        return $this->_updatedFields;
-    }
-    /**
-     * Get fields which values need to be updated
-     *
-     * @return array fields which values need to be updated
-     *
-     */ //felix
-    public function getUpdatedWhere()
-    {
-        return $this->_updatedWhere;
-    }
-
-    /**
-     * Add values of a record to be added
-     *
-     * @param string $name name of the field
-     *
-     */
-    public function addDroppedField($name)
-    {
-        $this->_droppedFields[] = $name;
-    }
-
-    /**
-     * Get fields that need to be dropped
-     *
-     * @return array fields that need to be dropped
-     *
-     */
-    public function getDroppedFields()
-    {
-        return $this->_droppedFields;
-    }
-
-    /**
-     * Set the flag to drop the table
-     *
-     */
-    public function setFlagForDrop()
-    {
-        $this->_flagForDrop = true;
-    }
-
-    /**
-     * Use to create a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function createTable()
-    {
-        global $xoopsDB;
-        $query = $this->getStructure();
-        $query = 'CREATE TABLE `' . $this->name() . '` (' . $query . ") ENGINE=MyISAM COMMENT='The SmartFactory <www.smartfactory.ca>'";
-        //xoops_debug($query);
-        $ret = $xoopsDB->query($query);
-        if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
-        } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE, $this->name()) . '<br>';
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to drop a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function dropTable()
-    {
-        global $xoopsDB;
-        $query = sprintf('DROP TABLE %s', $this->name());
-        $ret   = $xoopsDB->query($query);
-        if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
-
-            return false;
-        } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE, $this->name()) . '<br>';
-
-            return true;
-        }
-    }
-
-    /**
-     * Use to alter a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function alterTable()
-    {
-        global $xoopsDB;
-        $ret = true;
-
-        foreach ($this->getAlteredFields() as $alteredField) {
-            if (!$alteredField['newname']) {
-                $alteredField['newname'] = $alteredField['name'];
-            }
-
-            $query = sprintf('ALTER TABLE `%s` CHANGE `%s` `%s` %s', $this->name(), $alteredField['name'], $alteredField['newname'], $alteredField['properties']);
-            $ret   = $ret && $xoopsDB->query($query);
-            if ($alteredField['showerror']) {
-                if (!$ret) {
-                    echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
-                } else {
-                    echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()) . '<br>';
-                }
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to add new fileds in the table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function addNewFields()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getNewFields() as $newField) {
-            $query = sprintf('ALTER TABLE `%s` ADD `%s` %s', $this->name(), $newField['name'], $newField['properties']);
-            //echo $query;
-            $ret = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD_ERR, $newField['name'], $this->name()) . '<br>';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD, $newField['name'], $this->name()) . '<br>';
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to update fields values
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function updateFieldsValues()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getUpdatedFields() as $updatedField) {
-            $query = sprintf('UPDATE %s SET %s = %s', $this->name(), $updatedField['name'], $updatedField['value']);
-            $ret   = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br>';
-            }
-        }
-
-        return $ret;
-    }
-    /**
-     * Use to update fields values
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */ //felix
-    public function updateWhereValues()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getUpdatedWhere() as $updatedWhere) {
-            $query = sprintf('UPDATE %s SET %s = %s WHERE %s  %s', $this->name(), $updatedWhere['name'], $updatedWhere['value'], $updatedWhere['name'], $updatedWhere['where']);
-            //echo $query."<br>";
-            $ret = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br>';
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to drop fields
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function dropFields()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getDroppedFields() as $droppedField) {
-            $query = sprintf('ALTER TABLE %s DROP %s', $this->name(), $droppedField);
-            $ret   = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD_ERR, $droppedField, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD, $droppedField, $this->name()) . '<br>';
-            }
-        }
-
-        return $ret;
-    }
+	/**
+	 * @var string $_name name of the table
+	 */
+	public $_name;
+	/**
+	 * @var string $_structure structure of the table
+	 */
+	public $_structure;
+
+	/**
+	 * @var array $_data containing valued of each records to be added
+	 */
+	public $_data;
+
+	/**
+	 * @var array $_alteredFields containing fields to be altered
+	 */
+	public $_alteredFields;
+
+	/**
+	 * @var array $_newFields containing new fields to be added
+	 */
+	public $_newFields;
+
+	/**
+	 * @var array $_droppedFields containing fields to be dropped
+	 */
+	public $_droppedFields;
+
+	/**
+	 * @var array $_flagForDrop flag table to drop it
+	 */
+	public $_flagForDrop = false;
+
+	/**
+	 * @var array $_updatedFields containing fields which values will be updated
+	 */
+	public $_updatedFields;
+
+	/**
+	 * @var array $_updatedFields containing fields which values will be updated
+	 */ //felix
+	public $_updatedWhere;
+
+	public $_existingFieldsArray = false;
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $name name of the table
+	 *
+	 */
+	public function __construct($name)
+	{
+		$this->_name = $name;
+		$this->_data = [];
+	}
+
+	/**
+	 * Return the table name, prefixed with site table prefix
+	 *
+	 * @return string table name
+	 *
+	 */
+	public function name()
+	{
+		global $xoopsDB;
+
+		return $xoopsDB->prefix($this->_name);
+	}
+
+	/**
+	 * Checks if the table already exists in the database
+	 *
+	 * @return bool TRUE if it exists, FALSE if not
+	 *
+	 */
+	public function exists()
+	{
+		return smart_TableExists($this->_name);
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getExistingFieldsArray()
+	{
+		global $xoopsDB;
+		$result = $xoopsDB->query('SHOW COLUMNS FROM ' . $this->name());
+		while (false !== ($existing_field = $xoopsDB->fetchArray($result))) {
+			$fields[$existing_field['Field']] = $existing_field['Type'];
+			if ('YES' !== $existing_field['Null']) {
+				$fields[$existing_field['Field']] .= ' NOT NULL';
+			}
+			if ($existing_field['Extra']) {
+				$fields[$existing_field['Field']] .= ' ' . $existing_field['Extra'];
+			}
+			if (!(null === $existing_field['Default'])
+				&& ($existing_field['Default']
+					|| '' === $existing_field['Default']
+					|| 0 == $existing_field['Default'])) {
+				$fields[$existing_field['Field']] .= " default '" . $existing_field['Default'] . "'";
+			}
+		}
+
+		return $fields;
+	}
+
+	/**
+	 * @param $field
+	 * @return bool
+	 */
+	public function fieldExists($field)
+	{
+		$existingFields = $this->getExistingFieldsArray();
+
+		return isset($existingFields[$field]);
+	}
+
+	/**
+	 * Set the table structure
+	 *
+	 * Example:
+	 *
+	 *      $table->setStructure("`transactionid` int(11) NOT NULL auto_increment,
+	 *                `date` int(11) NOT NULL default '0',
+	 *                `status` int(1) NOT NULL default '-1',
+	 *                `itemid` int(11) NOT NULL default '0',
+	 *                `uid` int(11) NOT NULL default '0',
+	 *                `price` float NOT NULL default '0',
+	 *                `currency` varchar(100) NOT NULL default '',
+	 *                PRIMARY KEY  (`transactionid`)");
+	 *
+	 * @param string $structure table structure
+	 *
+	 */
+	public function setStructure($structure)
+	{
+		$this->_structure = $structure;
+	}
+
+	/**
+	 * Return the table structure
+	 *
+	 * @return string table structure
+	 *
+	 */
+	public function getStructure()
+	{
+		return sprintf($this->_structure, $this->name());
+	}
+
+	/**
+	 * Add values of a record to be added
+	 *
+	 * @param string $data values of a record
+	 *
+	 */
+	public function setData($data)
+	{
+		$this->_data[] = $data;
+	}
+
+	/**
+	 * Get the data array
+	 *
+	 * @return array containing the records values to be added
+	 *
+	 */
+	public function getData()
+	{
+		return $this->_data;
+	}
+
+	/**
+	 * Use to insert data in a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function addData()
+	{
+		global $xoopsDB;
+		foreach ($this->getData() as $data) {
+			$query = sprintf('INSERT INTO %s VALUES (%s)', $this->name(), $data);
+			$ret   = $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA_ERR, $this->name()) . '<br>';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA, $this->name()) . '<br>';
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Add a field to be added
+	 *
+	 * @param string $name       name of the field
+	 * @param string $properties properties of the field
+	 * @param bool   $newname
+	 * @param bool   $showerror
+	 */
+	public function addAlteredField($name, $properties, $newname = false, $showerror = true)
+	{
+		$field['name']          = $name;
+		$field['properties']    = $properties;
+		$field['showerror']     = $showerror;
+		$field['newname']       = $newname;
+		$this->_alteredFields[] = $field;
+	}
+	/**
+	 * Invert values 0 to 1 and 1 to 0
+	 *
+	 * @param string $name name of the field
+	 * @param        $newValue
+	 * @param        $oldValue
+	 * @internal param string $old old propertie
+	 * @internal param string $new new propertie
+	 */ //felix
+	public function addUpdatedWhere($name, $newValue, $oldValue)
+	{
+		$field['name']         = $name;
+		$field['value']        = $newValue;
+		$field['where']        = $oldValue;
+		$this->_updatedWhere[] = $field;
+	}
+
+	/**
+	 * Add new field of a record to be added
+	 *
+	 * @param string $name       name of the field
+	 * @param string $properties properties of the field
+	 *
+	 */
+	public function addNewField($name, $properties)
+	{
+		$field['name']       = $name;
+		$field['properties'] = $properties;
+		$this->_newFields[]  = $field;
+	}
+
+	/**
+	 * Get fields that need to be altered
+	 *
+	 * @return array fields that need to be altered
+	 *
+	 */
+	public function getAlteredFields()
+	{
+		return $this->_alteredFields;
+	}
+
+	/**
+	 * Add field for which the value will be updated
+	 *
+	 * @param string $name  name of the field
+	 * @param string $value value to be set
+	 *
+	 */
+	public function addUpdatedField($name, $value)
+	{
+		$field['name']          = $name;
+		$field['value']         = $value;
+		$this->_updatedFields[] = $field;
+	}
+
+	/**
+	 * Get new fields to be added
+	 *
+	 * @return array fields to be added
+	 *
+	 */
+	public function getNewFields()
+	{
+		return $this->_newFields;
+	}
+
+	/**
+	 * Get fields which values need to be updated
+	 *
+	 * @return array fields which values need to be updated
+	 *
+	 */
+	public function getUpdatedFields()
+	{
+		return $this->_updatedFields;
+	}
+	/**
+	 * Get fields which values need to be updated
+	 *
+	 * @return array fields which values need to be updated
+	 *
+	 */ //felix
+	public function getUpdatedWhere()
+	{
+		return $this->_updatedWhere;
+	}
+
+	/**
+	 * Add values of a record to be added
+	 *
+	 * @param string $name name of the field
+	 *
+	 */
+	public function addDroppedField($name)
+	{
+		$this->_droppedFields[] = $name;
+	}
+
+	/**
+	 * Get fields that need to be dropped
+	 *
+	 * @return array fields that need to be dropped
+	 *
+	 */
+	public function getDroppedFields()
+	{
+		return $this->_droppedFields;
+	}
+
+	/**
+	 * Set the flag to drop the table
+	 *
+	 */
+	public function setFlagForDrop()
+	{
+		$this->_flagForDrop = true;
+	}
+
+	/**
+	 * Use to create a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function createTable()
+	{
+		global $xoopsDB;
+		$query = $this->getStructure();
+		$query = 'CREATE TABLE `' . $this->name() . '` (' . $query . ") ENGINE=MyISAM COMMENT='The SmartFactory <www.smartfactory.ca>'";
+		//xoops_debug($query);
+		$ret = $xoopsDB->query($query);
+		if (!$ret) {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+		} else {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE, $this->name()) . '<br>';
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to drop a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function dropTable()
+	{
+		global $xoopsDB;
+		$query = sprintf('DROP TABLE %s', $this->name());
+		$ret   = $xoopsDB->query($query);
+		if (!$ret) {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+
+			return false;
+		} else {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE, $this->name()) . '<br>';
+
+			return true;
+		}
+	}
+
+	/**
+	 * Use to alter a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function alterTable()
+	{
+		global $xoopsDB;
+		$ret = true;
+
+		foreach ($this->getAlteredFields() as $alteredField) {
+			if (!$alteredField['newname']) {
+				$alteredField['newname'] = $alteredField['name'];
+			}
+
+			$query = sprintf('ALTER TABLE `%s` CHANGE `%s` `%s` %s', $this->name(), $alteredField['name'], $alteredField['newname'], $alteredField['properties']);
+			$ret   = $ret && $xoopsDB->query($query);
+			if ($alteredField['showerror']) {
+				if (!$ret) {
+					echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+				} else {
+					echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()) . '<br>';
+				}
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to add new fileds in the table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function addNewFields()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getNewFields() as $newField) {
+			$query = sprintf('ALTER TABLE `%s` ADD `%s` %s', $this->name(), $newField['name'], $newField['properties']);
+			//echo $query;
+			$ret = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD_ERR, $newField['name'], $this->name()) . '<br>';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD, $newField['name'], $this->name()) . '<br>';
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to update fields values
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function updateFieldsValues()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getUpdatedFields() as $updatedField) {
+			$query = sprintf('UPDATE %s SET %s = %s', $this->name(), $updatedField['name'], $updatedField['value']);
+			$ret   = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br>';
+			}
+		}
+
+		return $ret;
+	}
+	/**
+	 * Use to update fields values
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */ //felix
+	public function updateWhereValues()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getUpdatedWhere() as $updatedWhere) {
+			$query = sprintf('UPDATE %s SET %s = %s WHERE %s  %s', $this->name(), $updatedWhere['name'], $updatedWhere['value'], $updatedWhere['name'], $updatedWhere['where']);
+			//echo $query."<br>";
+			$ret = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br>';
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to drop fields
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function dropFields()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getDroppedFields() as $droppedField) {
+			$query = sprintf('ALTER TABLE %s DROP %s', $this->name(), $droppedField);
+			$ret   = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD_ERR, $droppedField, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD, $droppedField, $this->name()) . '<br>';
+			}
+		}
+
+		return $ret;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -38,15 +38,15 @@ 
  */
 // 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
  */
 global $xoopsConfig;
-$common_file = SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/smartdbupdater.php';
+$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;
 
@@ -143,20 +143,20 @@ 
     public function getExistingFieldsArray()
     {
         global $xoopsDB;
-        $result = $xoopsDB->query('SHOW COLUMNS FROM ' . $this->name());
+        $result = $xoopsDB->query('SHOW COLUMNS FROM '.$this->name());
         while (false !== ($existing_field = $xoopsDB->fetchArray($result))) {
             $fields[$existing_field['Field']] = $existing_field['Type'];
             if ('YES' !== $existing_field['Null']) {
                 $fields[$existing_field['Field']] .= ' NOT NULL';
             }
             if ($existing_field['Extra']) {
-                $fields[$existing_field['Field']] .= ' ' . $existing_field['Extra'];
+                $fields[$existing_field['Field']] .= ' '.$existing_field['Extra'];
             }
             if (!(null === $existing_field['Default'])
                 && ($existing_field['Default']
                     || '' === $existing_field['Default']
                     || 0 == $existing_field['Default'])) {
-                $fields[$existing_field['Field']] .= " default '" . $existing_field['Default'] . "'";
+                $fields[$existing_field['Field']] .= " default '".$existing_field['Default']."'";
             }
         }
 
@@ -242,9 +242,9 @@ 
             $query = sprintf('INSERT INTO %s VALUES (%s)', $this->name(), $data);
             $ret   = $xoopsDB->query($query);
             if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA_ERR, $this->name()) . '<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_ADD_DATA_ERR, $this->name()).'<br>';
             } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA, $this->name()) . '<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_ADD_DATA, $this->name()).'<br>';
             }
         }
 
@@ -396,13 +396,13 @@ 
     {
         global $xoopsDB;
         $query = $this->getStructure();
-        $query = 'CREATE TABLE `' . $this->name() . '` (' . $query . ") ENGINE=MyISAM COMMENT='The SmartFactory <www.smartfactory.ca>'";
+        $query = 'CREATE TABLE `'.$this->name().'` ('.$query.") ENGINE=MyISAM COMMENT='The SmartFactory <www.smartfactory.ca>'";
         //xoops_debug($query);
         $ret = $xoopsDB->query($query);
         if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+            echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()).' ('.$xoopsDB->error().')<br>';
         } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE, $this->name()) . '<br>';
+            echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_CREATE_TABLE, $this->name()).'<br>';
         }
 
         return $ret;
@@ -420,11 +420,11 @@ 
         $query = sprintf('DROP TABLE %s', $this->name());
         $ret   = $xoopsDB->query($query);
         if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+            echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()).' ('.$xoopsDB->error().')<br>';
 
             return false;
         } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE, $this->name()) . '<br>';
+            echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_DROP_TABLE, $this->name()).'<br>';
 
             return true;
         }
@@ -450,9 +450,9 @@ 
             $ret   = $ret && $xoopsDB->query($query);
             if ($alteredField['showerror']) {
                 if (!$ret) {
-                    echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+                    echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()).' ('.$xoopsDB->error().')<br>';
                 } else {
-                    echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()) . '<br>';
+                    echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()).'<br>';
                 }
             }
         }
@@ -475,9 +475,9 @@ 
             //echo $query;
             $ret = $ret && $xoopsDB->query($query);
             if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD_ERR, $newField['name'], $this->name()) . '<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_NEWFIELD_ERR, $newField['name'], $this->name()).'<br>';
             } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD, $newField['name'], $this->name()) . '<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_NEWFIELD, $newField['name'], $this->name()).'<br>';
             }
         }
 
@@ -498,9 +498,9 @@ 
             $query = sprintf('UPDATE %s SET %s = %s', $this->name(), $updatedField['name'], $updatedField['value']);
             $ret   = $ret && $xoopsDB->query($query);
             if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()).' ('.$xoopsDB->error().')<br>';
             } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()).'<br>';
             }
         }
 
@@ -521,9 +521,9 @@ 
             //echo $query."<br>";
             $ret = $ret && $xoopsDB->query($query);
             if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()).' ('.$xoopsDB->error().')<br>';
             } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()).'<br>';
             }
         }
 
@@ -544,9 +544,9 @@ 
             $query = sprintf('ALTER TABLE %s DROP %s', $this->name(), $droppedField);
             $ret   = $ret && $xoopsDB->query($query);
             if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD_ERR, $droppedField, $this->name()) . ' (' . $xoopsDB->error() . ')<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_DROPFIELD_ERR, $droppedField, $this->name()).' ('.$xoopsDB->error().')<br>';
             } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD, $droppedField, $this->name()) . '<br>';
+                echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_DROPFIELD, $droppedField, $this->name()).'<br>';
             }
         }
 

class/SmartObjectColumn.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 
     /**
      * SmartObjectColumn constructor.
-     * @param        $keyname
+     * @param        string $keyname
      * @param string $align
      * @param bool   $width
      * @param bool   $customMethodForValue

Indentation +71 added lines, -71 removed lines

@@ -23,82 +23,82 @@
  */
 class SmartObjectColumn
 {
-    public $_keyname;
-    public $_align;
-    public $_width;
-    public $_customMethodForValue;
-    public $_extraParams;
-    public $_sortable;
-    public $_customCaption;
+	public $_keyname;
+	public $_align;
+	public $_width;
+	public $_customMethodForValue;
+	public $_extraParams;
+	public $_sortable;
+	public $_customCaption;
 
-    /**
-     * SmartObjectColumn constructor.
-     * @param        $keyname
-     * @param string $align
-     * @param bool   $width
-     * @param bool   $customMethodForValue
-     * @param bool   $param
-     * @param bool   $customCaption
-     * @param bool   $sortable
-     */
-    public function __construct(
-        $keyname,
-        $align = 'left',
-        $width = false,
-        $customMethodForValue = false,
-        $param = false,
-        $customCaption = false,
-        $sortable = true
-    ) {
-        $this->_keyname              = $keyname;
-        $this->_align                = $align;
-        $this->_width                = $width;
-        $this->_customMethodForValue = $customMethodForValue;
-        $this->_sortable             = $sortable;
-        $this->_param                = $param;
-        $this->_customCaption        = $customCaption;
-    }
+	/**
+	 * SmartObjectColumn constructor.
+	 * @param        $keyname
+	 * @param string $align
+	 * @param bool   $width
+	 * @param bool   $customMethodForValue
+	 * @param bool   $param
+	 * @param bool   $customCaption
+	 * @param bool   $sortable
+	 */
+	public function __construct(
+		$keyname,
+		$align = 'left',
+		$width = false,
+		$customMethodForValue = false,
+		$param = false,
+		$customCaption = false,
+		$sortable = true
+	) {
+		$this->_keyname              = $keyname;
+		$this->_align                = $align;
+		$this->_width                = $width;
+		$this->_customMethodForValue = $customMethodForValue;
+		$this->_sortable             = $sortable;
+		$this->_param                = $param;
+		$this->_customCaption        = $customCaption;
+	}
 
-    public function getKeyName()
-    {
-        return $this->_keyname;
-    }
+	public function getKeyName()
+	{
+		return $this->_keyname;
+	}
 
-    /**
-     * @return string
-     */
-    public function getAlign()
-    {
-        return $this->_align;
-    }
+	/**
+	 * @return string
+	 */
+	public function getAlign()
+	{
+		return $this->_align;
+	}
 
-    /**
-     * @return bool
-     */
-    public function isSortable()
-    {
-        return $this->_sortable;
-    }
+	/**
+	 * @return bool
+	 */
+	public function isSortable()
+	{
+		return $this->_sortable;
+	}
 
-    /**
-     * @return bool|string
-     */
-    public function getWidth()
-    {
-        if ($this->_width) {
-            $ret = $this->_width;
-        } else {
-            $ret = '';
-        }
+	/**
+	 * @return bool|string
+	 */
+	public function getWidth()
+	{
+		if ($this->_width) {
+			$ret = $this->_width;
+		} else {
+			$ret = '';
+		}
 
-        return $ret;
-    }
+		return $ret;
+	}
 
-    /**
-     * @return bool
-     */
-    public function getCustomCaption()
-    {
-        return $this->_customCaption;
-    }
+	/**
+	 * @return bool
+	 */
+	public function getCustomCaption()
+	{
+		return $this->_customCaption;
+	}
 }

class/SmartObjectController.php

Doc Comments +5 added lines, -5 removed lines

@@ -126,9 +126,9 @@ 
 
     /**
      * @param        $smartObj
-     * @param        $objectid
-     * @param        $created_success_msg
-     * @param        $modified_success_msg
+     * @param        integer $objectid
+     * @param        string $created_success_msg
+     * @param        string $modified_success_msg
      * @param  bool  $redirect_page
      * @param  bool  $debug
      * @return mixed
@@ -440,7 +440,7 @@ 
     }
 
     /**
-     * @param         $smartObj
+     * @param         SmartMlObject $smartObj
      * @param  bool   $onlyUrl
      * @param  bool   $withimage
      * @return string
@@ -498,7 +498,7 @@ 
     }
 
     /**
-     * @param $smartObj
+     * @param BaseSmartObject $smartObj
      * @return string
      */
     public function getPrintAndMailLink($smartObj)

Indentation +506 added lines, -506 removed lines

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

Spacing +46 added lines, -46 removed lines

@@ -52,15 +52,15 @@ 
         foreach (array_keys($smartObj->vars) as $key) {
             switch ($smartObj->vars[$key]['data_type']) {
                 case XOBJ_DTYPE_IMAGE:
-                    if (isset($_POST['url_' . $key]) && '' !== $_POST['url_' . $key]) {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
-                        $smartObj->setVar($key, $_POST['url_' . $key]);
+                    if (isset($_POST['url_'.$key]) && '' !== $_POST['url_'.$key]) {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
+                        $smartObj->setVar($key, $_POST['url_'.$key]);
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
                         }
                     }
-                    if (isset($_POST['delete_' . $key]) && '1' == $_POST['delete_' . $key]) {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
+                    if (isset($_POST['delete_'.$key]) && '1' == $_POST['delete_'.$key]) {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
                         $smartObj->setVar($key, '');
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
@@ -70,10 +70,10 @@ 
 
                 case XOBJ_DTYPE_URLLINK:
                     $linkObj = $smartObj->getUrlLinkObj($key);
-                    $linkObj->setVar('caption', $_POST['caption_' . $key]);
-                    $linkObj->setVar('description', $_POST['desc_' . $key]);
-                    $linkObj->setVar('target', $_POST['target_' . $key]);
-                    $linkObj->setVar('url', $_POST['url_' . $key]);
+                    $linkObj->setVar('caption', $_POST['caption_'.$key]);
+                    $linkObj->setVar('description', $_POST['desc_'.$key]);
+                    $linkObj->setVar('target', $_POST['target_'.$key]);
+                    $linkObj->setVar('url', $_POST['url_'.$key]);
                     if ('' !== $linkObj->getVar('url')) {
                         $smartObj->storeUrlLinkObj($linkObj);
                     }
@@ -82,11 +82,11 @@ 
                     break;
 
                 case XOBJ_DTYPE_FILE:
-                    if (!isset($_FILES['upload_' . $key]['name']) || '' === $_FILES['upload_' . $key]['name']) {
+                    if (!isset($_FILES['upload_'.$key]['name']) || '' === $_FILES['upload_'.$key]['name']) {
                         $fileObj = $smartObj->getFileObj($key);
-                        $fileObj->setVar('caption', $_POST['caption_' . $key]);
-                        $fileObj->setVar('description', $_POST['desc_' . $key]);
-                        $fileObj->setVar('url', $_POST['url_' . $key]);
+                        $fileObj->setVar('caption', $_POST['caption_'.$key]);
+                        $fileObj->setVar('description', $_POST['desc_'.$key]);
+                        $fileObj->setVar('url', $_POST['url_'.$key]);
                         if (!('' === $fileObj->getVar('url') && '' === $fileObj->getVar('url')
                               && '' === $fileObj->getVar('url'))) {
                             $res = $smartObj->storeFileObj($fileObj);
@@ -110,7 +110,7 @@ 
                         $value = strtotime($_POST[$key]);
                         //if strtotime returns false, the value is already a time stamp
                         if (!$value) {
-                            $value = (int)$_POST[$key];
+                            $value = (int) $_POST[$key];
                         }
                     }
                     $smartObj->setVar($key, $value);
@@ -159,7 +159,7 @@ 
                 if (isset($file_array['name']) && '' !== $file_array['name']
                     && in_array(str_replace('upload_', '', $name), array_keys($smartObj->vars))) {
                     if ($uploaderObj->fetchMedia($name)) {
-                        $uploaderObj->setTargetFileName(time() . '_' . $uploaderObj->getMediaName());
+                        $uploaderObj->setTargetFileName(time().'_'.$uploaderObj->getMediaName());
                         if ($uploaderObj->upload()) {
                             // Find the related field in the SmartObject
                             $related_field   = str_replace('upload_', '', $name);
@@ -168,14 +168,14 @@ 
                             if (XOBJ_DTYPE_FILE === $smartObj->vars[$related_field]['data_type']) {
                                 $object_fileurl = $smartObj->getUploadDir();
                                 $fileObj        = $smartObj->getFileObj($related_field);
-                                $fileObj->setVar('url', $object_fileurl . $uploaderObj->getSavedFileName());
-                                $fileObj->setVar('caption', $_POST['caption_' . $related_field]);
-                                $fileObj->setVar('description', $_POST['desc_' . $related_field]);
+                                $fileObj->setVar('url', $object_fileurl.$uploaderObj->getSavedFileName());
+                                $fileObj->setVar('caption', $_POST['caption_'.$related_field]);
+                                $fileObj->setVar('description', $_POST['desc_'.$related_field]);
                                 $smartObj->storeFileObj($fileObj);
                                 //todo: catch errors
                                 $smartObj->setVar($related_field, $fileObj->getVar('fileid'));
                             } else {
-                                $old_file = $smartObj->getUploadDir(true) . $smartObj->getVar($related_field);
+                                $old_file = $smartObj->getUploadDir(true).$smartObj->getVar($related_field);
                                 unlink($old_file);
                                 $smartObj->setVar($related_field, $uploaderObj->getSavedFileName());
                             }
@@ -206,7 +206,7 @@ 
             return $smartObj;
         } else {
             if (!$storeResult) {
-                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR.$smartObj->getHtmlErrors());
             }
 
             $redirect_page = $redirect_page ?: smart_get_page_before_form();
@@ -235,7 +235,7 @@ 
         $debug = false,
         $x_param = false
     ) {
-        $objectid = isset($_POST[$this->handler->keyName]) ? (int)$_POST[$this->handler->keyName] : 0;
+        $objectid = isset($_POST[$this->handler->keyName]) ? (int) $_POST[$this->handler->keyName] : 0;
         if ($debug) {
             if ($x_param) {
                 $smartObj = $this->handler->getD($objectid, true, $x_param);
@@ -311,7 +311,7 @@ 
     {
         global $smart_previous_page;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -321,7 +321,7 @@ 
         $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
             }
 
             redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
@@ -354,7 +354,7 @@ 
     {
         global $smart_previous_page, $xoopsTpl;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -364,7 +364,7 @@ 
         $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
             }
 
             redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
@@ -396,14 +396,14 @@ 
      */
     public function getAdminViewItemLink(SmartObject $smartObj, $onlyUrl = false, $withimage = false)
     {
-        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=view&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret = $this->handler->_moduleUrl.'admin/'.$this->handler->_page.'?op=view&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "viewmag.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_ADMIN_VIEW . "'  title='" . _CO_SOBJECT_ADMIN_VIEW . "'></a>";
+            return "<a href='".$ret."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."viewmag.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_ADMIN_VIEW."'  title='"._CO_SOBJECT_ADMIN_VIEW."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -425,15 +425,15 @@ 
         $seoIncludeId = true;
 
         if ('rewrite' === $seoMode) {
-            $ret = XOOPS_URL . '/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
+            $ret = XOOPS_URL.'/'.$seoModuleName.'.'.$this->handler->_itemname.($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').'/'.$smartObj->getVar('short_url').'.html';
         } elseif ('pathinfo' === $seoMode) {
-            $ret = SMARTOBJECT_URL . 'seo.php/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
+            $ret = SMARTOBJECT_URL.'seo.php/'.$seoModuleName.'.'.$this->handler->_itemname.($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').'/'.$smartObj->getVar('short_url').'.html';
         } else {
-            $ret = $this->handler->_moduleUrl . $this->handler->_page . '?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+            $ret = $this->handler->_moduleUrl.$this->handler->_page.'?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         }
 
         if (!$onlyUrl) {
-            $ret = "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+            $ret = "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
         }
 
         return $ret;
@@ -447,14 +447,14 @@ 
      */
     public function getEditLanguageLink($smartObj, $onlyUrl = false, $withimage = true)
     {
-        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName) . '&language=' . $smartObj->getVar('language');
+        $ret = $this->handler->_moduleUrl.'admin/'.$this->handler->_page.'?op=mod&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName).'&language='.$smartObj->getVar('language');
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "wizard.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_LANGUAGE_MODIFY . "'  title='" . _CO_SOBJECT_LANGUAGE_MODIFY . "'></a>";
+            return "<a href='".$ret."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."wizard.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_LANGUAGE_MODIFY."'  title='"._CO_SOBJECT_LANGUAGE_MODIFY."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -467,14 +467,14 @@ 
     public function getEditItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=mod&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "edit.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_MODIFY . "'  title='" . _CO_SOBJECT_MODIFY . "'></a>";
+            return "<a href='".$ret."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."edit.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_MODIFY."'  title='"._CO_SOBJECT_MODIFY."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -487,14 +487,14 @@ 
     public function getDeleteItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=del&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=del&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "editdelete.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_DELETE . "'  title='" . _CO_SOBJECT_DELETE . "'></a>";
+            return "<a href='".$ret."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."editdelete.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_DELETE."'  title='"._CO_SOBJECT_DELETE."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -505,9 +505,9 @@ 
     {
         global $xoopsConfig;
 
-        $printlink = $this->handler->_moduleUrl . 'print.php?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        $js        = "javascript:openWithSelfMain('" . $printlink . "', 'smartpopup', 700, 519);";
-        $printlink = '<a href="' . $js . '"><img  src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'fileprint.png" alt="" style="vertical-align: middle;"></a>';
+        $printlink = $this->handler->_moduleUrl.'print.php?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
+        $js        = "javascript:openWithSelfMain('".$printlink."', 'smartpopup', 700, 519);";
+        $printlink = '<a href="'.$js.'"><img  src="'.SMARTOBJECT_IMAGES_ACTIONS_URL.'fileprint.png" alt="" style="vertical-align: middle;"></a>';
 
         $smartModule = smart_getModuleInfo($smartObj->handler->_moduleName);
         $link        = smart_getCurrentPage();
@@ -526,7 +526,7 @@ 
                        . _CO_SOBJECT_EMAIL
                        . '" style="vertical-align: middle;"></a>';
 
-        $ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';
+        $ret = '<span id="smartobject_print_button">'.$printlink.'&nbsp;</span>'.'<span id="smartobject_mail_button">'.$friendlink.'</span>';
 
         return $ret;
     }
@@ -536,7 +536,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;
+        $ret = $this->handler->_moduleName.'_'.$this->handler->_itemname;
 
         return $ret;
     }

class/SmartobjectDbupdater.php

Doc Comments +2 added lines, -2 removed lines

@@ -143,7 +143,7 @@ 
     /**
      * Use to update a table
      *
-     * @param object $table {@link SmartDbTable} that will be updated
+     * @param SmartDbTable $table {@link SmartDbTable} that will be updated
      *
      * @see SmartDbTable
      *
@@ -245,7 +245,7 @@ 
     /**
      * @param $module
      * @param $item
-     * @return bool
+     * @return false|null
      */
     public function upgradeObjectItem($module, $item)
     {

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 SmartobjectDbupdater
 {
-    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 SmartDbTable
-     *
-     * @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 SmartDbTable($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 SmartDbTable
+	 *
+	 * @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 SmartDbTable($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 SmartDbTable($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 SmartDbTable($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 = smart_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 = smart_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;
-        }
-        smart_SetMeta('version', $newDbVersion, $dirname); //Set meta version to current
-
-        return true;
-    }
+			$table->setData("'version',0");
+			if (!$this->updateTable($table)) {
+				/**
+				 * @todo trap the errors
+				 */
+			}
+		}
+
+		$dbVersion = smart_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 = smart_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;
+		}
+		smart_SetMeta('version', $newDbVersion, $dirname); //Set meta version to current
+
+		return true;
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -38,15 +38,15 @@ 
  */
 // 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
  */
 global $xoopsConfig;
-$common_file = SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/smartdbupdater.php';
+$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;
 
@@ -130,11 +130,11 @@ 
         $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>';
+            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>';
+            echo '&nbsp;&nbsp;'.sprintf(_SDU_MSG_RENAME_TABLE, $from, $to).'<br>';
 
             return true;
         }
@@ -254,7 +254,7 @@ 
             return false;
         }
 
-        $table      = new SmartDbTable($module . '_' . $item);
+        $table      = new SmartDbTable($module.'_'.$item);
         $object     = $moduleHandler->create();
         $objectVars = $object->getVars();
 
@@ -275,7 +275,7 @@ 
 ";
                 }
             }
-            $structure .= 'PRIMARY KEY  (`' . $moduleHandler->keyName . '`)
+            $structure .= 'PRIMARY KEY  (`'.$moduleHandler->keyName.'`)
 ';
             $table->setStructure($structure);
             if (!$this->updateTable($table)) {
@@ -335,7 +335,7 @@ 
 
         ob_start();
 
-        $table = new SmartDbTable($dirname . '_meta');
+        $table = new SmartDbTable($dirname.'_meta');
         if (!$table->exists()) {
             $table->setStructure("
               `metakey` varchar(50) NOT NULL default '',
@@ -353,20 +353,20 @@ 
         if (!$dbVersion) {
             $dbVersion = 0;
         }
-        $newDbVersion = constant(strtoupper($dirname . '_db_version')) ?: 0;
-        echo 'Database version: ' . $dbVersion . '<br>';
-        echo 'New database version: ' . $newDbVersion . '<br>';
+        $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;
+                $upgrade_function = $dirname.'_db_upgrade_'.$i;
                 if (function_exists($upgrade_function)) {
                     $upgrade_function();
                 }
             }
         }
 
-        echo '<code>' . _SDU_UPDATE_UPDATING_DATABASE . '<br>';
+        echo '<code>'._SDU_UPDATE_UPDATING_DATABASE.'<br>';
 
         // if there is a function to execute for this DB version, let's do it
         //$function_

class/SmartobjectMemberHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -228,7 +228,7 @@
      * Creates a random number with a specified number of $digits
      *
      * @param  int $digits number of digits
-     * @return int random number
+     * @return string random number
      * @author xHelp Team
      *
      * @access public

Indentation +200 added lines, -200 removed lines

@@ -37,227 +37,227 @@
  */
 class SmartobjectMemberHandler extends \XoopsMemberHandler
 {
-    /**
-     * constructor
-     * @param \XoopsDatabase $db
-     */
-    public function __construct(\XoopsDatabase $db)
-    {
-        parent::__construct($db);
-        $this->_uHandler = xoops_getModuleHandler('user', 'smartobject');
-    }
+	/**
+	 * constructor
+	 * @param \XoopsDatabase $db
+	 */
+	public function __construct(\XoopsDatabase $db)
+	{
+		parent::__construct($db);
+		$this->_uHandler = xoops_getModuleHandler('user', 'smartobject');
+	}
 
-    /**
-     * @param       $userObj
-     * @param  bool $groups
-     * @param  bool $notifyUser
-     * @param  bool $password
-     * @return bool
-     */
-    public function addAndActivateUser($userObj, $groups = false, $notifyUser = true, &$password = false)
-    {
-        $email = $userObj->getVar('email');
-        if (!$userObj->getVar('email') || '' === $email) {
-            $userObj->setErrors(_CO_SOBJECT_USER_NEED_EMAIL);
+	/**
+	 * @param       $userObj
+	 * @param  bool $groups
+	 * @param  bool $notifyUser
+	 * @param  bool $password
+	 * @return bool
+	 */
+	public function addAndActivateUser($userObj, $groups = false, $notifyUser = true, &$password = false)
+	{
+		$email = $userObj->getVar('email');
+		if (!$userObj->getVar('email') || '' === $email) {
+			$userObj->setErrors(_CO_SOBJECT_USER_NEED_EMAIL);
 
-            return false;
-        }
+			return false;
+		}
 
-        $password = $userObj->getVar('pass');
-        // randomly generating the password if not already set
-        if ('' === $password) {
-            $password = substr(md5(uniqid(mt_rand(), 1)), 0, 6);
-        }
-        $userObj->setVar('pass', md5($password));
+		$password = $userObj->getVar('pass');
+		// randomly generating the password if not already set
+		if ('' === $password) {
+			$password = substr(md5(uniqid(mt_rand(), 1)), 0, 6);
+		}
+		$userObj->setVar('pass', md5($password));
 
-        // if no username is set, let's generate one
-        $unamecount = 20;
-        $uname      = $userObj->getVar('uname');
-        if (!$uname || '' === $uname) {
-            $usernames = $this->genUserNames($email, $unamecount);
-            $newuser   = false;
-            $i         = 0;
-            while (false === $newuser) {
-                $crit  = new \Criteria('uname', $usernames[$i]);
-                $count = $this->getUserCount($crit);
-                if (0 == $count) {
-                    $newuser = true;
-                } else {
-                    //Move to next username
-                    ++$i;
-                    if ($i == $unamecount) {
-                        //Get next batch of usernames to try, reset counter
-                        $usernames = $this->genUserNames($email, $unamecount);
-                        $i         = 0;
-                    }
-                }
-            }
-        }
+		// if no username is set, let's generate one
+		$unamecount = 20;
+		$uname      = $userObj->getVar('uname');
+		if (!$uname || '' === $uname) {
+			$usernames = $this->genUserNames($email, $unamecount);
+			$newuser   = false;
+			$i         = 0;
+			while (false === $newuser) {
+				$crit  = new \Criteria('uname', $usernames[$i]);
+				$count = $this->getUserCount($crit);
+				if (0 == $count) {
+					$newuser = true;
+				} else {
+					//Move to next username
+					++$i;
+					if ($i == $unamecount) {
+						//Get next batch of usernames to try, reset counter
+						$usernames = $this->genUserNames($email, $unamecount);
+						$i         = 0;
+					}
+				}
+			}
+		}
 
-        global $xoopsConfig;
+		global $xoopsConfig;
 
-        $configHandler   = xoops_getHandler('config');
-        $xoopsConfigUser = $configHandler->getConfigsByCat(XOOPS_CONF_USER);
-        switch ($xoopsConfigUser['activation_type']) {
-            case 0:
-                $level           = 0;
-                $mailtemplate    = 'smartmail_activate_user.tpl';
-                $aInfoMessages[] = sprintf(_NL_MA_NEW_USER_NEED_ACT, $user_email);
-                break;
-            case 1:
-                $level           = 1;
-                $mailtemplate    = 'smartmail_auto_activate_user.tpl';
-                $aInfoMessages[] = sprintf(_NL_MA_NEW_USER_AUTO_ACT, $user_email);
-                break;
-            case 2:
-            default:
-                $level           = 0;
-                $mailtemplate    = 'smartmail_admin_activate_user.tpl';
-                $aInfoMessages[] = sprintf(_NL_MA_NEW_USER_ADMIN_ACT, $user_email);
-        }
+		$configHandler   = xoops_getHandler('config');
+		$xoopsConfigUser = $configHandler->getConfigsByCat(XOOPS_CONF_USER);
+		switch ($xoopsConfigUser['activation_type']) {
+			case 0:
+				$level           = 0;
+				$mailtemplate    = 'smartmail_activate_user.tpl';
+				$aInfoMessages[] = sprintf(_NL_MA_NEW_USER_NEED_ACT, $user_email);
+				break;
+			case 1:
+				$level           = 1;
+				$mailtemplate    = 'smartmail_auto_activate_user.tpl';
+				$aInfoMessages[] = sprintf(_NL_MA_NEW_USER_AUTO_ACT, $user_email);
+				break;
+			case 2:
+			default:
+				$level           = 0;
+				$mailtemplate    = 'smartmail_admin_activate_user.tpl';
+				$aInfoMessages[] = sprintf(_NL_MA_NEW_USER_ADMIN_ACT, $user_email);
+		}
 
-        $userObj->setVar('uname', $usernames[$i]);
-        $userObj->setVar('user_avatar', 'blank.gif');
-        $userObj->setVar('user_regdate', time());
-        $userObj->setVar('timezone_offset', $xoopsConfig['default_TZ']);
-        $actkey = substr(md5(uniqid(mt_rand(), 1)), 0, 8);
-        $userObj->setVar('actkey', $actkey);
-        $userObj->setVar('email', $email);
-        $userObj->setVar('notify_method', 2);
-        $userObj->setVar('level', $userObj);
+		$userObj->setVar('uname', $usernames[$i]);
+		$userObj->setVar('user_avatar', 'blank.gif');
+		$userObj->setVar('user_regdate', time());
+		$userObj->setVar('timezone_offset', $xoopsConfig['default_TZ']);
+		$actkey = substr(md5(uniqid(mt_rand(), 1)), 0, 8);
+		$userObj->setVar('actkey', $actkey);
+		$userObj->setVar('email', $email);
+		$userObj->setVar('notify_method', 2);
+		$userObj->setVar('level', $userObj);
 
-        if ($this->insertUser($userObj)) {
+		if ($this->insertUser($userObj)) {
 
-            // if $groups=false, Add the user to Registered Users group
-            if (!$groups) {
-                $this->addUserToGroup(XOOPS_GROUP_USERS, $userObj->getVar('uid'));
-            } else {
-                foreach ($groups as $groupid) {
-                    $this->addUserToGroup($groupid, $userObj->getVar('uid'));
-                }
-            }
-        } else {
-            return false;
-        }
+			// if $groups=false, Add the user to Registered Users group
+			if (!$groups) {
+				$this->addUserToGroup(XOOPS_GROUP_USERS, $userObj->getVar('uid'));
+			} else {
+				foreach ($groups as $groupid) {
+					$this->addUserToGroup($groupid, $userObj->getVar('uid'));
+				}
+			}
+		} else {
+			return false;
+		}
 
-        if ($notifyUser) {
-            // send some notifications
-            $xoopsMailer = xoops_getMailer();
-            $xoopsMailer->useMail();
-            $xoopsMailer->setTemplateDir(SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/mail_template');
-            $xoopsMailer->setTemplate('smartobject_notify_user_added_by_admin.tpl');
-            $xoopsMailer->assign('XOOPS_USER_PASSWORD', $password);
-            $xoopsMailer->assign('SITENAME', $xoopsConfig['sitename']);
-            $xoopsMailer->assign('ADMINMAIL', $xoopsConfig['adminmail']);
-            $xoopsMailer->assign('SITEURL', XOOPS_URL . '/');
-            $xoopsMailer->assign('NAME', $userObj->getVar('name'));
-            $xoopsMailer->assign('UNAME', $userObj->getVar('uname'));
-            $xoopsMailer->setToUsers($userObj);
-            $xoopsMailer->setFromEmail($xoopsConfig['adminmail']);
-            $xoopsMailer->setFromName($xoopsConfig['sitename']);
-            $xoopsMailer->setSubject(sprintf(_CO_SOBJECT_NEW_USER_NOTIFICATION_SUBJECT, $xoopsConfig['sitename']));
+		if ($notifyUser) {
+			// send some notifications
+			$xoopsMailer = xoops_getMailer();
+			$xoopsMailer->useMail();
+			$xoopsMailer->setTemplateDir(SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/mail_template');
+			$xoopsMailer->setTemplate('smartobject_notify_user_added_by_admin.tpl');
+			$xoopsMailer->assign('XOOPS_USER_PASSWORD', $password);
+			$xoopsMailer->assign('SITENAME', $xoopsConfig['sitename']);
+			$xoopsMailer->assign('ADMINMAIL', $xoopsConfig['adminmail']);
+			$xoopsMailer->assign('SITEURL', XOOPS_URL . '/');
+			$xoopsMailer->assign('NAME', $userObj->getVar('name'));
+			$xoopsMailer->assign('UNAME', $userObj->getVar('uname'));
+			$xoopsMailer->setToUsers($userObj);
+			$xoopsMailer->setFromEmail($xoopsConfig['adminmail']);
+			$xoopsMailer->setFromName($xoopsConfig['sitename']);
+			$xoopsMailer->setSubject(sprintf(_CO_SOBJECT_NEW_USER_NOTIFICATION_SUBJECT, $xoopsConfig['sitename']));
 
-            if (!$xoopsMailer->send(true)) {
-                /**
-                 * @todo trap error if email was not sent
-                 */
-                $xoopsMailer->getErrors(true);
-            }
-        }
+			if (!$xoopsMailer->send(true)) {
+				/**
+				 * @todo trap error if email was not sent
+				 */
+				$xoopsMailer->getErrors(true);
+			}
+		}
 
-        return true;
-    }
+		return true;
+	}
 
-    /**
-     * Generates an array of usernames
-     *
-     * @param  string $email email of user
-     * @param  int    $count number of names to generate
-     * @return array  $names
-     * @internal param string $name name of user
-     * @author   xHelp Team
-     *
-     * @access   public
-     */
-    public function genUserNames($email, $count = 20)
-    {
-        $name = substr($email, 0, strpos($email, '@')); //Take the email adress without domain as username
+	/**
+	 * Generates an array of usernames
+	 *
+	 * @param  string $email email of user
+	 * @param  int    $count number of names to generate
+	 * @return array  $names
+	 * @internal param string $name name of user
+	 * @author   xHelp Team
+	 *
+	 * @access   public
+	 */
+	public function genUserNames($email, $count = 20)
+	{
+		$name = substr($email, 0, strpos($email, '@')); //Take the email adress without domain as username
 
-        $names  = [];
-        $userid = explode('@', $email);
+		$names  = [];
+		$userid = explode('@', $email);
 
-        $basename    = '';
-        $hasbasename = false;
-        $emailname   = $userid[0];
+		$basename    = '';
+		$hasbasename = false;
+		$emailname   = $userid[0];
 
-        $names[] = $emailname;
+		$names[] = $emailname;
 
-        if (strlen($name) > 0) {
-            $name = explode(' ', trim($name));
-            if (count($name) > 1) {
-                $basename = strtolower(substr($name[0], 0, 1) . $name[count($name) - 1]);
-            } else {
-                $basename = strtolower($name[0]);
-            }
-            $basename = xoops_substr($basename, 0, 60, '');
-            //Prevent Duplication of Email Username and Name
-            if (!in_array($basename, $names)) {
-                $names[]     = $basename;
-                $hasbasename = true;
-            }
-        }
+		if (strlen($name) > 0) {
+			$name = explode(' ', trim($name));
+			if (count($name) > 1) {
+				$basename = strtolower(substr($name[0], 0, 1) . $name[count($name) - 1]);
+			} else {
+				$basename = strtolower($name[0]);
+			}
+			$basename = xoops_substr($basename, 0, 60, '');
+			//Prevent Duplication of Email Username and Name
+			if (!in_array($basename, $names)) {
+				$names[]     = $basename;
+				$hasbasename = true;
+			}
+		}
 
-        $i          = count($names);
-        $onbasename = 1;
-        while ($i < $count) {
-            $num = $this->genRandNumber();
-            if ($onbasename < 0 && $hasbasename) {
-                $names[] = xoops_substr($basename, 0, 58, '') . $num;
-            } else {
-                $names[] = xoops_substr($emailname, 0, 58, '') . $num;
-            }
-            $i          = count($names);
-            $onbasename = ~$onbasename;
-            $num        = '';
-        }
+		$i          = count($names);
+		$onbasename = 1;
+		while ($i < $count) {
+			$num = $this->genRandNumber();
+			if ($onbasename < 0 && $hasbasename) {
+				$names[] = xoops_substr($basename, 0, 58, '') . $num;
+			} else {
+				$names[] = xoops_substr($emailname, 0, 58, '') . $num;
+			}
+			$i          = count($names);
+			$onbasename = ~$onbasename;
+			$num        = '';
+		}
 
-        return $names;
-    }
+		return $names;
+	}
 
-    /**
-     * Creates a random number with a specified number of $digits
-     *
-     * @param  int $digits number of digits
-     * @return int random number
-     * @author xHelp Team
-     *
-     * @access public
-     */
-    public function genRandNumber($digits = 2)
-    {
-        $this->initRand();
-        $tmp = [];
+	/**
+	 * Creates a random number with a specified number of $digits
+	 *
+	 * @param  int $digits number of digits
+	 * @return int random number
+	 * @author xHelp Team
+	 *
+	 * @access public
+	 */
+	public function genRandNumber($digits = 2)
+	{
+		$this->initRand();
+		$tmp = [];
 
-        for ($i = 0; $i < $digits; ++$i) {
-            $tmp[$i] = (mt_rand() % 9);
-        }
+		for ($i = 0; $i < $digits; ++$i) {
+			$tmp[$i] = (mt_rand() % 9);
+		}
 
-        return implode('', $tmp);
-    }
+		return implode('', $tmp);
+	}
 
-    /**
-     * Gives the random number generator a seed to start from
-     *
-     * @return void
-     *
-     * @access public
-     */
-    public function initRand()
-    {
-        static $randCalled = false;
-        if (!$randCalled) {
-            mt_srand((double)microtime() * 1000000);
-            $randCalled = true;
-        }
-    }
+	/**
+	 * Gives the random number generator a seed to start from
+	 *
+	 * @return void
+	 *
+	 * @access public
+	 */
+	public function initRand()
+	{
+		static $randCalled = false;
+		if (!$randCalled) {
+			mt_srand((double)microtime() * 1000000);
+			$randCalled = true;
+		}
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -21,9 +21,9 @@ 
 use XoopsModules\Smartobject;
 
 // defined('XOOPS_ROOT_PATH') || die('Restricted access');
-require_once XOOPS_ROOT_PATH . '/kernel/user.php';
-require_once XOOPS_ROOT_PATH . '/kernel/group.php';
-require_once XOOPS_ROOT_PATH . '/kernel/member.php';
+require_once XOOPS_ROOT_PATH.'/kernel/user.php';
+require_once XOOPS_ROOT_PATH.'/kernel/group.php';
+require_once XOOPS_ROOT_PATH.'/kernel/member.php';
 
 /**
  * XOOPS member handler class.
@@ -144,12 +144,12 @@ 
             // send some notifications
             $xoopsMailer = xoops_getMailer();
             $xoopsMailer->useMail();
-            $xoopsMailer->setTemplateDir(SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/mail_template');
+            $xoopsMailer->setTemplateDir(SMARTOBJECT_ROOT_PATH.'language/'.$xoopsConfig['language'].'/mail_template');
             $xoopsMailer->setTemplate('smartobject_notify_user_added_by_admin.tpl');
             $xoopsMailer->assign('XOOPS_USER_PASSWORD', $password);
             $xoopsMailer->assign('SITENAME', $xoopsConfig['sitename']);
             $xoopsMailer->assign('ADMINMAIL', $xoopsConfig['adminmail']);
-            $xoopsMailer->assign('SITEURL', XOOPS_URL . '/');
+            $xoopsMailer->assign('SITEURL', XOOPS_URL.'/');
             $xoopsMailer->assign('NAME', $userObj->getVar('name'));
             $xoopsMailer->assign('UNAME', $userObj->getVar('uname'));
             $xoopsMailer->setToUsers($userObj);
@@ -195,7 +195,7 @@ 
         if (strlen($name) > 0) {
             $name = explode(' ', trim($name));
             if (count($name) > 1) {
-                $basename = strtolower(substr($name[0], 0, 1) . $name[count($name) - 1]);
+                $basename = strtolower(substr($name[0], 0, 1).$name[count($name) - 1]);
             } else {
                 $basename = strtolower($name[0]);
             }
@@ -212,9 +212,9 @@ 
         while ($i < $count) {
             $num = $this->genRandNumber();
             if ($onbasename < 0 && $hasbasename) {
-                $names[] = xoops_substr($basename, 0, 58, '') . $num;
+                $names[] = xoops_substr($basename, 0, 58, '').$num;
             } else {
-                $names[] = xoops_substr($emailname, 0, 58, '') . $num;
+                $names[] = xoops_substr($emailname, 0, 58, '').$num;
             }
             $i          = count($names);
             $onbasename = ~$onbasename;
@@ -256,7 +256,7 @@ 
     {
         static $randCalled = false;
         if (!$randCalled) {
-            mt_srand((double)microtime() * 1000000);
+            mt_srand((double) microtime() * 1000000);
             $randCalled = true;
         }
     }

class/SmartObjectSingleView.php

Doc Comments +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
 
     /**
      * Constructor
-     * @param       $object
+     * @param       BaseSmartObject $object
      * @param bool  $userSide
      * @param array $actions
      * @param bool  $headerAsRow
@@ -46,7 +46,7 @@ 
     }
 
     /**
-     * @param $rowObj
+     * @param SmartObjectRow $rowObj
      */
     public function addRow($rowObj)
     {

Indentation +82 added lines, -82 removed lines

@@ -23,94 +23,94 @@
  */
 class SmartObjectSingleView
 {
-    public $_object;
-    public $_userSide;
-    public $_tpl;
-    public $_rows;
-    public $_actions;
-    public $_headerAsRow = true;
+	public $_object;
+	public $_userSide;
+	public $_tpl;
+	public $_rows;
+	public $_actions;
+	public $_headerAsRow = true;
 
-    /**
-     * Constructor
-     * @param       $object
-     * @param bool  $userSide
-     * @param array $actions
-     * @param bool  $headerAsRow
-     */
-    public function __construct($object, $userSide = false, $actions = [], $headerAsRow = true)
-    {
-        $this->_object      = $object;
-        $this->_userSide    = $userSide;
-        $this->_actions     = $actions;
-        $this->_headerAsRow = $headerAsRow;
-    }
+	/**
+	 * Constructor
+	 * @param       $object
+	 * @param bool  $userSide
+	 * @param array $actions
+	 * @param bool  $headerAsRow
+	 */
+	public function __construct($object, $userSide = false, $actions = [], $headerAsRow = true)
+	{
+		$this->_object      = $object;
+		$this->_userSide    = $userSide;
+		$this->_actions     = $actions;
+		$this->_headerAsRow = $headerAsRow;
+	}
 
-    /**
-     * @param $rowObj
-     */
-    public function addRow($rowObj)
-    {
-        $this->_rows[] = $rowObj;
-    }
+	/**
+	 * @param $rowObj
+	 */
+	public function addRow($rowObj)
+	{
+		$this->_rows[] = $rowObj;
+	}
 
-    /**
-     * @param  bool $fetchOnly
-     * @param  bool $debug
-     * @return mixed|string|void
-     */
-    public function render($fetchOnly = false, $debug = false)
-    {
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
+	/**
+	 * @param  bool $fetchOnly
+	 * @param  bool $debug
+	 * @return mixed|string|void
+	 */
+	public function render($fetchOnly = false, $debug = false)
+	{
+		require_once XOOPS_ROOT_PATH . '/class/template.php';
 
-        $this->_tpl             = new \XoopsTpl();
-        $vars                   = $this->_object->vars;
-        $smartobjectObjectArray = [];
+		$this->_tpl             = new \XoopsTpl();
+		$vars                   = $this->_object->vars;
+		$smartobjectObjectArray = [];
 
-        foreach ($this->_rows as $row) {
-            $key = $row->getKeyName();
-            if ($row->_customMethodForValue && method_exists($this->_object, $row->_customMethodForValue)) {
-                $method = $row->_customMethodForValue;
-                $value  = $this->_object->$method();
-            } else {
-                $value = $this->_object->getVar($row->getKeyName());
-            }
-            if ($row->isHeader()) {
-                $this->_tpl->assign('smartobject_single_view_header_caption', $this->_object->vars[$key]['form_caption']);
-                $this->_tpl->assign('smartobject_single_view_header_value', $value);
-            } else {
-                $smartobjectObjectArray[$key]['value']   = $value;
-                $smartobjectObjectArray[$key]['header']  = $row->isHeader();
-                $smartobjectObjectArray[$key]['caption'] = $this->_object->vars[$key]['form_caption'];
-            }
-        }
-        $action_row = '';
-        if (in_array('edit', $this->_actions)) {
-            $action_row .= $this->_object->getEditItemLink(false, true, true);
-        }
-        if (in_array('delete', $this->_actions)) {
-            $action_row .= $this->_object->getDeleteItemLink(false, true, true);
-        }
-        if ($action_row) {
-            $smartobjectObjectArray['zaction']['value']   = $action_row;
-            $smartobjectObjectArray['zaction']['caption'] = _CO_SOBJECT_ACTIONS;
-        }
+		foreach ($this->_rows as $row) {
+			$key = $row->getKeyName();
+			if ($row->_customMethodForValue && method_exists($this->_object, $row->_customMethodForValue)) {
+				$method = $row->_customMethodForValue;
+				$value  = $this->_object->$method();
+			} else {
+				$value = $this->_object->getVar($row->getKeyName());
+			}
+			if ($row->isHeader()) {
+				$this->_tpl->assign('smartobject_single_view_header_caption', $this->_object->vars[$key]['form_caption']);
+				$this->_tpl->assign('smartobject_single_view_header_value', $value);
+			} else {
+				$smartobjectObjectArray[$key]['value']   = $value;
+				$smartobjectObjectArray[$key]['header']  = $row->isHeader();
+				$smartobjectObjectArray[$key]['caption'] = $this->_object->vars[$key]['form_caption'];
+			}
+		}
+		$action_row = '';
+		if (in_array('edit', $this->_actions)) {
+			$action_row .= $this->_object->getEditItemLink(false, true, true);
+		}
+		if (in_array('delete', $this->_actions)) {
+			$action_row .= $this->_object->getDeleteItemLink(false, true, true);
+		}
+		if ($action_row) {
+			$smartobjectObjectArray['zaction']['value']   = $action_row;
+			$smartobjectObjectArray['zaction']['caption'] = _CO_SOBJECT_ACTIONS;
+		}
 
-        $this->_tpl->assign('smartobject_header_as_row', $this->_headerAsRow);
-        $this->_tpl->assign('smartobject_object_array', $smartobjectObjectArray);
+		$this->_tpl->assign('smartobject_header_as_row', $this->_headerAsRow);
+		$this->_tpl->assign('smartobject_object_array', $smartobjectObjectArray);
 
-        if ($fetchOnly) {
-            return $this->_tpl->fetch('db:smartobject_singleview_display.tpl');
-        } else {
-            $this->_tpl->display('db:smartobject_singleview_display.tpl');
-        }
-    }
+		if ($fetchOnly) {
+			return $this->_tpl->fetch('db:smartobject_singleview_display.tpl');
+		} else {
+			$this->_tpl->display('db:smartobject_singleview_display.tpl');
+		}
+	}
 
-    /**
-     * @param  bool $debug
-     * @return mixed|string|void
-     */
-    public function fetch($debug = false)
-    {
-        return $this->render(true, $debug);
-    }
+	/**
+	 * @param  bool $debug
+	 * @return mixed|string|void
+	 */
+	public function fetch($debug = false)
+	{
+		return $this->render(true, $debug);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      */
     public function render($fetchOnly = false, $debug = false)
     {
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
+        require_once XOOPS_ROOT_PATH.'/class/template.php';
 
         $this->_tpl             = new \XoopsTpl();
         $vars                   = $this->_object->vars;

class/SmartObjectTable.php

Doc Comments +3 added lines, -3 removed lines

@@ -106,7 +106,7 @@ 
     }
 
     /**
-     * @param $columnObj
+     * @param SmartObjectColumn $columnObj
      */
     public function addColumn($columnObj)
     {
@@ -114,8 +114,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $location
+     * @param string $name
+     * @param string $location
      * @param $value
      */
     public function addIntroButton($name, $location, $value)

Indentation +801 added lines, -801 removed lines

@@ -25,805 +25,805 @@
  */
 class SmartObjectTable
 {
-    public $_id;
-    public $_objectHandler;
-    public $_columns;
-    public $_criteria;
-    public $_actions;
-    public $_objects = false;
-    public $_aObjects;
-    public $_custom_actions;
-    public $_sortsel;
-    public $_ordersel;
-    public $_limitsel;
-    public $_filtersel;
-    public $_filterseloptions;
-    public $_filtersel2;
-    public $_filtersel2options;
-    public $_filtersel2optionsDefault;
-
-    public $_tempObject;
-    public $_tpl;
-    public $_introButtons;
-    public $_quickSearch            = false;
-    public $_actionButtons          = false;
-    public $_head_css_class         = 'bg3';
-    public $_hasActions             = false;
-    public $_userSide               = false;
-    public $_printerFriendlyPage    = false;
-    public $_tableHeader            = false;
-    public $_tableFooter            = false;
-    public $_showActionsColumnTitle = true;
-    public $_isTree                 = false;
-    public $_showFilterAndLimit     = true;
-    public $_enableColumnsSorting   = true;
-    public $_customTemplate         = false;
-    public $_withSelectedActions    = [];
-
-    /**
-     * Constructor
-     *
-     * @param SmartPersistableObjectHandler $objectHandler {@link SmartPersistableObjectHandler}
-     * @param CriteriaElement               $criteria
-     * @param array                         $actions       array representing the actions to offer
-     *
-     * @param bool                          $userSide
-     */
-    public function __construct(
-        SmartPersistableObjectHandler $objectHandler,
-        CriteriaElement $criteria = null,
-        $actions = ['edit', 'delete'],
-        $userSide = false
-    ) {
-        $this->_id            = $objectHandler->className;
-        $this->_objectHandler = $objectHandler;
-
-        if (!$criteria) {
-            $criteria = new \CriteriaCompo();
-        }
-        $this->_criteria       = $criteria;
-        $this->_actions        = $actions;
-        $this->_custom_actions = [];
-        $this->_userSide       = $userSide;
-        if ($userSide) {
-            $this->_head_css_class = 'head';
-        }
-    }
-
-    /**
-     * @param      $op
-     * @param bool $caption
-     * @param bool $text
-     */
-    public function addActionButton($op, $caption = false, $text = false)
-    {
-        $action                 = [
-            'op'      => $op,
-            'caption' => $caption,
-            'text'    => $text
-        ];
-        $this->_actionButtons[] = $action;
-    }
-
-    /**
-     * @param $columnObj
-     */
-    public function addColumn($columnObj)
-    {
-        $this->_columns[] = $columnObj;
-    }
-
-    /**
-     * @param $name
-     * @param $location
-     * @param $value
-     */
-    public function addIntroButton($name, $location, $value)
-    {
-        $introButton             = [];
-        $introButton['name']     = $name;
-        $introButton['location'] = $location;
-        $introButton['value']    = $value;
-        $this->_introButtons[]   = $introButton;
-        unset($introButton);
-    }
-
-    public function addPrinterFriendlyLink()
-    {
-        $current_urls               = smart_getCurrentUrls();
-        $current_url                = $current_urls['full'];
-        $this->_printerFriendlyPage = $current_url . '&print';
-    }
-
-    /**
-     * @param        $fields
-     * @param string $caption
-     */
-    public function addQuickSearch($fields, $caption = _CO_SOBJECT_QUICK_SEARCH)
-    {
-        $this->_quickSearch = ['fields' => $fields, 'caption' => $caption];
-    }
-
-    /**
-     * @param $content
-     */
-    public function addHeader($content)
-    {
-        $this->_tableHeader = $content;
-    }
-
-    /**
-     * @param $content
-     */
-    public function addFooter($content)
-    {
-        $this->_tableFooter = $content;
-    }
-
-    /**
-     * @param $caption
-     */
-    public function addDefaultIntroButton($caption)
-    {
-        $this->addIntroButton($this->_objectHandler->_itemname, $this->_objectHandler->_page . '?op=mod', $caption);
-    }
-
-    /**
-     * @param $method
-     */
-    public function addCustomAction($method)
-    {
-        $this->_custom_actions[] = $method;
-    }
-
-    /**
-     * @param $default_sort
-     */
-    public function setDefaultSort($default_sort)
-    {
-        $this->_sortsel = $default_sort;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDefaultSort()
-    {
-        if ($this->_sortsel) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_sortsel);
-        } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_objectHandler->identifierName);
-        }
-    }
-
-    /**
-     * @param $default_order
-     */
-    public function setDefaultOrder($default_order)
-    {
-        $this->_ordersel = $default_order;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDefaultOrder()
-    {
-        if ($this->_ordersel) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', $this->_ordersel);
-        } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', 'ASC');
-        }
-    }
-
-    /**
-     * @param array $actions
-     */
-    public function addWithSelectedActions($actions = [])
-    {
-        $this->addColumn(new SmartObjectColumn('checked', 'center', 20, false, false, ' '));
-        $this->_withSelectedActions = $actions;
-    }
-
-    /**
-     * Adding a filter in the table
-     *
-     * @param string $key    key to the field that will be used for sorting
-     * @param string $method method of the handler that will be called to populate the options when this filter is selected
-     * @param bool   $default
-     */
-    public function addFilter($key, $method, $default = false)
-    {
-        $this->_filterseloptions[$key]   = $method;
-        $this->_filtersel2optionsDefault = $default;
-    }
-
-    /**
-     * @param $default_filter
-     */
-    public function setDefaultFilter($default_filter)
-    {
-        $this->_filtersel = $default_filter;
-    }
-
-    public function isForUserSide()
-    {
-        $this->_userSide = true;
-    }
-
-    /**
-     * @param $template
-     */
-    public function setCustomTemplate($template)
-    {
-        $this->_customTemplate = $template;
-    }
-
-    public function setSortOrder()
-    {
-        $this->_sortsel = isset($_GET[$this->_objectHandler->_itemname . '_' . 'sortsel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'] : $this->getDefaultSort();
-        //$this->_sortsel = isset($_POST['sortsel']) ? $_POST['sortsel']: $this->_sortsel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_sortsel);
-        $fieldsForSorting = $this->_tempObject->getFieldsForSorting($this->_sortsel);
-
-        if (isset($this->_tempObject->vars[$this->_sortsel]['itemName'])
-            && $this->_tempObject->vars[$this->_sortsel]['itemName']) {
-            $this->_criteria->setSort($this->_tempObject->vars[$this->_sortsel]['itemName'] . '.' . $this->_sortsel);
-        } else {
-            $this->_criteria->setSort($this->_objectHandler->_itemname . '.' . $this->_sortsel);
-        }
-
-        $this->_ordersel = isset($_GET[$this->_objectHandler->_itemname . '_' . 'ordersel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'ordersel'] : $this->getDefaultOrder();
-        //$this->_ordersel = isset($_POST['ordersel']) ? $_POST['ordersel']:$this->_ordersel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', $this->_ordersel);
-        $ordersArray = $this->getOrdersArray();
-        $this->_criteria->setOrder($this->_ordersel);
-    }
-
-    /**
-     * @param $id
-     */
-    public function setTableId($id)
-    {
-        $this->_id = $id;
-    }
-
-    /**
-     * @param $objects
-     */
-    public function setObjects($objects)
-    {
-        $this->_objects = $objects;
-    }
-
-    public function createTableRows()
-    {
-        $this->_aObjects = [];
-
-        $doWeHaveActions = false;
-
-        $objectclass = 'odd';
-        if (count($this->_objects) > 0) {
-            foreach ($this->_objects as $object) {
-                $aObject = [];
-
-                $i = 0;
-
-                $aColumns = [];
-
-                foreach ($this->_columns as $column) {
-                    $aColumn = [];
-
-                    if (0 == $i) {
-                        $class = 'head';
-                    } elseif (0 == $i % 2) {
-                        $class = 'even';
-                    } else {
-                        $class = 'odd';
-                    }
-                    if (method_exists($object, 'initiateCustomFields')) {
-                        //$object->initiateCustomFields();
-                    }
-                    if ('checked' === $column->_keyname) {
-                        $value = '<input type ="checkbox" name="selected_smartobjects[]" value="' . $object->id() . '">';
-                    } elseif ($column->_customMethodForValue
-                              && method_exists($object, $column->_customMethodForValue)) {
-                        $method = $column->_customMethodForValue;
-                        if ($column->_param) {
-                            $value = $object->$method($column->_param);
-                        } else {
-                            $value = $object->$method();
-                        }
-                    } else {
-                        /**
-                         * If the column is the identifier, then put a link on it
-                         */
-                        if ($column->getKeyName() == $this->_objectHandler->identifierName) {
-                            $value = $object->getItemLink();
-                        } else {
-                            $value = $object->getVar($column->getKeyName());
-                        }
-                    }
-
-                    $aColumn['value'] = $value;
-                    $aColumn['class'] = $class;
-                    $aColumn['width'] = $column->getWidth();
-                    $aColumn['align'] = $column->getAlign();
-
-                    $aColumns[] = $aColumn;
-                    ++$i;
-                }
-
-                $aObject['columns'] = $aColumns;
-                $aObject['id']      = $object->id();
-
-                $objectclass = ('even' === $objectclass) ? 'odd' : 'even';
-
-                $aObject['class'] = $objectclass;
-
-                $actions = [];
-
-                // Adding the custom actions if any
-                foreach ($this->_custom_actions as $action) {
-                    if (method_exists($object, $action)) {
-                        $actions[] = $object->$action();
-                    }
-                }
-
-                require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
-                $controller = new SmartObjectController($this->_objectHandler);
-
-                if ((!is_array($this->_actions)) || in_array('edit', $this->_actions)) {
-                    $actions[] = $controller->getEditItemLink($object, false, true, $this->_userSide);
-                }
-                if ((!is_array($this->_actions)) || in_array('delete', $this->_actions)) {
-                    $actions[] = $controller->getDeleteItemLink($object, false, true, $this->_userSide);
-                }
-                $aObject['actions'] = $actions;
-
-                $this->_tpl->assign('smartobject_actions_column_width', count($actions) * 30);
-
-                $doWeHaveActions = $doWeHaveActions ? true : count($actions) > 0;
-
-                $this->_aObjects[] = $aObject;
-            }
-            $this->_tpl->assign('smartobject_objects', $this->_aObjects);
-        } else {
-            $colspan = count($this->_columns) + 1;
-            $this->_tpl->assign('smartobject_colspan', $colspan);
-        }
-        $this->_hasActions = $doWeHaveActions;
-    }
-
-    /**
-     * @param  bool $debug
-     * @return mixed
-     */
-    public function fetchObjects($debug = false)
-    {
-        return $this->_objectHandler->getObjects($this->_criteria, true, true, false, $debug);
-    }
-
-    /**
-     * @return string
-     */
-    public function getDefaultFilter()
-    {
-        if ($this->_filtersel) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', $this->_filtersel);
-        } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', 'default');
-        }
-    }
-
-    /**
-     * @return array|bool
-     */
-    public function getFiltersArray()
-    {
-        $ret               = [];
-        $field             = [];
-        $field['caption']  = _CO_OBJ_NONE;
-        $field['selected'] = '';
-        $ret['default']    = $field;
-        unset($field);
-
-        if ($this->_filterseloptions) {
-            foreach ($this->_filterseloptions as $key => $value) {
-                $field = [];
-                if (is_array($value)) {
-                    $field['caption']  = $key;
-                    $field['selected'] = $this->_filtersel == $key ? 'selected' : '';
-                } else {
-                    $field['caption']  = $this->_tempObject->vars[$key]['form_caption'];
-                    $field['selected'] = $this->_filtersel == $key ? 'selected' : '';
-                }
-                $ret[$key] = $field;
-                unset($field);
-            }
-        } else {
-            $ret = false;
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param $default_filter2
-     */
-    public function setDefaultFilter2($default_filter2)
-    {
-        $this->_filtersel2 = $default_filter2;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDefaultFilter2()
-    {
-        if ($this->_filtersel2) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', $this->_filtersel2);
-        } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', 'default');
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function getFilters2Array()
-    {
-        $ret = [];
-
-        foreach ($this->_filtersel2options as $key => $value) {
-            $field             = [];
-            $field['caption']  = $value;
-            $field['selected'] = $this->_filtersel2 == $key ? 'selected' : '';
-            $ret[$key]         = $field;
-            unset($field);
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param $limitsArray
-     * @param $params_of_the_options_sel
-     */
-    public function renderOptionSelection($limitsArray, $params_of_the_options_sel)
-    {
-        // Rendering the form to select options on the table
-        $current_urls = smart_getCurrentUrls();
-        $current_url  = $current_urls['full'];
-
-        /**
-         * What was $params_of_the_options_sel doing again ?
-         */
-        //$this->_tpl->assign('smartobject_optionssel_action', $_SERVER['PHP_SELF'] . "?" . implode('&', $params_of_the_options_sel));
-        $this->_tpl->assign('smartobject_optionssel_action', $current_url);
-        $this->_tpl->assign('smartobject_optionssel_limitsArray', $limitsArray);
-    }
-
-    /**
-     * @return array
-     */
-    public function getLimitsArray()
-    {
-        $ret                    = [];
-        $ret['all']['caption']  = _CO_SOBJECT_LIMIT_ALL;
-        $ret['all']['selected'] = ('all' === $this->_limitsel) ? 'selected' : '';
-
-        $ret['5']['caption']  = '5';
-        $ret['5']['selected'] = ('5' == $this->_limitsel) ? 'selected' : '';
-
-        $ret['10']['caption']  = '10';
-        $ret['10']['selected'] = ('10' == $this->_limitsel) ? 'selected' : '';
-
-        $ret['15']['caption']  = '15';
-        $ret['15']['selected'] = ('15' == $this->_limitsel) ? 'selected' : '';
-
-        $ret['20']['caption']  = '20';
-        $ret['20']['selected'] = ('20' == $this->_limitsel) ? 'selected' : '';
-
-        $ret['25']['caption']  = '25';
-        $ret['25']['selected'] = ('25' == $this->_limitsel) ? 'selected' : '';
-
-        $ret['30']['caption']  = '30';
-        $ret['30']['selected'] = ('30' == $this->_limitsel) ? 'selected' : '';
-
-        $ret['35']['caption']  = '35';
-        $ret['35']['selected'] = ('35' == $this->_limitsel) ? 'selected' : '';
-
-        $ret['40']['caption']  = '40';
-        $ret['40']['selected'] = ('40' == $this->_limitsel) ? 'selected' : '';
-
-        return $ret;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getObjects()
-    {
-        return $this->_objects;
-    }
-
-    public function hideActionColumnTitle()
-    {
-        $this->_showActionsColumnTitle = false;
-    }
-
-    public function hideFilterAndLimit()
-    {
-        $this->_showFilterAndLimit = false;
-    }
-
-    /**
-     * @return array
-     */
-    public function getOrdersArray()
-    {
-        $ret                    = [];
-        $ret['ASC']['caption']  = _CO_SOBJECT_SORT_ASC;
-        $ret['ASC']['selected'] = ('ASC' === $this->_ordersel) ? 'selected' : '';
-
-        $ret['DESC']['caption']  = _CO_SOBJECT_SORT_DESC;
-        $ret['DESC']['selected'] = ('DESC' === $this->_ordersel) ? 'selected' : '';
-
-        return $ret;
-    }
-
-    /**
-     * @return mixed|string|void
-     */
-    public function renderD()
-    {
-        return $this->render(false, true);
-    }
-
-    public function renderForPrint()
-    {
-    }
-
-    /**
-     * @param  bool $fetchOnly
-     * @param  bool $debug
-     * @return mixed|string|void
-     */
-    public function render($fetchOnly = false, $debug = false)
-    {
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
-
-        $this->_tpl = new \XoopsTpl();
-
-        /**
-         * We need access to the vars of the SmartObject for a few things in the table creation.
-         * Since we may not have a SmartObject to look into now, let's create one for this purpose
-         * and we will free it after
-         */
-        $this->_tempObject = $this->_objectHandler->create();
-
-        $this->_criteria->setStart(isset($_GET['start' . $this->_objectHandler->keyName]) ? (int)$_GET['start' . $this->_objectHandler->keyName] : 0);
-
-        $this->setSortOrder();
-
-        if (!$this->_isTree) {
-            $this->_limitsel = isset($_GET['limitsel']) ? $_GET['limitsel'] : smart_getCookieVar($_SERVER['PHP_SELF'] . '_limitsel', '15');
-        } else {
-            $this->_limitsel = 'all';
-        }
-
-        $this->_limitsel = isset($_POST['limitsel']) ? $_POST['limitsel'] : $this->_limitsel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_limitsel', $this->_limitsel);
-        $limitsArray = $this->getLimitsArray();
-        $this->_criteria->setLimit($this->_limitsel);
-
-        $this->_filtersel = isset($_GET['filtersel']) ? $_GET['filtersel'] : $this->getDefaultFilter();
-        $this->_filtersel = isset($_POST['filtersel']) ? $_POST['filtersel'] : $this->_filtersel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', $this->_filtersel);
-        $filtersArray = $this->getFiltersArray();
-
-        if ($filtersArray) {
-            $this->_tpl->assign('smartobject_optionssel_filtersArray', $filtersArray);
-        }
-
-        // Check if the selected filter is defined and if so, create the selfilter2
-        if (isset($this->_filterseloptions[$this->_filtersel])) {
-            // check if method associate with this filter exists in the handler
-            if (is_array($this->_filterseloptions[$this->_filtersel])) {
-                $filter = $this->_filterseloptions[$this->_filtersel];
-                $this->_criteria->add($filter['criteria']);
-            } else {
-                if (method_exists($this->_objectHandler, $this->_filterseloptions[$this->_filtersel])) {
-
-                    // then we will create the selfilter2 options by calling this method
-                    $method                   = $this->_filterseloptions[$this->_filtersel];
-                    $this->_filtersel2options = $this->_objectHandler->$method();
-
-                    $this->_filtersel2 = isset($_GET['filtersel2']) ? $_GET['filtersel2'] : $this->getDefaultFilter2();
-                    $this->_filtersel2 = isset($_POST['filtersel2']) ? $_POST['filtersel2'] : $this->_filtersel2;
-
-                    $filters2Array = $this->getFilters2Array();
-                    $this->_tpl->assign('smartobject_optionssel_filters2Array', $filters2Array);
-
-                    smart_setCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', $this->_filtersel2);
-                    if ('default' !== $this->_filtersel2) {
-                        $this->_criteria->add(new \Criteria($this->_filtersel, $this->_filtersel2));
-                    }
-                }
-            }
-        }
-        // Check if we have a quicksearch
-
-        if (isset($_POST['quicksearch_' . $this->_id]) && '' != $_POST['quicksearch_' . $this->_id]) {
-            $quicksearch_criteria = new \CriteriaCompo();
-            if (is_array($this->_quickSearch['fields'])) {
-                foreach ($this->_quickSearch['fields'] as $v) {
-                    $quicksearch_criteria->add(new \Criteria($v, '%' . $_POST['quicksearch_' . $this->_id] . '%', 'LIKE'), 'OR');
-                }
-            } else {
-                $quicksearch_criteria->add(new \Criteria($this->_quickSearch['fields'], '%' . $_POST['quicksearch_' . $this->_id] . '%', 'LIKE'));
-            }
-            $this->_criteria->add($quicksearch_criteria);
-        }
-
-        $this->_objects = $this->fetchObjects($debug);
-
-        require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
-        if ($this->_criteria->getLimit() > 0) {
-
-            /**
-             * Geeting rid of the old params
-             * $new_get_array is an array containing the new GET parameters
-             */
-            $new_get_array = [];
-
-            /**
-             * $params_of_the_options_sel is an array with all the parameters of the page
-             * but without the pagenave parameters. This array will be used in the
-             * OptionsSelection
-             */
-            $params_of_the_options_sel = [];
-
-            $not_needed_params = ['sortsel', 'limitsel', 'ordersel', 'start' . $this->_objectHandler->keyName];
-            foreach ($_GET as $k => $v) {
-                if (!in_array($k, $not_needed_params)) {
-                    $new_get_array[]             = "$k=$v";
-                    $params_of_the_options_sel[] = "$k=$v";
-                }
-            }
-
-            /**
-             * Adding the new params of the pagenav
-             */
-            $new_get_array[] = 'sortsel=' . $this->_sortsel;
-            $new_get_array[] = 'ordersel=' . $this->_ordersel;
-            $new_get_array[] = 'limitsel=' . $this->_limitsel;
-            $otherParams     = implode('&', $new_get_array);
-
-            $pagenav = new \XoopsPageNav($this->_objectHandler->getCount($this->_criteria), $this->_criteria->getLimit(), $this->_criteria->getStart(), 'start' . $this->_objectHandler->keyName, $otherParams);
-            $this->_tpl->assign('smartobject_pagenav', $pagenav->renderNav());
-        }
-        $this->renderOptionSelection($limitsArray, $params_of_the_options_sel);
-
-        // retreive the current url and the query string
-        $current_urls = smart_getCurrentUrls();
-        $current_url  = $current_urls['full_phpself'];
-        $query_string = $current_urls['querystring'];
-        if ($query_string) {
-            $query_string = str_replace('?', '', $query_string);
-        }
-        $query_stringArray     = explode('&', $query_string);
-        $new_query_stringArray = [];
-        foreach ($query_stringArray as $query_string) {
-            if (false === strpos($query_string, 'sortsel') && false === strpos($query_string, 'ordersel')) {
-                $new_query_stringArray[] = $query_string;
-            }
-        }
-        $new_query_string = implode('&', $new_query_stringArray);
-
-        $orderArray                     = [];
-        $orderArray['ASC']['image']     = 'desc.png';
-        $orderArray['ASC']['neworder']  = 'DESC';
-        $orderArray['DESC']['image']    = 'asc.png';
-        $orderArray['DESC']['neworder'] = 'ASC';
-
-        $aColumns = [];
-
-        foreach ($this->_columns as $column) {
-            $qs_param         = '';
-            $aColumn          = [];
-            $aColumn['width'] = $column->getWidth();
-            $aColumn['align'] = $column->getAlign();
-            $aColumn['key']   = $column->getKeyName();
-            if ('checked' === $column->_keyname) {
-                $aColumn['caption'] = '<input type ="checkbox" id="checkall_smartobjects" name="checkall_smartobjects"' . ' value="checkall_smartobjects" onclick="smartobject_checkall(window.document.form_' . $this->_id . ', \'selected_smartobjects\');">';
-            } elseif ($column->getCustomCaption()) {
-                $aColumn['caption'] = $column->getCustomCaption();
-            } else {
-                $aColumn['caption'] = isset($this->_tempObject->vars[$column->getKeyName()]['form_caption']) ? $this->_tempObject->vars[$column->getKeyName()]['form_caption'] : $column->getKeyName();
-            }
-            // Are we doing a GET sort on this column ?
-            $getSort = (isset($_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'])
-                        && $_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'] == $column->getKeyName())
-                       || ($this->_sortsel == $column->getKeyName());
-            $order   = isset($_GET[$this->_objectHandler->_itemname . '_' . 'ordersel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'ordersel'] : 'DESC';
-
-            if (isset($_REQUEST['quicksearch_' . $this->_id]) && '' != $_REQUEST['quicksearch_' . $this->_id]) {
-                $qs_param = '&quicksearch_' . $this->_id . '=' . $_REQUEST['quicksearch_' . $this->_id];
-            }
-            if (!$this->_enableColumnsSorting || 'checked' === $column->_keyname || !$column->isSortable()) {
-                $aColumn['caption'] = $aColumn['caption'];
-            } elseif ($getSort) {
-                $aColumn['caption'] = '<a href="'
-                                      . $current_url
-                                      . '?'
-                                      . $this->_objectHandler->_itemname
-                                      . '_'
-                                      . 'sortsel='
-                                      . $column->getKeyName()
-                                      . '&'
-                                      . $this->_objectHandler->_itemname
-                                      . '_'
-                                      . 'ordersel='
-                                      . $orderArray[$order]['neworder']
-                                      . $qs_param
-                                      . '&'
-                                      . $new_query_string
-                                      . '">'
-                                      . $aColumn['caption']
-                                      . ' <img src="'
-                                      . SMARTOBJECT_IMAGES_ACTIONS_URL
-                                      . $orderArray[$order]['image']
-                                      . '" alt="ASC"></a>';
-            } else {
-                $aColumn['caption'] = '<a href="' . $current_url . '?' . $this->_objectHandler->_itemname . '_' . 'sortsel=' . $column->getKeyName() . '&' . $this->_objectHandler->_itemname . '_' . 'ordersel=ASC' . $qs_param . '&' . $new_query_string . '">' . $aColumn['caption'] . '</a>';
-            }
-            $aColumns[] = $aColumn;
-        }
-        $this->_tpl->assign('smartobject_columns', $aColumns);
-
-        if ($this->_quickSearch) {
-            $this->_tpl->assign('smartobject_quicksearch', $this->_quickSearch['caption']);
-        }
-
-        $this->createTableRows();
-
-        $this->_tpl->assign('smartobject_showFilterAndLimit', $this->_showFilterAndLimit);
-        $this->_tpl->assign('smartobject_isTree', $this->_isTree);
-        $this->_tpl->assign('smartobject_show_action_column_title', $this->_showActionsColumnTitle);
-        $this->_tpl->assign('smartobject_table_header', $this->_tableHeader);
-        $this->_tpl->assign('smartobject_table_footer', $this->_tableFooter);
-        $this->_tpl->assign('smartobject_printer_friendly_page', $this->_printerFriendlyPage);
-        $this->_tpl->assign('smartobject_user_side', $this->_userSide);
-        $this->_tpl->assign('smartobject_has_actions', $this->_hasActions);
-        $this->_tpl->assign('smartobject_head_css_class', $this->_head_css_class);
-        $this->_tpl->assign('smartobject_actionButtons', $this->_actionButtons);
-        $this->_tpl->assign('smartobject_introButtons', $this->_introButtons);
-        $this->_tpl->assign('smartobject_id', $this->_id);
-        if (!empty($this->_withSelectedActions)) {
-            $this->_tpl->assign('smartobject_withSelectedActions', $this->_withSelectedActions);
-        }
-
-        $smartobjectTable_template = $this->_customTemplate ?: 'smartobject_smarttable_display.tpl';
-        if ($fetchOnly) {
-            return $this->_tpl->fetch('db:' . $smartobjectTable_template);
-        } else {
-            $this->_tpl->display('db:' . $smartobjectTable_template);
-        }
-    }
-
-    public function disableColumnsSorting()
-    {
-        $this->_enableColumnsSorting = false;
-    }
-
-    /**
-     * @param  bool $debug
-     * @return mixed|string|void
-     */
-    public function fetch($debug = false)
-    {
-        return $this->render(true, $debug);
-    }
+	public $_id;
+	public $_objectHandler;
+	public $_columns;
+	public $_criteria;
+	public $_actions;
+	public $_objects = false;
+	public $_aObjects;
+	public $_custom_actions;
+	public $_sortsel;
+	public $_ordersel;
+	public $_limitsel;
+	public $_filtersel;
+	public $_filterseloptions;
+	public $_filtersel2;
+	public $_filtersel2options;
+	public $_filtersel2optionsDefault;
+
+	public $_tempObject;
+	public $_tpl;
+	public $_introButtons;
+	public $_quickSearch            = false;
+	public $_actionButtons          = false;
+	public $_head_css_class         = 'bg3';
+	public $_hasActions             = false;
+	public $_userSide               = false;
+	public $_printerFriendlyPage    = false;
+	public $_tableHeader            = false;
+	public $_tableFooter            = false;
+	public $_showActionsColumnTitle = true;
+	public $_isTree                 = false;
+	public $_showFilterAndLimit     = true;
+	public $_enableColumnsSorting   = true;
+	public $_customTemplate         = false;
+	public $_withSelectedActions    = [];
+
+	/**
+	 * Constructor
+	 *
+	 * @param SmartPersistableObjectHandler $objectHandler {@link SmartPersistableObjectHandler}
+	 * @param CriteriaElement               $criteria
+	 * @param array                         $actions       array representing the actions to offer
+	 *
+	 * @param bool                          $userSide
+	 */
+	public function __construct(
+		SmartPersistableObjectHandler $objectHandler,
+		CriteriaElement $criteria = null,
+		$actions = ['edit', 'delete'],
+		$userSide = false
+	) {
+		$this->_id            = $objectHandler->className;
+		$this->_objectHandler = $objectHandler;
+
+		if (!$criteria) {
+			$criteria = new \CriteriaCompo();
+		}
+		$this->_criteria       = $criteria;
+		$this->_actions        = $actions;
+		$this->_custom_actions = [];
+		$this->_userSide       = $userSide;
+		if ($userSide) {
+			$this->_head_css_class = 'head';
+		}
+	}
+
+	/**
+	 * @param      $op
+	 * @param bool $caption
+	 * @param bool $text
+	 */
+	public function addActionButton($op, $caption = false, $text = false)
+	{
+		$action                 = [
+			'op'      => $op,
+			'caption' => $caption,
+			'text'    => $text
+		];
+		$this->_actionButtons[] = $action;
+	}
+
+	/**
+	 * @param $columnObj
+	 */
+	public function addColumn($columnObj)
+	{
+		$this->_columns[] = $columnObj;
+	}
+
+	/**
+	 * @param $name
+	 * @param $location
+	 * @param $value
+	 */
+	public function addIntroButton($name, $location, $value)
+	{
+		$introButton             = [];
+		$introButton['name']     = $name;
+		$introButton['location'] = $location;
+		$introButton['value']    = $value;
+		$this->_introButtons[]   = $introButton;
+		unset($introButton);
+	}
+
+	public function addPrinterFriendlyLink()
+	{
+		$current_urls               = smart_getCurrentUrls();
+		$current_url                = $current_urls['full'];
+		$this->_printerFriendlyPage = $current_url . '&print';
+	}
+
+	/**
+	 * @param        $fields
+	 * @param string $caption
+	 */
+	public function addQuickSearch($fields, $caption = _CO_SOBJECT_QUICK_SEARCH)
+	{
+		$this->_quickSearch = ['fields' => $fields, 'caption' => $caption];
+	}
+
+	/**
+	 * @param $content
+	 */
+	public function addHeader($content)
+	{
+		$this->_tableHeader = $content;
+	}
+
+	/**
+	 * @param $content
+	 */
+	public function addFooter($content)
+	{
+		$this->_tableFooter = $content;
+	}
+
+	/**
+	 * @param $caption
+	 */
+	public function addDefaultIntroButton($caption)
+	{
+		$this->addIntroButton($this->_objectHandler->_itemname, $this->_objectHandler->_page . '?op=mod', $caption);
+	}
+
+	/**
+	 * @param $method
+	 */
+	public function addCustomAction($method)
+	{
+		$this->_custom_actions[] = $method;
+	}
+
+	/**
+	 * @param $default_sort
+	 */
+	public function setDefaultSort($default_sort)
+	{
+		$this->_sortsel = $default_sort;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDefaultSort()
+	{
+		if ($this->_sortsel) {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_sortsel);
+		} else {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_objectHandler->identifierName);
+		}
+	}
+
+	/**
+	 * @param $default_order
+	 */
+	public function setDefaultOrder($default_order)
+	{
+		$this->_ordersel = $default_order;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDefaultOrder()
+	{
+		if ($this->_ordersel) {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', $this->_ordersel);
+		} else {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', 'ASC');
+		}
+	}
+
+	/**
+	 * @param array $actions
+	 */
+	public function addWithSelectedActions($actions = [])
+	{
+		$this->addColumn(new SmartObjectColumn('checked', 'center', 20, false, false, '&nbsp;'));
+		$this->_withSelectedActions = $actions;
+	}
+
+	/**
+	 * Adding a filter in the table
+	 *
+	 * @param string $key    key to the field that will be used for sorting
+	 * @param string $method method of the handler that will be called to populate the options when this filter is selected
+	 * @param bool   $default
+	 */
+	public function addFilter($key, $method, $default = false)
+	{
+		$this->_filterseloptions[$key]   = $method;
+		$this->_filtersel2optionsDefault = $default;
+	}
+
+	/**
+	 * @param $default_filter
+	 */
+	public function setDefaultFilter($default_filter)
+	{
+		$this->_filtersel = $default_filter;
+	}
+
+	public function isForUserSide()
+	{
+		$this->_userSide = true;
+	}
+
+	/**
+	 * @param $template
+	 */
+	public function setCustomTemplate($template)
+	{
+		$this->_customTemplate = $template;
+	}
+
+	public function setSortOrder()
+	{
+		$this->_sortsel = isset($_GET[$this->_objectHandler->_itemname . '_' . 'sortsel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'] : $this->getDefaultSort();
+		//$this->_sortsel = isset($_POST['sortsel']) ? $_POST['sortsel']: $this->_sortsel;
+		smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_sortsel);
+		$fieldsForSorting = $this->_tempObject->getFieldsForSorting($this->_sortsel);
+
+		if (isset($this->_tempObject->vars[$this->_sortsel]['itemName'])
+			&& $this->_tempObject->vars[$this->_sortsel]['itemName']) {
+			$this->_criteria->setSort($this->_tempObject->vars[$this->_sortsel]['itemName'] . '.' . $this->_sortsel);
+		} else {
+			$this->_criteria->setSort($this->_objectHandler->_itemname . '.' . $this->_sortsel);
+		}
+
+		$this->_ordersel = isset($_GET[$this->_objectHandler->_itemname . '_' . 'ordersel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'ordersel'] : $this->getDefaultOrder();
+		//$this->_ordersel = isset($_POST['ordersel']) ? $_POST['ordersel']:$this->_ordersel;
+		smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', $this->_ordersel);
+		$ordersArray = $this->getOrdersArray();
+		$this->_criteria->setOrder($this->_ordersel);
+	}
+
+	/**
+	 * @param $id
+	 */
+	public function setTableId($id)
+	{
+		$this->_id = $id;
+	}
+
+	/**
+	 * @param $objects
+	 */
+	public function setObjects($objects)
+	{
+		$this->_objects = $objects;
+	}
+
+	public function createTableRows()
+	{
+		$this->_aObjects = [];
+
+		$doWeHaveActions = false;
+
+		$objectclass = 'odd';
+		if (count($this->_objects) > 0) {
+			foreach ($this->_objects as $object) {
+				$aObject = [];
+
+				$i = 0;
+
+				$aColumns = [];
+
+				foreach ($this->_columns as $column) {
+					$aColumn = [];
+
+					if (0 == $i) {
+						$class = 'head';
+					} elseif (0 == $i % 2) {
+						$class = 'even';
+					} else {
+						$class = 'odd';
+					}
+					if (method_exists($object, 'initiateCustomFields')) {
+						//$object->initiateCustomFields();
+					}
+					if ('checked' === $column->_keyname) {
+						$value = '<input type ="checkbox" name="selected_smartobjects[]" value="' . $object->id() . '">';
+					} elseif ($column->_customMethodForValue
+							  && method_exists($object, $column->_customMethodForValue)) {
+						$method = $column->_customMethodForValue;
+						if ($column->_param) {
+							$value = $object->$method($column->_param);
+						} else {
+							$value = $object->$method();
+						}
+					} else {
+						/**
+						 * If the column is the identifier, then put a link on it
+						 */
+						if ($column->getKeyName() == $this->_objectHandler->identifierName) {
+							$value = $object->getItemLink();
+						} else {
+							$value = $object->getVar($column->getKeyName());
+						}
+					}
+
+					$aColumn['value'] = $value;
+					$aColumn['class'] = $class;
+					$aColumn['width'] = $column->getWidth();
+					$aColumn['align'] = $column->getAlign();
+
+					$aColumns[] = $aColumn;
+					++$i;
+				}
+
+				$aObject['columns'] = $aColumns;
+				$aObject['id']      = $object->id();
+
+				$objectclass = ('even' === $objectclass) ? 'odd' : 'even';
+
+				$aObject['class'] = $objectclass;
+
+				$actions = [];
+
+				// Adding the custom actions if any
+				foreach ($this->_custom_actions as $action) {
+					if (method_exists($object, $action)) {
+						$actions[] = $object->$action();
+					}
+				}
+
+				require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
+				$controller = new SmartObjectController($this->_objectHandler);
+
+				if ((!is_array($this->_actions)) || in_array('edit', $this->_actions)) {
+					$actions[] = $controller->getEditItemLink($object, false, true, $this->_userSide);
+				}
+				if ((!is_array($this->_actions)) || in_array('delete', $this->_actions)) {
+					$actions[] = $controller->getDeleteItemLink($object, false, true, $this->_userSide);
+				}
+				$aObject['actions'] = $actions;
+
+				$this->_tpl->assign('smartobject_actions_column_width', count($actions) * 30);
+
+				$doWeHaveActions = $doWeHaveActions ? true : count($actions) > 0;
+
+				$this->_aObjects[] = $aObject;
+			}
+			$this->_tpl->assign('smartobject_objects', $this->_aObjects);
+		} else {
+			$colspan = count($this->_columns) + 1;
+			$this->_tpl->assign('smartobject_colspan', $colspan);
+		}
+		$this->_hasActions = $doWeHaveActions;
+	}
+
+	/**
+	 * @param  bool $debug
+	 * @return mixed
+	 */
+	public function fetchObjects($debug = false)
+	{
+		return $this->_objectHandler->getObjects($this->_criteria, true, true, false, $debug);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDefaultFilter()
+	{
+		if ($this->_filtersel) {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', $this->_filtersel);
+		} else {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', 'default');
+		}
+	}
+
+	/**
+	 * @return array|bool
+	 */
+	public function getFiltersArray()
+	{
+		$ret               = [];
+		$field             = [];
+		$field['caption']  = _CO_OBJ_NONE;
+		$field['selected'] = '';
+		$ret['default']    = $field;
+		unset($field);
+
+		if ($this->_filterseloptions) {
+			foreach ($this->_filterseloptions as $key => $value) {
+				$field = [];
+				if (is_array($value)) {
+					$field['caption']  = $key;
+					$field['selected'] = $this->_filtersel == $key ? 'selected' : '';
+				} else {
+					$field['caption']  = $this->_tempObject->vars[$key]['form_caption'];
+					$field['selected'] = $this->_filtersel == $key ? 'selected' : '';
+				}
+				$ret[$key] = $field;
+				unset($field);
+			}
+		} else {
+			$ret = false;
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param $default_filter2
+	 */
+	public function setDefaultFilter2($default_filter2)
+	{
+		$this->_filtersel2 = $default_filter2;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDefaultFilter2()
+	{
+		if ($this->_filtersel2) {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', $this->_filtersel2);
+		} else {
+			return smart_getCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', 'default');
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getFilters2Array()
+	{
+		$ret = [];
+
+		foreach ($this->_filtersel2options as $key => $value) {
+			$field             = [];
+			$field['caption']  = $value;
+			$field['selected'] = $this->_filtersel2 == $key ? 'selected' : '';
+			$ret[$key]         = $field;
+			unset($field);
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param $limitsArray
+	 * @param $params_of_the_options_sel
+	 */
+	public function renderOptionSelection($limitsArray, $params_of_the_options_sel)
+	{
+		// Rendering the form to select options on the table
+		$current_urls = smart_getCurrentUrls();
+		$current_url  = $current_urls['full'];
+
+		/**
+		 * What was $params_of_the_options_sel doing again ?
+		 */
+		//$this->_tpl->assign('smartobject_optionssel_action', $_SERVER['PHP_SELF'] . "?" . implode('&', $params_of_the_options_sel));
+		$this->_tpl->assign('smartobject_optionssel_action', $current_url);
+		$this->_tpl->assign('smartobject_optionssel_limitsArray', $limitsArray);
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getLimitsArray()
+	{
+		$ret                    = [];
+		$ret['all']['caption']  = _CO_SOBJECT_LIMIT_ALL;
+		$ret['all']['selected'] = ('all' === $this->_limitsel) ? 'selected' : '';
+
+		$ret['5']['caption']  = '5';
+		$ret['5']['selected'] = ('5' == $this->_limitsel) ? 'selected' : '';
+
+		$ret['10']['caption']  = '10';
+		$ret['10']['selected'] = ('10' == $this->_limitsel) ? 'selected' : '';
+
+		$ret['15']['caption']  = '15';
+		$ret['15']['selected'] = ('15' == $this->_limitsel) ? 'selected' : '';
+
+		$ret['20']['caption']  = '20';
+		$ret['20']['selected'] = ('20' == $this->_limitsel) ? 'selected' : '';
+
+		$ret['25']['caption']  = '25';
+		$ret['25']['selected'] = ('25' == $this->_limitsel) ? 'selected' : '';
+
+		$ret['30']['caption']  = '30';
+		$ret['30']['selected'] = ('30' == $this->_limitsel) ? 'selected' : '';
+
+		$ret['35']['caption']  = '35';
+		$ret['35']['selected'] = ('35' == $this->_limitsel) ? 'selected' : '';
+
+		$ret['40']['caption']  = '40';
+		$ret['40']['selected'] = ('40' == $this->_limitsel) ? 'selected' : '';
+
+		return $ret;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getObjects()
+	{
+		return $this->_objects;
+	}
+
+	public function hideActionColumnTitle()
+	{
+		$this->_showActionsColumnTitle = false;
+	}
+
+	public function hideFilterAndLimit()
+	{
+		$this->_showFilterAndLimit = false;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getOrdersArray()
+	{
+		$ret                    = [];
+		$ret['ASC']['caption']  = _CO_SOBJECT_SORT_ASC;
+		$ret['ASC']['selected'] = ('ASC' === $this->_ordersel) ? 'selected' : '';
+
+		$ret['DESC']['caption']  = _CO_SOBJECT_SORT_DESC;
+		$ret['DESC']['selected'] = ('DESC' === $this->_ordersel) ? 'selected' : '';
+
+		return $ret;
+	}
+
+	/**
+	 * @return mixed|string|void
+	 */
+	public function renderD()
+	{
+		return $this->render(false, true);
+	}
+
+	public function renderForPrint()
+	{
+	}
+
+	/**
+	 * @param  bool $fetchOnly
+	 * @param  bool $debug
+	 * @return mixed|string|void
+	 */
+	public function render($fetchOnly = false, $debug = false)
+	{
+		require_once XOOPS_ROOT_PATH . '/class/template.php';
+
+		$this->_tpl = new \XoopsTpl();
+
+		/**
+		 * We need access to the vars of the SmartObject for a few things in the table creation.
+		 * Since we may not have a SmartObject to look into now, let's create one for this purpose
+		 * and we will free it after
+		 */
+		$this->_tempObject = $this->_objectHandler->create();
+
+		$this->_criteria->setStart(isset($_GET['start' . $this->_objectHandler->keyName]) ? (int)$_GET['start' . $this->_objectHandler->keyName] : 0);
+
+		$this->setSortOrder();
+
+		if (!$this->_isTree) {
+			$this->_limitsel = isset($_GET['limitsel']) ? $_GET['limitsel'] : smart_getCookieVar($_SERVER['PHP_SELF'] . '_limitsel', '15');
+		} else {
+			$this->_limitsel = 'all';
+		}
+
+		$this->_limitsel = isset($_POST['limitsel']) ? $_POST['limitsel'] : $this->_limitsel;
+		smart_setCookieVar($_SERVER['PHP_SELF'] . '_limitsel', $this->_limitsel);
+		$limitsArray = $this->getLimitsArray();
+		$this->_criteria->setLimit($this->_limitsel);
+
+		$this->_filtersel = isset($_GET['filtersel']) ? $_GET['filtersel'] : $this->getDefaultFilter();
+		$this->_filtersel = isset($_POST['filtersel']) ? $_POST['filtersel'] : $this->_filtersel;
+		smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', $this->_filtersel);
+		$filtersArray = $this->getFiltersArray();
+
+		if ($filtersArray) {
+			$this->_tpl->assign('smartobject_optionssel_filtersArray', $filtersArray);
+		}
+
+		// Check if the selected filter is defined and if so, create the selfilter2
+		if (isset($this->_filterseloptions[$this->_filtersel])) {
+			// check if method associate with this filter exists in the handler
+			if (is_array($this->_filterseloptions[$this->_filtersel])) {
+				$filter = $this->_filterseloptions[$this->_filtersel];
+				$this->_criteria->add($filter['criteria']);
+			} else {
+				if (method_exists($this->_objectHandler, $this->_filterseloptions[$this->_filtersel])) {
+
+					// then we will create the selfilter2 options by calling this method
+					$method                   = $this->_filterseloptions[$this->_filtersel];
+					$this->_filtersel2options = $this->_objectHandler->$method();
+
+					$this->_filtersel2 = isset($_GET['filtersel2']) ? $_GET['filtersel2'] : $this->getDefaultFilter2();
+					$this->_filtersel2 = isset($_POST['filtersel2']) ? $_POST['filtersel2'] : $this->_filtersel2;
+
+					$filters2Array = $this->getFilters2Array();
+					$this->_tpl->assign('smartobject_optionssel_filters2Array', $filters2Array);
+
+					smart_setCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', $this->_filtersel2);
+					if ('default' !== $this->_filtersel2) {
+						$this->_criteria->add(new \Criteria($this->_filtersel, $this->_filtersel2));
+					}
+				}
+			}
+		}
+		// Check if we have a quicksearch
+
+		if (isset($_POST['quicksearch_' . $this->_id]) && '' != $_POST['quicksearch_' . $this->_id]) {
+			$quicksearch_criteria = new \CriteriaCompo();
+			if (is_array($this->_quickSearch['fields'])) {
+				foreach ($this->_quickSearch['fields'] as $v) {
+					$quicksearch_criteria->add(new \Criteria($v, '%' . $_POST['quicksearch_' . $this->_id] . '%', 'LIKE'), 'OR');
+				}
+			} else {
+				$quicksearch_criteria->add(new \Criteria($this->_quickSearch['fields'], '%' . $_POST['quicksearch_' . $this->_id] . '%', 'LIKE'));
+			}
+			$this->_criteria->add($quicksearch_criteria);
+		}
+
+		$this->_objects = $this->fetchObjects($debug);
+
+		require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
+		if ($this->_criteria->getLimit() > 0) {
+
+			/**
+			 * Geeting rid of the old params
+			 * $new_get_array is an array containing the new GET parameters
+			 */
+			$new_get_array = [];
+
+			/**
+			 * $params_of_the_options_sel is an array with all the parameters of the page
+			 * but without the pagenave parameters. This array will be used in the
+			 * OptionsSelection
+			 */
+			$params_of_the_options_sel = [];
+
+			$not_needed_params = ['sortsel', 'limitsel', 'ordersel', 'start' . $this->_objectHandler->keyName];
+			foreach ($_GET as $k => $v) {
+				if (!in_array($k, $not_needed_params)) {
+					$new_get_array[]             = "$k=$v";
+					$params_of_the_options_sel[] = "$k=$v";
+				}
+			}
+
+			/**
+			 * Adding the new params of the pagenav
+			 */
+			$new_get_array[] = 'sortsel=' . $this->_sortsel;
+			$new_get_array[] = 'ordersel=' . $this->_ordersel;
+			$new_get_array[] = 'limitsel=' . $this->_limitsel;
+			$otherParams     = implode('&', $new_get_array);
+
+			$pagenav = new \XoopsPageNav($this->_objectHandler->getCount($this->_criteria), $this->_criteria->getLimit(), $this->_criteria->getStart(), 'start' . $this->_objectHandler->keyName, $otherParams);
+			$this->_tpl->assign('smartobject_pagenav', $pagenav->renderNav());
+		}
+		$this->renderOptionSelection($limitsArray, $params_of_the_options_sel);
+
+		// retreive the current url and the query string
+		$current_urls = smart_getCurrentUrls();
+		$current_url  = $current_urls['full_phpself'];
+		$query_string = $current_urls['querystring'];
+		if ($query_string) {
+			$query_string = str_replace('?', '', $query_string);
+		}
+		$query_stringArray     = explode('&', $query_string);
+		$new_query_stringArray = [];
+		foreach ($query_stringArray as $query_string) {
+			if (false === strpos($query_string, 'sortsel') && false === strpos($query_string, 'ordersel')) {
+				$new_query_stringArray[] = $query_string;
+			}
+		}
+		$new_query_string = implode('&', $new_query_stringArray);
+
+		$orderArray                     = [];
+		$orderArray['ASC']['image']     = 'desc.png';
+		$orderArray['ASC']['neworder']  = 'DESC';
+		$orderArray['DESC']['image']    = 'asc.png';
+		$orderArray['DESC']['neworder'] = 'ASC';
+
+		$aColumns = [];
+
+		foreach ($this->_columns as $column) {
+			$qs_param         = '';
+			$aColumn          = [];
+			$aColumn['width'] = $column->getWidth();
+			$aColumn['align'] = $column->getAlign();
+			$aColumn['key']   = $column->getKeyName();
+			if ('checked' === $column->_keyname) {
+				$aColumn['caption'] = '<input type ="checkbox" id="checkall_smartobjects" name="checkall_smartobjects"' . ' value="checkall_smartobjects" onclick="smartobject_checkall(window.document.form_' . $this->_id . ', \'selected_smartobjects\');">';
+			} elseif ($column->getCustomCaption()) {
+				$aColumn['caption'] = $column->getCustomCaption();
+			} else {
+				$aColumn['caption'] = isset($this->_tempObject->vars[$column->getKeyName()]['form_caption']) ? $this->_tempObject->vars[$column->getKeyName()]['form_caption'] : $column->getKeyName();
+			}
+			// Are we doing a GET sort on this column ?
+			$getSort = (isset($_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'])
+						&& $_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'] == $column->getKeyName())
+					   || ($this->_sortsel == $column->getKeyName());
+			$order   = isset($_GET[$this->_objectHandler->_itemname . '_' . 'ordersel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'ordersel'] : 'DESC';
+
+			if (isset($_REQUEST['quicksearch_' . $this->_id]) && '' != $_REQUEST['quicksearch_' . $this->_id]) {
+				$qs_param = '&quicksearch_' . $this->_id . '=' . $_REQUEST['quicksearch_' . $this->_id];
+			}
+			if (!$this->_enableColumnsSorting || 'checked' === $column->_keyname || !$column->isSortable()) {
+				$aColumn['caption'] = $aColumn['caption'];
+			} elseif ($getSort) {
+				$aColumn['caption'] = '<a href="'
+									  . $current_url
+									  . '?'
+									  . $this->_objectHandler->_itemname
+									  . '_'
+									  . 'sortsel='
+									  . $column->getKeyName()
+									  . '&'
+									  . $this->_objectHandler->_itemname
+									  . '_'
+									  . 'ordersel='
+									  . $orderArray[$order]['neworder']
+									  . $qs_param
+									  . '&'
+									  . $new_query_string
+									  . '">'
+									  . $aColumn['caption']
+									  . ' <img src="'
+									  . SMARTOBJECT_IMAGES_ACTIONS_URL
+									  . $orderArray[$order]['image']
+									  . '" alt="ASC"></a>';
+			} else {
+				$aColumn['caption'] = '<a href="' . $current_url . '?' . $this->_objectHandler->_itemname . '_' . 'sortsel=' . $column->getKeyName() . '&' . $this->_objectHandler->_itemname . '_' . 'ordersel=ASC' . $qs_param . '&' . $new_query_string . '">' . $aColumn['caption'] . '</a>';
+			}
+			$aColumns[] = $aColumn;
+		}
+		$this->_tpl->assign('smartobject_columns', $aColumns);
+
+		if ($this->_quickSearch) {
+			$this->_tpl->assign('smartobject_quicksearch', $this->_quickSearch['caption']);
+		}
+
+		$this->createTableRows();
+
+		$this->_tpl->assign('smartobject_showFilterAndLimit', $this->_showFilterAndLimit);
+		$this->_tpl->assign('smartobject_isTree', $this->_isTree);
+		$this->_tpl->assign('smartobject_show_action_column_title', $this->_showActionsColumnTitle);
+		$this->_tpl->assign('smartobject_table_header', $this->_tableHeader);
+		$this->_tpl->assign('smartobject_table_footer', $this->_tableFooter);
+		$this->_tpl->assign('smartobject_printer_friendly_page', $this->_printerFriendlyPage);
+		$this->_tpl->assign('smartobject_user_side', $this->_userSide);
+		$this->_tpl->assign('smartobject_has_actions', $this->_hasActions);
+		$this->_tpl->assign('smartobject_head_css_class', $this->_head_css_class);
+		$this->_tpl->assign('smartobject_actionButtons', $this->_actionButtons);
+		$this->_tpl->assign('smartobject_introButtons', $this->_introButtons);
+		$this->_tpl->assign('smartobject_id', $this->_id);
+		if (!empty($this->_withSelectedActions)) {
+			$this->_tpl->assign('smartobject_withSelectedActions', $this->_withSelectedActions);
+		}
+
+		$smartobjectTable_template = $this->_customTemplate ?: 'smartobject_smarttable_display.tpl';
+		if ($fetchOnly) {
+			return $this->_tpl->fetch('db:' . $smartobjectTable_template);
+		} else {
+			$this->_tpl->display('db:' . $smartobjectTable_template);
+		}
+	}
+
+	public function disableColumnsSorting()
+	{
+		$this->_enableColumnsSorting = false;
+	}
+
+	/**
+	 * @param  bool $debug
+	 * @return mixed|string|void
+	 */
+	public function fetch($debug = false)
+	{
+		return $this->render(true, $debug);
+	}
 }

Spacing +43 added lines, -43 removed lines

@@ -97,7 +97,7 @@ 
      */
     public function addActionButton($op, $caption = false, $text = false)
     {
-        $action                 = [
+        $action = [
             'op'      => $op,
             'caption' => $caption,
             'text'    => $text
@@ -132,7 +132,7 @@ 
     {
         $current_urls               = smart_getCurrentUrls();
         $current_url                = $current_urls['full'];
-        $this->_printerFriendlyPage = $current_url . '&print';
+        $this->_printerFriendlyPage = $current_url.'&print';
     }
 
     /**
@@ -165,7 +165,7 @@ 
      */
     public function addDefaultIntroButton($caption)
     {
-        $this->addIntroButton($this->_objectHandler->_itemname, $this->_objectHandler->_page . '?op=mod', $caption);
+        $this->addIntroButton($this->_objectHandler->_itemname, $this->_objectHandler->_page.'?op=mod', $caption);
     }
 
     /**
@@ -190,9 +190,9 @@ 
     public function getDefaultSort()
     {
         if ($this->_sortsel) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_sortsel);
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_sortsel', $this->_sortsel);
         } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_objectHandler->identifierName);
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_sortsel', $this->_objectHandler->identifierName);
         }
     }
 
@@ -210,9 +210,9 @@ 
     public function getDefaultOrder()
     {
         if ($this->_ordersel) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', $this->_ordersel);
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_ordersel', $this->_ordersel);
         } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', 'ASC');
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_ordersel', 'ASC');
         }
     }
 
@@ -261,21 +261,21 @@ 
 
     public function setSortOrder()
     {
-        $this->_sortsel = isset($_GET[$this->_objectHandler->_itemname . '_' . 'sortsel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'] : $this->getDefaultSort();
+        $this->_sortsel = isset($_GET[$this->_objectHandler->_itemname.'_'.'sortsel']) ? $_GET[$this->_objectHandler->_itemname.'_'.'sortsel'] : $this->getDefaultSort();
         //$this->_sortsel = isset($_POST['sortsel']) ? $_POST['sortsel']: $this->_sortsel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_sortsel', $this->_sortsel);
+        smart_setCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_sortsel', $this->_sortsel);
         $fieldsForSorting = $this->_tempObject->getFieldsForSorting($this->_sortsel);
 
         if (isset($this->_tempObject->vars[$this->_sortsel]['itemName'])
             && $this->_tempObject->vars[$this->_sortsel]['itemName']) {
-            $this->_criteria->setSort($this->_tempObject->vars[$this->_sortsel]['itemName'] . '.' . $this->_sortsel);
+            $this->_criteria->setSort($this->_tempObject->vars[$this->_sortsel]['itemName'].'.'.$this->_sortsel);
         } else {
-            $this->_criteria->setSort($this->_objectHandler->_itemname . '.' . $this->_sortsel);
+            $this->_criteria->setSort($this->_objectHandler->_itemname.'.'.$this->_sortsel);
         }
 
-        $this->_ordersel = isset($_GET[$this->_objectHandler->_itemname . '_' . 'ordersel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'ordersel'] : $this->getDefaultOrder();
+        $this->_ordersel = isset($_GET[$this->_objectHandler->_itemname.'_'.'ordersel']) ? $_GET[$this->_objectHandler->_itemname.'_'.'ordersel'] : $this->getDefaultOrder();
         //$this->_ordersel = isset($_POST['ordersel']) ? $_POST['ordersel']:$this->_ordersel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_ordersel', $this->_ordersel);
+        smart_setCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_ordersel', $this->_ordersel);
         $ordersArray = $this->getOrdersArray();
         $this->_criteria->setOrder($this->_ordersel);
     }
@@ -325,7 +325,7 @@ 
                         //$object->initiateCustomFields();
                     }
                     if ('checked' === $column->_keyname) {
-                        $value = '<input type ="checkbox" name="selected_smartobjects[]" value="' . $object->id() . '">';
+                        $value = '<input type ="checkbox" name="selected_smartobjects[]" value="'.$object->id().'">';
                     } elseif ($column->_customMethodForValue
                               && method_exists($object, $column->_customMethodForValue)) {
                         $method = $column->_customMethodForValue;
@@ -370,7 +370,7 @@ 
                     }
                 }
 
-                require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
+                require_once SMARTOBJECT_ROOT_PATH.'class/smartobjectcontroller.php';
                 $controller = new SmartObjectController($this->_objectHandler);
 
                 if ((!is_array($this->_actions)) || in_array('edit', $this->_actions)) {
@@ -410,9 +410,9 @@ 
     public function getDefaultFilter()
     {
         if ($this->_filtersel) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', $this->_filtersel);
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_filtersel', $this->_filtersel);
         } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', 'default');
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_filtersel', 'default');
         }
     }
 
@@ -462,9 +462,9 @@ 
     public function getDefaultFilter2()
     {
         if ($this->_filtersel2) {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', $this->_filtersel2);
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_filtersel2', $this->_filtersel2);
         } else {
-            return smart_getCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', 'default');
+            return smart_getCookieVar($_SERVER['PHP_SELF'].'_filtersel2', 'default');
         }
     }
 
@@ -592,7 +592,7 @@ 
      */
     public function render($fetchOnly = false, $debug = false)
     {
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
+        require_once XOOPS_ROOT_PATH.'/class/template.php';
 
         $this->_tpl = new \XoopsTpl();
 
@@ -603,24 +603,24 @@ 
          */
         $this->_tempObject = $this->_objectHandler->create();
 
-        $this->_criteria->setStart(isset($_GET['start' . $this->_objectHandler->keyName]) ? (int)$_GET['start' . $this->_objectHandler->keyName] : 0);
+        $this->_criteria->setStart(isset($_GET['start'.$this->_objectHandler->keyName]) ? (int) $_GET['start'.$this->_objectHandler->keyName] : 0);
 
         $this->setSortOrder();
 
         if (!$this->_isTree) {
-            $this->_limitsel = isset($_GET['limitsel']) ? $_GET['limitsel'] : smart_getCookieVar($_SERVER['PHP_SELF'] . '_limitsel', '15');
+            $this->_limitsel = isset($_GET['limitsel']) ? $_GET['limitsel'] : smart_getCookieVar($_SERVER['PHP_SELF'].'_limitsel', '15');
         } else {
             $this->_limitsel = 'all';
         }
 
         $this->_limitsel = isset($_POST['limitsel']) ? $_POST['limitsel'] : $this->_limitsel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_limitsel', $this->_limitsel);
+        smart_setCookieVar($_SERVER['PHP_SELF'].'_limitsel', $this->_limitsel);
         $limitsArray = $this->getLimitsArray();
         $this->_criteria->setLimit($this->_limitsel);
 
         $this->_filtersel = isset($_GET['filtersel']) ? $_GET['filtersel'] : $this->getDefaultFilter();
         $this->_filtersel = isset($_POST['filtersel']) ? $_POST['filtersel'] : $this->_filtersel;
-        smart_setCookieVar($_SERVER['PHP_SELF'] . '_' . $this->_id . '_filtersel', $this->_filtersel);
+        smart_setCookieVar($_SERVER['PHP_SELF'].'_'.$this->_id.'_filtersel', $this->_filtersel);
         $filtersArray = $this->getFiltersArray();
 
         if ($filtersArray) {
@@ -646,7 +646,7 @@ 
                     $filters2Array = $this->getFilters2Array();
                     $this->_tpl->assign('smartobject_optionssel_filters2Array', $filters2Array);
 
-                    smart_setCookieVar($_SERVER['PHP_SELF'] . '_filtersel2', $this->_filtersel2);
+                    smart_setCookieVar($_SERVER['PHP_SELF'].'_filtersel2', $this->_filtersel2);
                     if ('default' !== $this->_filtersel2) {
                         $this->_criteria->add(new \Criteria($this->_filtersel, $this->_filtersel2));
                     }
@@ -655,21 +655,21 @@ 
         }
         // Check if we have a quicksearch
 
-        if (isset($_POST['quicksearch_' . $this->_id]) && '' != $_POST['quicksearch_' . $this->_id]) {
+        if (isset($_POST['quicksearch_'.$this->_id]) && '' != $_POST['quicksearch_'.$this->_id]) {
             $quicksearch_criteria = new \CriteriaCompo();
             if (is_array($this->_quickSearch['fields'])) {
                 foreach ($this->_quickSearch['fields'] as $v) {
-                    $quicksearch_criteria->add(new \Criteria($v, '%' . $_POST['quicksearch_' . $this->_id] . '%', 'LIKE'), 'OR');
+                    $quicksearch_criteria->add(new \Criteria($v, '%'.$_POST['quicksearch_'.$this->_id].'%', 'LIKE'), 'OR');
                 }
             } else {
-                $quicksearch_criteria->add(new \Criteria($this->_quickSearch['fields'], '%' . $_POST['quicksearch_' . $this->_id] . '%', 'LIKE'));
+                $quicksearch_criteria->add(new \Criteria($this->_quickSearch['fields'], '%'.$_POST['quicksearch_'.$this->_id].'%', 'LIKE'));
             }
             $this->_criteria->add($quicksearch_criteria);
         }
 
         $this->_objects = $this->fetchObjects($debug);
 
-        require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
+        require_once XOOPS_ROOT_PATH.'/class/pagenav.php';
         if ($this->_criteria->getLimit() > 0) {
 
             /**
@@ -685,7 +685,7 @@ 
              */
             $params_of_the_options_sel = [];
 
-            $not_needed_params = ['sortsel', 'limitsel', 'ordersel', 'start' . $this->_objectHandler->keyName];
+            $not_needed_params = ['sortsel', 'limitsel', 'ordersel', 'start'.$this->_objectHandler->keyName];
             foreach ($_GET as $k => $v) {
                 if (!in_array($k, $not_needed_params)) {
                     $new_get_array[]             = "$k=$v";
@@ -696,12 +696,12 @@ 
             /**
              * Adding the new params of the pagenav
              */
-            $new_get_array[] = 'sortsel=' . $this->_sortsel;
-            $new_get_array[] = 'ordersel=' . $this->_ordersel;
-            $new_get_array[] = 'limitsel=' . $this->_limitsel;
+            $new_get_array[] = 'sortsel='.$this->_sortsel;
+            $new_get_array[] = 'ordersel='.$this->_ordersel;
+            $new_get_array[] = 'limitsel='.$this->_limitsel;
             $otherParams     = implode('&', $new_get_array);
 
-            $pagenav = new \XoopsPageNav($this->_objectHandler->getCount($this->_criteria), $this->_criteria->getLimit(), $this->_criteria->getStart(), 'start' . $this->_objectHandler->keyName, $otherParams);
+            $pagenav = new \XoopsPageNav($this->_objectHandler->getCount($this->_criteria), $this->_criteria->getLimit(), $this->_criteria->getStart(), 'start'.$this->_objectHandler->keyName, $otherParams);
             $this->_tpl->assign('smartobject_pagenav', $pagenav->renderNav());
         }
         $this->renderOptionSelection($limitsArray, $params_of_the_options_sel);
@@ -737,20 +737,20 @@ 
             $aColumn['align'] = $column->getAlign();
             $aColumn['key']   = $column->getKeyName();
             if ('checked' === $column->_keyname) {
-                $aColumn['caption'] = '<input type ="checkbox" id="checkall_smartobjects" name="checkall_smartobjects"' . ' value="checkall_smartobjects" onclick="smartobject_checkall(window.document.form_' . $this->_id . ', \'selected_smartobjects\');">';
+                $aColumn['caption'] = '<input type ="checkbox" id="checkall_smartobjects" name="checkall_smartobjects"'.' value="checkall_smartobjects" onclick="smartobject_checkall(window.document.form_'.$this->_id.', \'selected_smartobjects\');">';
             } elseif ($column->getCustomCaption()) {
                 $aColumn['caption'] = $column->getCustomCaption();
             } else {
                 $aColumn['caption'] = isset($this->_tempObject->vars[$column->getKeyName()]['form_caption']) ? $this->_tempObject->vars[$column->getKeyName()]['form_caption'] : $column->getKeyName();
             }
             // Are we doing a GET sort on this column ?
-            $getSort = (isset($_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'])
-                        && $_GET[$this->_objectHandler->_itemname . '_' . 'sortsel'] == $column->getKeyName())
+            $getSort = (isset($_GET[$this->_objectHandler->_itemname.'_'.'sortsel'])
+                        && $_GET[$this->_objectHandler->_itemname.'_'.'sortsel'] == $column->getKeyName())
                        || ($this->_sortsel == $column->getKeyName());
-            $order   = isset($_GET[$this->_objectHandler->_itemname . '_' . 'ordersel']) ? $_GET[$this->_objectHandler->_itemname . '_' . 'ordersel'] : 'DESC';
+            $order   = isset($_GET[$this->_objectHandler->_itemname.'_'.'ordersel']) ? $_GET[$this->_objectHandler->_itemname.'_'.'ordersel'] : 'DESC';
 
-            if (isset($_REQUEST['quicksearch_' . $this->_id]) && '' != $_REQUEST['quicksearch_' . $this->_id]) {
-                $qs_param = '&quicksearch_' . $this->_id . '=' . $_REQUEST['quicksearch_' . $this->_id];
+            if (isset($_REQUEST['quicksearch_'.$this->_id]) && '' != $_REQUEST['quicksearch_'.$this->_id]) {
+                $qs_param = '&quicksearch_'.$this->_id.'='.$_REQUEST['quicksearch_'.$this->_id];
             }
             if (!$this->_enableColumnsSorting || 'checked' === $column->_keyname || !$column->isSortable()) {
                 $aColumn['caption'] = $aColumn['caption'];
@@ -777,7 +777,7 @@ 
                                       . $orderArray[$order]['image']
                                       . '" alt="ASC"></a>';
             } else {
-                $aColumn['caption'] = '<a href="' . $current_url . '?' . $this->_objectHandler->_itemname . '_' . 'sortsel=' . $column->getKeyName() . '&' . $this->_objectHandler->_itemname . '_' . 'ordersel=ASC' . $qs_param . '&' . $new_query_string . '">' . $aColumn['caption'] . '</a>';
+                $aColumn['caption'] = '<a href="'.$current_url.'?'.$this->_objectHandler->_itemname.'_'.'sortsel='.$column->getKeyName().'&'.$this->_objectHandler->_itemname.'_'.'ordersel=ASC'.$qs_param.'&'.$new_query_string.'">'.$aColumn['caption'].'</a>';
             }
             $aColumns[] = $aColumn;
         }
@@ -807,9 +807,9 @@ 
 
         $smartobjectTable_template = $this->_customTemplate ?: 'smartobject_smarttable_display.tpl';
         if ($fetchOnly) {
-            return $this->_tpl->fetch('db:' . $smartobjectTable_template);
+            return $this->_tpl->fetch('db:'.$smartobjectTable_template);
         } else {
-            $this->_tpl->display('db:' . $smartobjectTable_template);
+            $this->_tpl->display('db:'.$smartobjectTable_template);
         }
     }
 

class/SmartPersistableObjectHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -193,7 +193,7 @@ 
 
     /**
      * @param $criteria
-     * @param $perm_name
+     * @param boolean $perm_name
      * @return bool
      */
     public function setGrantedObjectsCriteria($criteria, $perm_name)
@@ -387,7 +387,7 @@ 
     }
 
     /**
-     * @param        $sql
+     * @param        string $sql
      * @param        $criteria
      * @param  bool  $force
      * @param  bool  $debug

Indentation +976 added lines, -976 removed lines

@@ -29,980 +29,980 @@
 
 class SmartPersistableObjectHandler extends \XoopsObjectHandler
 {
-    public $_itemname;
-
-    /**
-     * Name of the table use to store this {@link SmartObject}
-     *
-     * Note that the name of the table needs to be free of the database prefix.
-     * For example "smartsection_categories"
-     * @var string
-     */
-    public $table;
-
-    /**
-     * Name of the table key that uniquely identify each {@link SmartObject}
-     *
-     * For example: "categoryid"
-     * @var string
-     */
-    public $keyName;
-
-    /**
-     * Name of the class derived from {@link SmartObject} and which this handler is handling
-     *
-     * Note that this string needs to be lowercase
-     *
-     * For example: "smartsectioncategory"
-     * @var string
-     */
-    public $className;
-
-    /**
-     * Name of the field which properly identify the {@link SmartObject}
-     *
-     * For example: "name" (this will be the category's name)
-     * @var string
-     */
-    public $identifierName;
-
-    /**
-     * Name of the field which will be use as a summary for the object
-     *
-     * For example: "summary"
-     * @var string
-     */
-    public $summaryName;
-
-    /**
-     * Page name use to basically manage and display the {@link SmartObject}
-     *
-     * This page needs to be the same in user side and admin side
-     *
-     * For example category.php - we will deduct smartsection/category.php as well as smartsection/admin/category.php
-     * @todo this could probably be automatically deducted from the class name - for example, the class SmartsectionCategory will have "category.php" as it's managing page
-     * @var string
-     */
-    public $_page;
-
-    /**
-     * Full path of the module using this {@link SmartObject}
-     *
-     * <code>XOOPS_URL . "/modules/smartsection/"</code>
-     * @todo this could probably be automatically deducted from the class name as it is always prefixed with the module name
-     * @var string
-     */
-    public $_modulePath;
-
-    public $_moduleUrl;
-
-    public $_moduleName;
-
-    public $_uploadUrl;
-
-    public $_uploadPath;
-
-    public $_allowedMimeTypes = 0;
-
-    public $_maxFileSize = 1000000;
-
-    public $_maxWidth = 500;
-
-    public $_maxHeight = 500;
-
-    public $highlightFields = [];
-
-    /**
-     * Array 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->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 SmartobjectPermissionHandler($this);
-        $grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
-        if (count($grantedItems) > 0) {
-            $criteria->add(new \Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
-
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * @param bool $_uploadPath
-     * @param bool $_allowedMimeTypes
-     * @param bool $_maxFileSize
-     * @param bool $_maxWidth
-     * @param bool $_maxHeight
-     */
-    public function setUploaderConfig(
-        $_uploadPath = false,
-        $_allowedMimeTypes = false,
-        $_maxFileSize = false,
-        $_maxWidth = false,
-        $_maxHeight = false
-    ) {
-        $this->_uploadPath       = $_uploadPath ?: $this->_uploadPath;
-        $this->_allowedMimeTypes = $_allowedMimeTypes ?: $this->_allowedMimeTypes;
-        $this->_maxFileSize      = $_maxFileSize ?: $this->_maxFileSize;
-        $this->_maxWidth         = $_maxWidth ?: $this->_maxWidth;
-        $this->_maxHeight        = $_maxHeight ?: $this->_maxHeight;
-    }
-
-    /**
-     * create a new {@link SmartObject}
-     *
-     * @param bool $isNew Flag the new objects as "new"?
-     *
-     * @return Smartobject\SmartObject {@link SmartObject}
-     */
-    public function create($isNew = true)
-    {
-        $obj = new $this->className($this);
-        $obj->setImageDir($this->getImageUrl(), $this->getImagePath());
-        if (!$obj->handler) {
-            $obj->Handler = $this;
-        }
-
-        if (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)) {
-            smart_admin_mkdir($dir);
-        }
-
-        return $dir . '/';
-    }
-
-    /**
-     * retrieve a {@link SmartObject}
-     *
-     * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
-     * @param  bool  $as_object whether to return an object or an array
-     * @param  bool  $debug
-     * @param  bool  $criteria
-     * @return mixed reference to the <a href='psi_element://SmartObject'>SmartObject</a>, FALSE if failed
-     *                          FALSE if failed
-     */
-    public function get($id, $as_object = true, $debug = false, $criteria = false)
-    {
-        if (!$criteria) {
-            $criteria = new \CriteriaCompo();
-        }
-        if (is_array($this->keyName)) {
-            for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                /**
-                 * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
-                 * Is the fact that we removed the (int)() represents a security risk ?
-                 */
-                //$criteria->add(new \Criteria($this->keyName[$i], ($id[$i]), '=', $this->_itemname));
-                $criteria->add(new \Criteria($this->keyName[$i], $id[$i], '=', $this->_itemname));
-            }
-        } else {
-            //$criteria = new \Criteria($this->keyName, (int)($id), '=', $this->_itemname);
-            /**
-             * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
-             * Is the fact that we removed the (int)() represents a security risk ?
-             */
-            $criteria->add(new \Criteria($this->keyName, $id, '=', $this->_itemname));
-        }
-        $criteria->setLimit(1);
-        if ($debug) {
-            $obj_array = $this->getObjectsD($criteria, false, $as_object);
-        } else {
-            $obj_array =& $this->getObjects($criteria, false, $as_object);
-            //patch: weird bug of indexing by id even if id_as_key = false;
-            if (!isset($obj_array[0]) && is_object($obj_array[$id])) {
-                $obj_array[0] = $obj_array[$id];
-                unset($obj_array[$id]);
-                $obj_array[0]->unsetNew();
-            }
-        }
-
-        if (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 SmartMetagen($obj->title(), $obj->getVar('meta_keywords'), $obj->summary());
-
-            if (!$obj->getVar('meta_keywords') || !$obj->getVar('meta_description')) {
-                if (!$obj->meta_keywords()) {
-                    $obj->setVar('meta_keywords', $smartobjectMetagen->_keywords);
-                }
-
-                if (!$obj->meta_description()) {
-                    $obj->setVar('meta_description', $smartobjectMetagen->_meta_description);
-                }
-            }
-
-            // Auto create short_url if empty
-            if (!$obj->short_url()) {
-                $obj->setVar('short_url', $smartobjectMetagen->generateSeoTitle($obj->title('n'), false));
-            }
-        }
-
-        $eventResult = $this->executeEvent('beforeSave', $obj);
-        if (!$eventResult) {
-            $obj->setErrors('An error occured during the BeforeSave event');
-
-            return false;
-        }
-
-        if ($obj->isNew()) {
-            $eventResult = $this->executeEvent('beforeInsert', $obj);
-            if (!$eventResult) {
-                $obj->setErrors('An error occured during the BeforeInsert event');
-
-                return false;
-            }
-        } else {
-            $eventResult = $this->executeEvent('beforeUpdate', $obj);
-            if (!$eventResult) {
-                $obj->setErrors('An error occured during the BeforeUpdate event');
-
-                return false;
-            }
-        }
-        if (!$obj->cleanVars()) {
-            $obj->setErrors('Variables were not cleaned properly.');
-
-            return false;
-        }
-        $fieldsToStoreInDB = [];
-        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 smart_getModuleInfo($this->_moduleName);
-    }
-
-    /**
-     * @return bool
-     */
-    public function getModuleConfig()
-    {
-        return smart_getModuleConfig($this->_moduleName);
-    }
-
-    /**
-     * @return string
-     */
-    public function getModuleItemString()
-    {
-        $ret = $this->_moduleName . '_' . $this->_itemname;
-
-        return $ret;
-    }
-
-    /**
-     * @param $object
-     */
-    public function updateCounter($object)
-    {
-        if (isset($object->vars['counter'])) {
-            $new_counter = $object->getVar('counter') + 1;
-            $sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
-            $this->query($sql, null, true);
-        }
-    }
-
-    /**
-     * Execute the function associated with an event
-     * This method will check if the function is available
-     *
-     * @param  string $event name of the event
-     * @param         $executeEventObj
-     * @return mixed  result of the execution of the function or FALSE if the function was not executed
-     * @internal param object $obj $object on which is performed the event
-     */
-    public function executeEvent($event, &$executeEventObj)
-    {
-        if (!in_array($event, $this->_disabledEvents)) {
-            if (method_exists($this, $event)) {
-                $ret = $this->$event($executeEventObj);
-            } else {
-                // check to see if there is a hook for this event
-                if (isset($this->_eventHooks[$event])) {
-                    $method = $this->_eventHooks[$event];
-                    // check to see if the method specified by this hook exists
-                    if (method_exists($this, $method)) {
-                        $ret = $this->$method($executeEventObj);
-                    }
-                }
-                $ret = true;
-            }
-
-            return $ret;
-        }
-
-        return true;
-    }
-
-    /**
-     * @param  bool $withprefix
-     * @return string
-     */
-    public function getIdentifierName($withprefix = true)
-    {
-        if ($withprefix) {
-            return $this->_itemname . '.' . $this->identifierName;
-        } else {
-            return $this->identifierName;
-        }
-    }
+	public $_itemname;
+
+	/**
+	 * Name of the table use to store this {@link SmartObject}
+	 *
+	 * Note that the name of the table needs to be free of the database prefix.
+	 * For example "smartsection_categories"
+	 * @var string
+	 */
+	public $table;
+
+	/**
+	 * Name of the table key that uniquely identify each {@link SmartObject}
+	 *
+	 * For example: "categoryid"
+	 * @var string
+	 */
+	public $keyName;
+
+	/**
+	 * Name of the class derived from {@link SmartObject} and which this handler is handling
+	 *
+	 * Note that this string needs to be lowercase
+	 *
+	 * For example: "smartsectioncategory"
+	 * @var string
+	 */
+	public $className;
+
+	/**
+	 * Name of the field which properly identify the {@link SmartObject}
+	 *
+	 * For example: "name" (this will be the category's name)
+	 * @var string
+	 */
+	public $identifierName;
+
+	/**
+	 * Name of the field which will be use as a summary for the object
+	 *
+	 * For example: "summary"
+	 * @var string
+	 */
+	public $summaryName;
+
+	/**
+	 * Page name use to basically manage and display the {@link SmartObject}
+	 *
+	 * This page needs to be the same in user side and admin side
+	 *
+	 * For example category.php - we will deduct smartsection/category.php as well as smartsection/admin/category.php
+	 * @todo this could probably be automatically deducted from the class name - for example, the class SmartsectionCategory will have "category.php" as it's managing page
+	 * @var string
+	 */
+	public $_page;
+
+	/**
+	 * Full path of the module using this {@link SmartObject}
+	 *
+	 * <code>XOOPS_URL . "/modules/smartsection/"</code>
+	 * @todo this could probably be automatically deducted from the class name as it is always prefixed with the module name
+	 * @var string
+	 */
+	public $_modulePath;
+
+	public $_moduleUrl;
+
+	public $_moduleName;
+
+	public $_uploadUrl;
+
+	public $_uploadPath;
+
+	public $_allowedMimeTypes = 0;
+
+	public $_maxFileSize = 1000000;
+
+	public $_maxWidth = 500;
+
+	public $_maxHeight = 500;
+
+	public $highlightFields = [];
+
+	/**
+	 * Array 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->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 SmartobjectPermissionHandler($this);
+		$grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
+		if (count($grantedItems) > 0) {
+			$criteria->add(new \Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
+
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * @param bool $_uploadPath
+	 * @param bool $_allowedMimeTypes
+	 * @param bool $_maxFileSize
+	 * @param bool $_maxWidth
+	 * @param bool $_maxHeight
+	 */
+	public function setUploaderConfig(
+		$_uploadPath = false,
+		$_allowedMimeTypes = false,
+		$_maxFileSize = false,
+		$_maxWidth = false,
+		$_maxHeight = false
+	) {
+		$this->_uploadPath       = $_uploadPath ?: $this->_uploadPath;
+		$this->_allowedMimeTypes = $_allowedMimeTypes ?: $this->_allowedMimeTypes;
+		$this->_maxFileSize      = $_maxFileSize ?: $this->_maxFileSize;
+		$this->_maxWidth         = $_maxWidth ?: $this->_maxWidth;
+		$this->_maxHeight        = $_maxHeight ?: $this->_maxHeight;
+	}
+
+	/**
+	 * create a new {@link SmartObject}
+	 *
+	 * @param bool $isNew Flag the new objects as "new"?
+	 *
+	 * @return Smartobject\SmartObject {@link SmartObject}
+	 */
+	public function create($isNew = true)
+	{
+		$obj = new $this->className($this);
+		$obj->setImageDir($this->getImageUrl(), $this->getImagePath());
+		if (!$obj->handler) {
+			$obj->Handler = $this;
+		}
+
+		if (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)) {
+			smart_admin_mkdir($dir);
+		}
+
+		return $dir . '/';
+	}
+
+	/**
+	 * retrieve a {@link SmartObject}
+	 *
+	 * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
+	 * @param  bool  $as_object whether to return an object or an array
+	 * @param  bool  $debug
+	 * @param  bool  $criteria
+	 * @return mixed reference to the <a href='psi_element://SmartObject'>SmartObject</a>, FALSE if failed
+	 *                          FALSE if failed
+	 */
+	public function get($id, $as_object = true, $debug = false, $criteria = false)
+	{
+		if (!$criteria) {
+			$criteria = new \CriteriaCompo();
+		}
+		if (is_array($this->keyName)) {
+			for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
+				/**
+				 * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
+				 * Is the fact that we removed the (int)() represents a security risk ?
+				 */
+				//$criteria->add(new \Criteria($this->keyName[$i], ($id[$i]), '=', $this->_itemname));
+				$criteria->add(new \Criteria($this->keyName[$i], $id[$i], '=', $this->_itemname));
+			}
+		} else {
+			//$criteria = new \Criteria($this->keyName, (int)($id), '=', $this->_itemname);
+			/**
+			 * In some situations, the $id is not an INTEGER. SmartObjectTag is an example.
+			 * Is the fact that we removed the (int)() represents a security risk ?
+			 */
+			$criteria->add(new \Criteria($this->keyName, $id, '=', $this->_itemname));
+		}
+		$criteria->setLimit(1);
+		if ($debug) {
+			$obj_array = $this->getObjectsD($criteria, false, $as_object);
+		} else {
+			$obj_array =& $this->getObjects($criteria, false, $as_object);
+			//patch: weird bug of indexing by id even if id_as_key = false;
+			if (!isset($obj_array[0]) && is_object($obj_array[$id])) {
+				$obj_array[0] = $obj_array[$id];
+				unset($obj_array[$id]);
+				$obj_array[0]->unsetNew();
+			}
+		}
+
+		if (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 SmartMetagen($obj->title(), $obj->getVar('meta_keywords'), $obj->summary());
+
+			if (!$obj->getVar('meta_keywords') || !$obj->getVar('meta_description')) {
+				if (!$obj->meta_keywords()) {
+					$obj->setVar('meta_keywords', $smartobjectMetagen->_keywords);
+				}
+
+				if (!$obj->meta_description()) {
+					$obj->setVar('meta_description', $smartobjectMetagen->_meta_description);
+				}
+			}
+
+			// Auto create short_url if empty
+			if (!$obj->short_url()) {
+				$obj->setVar('short_url', $smartobjectMetagen->generateSeoTitle($obj->title('n'), false));
+			}
+		}
+
+		$eventResult = $this->executeEvent('beforeSave', $obj);
+		if (!$eventResult) {
+			$obj->setErrors('An error occured during the BeforeSave event');
+
+			return false;
+		}
+
+		if ($obj->isNew()) {
+			$eventResult = $this->executeEvent('beforeInsert', $obj);
+			if (!$eventResult) {
+				$obj->setErrors('An error occured during the BeforeInsert event');
+
+				return false;
+			}
+		} else {
+			$eventResult = $this->executeEvent('beforeUpdate', $obj);
+			if (!$eventResult) {
+				$obj->setErrors('An error occured during the BeforeUpdate event');
+
+				return false;
+			}
+		}
+		if (!$obj->cleanVars()) {
+			$obj->setErrors('Variables were not cleaned properly.');
+
+			return false;
+		}
+		$fieldsToStoreInDB = [];
+		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 smart_getModuleInfo($this->_moduleName);
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getModuleConfig()
+	{
+		return smart_getModuleConfig($this->_moduleName);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getModuleItemString()
+	{
+		$ret = $this->_moduleName . '_' . $this->_itemname;
+
+		return $ret;
+	}
+
+	/**
+	 * @param $object
+	 */
+	public function updateCounter($object)
+	{
+		if (isset($object->vars['counter'])) {
+			$new_counter = $object->getVar('counter') + 1;
+			$sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
+			$this->query($sql, null, true);
+		}
+	}
+
+	/**
+	 * Execute the function associated with an event
+	 * This method will check if the function is available
+	 *
+	 * @param  string $event name of the event
+	 * @param         $executeEventObj
+	 * @return mixed  result of the execution of the function or FALSE if the function was not executed
+	 * @internal param object $obj $object on which is performed the event
+	 */
+	public function executeEvent($event, &$executeEventObj)
+	{
+		if (!in_array($event, $this->_disabledEvents)) {
+			if (method_exists($this, $event)) {
+				$ret = $this->$event($executeEventObj);
+			} else {
+				// check to see if there is a hook for this event
+				if (isset($this->_eventHooks[$event])) {
+					$method = $this->_eventHooks[$event];
+					// check to see if the method specified by this hook exists
+					if (method_exists($this, $method)) {
+						$ret = $this->$method($executeEventObj);
+					}
+				}
+				$ret = true;
+			}
+
+			return $ret;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param  bool $withprefix
+	 * @return string
+	 */
+	public function getIdentifierName($withprefix = true)
+	{
+		if ($withprefix) {
+			return $this->_itemname . '.' . $this->identifierName;
+		} else {
+			return $this->identifierName;
+		}
+	}
 }

Spacing +49 added lines, -49 removed lines

@@ -150,16 +150,16 @@ 
 
         $this->_itemname      = $itemname;
         $this->_moduleName    = $modulename;
-        $this->table          = $db->prefix($modulename . '_' . $itemname);
+        $this->table          = $db->prefix($modulename.'_'.$itemname);
         $this->keyName        = $keyname;
-        $this->className      = ucfirst($modulename) . ucfirst($itemname);
+        $this->className      = ucfirst($modulename).ucfirst($itemname);
         $this->identifierName = $idenfierName;
         $this->summaryName    = $summaryName;
-        $this->_page          = $itemname . '.php';
-        $this->_modulePath    = XOOPS_ROOT_PATH . '/modules/' . $this->_moduleName . '/';
-        $this->_moduleUrl     = XOOPS_URL . '/modules/' . $this->_moduleName . '/';
-        $this->_uploadPath    = XOOPS_UPLOAD_PATH . '/' . $this->_moduleName . '/';
-        $this->_uploadUrl     = XOOPS_UPLOAD_URL . '/' . $this->_moduleName . '/';
+        $this->_page          = $itemname.'.php';
+        $this->_modulePath    = XOOPS_ROOT_PATH.'/modules/'.$this->_moduleName.'/';
+        $this->_moduleUrl     = XOOPS_URL.'/modules/'.$this->_moduleName.'/';
+        $this->_uploadPath    = XOOPS_UPLOAD_PATH.'/'.$this->_moduleName.'/';
+        $this->_uploadUrl     = XOOPS_UPLOAD_URL.'/'.$this->_moduleName.'/';
     }
 
     /**
@@ -182,7 +182,7 @@ 
      */
     public function addPermission($perm_name, $caption, $description = false)
     {
-        require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectpermission.php';
+        require_once SMARTOBJECT_ROOT_PATH.'class/smartobjectpermission.php';
 
         $this->permissionsArray[] = [
             'perm_name'   => $perm_name,
@@ -201,7 +201,7 @@ 
         $smartPermissionsHandler = new SmartobjectPermissionHandler($this);
         $grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
         if (count($grantedItems) > 0) {
-            $criteria->add(new \Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
+            $criteria->add(new \Criteria($this->keyName, '('.implode(', ', $grantedItems).')', 'IN'));
 
             return true;
         } else {
@@ -257,7 +257,7 @@ 
      */
     public function getImageUrl()
     {
-        return $this->_uploadUrl . $this->_itemname . '/';
+        return $this->_uploadUrl.$this->_itemname.'/';
     }
 
     /**
@@ -265,12 +265,12 @@ 
      */
     public function getImagePath()
     {
-        $dir = $this->_uploadPath . $this->_itemname;
+        $dir = $this->_uploadPath.$this->_itemname;
         if (!file_exists($dir)) {
             smart_admin_mkdir($dir);
         }
 
-        return $dir . '/';
+        return $dir.'/';
     }
 
     /**
@@ -309,7 +309,7 @@ 
         if ($debug) {
             $obj_array = $this->getObjectsD($criteria, false, $as_object);
         } else {
-            $obj_array =& $this->getObjects($criteria, false, $as_object);
+            $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];
@@ -363,13 +363,13 @@ 
         if ($this->generalSQL) {
             $sql = $this->generalSQL;
         } elseif (!$sql) {
-            $sql = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT * FROM '.$this->table.' AS '.$this->_itemname;
         }
 
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ('' !== $criteria->getSort()) {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -398,12 +398,12 @@ 
         $ret = [];
 
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby) {
                 $sql .= $criteria->getGroupby();
             }
             if ('' !== $criteria->getSort()) {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
         }
         if ($debug) {
@@ -476,18 +476,18 @@ 
             $obj->assignVars($myrow);
             if (!$id_as_key) {
                 if ($as_object) {
-                    $ret[] =& $obj;
+                    $ret[] = & $obj;
                 } else {
                     $ret[] = $obj->toArray();
                 }
             } else {
                 if ($as_object) {
-                    $value =& $obj;
+                    $value = & $obj;
                 } else {
                     $value = $obj->toArray();
                 }
                 if ('parentid' === $id_as_key) {
-                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] =& $value;
+                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] = & $value;
                 } else {
                     $ret[$obj->getVar($this->keyName)] = $value;
                 }
@@ -530,15 +530,15 @@ 
             $criteria->setSort($this->getIdentifierName());
         }
 
-        $sql = 'SELECT ' . (is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
+        $sql = 'SELECT '.(is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
         if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->getIdentifierName();
+            $sql .= ', '.$this->getIdentifierName();
         }
-        $sql .= ' FROM ' . $this->table . ' AS ' . $this->_itemname;
+        $sql .= ' FROM '.$this->table.' AS '.$this->_itemname;
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ('' !== $criteria->getSort()) {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -575,7 +575,7 @@ 
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
             if ('' !== $criteria->groupby) {
                 $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+                $field   = $criteria->groupby.', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
             }
         }
         /**
@@ -586,10 +586,10 @@ 
             $sql = $this->generalSQL;
             $sql = str_replace('SELECT *', 'SELECT COUNT(*)', $sql);
         } else {
-            $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table.' AS '.$this->_itemname;
         }
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ('' !== $criteria->groupby) {
                 $sql .= $criteria->getGroupby();
             }
@@ -632,13 +632,13 @@ 
         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]);
+                $clause[] = $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
             }
             $whereclause = implode(' AND ', $clause);
         } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+            $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
         }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+        $sql = 'DELETE FROM '.$this->table.' WHERE '.$whereclause;
         if (false !== $force) {
             $result = $this->db->queryF($sql);
         } else {
@@ -699,7 +699,7 @@ 
              * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
              */
             if (!is_a($obj, $this->className)) {
-                $obj->setError(get_class($obj) . ' Differs from ' . $this->className);
+                $obj->setError(get_class($obj).' Differs from '.$this->className);
 
                 return false;
             }
@@ -760,7 +760,7 @@ 
         $fieldsToStoreInDB = [];
         foreach ($obj->cleanVars as $k => $v) {
             if (XOBJ_DTYPE_INT == $obj->vars[$k]['data_type']) {
-                $cleanvars[$k] = (int)$v;
+                $cleanvars[$k] = (int) $v;
             } elseif (is_array($v)) {
                 $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
             } else {
@@ -773,13 +773,13 @@ 
         if ($obj->isNew()) {
             if (!is_array($this->keyName)) {
                 if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+                    $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq');
                 }
             }
 
-            $sql = 'INSERT INTO ' . $this->table . ' (' . implode(',', array_keys($fieldsToStoreInDB)) . ') VALUES (' . implode(',', array_values($fieldsToStoreInDB)) . ')';
+            $sql = 'INSERT INTO '.$this->table.' ('.implode(',', array_keys($fieldsToStoreInDB)).') VALUES ('.implode(',', array_values($fieldsToStoreInDB)).')';
         } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
+            $sql = 'UPDATE '.$this->table.' SET';
             foreach ($fieldsToStoreInDB as $key => $value) {
                 if ((!is_array($this->keyName) && $key == $this->keyName)
                     || (is_array($this->keyName)
@@ -789,7 +789,7 @@ 
                 if (isset($notfirst)) {
                     $sql .= ',';
                 }
-                $sql      .= ' ' . $key . ' = ' . $value;
+                $sql .= ' '.$key.' = '.$value;
                 $notfirst = true;
             }
             if (is_array($this->keyName)) {
@@ -798,12 +798,12 @@ 
                     if ($i > 0) {
                         $whereclause .= ' AND ';
                     }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                    $whereclause .= $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
                 }
             } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+                $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
             }
-            $sql .= ' WHERE ' . $whereclause;
+            $sql .= ' WHERE '.$whereclause;
         }
 
         if ($debug) {
@@ -876,7 +876,7 @@ 
      */
     public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = null, $force = false)
     {
-        $set_clause = $fieldname . ' = ';
+        $set_clause = $fieldname.' = ';
         if (is_numeric($fieldvalue)) {
             $set_clause .= $fieldvalue;
         } elseif (is_array($fieldvalue)) {
@@ -884,9 +884,9 @@ 
         } else {
             $set_clause .= $this->db->quoteString($fieldvalue);
         }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+        $sql = 'UPDATE '.$this->table.' SET '.$set_clause;
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
         }
         if (false != $force) {
             $result = $this->db->queryF($sql);
@@ -910,8 +910,8 @@ 
     public function deleteAll(CriteriaElement $criteria = null)
     {
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql = 'DELETE FROM '.$this->table;
+            $sql .= ' '.$criteria->renderWhere();
             if (!$this->db->query($sql)) {
                 return false;
             }
@@ -944,7 +944,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->_moduleName . '_' . $this->_itemname;
+        $ret = $this->_moduleName.'_'.$this->_itemname;
 
         return $ret;
     }
@@ -956,7 +956,7 @@ 
     {
         if (isset($object->vars['counter'])) {
             $new_counter = $object->getVar('counter') + 1;
-            $sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
+            $sql         = 'UPDATE '.$this->table.' SET counter='.$new_counter.' WHERE '.$this->keyName.'='.$object->id();
             $this->query($sql, null, true);
         }
     }
@@ -1000,7 +1000,7 @@ 
     public function getIdentifierName($withprefix = true)
     {
         if ($withprefix) {
-            return $this->_itemname . '.' . $this->identifierName;
+            return $this->_itemname.'.'.$this->identifierName;
         } else {
             return $this->identifierName;
         }