mambax7 / smartobject

class/smartdbupdater.php

Indentation +817 added lines, -817 removed lines

@@ -18,7 +18,7 @@ 
  */
 // defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 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
@@ -26,7 +26,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;
 
@@ -35,503 +35,503 @@ 
  */
 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 = array();
-    }
-
-    /**
-     * 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 ($existing_field = $xoopsDB->fetchArray($result)) {
-            $fields[$existing_field['Field']] = $existing_field['Type'];
-            if ($existing_field['Null'] !== 'YES') {
-                $fields[$existing_field['Field']] .= ' NOT NULL';
-            }
-            if ($existing_field['Extra']) {
-                $fields[$existing_field['Field']] .= ' ' . $existing_field['Extra'];
-            }
-            if (!($existing_field['Default'] === null)
-                && ($existing_field['Default']
-                    || $existing_field['Default'] === ''
-                    || $existing_field['Default'] == 0)) {
-                $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 = array();
+	}
+
+	/**
+	 * 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 ($existing_field = $xoopsDB->fetchArray($result)) {
+			$fields[$existing_field['Field']] = $existing_field['Type'];
+			if ($existing_field['Null'] !== 'YES') {
+				$fields[$existing_field['Field']] .= ' NOT NULL';
+			}
+			if ($existing_field['Extra']) {
+				$fields[$existing_field['Field']] .= ' ' . $existing_field['Extra'];
+			}
+			if (!($existing_field['Default'] === null)
+				&& ($existing_field['Default']
+					|| $existing_field['Default'] === ''
+					|| $existing_field['Default'] == 0)) {
+				$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;
+	}
 }
 
 /**
@@ -545,328 +545,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'], array(
-                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'], array(
+				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;
+	}
 }

class/smartobjecthandler.php

Indentation +976 added lines, -976 removed lines

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

class/smartobjectabout.php

Indentation +161 added lines, -161 removed lines

@@ -19,165 +19,165 @@
  */
 class SmartobjectAbout
 {
-    public $_lang_aboutTitle;
-    public $_lang_author_info;
-    public $_lang_developer_lead;
-    public $_lang_developer_contributor;
-    public $_lang_developer_website;
-    public $_lang_developer_email;
-    public $_lang_developer_credits;
-    public $_lang_module_info;
-    public $_lang_module_status;
-    public $_lang_module_release_date;
-    public $_lang_module_demo;
-    public $_lang_module_support;
-    public $_lang_module_bug;
-    public $_lang_module_submit_bug;
-    public $_lang_module_feature;
-    public $_lang_module_submit_feature;
-    public $_lang_module_disclaimer;
-    public $_lang_author_word;
-    public $_lang_version_history;
-    public $_lang_by;
-    public $_tpl;
-
-    /**
-     * SmartobjectAbout constructor.
-     * @param string $aboutTitle
-     */
-    public function __construct($aboutTitle = 'About')
-    {
-        global $xoopsModule, $xoopsConfig;
-
-        $fileName = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php';
-        if (file_exists($fileName)) {
-            require_once $fileName;
-        } else {
-            require_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/modinfo.php';
-        }
-        $this->_aboutTitle = $aboutTitle;
-
-        $this->_lang_developer_contributor = _CO_SOBJECT_DEVELOPER_CONTRIBUTOR;
-        $this->_lang_developer_website     = _CO_SOBJECT_DEVELOPER_WEBSITE;
-        $this->_lang_developer_email       = _CO_SOBJECT_DEVELOPER_EMAIL;
-        $this->_lang_developer_credits     = _CO_SOBJECT_DEVELOPER_CREDITS;
-        $this->_lang_module_info           = _CO_SOBJECT_MODULE_INFO;
-        $this->_lang_module_status         = _CO_SOBJECT_MODULE_STATUS;
-        $this->_lang_module_release_date   = _CO_SOBJECT_MODULE_RELEASE_DATE;
-        $this->_lang_module_demo           = _CO_SOBJECT_MODULE_DEMO;
-        $this->_lang_module_support        = _CO_SOBJECT_MODULE_SUPPORT;
-        $this->_lang_module_bug            = _CO_SOBJECT_MODULE_BUG;
-        $this->_lang_module_submit_bug     = _CO_SOBJECT_MODULE_SUBMIT_BUG;
-        $this->_lang_module_feature        = _CO_SOBJECT_MODULE_FEATURE;
-        $this->_lang_module_submit_feature = _CO_SOBJECT_MODULE_SUBMIT_FEATURE;
-        $this->_lang_module_disclaimer     = _CO_SOBJECT_MODULE_DISCLAIMER;
-        $this->_lang_author_word           = _CO_SOBJECT_AUTHOR_WORD;
-        $this->_lang_version_history       = _CO_SOBJECT_VERSION_HISTORY;
-    }
-
-    /**
-     * @param $value
-     * @return mixed
-     */
-    public function sanitize($value)
-    {
-        $myts = MyTextSanitizer::getInstance();
-
-        return $myts->displayTarea($value, 1);
-    }
-
-    public function render()
-    {
-        /**
-         * @todo move the output to a template
-         * @todo make the output XHTML compliant
-         */
-
-        $myts = MyTextSanitizer::getInstance();
-
-        global $xoopsModule;
-
-        smart_xoops_cp_header();
-
-        /** @var XoopsModuleHandler $moduleHandler */
-        $moduleHandler = xoops_getHandler('module');
-        $versioninfo   = $moduleHandler->get($xoopsModule->getVar('mid'));
-
-        //smart_adminMenu(-1, $this->_aboutTitle . " " . $versioninfo->getInfo('name'));
-
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
-
-        // ---
-        // 2012-01-01 PHP 5.3: Assigning the return value of new by reference is now deprecated.
-        //      $this->_tpl = new XoopsTpl();
-        $this->_tpl = new XoopsTpl();
-        // ---
-
-        $this->_tpl->assign('module_url', XOOPS_URL . '/modules/' . $xoopsModule->getVar('dirname') . '/');
-        $this->_tpl->assign('module_image', $versioninfo->getInfo('image'));
-        $this->_tpl->assign('module_name', $versioninfo->getInfo('name'));
-        $this->_tpl->assign('module_version', $versioninfo->getInfo('version'));
-        $this->_tpl->assign('module_status_version', $versioninfo->getInfo('status_version'));
-
-        // Left headings...
-        if ($versioninfo->getInfo('author_realname') !== '') {
-            $author_name = $versioninfo->getInfo('author') . ' (' . $versioninfo->getInfo('author_realname') . ')';
-        } else {
-            $author_name = $versioninfo->getInfo('author');
-        }
-        $this->_tpl->assign('module_author_name', $author_name);
-
-        $this->_tpl->assign('module_license', $versioninfo->getInfo('license'));
-
-        $this->_tpl->assign('module_credits', $versioninfo->getInfo('credits'));
-
-        // Developers Information
-        $this->_tpl->assign('module_developer_lead', $versioninfo->getInfo('developer_lead'));
-        $this->_tpl->assign('module_developer_contributor', $versioninfo->getInfo('developer_contributor'));
-        $this->_tpl->assign('module_developer_website_url', $versioninfo->getInfo('developer_website_url'));
-        $this->_tpl->assign('module_developer_website_name', $versioninfo->getInfo('developer_website_name'));
-        $this->_tpl->assign('module_developer_email', $versioninfo->getInfo('developer_email'));
-
-        $people = $versioninfo->getInfo('people');
-        if ($people) {
-            $this->_tpl->assign('module_people_developers', isset($people['developers']) ? array_map(array($this, 'sanitize'), $people['developers']) : false);
-            $this->_tpl->assign('module_people_testers', isset($people['testers']) ? array_map(array($this, 'sanitize'), $people['testers']) : false);
-            $this->_tpl->assign('module_people_translators', isset($people['translators']) ? array_map(array($this, 'sanitize'), $people['translators']) : false);
-            $this->_tpl->assign('module_people_documenters', isset($people['documenters']) ? array_map(array($this, 'sanitize'), $people['documenters']) : false);
-            $this->_tpl->assign('module_people_other', isset($people['other']) ? array_map(array($this, 'sanitize'), $people['other']) : false);
-        }
-        //$this->_tpl->assign('module_developers', $versioninfo->getInfo('developer_email'));
-
-        // Module Development information
-        $this->_tpl->assign('module_date', $versioninfo->getInfo('date'));
-        $this->_tpl->assign('module_status', $versioninfo->getInfo('status'));
-        $this->_tpl->assign('module_demo_site_url', $versioninfo->getInfo('demo_site_url'));
-        $this->_tpl->assign('module_demo_site_name', $versioninfo->getInfo('demo_site_name'));
-        $this->_tpl->assign('module_support_site_url', $versioninfo->getInfo('support_site_url'));
-        $this->_tpl->assign('module_support_site_name', $versioninfo->getInfo('support_site_name'));
-        $this->_tpl->assign('module_submit_bug', $versioninfo->getInfo('submit_bug'));
-        $this->_tpl->assign('module_submit_feature', $versioninfo->getInfo('submit_feature'));
-
-        // Warning
-        $this->_tpl->assign('module_warning', $this->sanitize($versioninfo->getInfo('warning')));
-
-        // Author's note
-        $this->_tpl->assign('module_author_word', $versioninfo->getInfo('author_word'));
-
-        // For changelog thanks to 3Dev
-        global $xoopsModule;
-        $filename = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/changelog.txt';
-        if (is_file($filename)) {
-            $filesize = filesize($filename);
-            $handle   = fopen($filename, 'r');
-            $this->_tpl->assign('module_version_history', $myts->displayTarea(fread($handle, $filesize), true));
-            fclose($handle);
-        }
-
-        $this->_tpl->display('db:smartobject_about.tpl');
-
-        smart_modFooter();
-
-        xoops_cp_footer();
-    }
+	public $_lang_aboutTitle;
+	public $_lang_author_info;
+	public $_lang_developer_lead;
+	public $_lang_developer_contributor;
+	public $_lang_developer_website;
+	public $_lang_developer_email;
+	public $_lang_developer_credits;
+	public $_lang_module_info;
+	public $_lang_module_status;
+	public $_lang_module_release_date;
+	public $_lang_module_demo;
+	public $_lang_module_support;
+	public $_lang_module_bug;
+	public $_lang_module_submit_bug;
+	public $_lang_module_feature;
+	public $_lang_module_submit_feature;
+	public $_lang_module_disclaimer;
+	public $_lang_author_word;
+	public $_lang_version_history;
+	public $_lang_by;
+	public $_tpl;
+
+	/**
+	 * SmartobjectAbout constructor.
+	 * @param string $aboutTitle
+	 */
+	public function __construct($aboutTitle = 'About')
+	{
+		global $xoopsModule, $xoopsConfig;
+
+		$fileName = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php';
+		if (file_exists($fileName)) {
+			require_once $fileName;
+		} else {
+			require_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/modinfo.php';
+		}
+		$this->_aboutTitle = $aboutTitle;
+
+		$this->_lang_developer_contributor = _CO_SOBJECT_DEVELOPER_CONTRIBUTOR;
+		$this->_lang_developer_website     = _CO_SOBJECT_DEVELOPER_WEBSITE;
+		$this->_lang_developer_email       = _CO_SOBJECT_DEVELOPER_EMAIL;
+		$this->_lang_developer_credits     = _CO_SOBJECT_DEVELOPER_CREDITS;
+		$this->_lang_module_info           = _CO_SOBJECT_MODULE_INFO;
+		$this->_lang_module_status         = _CO_SOBJECT_MODULE_STATUS;
+		$this->_lang_module_release_date   = _CO_SOBJECT_MODULE_RELEASE_DATE;
+		$this->_lang_module_demo           = _CO_SOBJECT_MODULE_DEMO;
+		$this->_lang_module_support        = _CO_SOBJECT_MODULE_SUPPORT;
+		$this->_lang_module_bug            = _CO_SOBJECT_MODULE_BUG;
+		$this->_lang_module_submit_bug     = _CO_SOBJECT_MODULE_SUBMIT_BUG;
+		$this->_lang_module_feature        = _CO_SOBJECT_MODULE_FEATURE;
+		$this->_lang_module_submit_feature = _CO_SOBJECT_MODULE_SUBMIT_FEATURE;
+		$this->_lang_module_disclaimer     = _CO_SOBJECT_MODULE_DISCLAIMER;
+		$this->_lang_author_word           = _CO_SOBJECT_AUTHOR_WORD;
+		$this->_lang_version_history       = _CO_SOBJECT_VERSION_HISTORY;
+	}
+
+	/**
+	 * @param $value
+	 * @return mixed
+	 */
+	public function sanitize($value)
+	{
+		$myts = MyTextSanitizer::getInstance();
+
+		return $myts->displayTarea($value, 1);
+	}
+
+	public function render()
+	{
+		/**
+		 * @todo move the output to a template
+		 * @todo make the output XHTML compliant
+		 */
+
+		$myts = MyTextSanitizer::getInstance();
+
+		global $xoopsModule;
+
+		smart_xoops_cp_header();
+
+		/** @var XoopsModuleHandler $moduleHandler */
+		$moduleHandler = xoops_getHandler('module');
+		$versioninfo   = $moduleHandler->get($xoopsModule->getVar('mid'));
+
+		//smart_adminMenu(-1, $this->_aboutTitle . " " . $versioninfo->getInfo('name'));
+
+		require_once XOOPS_ROOT_PATH . '/class/template.php';
+
+		// ---
+		// 2012-01-01 PHP 5.3: Assigning the return value of new by reference is now deprecated.
+		//      $this->_tpl = new XoopsTpl();
+		$this->_tpl = new XoopsTpl();
+		// ---
+
+		$this->_tpl->assign('module_url', XOOPS_URL . '/modules/' . $xoopsModule->getVar('dirname') . '/');
+		$this->_tpl->assign('module_image', $versioninfo->getInfo('image'));
+		$this->_tpl->assign('module_name', $versioninfo->getInfo('name'));
+		$this->_tpl->assign('module_version', $versioninfo->getInfo('version'));
+		$this->_tpl->assign('module_status_version', $versioninfo->getInfo('status_version'));
+
+		// Left headings...
+		if ($versioninfo->getInfo('author_realname') !== '') {
+			$author_name = $versioninfo->getInfo('author') . ' (' . $versioninfo->getInfo('author_realname') . ')';
+		} else {
+			$author_name = $versioninfo->getInfo('author');
+		}
+		$this->_tpl->assign('module_author_name', $author_name);
+
+		$this->_tpl->assign('module_license', $versioninfo->getInfo('license'));
+
+		$this->_tpl->assign('module_credits', $versioninfo->getInfo('credits'));
+
+		// Developers Information
+		$this->_tpl->assign('module_developer_lead', $versioninfo->getInfo('developer_lead'));
+		$this->_tpl->assign('module_developer_contributor', $versioninfo->getInfo('developer_contributor'));
+		$this->_tpl->assign('module_developer_website_url', $versioninfo->getInfo('developer_website_url'));
+		$this->_tpl->assign('module_developer_website_name', $versioninfo->getInfo('developer_website_name'));
+		$this->_tpl->assign('module_developer_email', $versioninfo->getInfo('developer_email'));
+
+		$people = $versioninfo->getInfo('people');
+		if ($people) {
+			$this->_tpl->assign('module_people_developers', isset($people['developers']) ? array_map(array($this, 'sanitize'), $people['developers']) : false);
+			$this->_tpl->assign('module_people_testers', isset($people['testers']) ? array_map(array($this, 'sanitize'), $people['testers']) : false);
+			$this->_tpl->assign('module_people_translators', isset($people['translators']) ? array_map(array($this, 'sanitize'), $people['translators']) : false);
+			$this->_tpl->assign('module_people_documenters', isset($people['documenters']) ? array_map(array($this, 'sanitize'), $people['documenters']) : false);
+			$this->_tpl->assign('module_people_other', isset($people['other']) ? array_map(array($this, 'sanitize'), $people['other']) : false);
+		}
+		//$this->_tpl->assign('module_developers', $versioninfo->getInfo('developer_email'));
+
+		// Module Development information
+		$this->_tpl->assign('module_date', $versioninfo->getInfo('date'));
+		$this->_tpl->assign('module_status', $versioninfo->getInfo('status'));
+		$this->_tpl->assign('module_demo_site_url', $versioninfo->getInfo('demo_site_url'));
+		$this->_tpl->assign('module_demo_site_name', $versioninfo->getInfo('demo_site_name'));
+		$this->_tpl->assign('module_support_site_url', $versioninfo->getInfo('support_site_url'));
+		$this->_tpl->assign('module_support_site_name', $versioninfo->getInfo('support_site_name'));
+		$this->_tpl->assign('module_submit_bug', $versioninfo->getInfo('submit_bug'));
+		$this->_tpl->assign('module_submit_feature', $versioninfo->getInfo('submit_feature'));
+
+		// Warning
+		$this->_tpl->assign('module_warning', $this->sanitize($versioninfo->getInfo('warning')));
+
+		// Author's note
+		$this->_tpl->assign('module_author_word', $versioninfo->getInfo('author_word'));
+
+		// For changelog thanks to 3Dev
+		global $xoopsModule;
+		$filename = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/changelog.txt';
+		if (is_file($filename)) {
+			$filesize = filesize($filename);
+			$handle   = fopen($filename, 'r');
+			$this->_tpl->assign('module_version_history', $myts->displayTarea(fread($handle, $filesize), true));
+			fclose($handle);
+		}
+
+		$this->_tpl->display('db:smartobject_about.tpl');
+
+		smart_modFooter();
+
+		xoops_cp_footer();
+	}
 }

class/smartobjecttag.php

Indentation +33 added lines, -33 removed lines

@@ -35,19 +35,19 @@ 
  */
 class SmartobjectTag extends SmartMlObject
 {
-    /**
-     * SmartobjectTag constructor.
-     */
-    public function __construct()
-    {
-        $this->initVar('tagid', XOBJ_DTYPE_INT, '', true);
-        $this->initVar('name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_TAG_TAGID_CAPTION, _CO_SOBJECT_TAG_TAGID_DSC, true);
-        $this->initVar('description', XOBJ_DTYPE_TXTAREA, '', true, null, '', false, _CO_SOBJECT_TAG_DESCRIPTION_CAPTION, _CO_SOBJECT_TAG_DESCRIPTION_DSC);
-        $this->initVar('value', XOBJ_DTYPE_TXTAREA, '', true, null, '', true, _CO_SOBJECT_TAG_VALUE_CAPTION, _CO_SOBJECT_TAG_VALUE_DSC);
+	/**
+	 * SmartobjectTag constructor.
+	 */
+	public function __construct()
+	{
+		$this->initVar('tagid', XOBJ_DTYPE_INT, '', true);
+		$this->initVar('name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_TAG_TAGID_CAPTION, _CO_SOBJECT_TAG_TAGID_DSC, true);
+		$this->initVar('description', XOBJ_DTYPE_TXTAREA, '', true, null, '', false, _CO_SOBJECT_TAG_DESCRIPTION_CAPTION, _CO_SOBJECT_TAG_DESCRIPTION_DSC);
+		$this->initVar('value', XOBJ_DTYPE_TXTAREA, '', true, null, '', true, _CO_SOBJECT_TAG_VALUE_CAPTION, _CO_SOBJECT_TAG_VALUE_DSC);
 
-        // call parent constructor to get Multilanguage field initiated
-        $this->SmartMlObject();
-    }
+		// call parent constructor to get Multilanguage field initiated
+		$this->SmartMlObject();
+	}
 }
 
 /**
@@ -55,27 +55,27 @@ 
  */
 class SmartobjectTagHandler extends SmartPersistableMlObjectHandler
 {
-    /**
-     * SmartobjectTagHandler constructor.
-     * @param XoopsDatabase $db
-     */
-    public function __construct(XoopsDatabase $db)
-    {
-        parent::__construct($db, 'tag', 'tagid', 'name', 'description', 'smartobject');
-    }
+	/**
+	 * SmartobjectTagHandler constructor.
+	 * @param XoopsDatabase $db
+	 */
+	public function __construct(XoopsDatabase $db)
+	{
+		parent::__construct($db, 'tag', 'tagid', 'name', 'description', 'smartobject');
+	}
 
-    /**
-     * @return mixed
-     */
-    public function getLanguages()
-    {
-        require_once XOOPS_ROOT_PATH . '/class/xoopslists.php';
-        $aLanguages     = XoopsLists::getLangList();
-        $ret['default'] = _CO_SOBJECT_ALL;
-        foreach ($aLanguages as $lang) {
-            $ret[$lang] = $lang;
-        }
+	/**
+	 * @return mixed
+	 */
+	public function getLanguages()
+	{
+		require_once XOOPS_ROOT_PATH . '/class/xoopslists.php';
+		$aLanguages     = XoopsLists::getLangList();
+		$ret['default'] = _CO_SOBJECT_ALL;
+		foreach ($aLanguages as $lang) {
+			$ret[$lang] = $lang;
+		}
 
-        return $ret;
-    }
+		return $ret;
+	}
 }

class/smartplugins.php

Indentation +115 added lines, -115 removed lines

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

class/smartaddto.php

Indentation +51 added lines, -51 removed lines

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

class/utility.php

Indentation +138 added lines, -138 removed lines

@@ -5,149 +5,149 @@
  */
 class SmartObjectUtility extends XoopsObject
 {
-    /**
-     * Function responsible for checking if a directory exists, we can also write in and create an index.html file
-     *
-     * @param string $folder The full path of the directory to check
-     *
-     * @return void
-     */
-    public static function createFolder($folder)
-    {
-        //        try {
-        //            if (!mkdir($folder) && !is_dir($folder)) {
-        //                throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
-        //            } else {
-        //                file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
-        //            }
-        //        }
-        //        catch (Exception $e) {
-        //            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
-        //        }
-        try {
-            if (!file_exists($folder)) {
-                if (!mkdir($folder) && !is_dir($folder)) {
-                    throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
-                } else {
-                    file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
-                }
-            }
-        } catch (Exception $e) {
-            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
-        }
-    }
+	/**
+	 * Function responsible for checking if a directory exists, we can also write in and create an index.html file
+	 *
+	 * @param string $folder The full path of the directory to check
+	 *
+	 * @return void
+	 */
+	public static function createFolder($folder)
+	{
+		//        try {
+		//            if (!mkdir($folder) && !is_dir($folder)) {
+		//                throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
+		//            } else {
+		//                file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
+		//            }
+		//        }
+		//        catch (Exception $e) {
+		//            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
+		//        }
+		try {
+			if (!file_exists($folder)) {
+				if (!mkdir($folder) && !is_dir($folder)) {
+					throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
+				} else {
+					file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
+				}
+			}
+		} catch (Exception $e) {
+			echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
+		}
+	}
 
-    /**
-     * @param $file
-     * @param $folder
-     * @return bool
-     */
-    public static function copyFile($file, $folder)
-    {
-        return copy($file, $folder);
-        //        try {
-        //            if (!is_dir($folder)) {
-        //                throw new \RuntimeException(sprintf('Unable to copy file as: %s ', $folder));
-        //            } else {
-        //                return copy($file, $folder);
-        //            }
-        //        } catch (Exception $e) {
-        //            echo 'Caught exception: ', $e->getMessage(), "\n", "<br>";
-        //        }
-        //        return false;
-    }
+	/**
+	 * @param $file
+	 * @param $folder
+	 * @return bool
+	 */
+	public static function copyFile($file, $folder)
+	{
+		return copy($file, $folder);
+		//        try {
+		//            if (!is_dir($folder)) {
+		//                throw new \RuntimeException(sprintf('Unable to copy file as: %s ', $folder));
+		//            } else {
+		//                return copy($file, $folder);
+		//            }
+		//        } catch (Exception $e) {
+		//            echo 'Caught exception: ', $e->getMessage(), "\n", "<br>";
+		//        }
+		//        return false;
+	}
 
-    /**
-     * @param $src
-     * @param $dst
-     */
-    public static function recurseCopy($src, $dst)
-    {
-        $dir = opendir($src);
-        //    @mkdir($dst);
-        while (false !== ($file = readdir($dir))) {
-            if (($file !== '.') && ($file !== '..')) {
-                if (is_dir($src . '/' . $file)) {
-                    self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
-                } else {
-                    copy($src . '/' . $file, $dst . '/' . $file);
-                }
-            }
-        }
-        closedir($dir);
-    }
+	/**
+	 * @param $src
+	 * @param $dst
+	 */
+	public static function recurseCopy($src, $dst)
+	{
+		$dir = opendir($src);
+		//    @mkdir($dst);
+		while (false !== ($file = readdir($dir))) {
+			if (($file !== '.') && ($file !== '..')) {
+				if (is_dir($src . '/' . $file)) {
+					self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
+				} else {
+					copy($src . '/' . $file, $dst . '/' . $file);
+				}
+			}
+		}
+		closedir($dir);
+	}
 
-    /**
-     *
-     * Verifies XOOPS version meets minimum requirements for this module
-     * @static
-     * @param XoopsModule $module
-     *
-     * @param null|string $requiredVer
-     * @return bool true if meets requirements, false if not
-     */
-    public static function checkVerXoops(XoopsModule $module = null, $requiredVer = null)
-    {
-        $moduleDirName = basename(dirname(__DIR__));
-        if (null === $module) {
-            $module = XoopsModule::getByDirname($moduleDirName);
-        }
-        xoops_loadLanguage('admin', $moduleDirName);
-        //check for minimum XOOPS version
-        $currentVer = substr(XOOPS_VERSION, 6); // get the numeric part of string
-        $currArray  = explode('.', $currentVer);
-        if (null === $requiredVer) {
-            $requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
-        }
-        $reqArray = explode('.', $requiredVer);
-        $success  = true;
-        foreach ($reqArray as $k => $v) {
-            if (isset($currArray[$k])) {
-                if ($currArray[$k] > $v) {
-                    break;
-                } elseif ($currArray[$k] == $v) {
-                    continue;
-                } else {
-                    $success = false;
-                    break;
-                }
-            } else {
-                if ((int)$v > 0) { // handles versions like x.x.x.0_RC2
-                    $success = false;
-                    break;
-                }
-            }
-        }
+	/**
+	 *
+	 * Verifies XOOPS version meets minimum requirements for this module
+	 * @static
+	 * @param XoopsModule $module
+	 *
+	 * @param null|string $requiredVer
+	 * @return bool true if meets requirements, false if not
+	 */
+	public static function checkVerXoops(XoopsModule $module = null, $requiredVer = null)
+	{
+		$moduleDirName = basename(dirname(__DIR__));
+		if (null === $module) {
+			$module = XoopsModule::getByDirname($moduleDirName);
+		}
+		xoops_loadLanguage('admin', $moduleDirName);
+		//check for minimum XOOPS version
+		$currentVer = substr(XOOPS_VERSION, 6); // get the numeric part of string
+		$currArray  = explode('.', $currentVer);
+		if (null === $requiredVer) {
+			$requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
+		}
+		$reqArray = explode('.', $requiredVer);
+		$success  = true;
+		foreach ($reqArray as $k => $v) {
+			if (isset($currArray[$k])) {
+				if ($currArray[$k] > $v) {
+					break;
+				} elseif ($currArray[$k] == $v) {
+					continue;
+				} else {
+					$success = false;
+					break;
+				}
+			} else {
+				if ((int)$v > 0) { // handles versions like x.x.x.0_RC2
+					$success = false;
+					break;
+				}
+			}
+		}
 
-        if (!$success) {
-            $module->setErrors(sprintf(_AM_XXXXX_ERROR_BAD_XOOPS, $requiredVer, $currentVer));
-        }
+		if (!$success) {
+			$module->setErrors(sprintf(_AM_XXXXX_ERROR_BAD_XOOPS, $requiredVer, $currentVer));
+		}
 
-        return $success;
-    }
+		return $success;
+	}
 
-    /**
-     *
-     * Verifies PHP version meets minimum requirements for this module
-     * @static
-     * @param XoopsModule $module
-     *
-     * @return bool true if meets requirements, false if not
-     */
-    public static function checkVerPhp(XoopsModule $module)
-    {
-        xoops_loadLanguage('admin', $module->dirname());
-        // check for minimum PHP version
-        $success = true;
-        $verNum  = PHP_VERSION;
-        $reqVer  = $module->getInfo('min_php');
-        if (false !== $reqVer && '' !== $reqVer) {
-            if (version_compare($verNum, $reqVer, '<')) {
-                $module->setErrors(sprintf(_AM_XXXXX_ERROR_BAD_PHP, $reqVer, $verNum));
-                $success = false;
-            }
-        }
+	/**
+	 *
+	 * Verifies PHP version meets minimum requirements for this module
+	 * @static
+	 * @param XoopsModule $module
+	 *
+	 * @return bool true if meets requirements, false if not
+	 */
+	public static function checkVerPhp(XoopsModule $module)
+	{
+		xoops_loadLanguage('admin', $module->dirname());
+		// check for minimum PHP version
+		$success = true;
+		$verNum  = PHP_VERSION;
+		$reqVer  = $module->getInfo('min_php');
+		if (false !== $reqVer && '' !== $reqVer) {
+			if (version_compare($verNum, $reqVer, '<')) {
+				$module->setErrors(sprintf(_AM_XXXXX_ERROR_BAD_PHP, $reqVer, $verNum));
+				$success = false;
+			}
+		}
 
-        return $success;
-    }
+		return $success;
+	}
 }

class/smartobjectpermission.php

Indentation +199 added lines, -199 removed lines

@@ -12,18 +12,18 @@ 
 
 class SmartobjectPermissionHandler extends XoopsObjectHandler
 {
-    public $handler;
-
-    /**
-     * SmartobjectPermissionHandler constructor.
-     * @param XoopsDatabase $handler
-     */
-    public function __construct($handler)
-    {
-        $this->handler = $handler;
-    }
-
-    /*
+	public $handler;
+
+	/**
+	 * SmartobjectPermissionHandler constructor.
+	 * @param XoopsDatabase $handler
+	 */
+	public function __construct($handler)
+	{
+		$this->handler = $handler;
+	}
+
+	/*
      * Returns permissions for a certain type
      *
      * @param string $type "global", "forum" or "topic" (should perhaps have "post" as well - but I don't know)
@@ -31,74 +31,74 @@ 
      *
      * @return array
      */
-    /**
-     * @param        $gperm_name
-     * @param  null  $id
-     * @return array
-     */
-    public function getGrantedGroups($gperm_name, $id = null)
-    {
-        static $groups;
-
-        if (!isset($groups[$gperm_name]) || ($id !== null && !isset($groups[$gperm_name][$id]))) {
-            $smartModule = $this->handler->getModuleInfo();
-            //Get group permissions handler
-            $gpermHandler = xoops_getHandler('groupperm');
-
-            //Get groups allowed for an item id
-            $allowedgroups            = $gpermHandler->getGroupIds($gperm_name, $id, $smartModule->getVar('mid'));
-            $groups[$gperm_name][$id] = $allowedgroups;
-        }
-
-        //Return the permission array
-        return isset($groups[$gperm_name][$id]) ? $groups[$gperm_name][$id] : array();
-    }
-
-    /**
-     * @param        $item_ids_array
-     * @param  bool  $gperm_name
-     * @return array
-     */
-    public function getGrantedGroupsForIds($item_ids_array, $gperm_name = false)
-    {
-        static $groups;
-
-        if ($gperm_name) {
-            if (isset($groups[$gperm_name])) {
-                return $groups[$gperm_name];
-            }
-        } else {
-            // if !$gperm_name then we will fetch all permissions in the module so we don't need them again
-            return $groups;
-        }
-
-        $smartModule = $this->handler->getModuleInfo();
-
-        $criteria = new CriteriaCompo();
-        $criteria->add(new Criteria('gperm_modid', $smartModule->getVar('mid')));
-
-        if ($gperm_name) {
-            $criteria->add(new Criteria('gperm_name', $gperm_name));
-        }
-
-        //Get group permissions handler
-        $gpermHandler = xoops_getHandler('groupperm');
-
-        $permissionsObj = $gpermHandler->getObjects($criteria);
-
-        foreach ($permissionsObj as $permissionObj) {
-            $groups[$permissionObj->getVar('gperm_name')][$permissionObj->getVar('gperm_itemid')][] = $permissionObj->getVar('gperm_groupid');
-        }
-
-        //Return the permission array
-        if ($gperm_name) {
-            return isset($groups[$gperm_name]) ? $groups[$gperm_name] : array();
-        } else {
-            return isset($groups) ? $groups : array();
-        }
-    }
-
-    /*
+	/**
+	 * @param        $gperm_name
+	 * @param  null  $id
+	 * @return array
+	 */
+	public function getGrantedGroups($gperm_name, $id = null)
+	{
+		static $groups;
+
+		if (!isset($groups[$gperm_name]) || ($id !== null && !isset($groups[$gperm_name][$id]))) {
+			$smartModule = $this->handler->getModuleInfo();
+			//Get group permissions handler
+			$gpermHandler = xoops_getHandler('groupperm');
+
+			//Get groups allowed for an item id
+			$allowedgroups            = $gpermHandler->getGroupIds($gperm_name, $id, $smartModule->getVar('mid'));
+			$groups[$gperm_name][$id] = $allowedgroups;
+		}
+
+		//Return the permission array
+		return isset($groups[$gperm_name][$id]) ? $groups[$gperm_name][$id] : array();
+	}
+
+	/**
+	 * @param        $item_ids_array
+	 * @param  bool  $gperm_name
+	 * @return array
+	 */
+	public function getGrantedGroupsForIds($item_ids_array, $gperm_name = false)
+	{
+		static $groups;
+
+		if ($gperm_name) {
+			if (isset($groups[$gperm_name])) {
+				return $groups[$gperm_name];
+			}
+		} else {
+			// if !$gperm_name then we will fetch all permissions in the module so we don't need them again
+			return $groups;
+		}
+
+		$smartModule = $this->handler->getModuleInfo();
+
+		$criteria = new CriteriaCompo();
+		$criteria->add(new Criteria('gperm_modid', $smartModule->getVar('mid')));
+
+		if ($gperm_name) {
+			$criteria->add(new Criteria('gperm_name', $gperm_name));
+		}
+
+		//Get group permissions handler
+		$gpermHandler = xoops_getHandler('groupperm');
+
+		$permissionsObj = $gpermHandler->getObjects($criteria);
+
+		foreach ($permissionsObj as $permissionObj) {
+			$groups[$permissionObj->getVar('gperm_name')][$permissionObj->getVar('gperm_itemid')][] = $permissionObj->getVar('gperm_groupid');
+		}
+
+		//Return the permission array
+		if ($gperm_name) {
+			return isset($groups[$gperm_name]) ? $groups[$gperm_name] : array();
+		} else {
+			return isset($groups) ? $groups : array();
+		}
+	}
+
+	/*
      * Returns permissions for a certain type
      *
      * @param string $type "global", "forum" or "topic" (should perhaps have "post" as well - but I don't know)
@@ -106,123 +106,123 @@ 
      *
      * @return array
      */
-    /**
-     * @param        $gperm_name
-     * @param  null  $id
-     * @return array
-     */
-    public function getGrantedItems($gperm_name, $id = null)
-    {
-        global $xoopsUser;
-        static $permissions;
-
-        if (!isset($permissions[$gperm_name]) || ($id !== null && !isset($permissions[$gperm_name][$id]))) {
-            $smartModule = $this->handler->getModuleInfo();
-
-            if (is_object($smartModule)) {
-
-                //Get group permissions handler
-                $gpermHandler = xoops_getHandler('groupperm');
-
-                //Get user's groups
-                $groups = is_object($xoopsUser) ? $xoopsUser->getGroups() : array(XOOPS_GROUP_ANONYMOUS);
-
-                //Get all allowed item ids in this module and for this user's groups
-                $userpermissions          = $gpermHandler->getItemIds($gperm_name, $groups, $smartModule->getVar('mid'));
-                $permissions[$gperm_name] = $userpermissions;
-            }
-        }
-
-        //Return the permission array
-        return isset($permissions[$gperm_name]) ? $permissions[$gperm_name] : array();
-    }
-
-    /**
-     * @param $id
-     */
-    public function storeAllPermissionsForId($id)
-    {
-        foreach ($this->handler->getPermissions() as $permission) {
-            $this->saveItem_Permissions($_POST[$permission['perm_name']], $id, $permission['perm_name']);
-        }
-    }
-
-    /**
-     * Saves permissions for the selected item
-     *
-     *  saveItem_Permissions()
-     *
-     * @param  array  $groups    : group with granted permission
-     * @param  int    $itemid    categoryID on which we are setting permissions for Categories and Forums
-     * @param  string $perm_name : name of the permission
-     * @return bool   : TRUE if the no errors occured
-     */
-
-    public function saveItem_Permissions($groups, $itemid, $perm_name)
-    {
-        $smartModule = $this->handler->getModuleInfo();
-
-        $result       = true;
-        $module_id    = $smartModule->getVar('mid');
-        $gpermHandler = xoops_getHandler('groupperm');
-
-        // First, if the permissions are already there, delete them
-        $gpermHandler->deleteByModule($module_id, $perm_name, $itemid);
-        //echo "itemid: $itemid - perm: $perm_name - modid: $module_id";
-        //exit;
-        // Save the new permissions
-
-        if (count($groups) > 0) {
-            foreach ($groups as $group_id) {
-                $gpermHandler->addRight($perm_name, $itemid, $group_id, $module_id);
-            }
-        }
-
-        return $result;
-    }
-
-    /**
-     * Delete all permission for a specific item
-     *
-     *  deletePermissions()
-     *
-     * @param  integer $itemid : id of the item for which to delete the permissions
-     * @param          $gperm_name
-     * @return bool:   TRUE if the no errors occured
-     */
-    public function deletePermissions($itemid, $gperm_name)
-    {
-        global $xoopsModule;
-
-        $smartModule =& smartsection_getModuleInfo();
-
-        $result       = true;
-        $module_id    = $smartModule->getVar('mid');
-        $gpermHandler = xoops_getHandler('groupperm');
-
-        $gpermHandler->deleteByModule($module_id, $gperm_name, $itemid);
-
-        return $result;
-    }
-
-    /**
-     * Checks if the user has access to a specific permission on a given object
-     *
-     * @param  string $gperm_name   name of the permission to test
-     * @param  int    $gperm_itemid id of the object to check
-     * @return boolean: TRUE if user has access, FALSE if not
-     **/
-    public function accessGranted($gperm_name, $gperm_itemid)
-    {
-        global $xoopsUser;
-
-        $gperm_groupid = is_object($xoopsUser) ? $xoopsUser->getGroups() : array(XOOPS_GROUP_ANONYMOUS);
-        $smartModule   = $this->handler->getModuleInfo();
-        $gperm_modid   = $smartModule->getVar('mid');
-
-        //Get group permissions handler
-        $gpermHandler = xoops_getHandler('groupperm');
-
-        return $gpermHandler->checkRight($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid);
-    }
+	/**
+	 * @param        $gperm_name
+	 * @param  null  $id
+	 * @return array
+	 */
+	public function getGrantedItems($gperm_name, $id = null)
+	{
+		global $xoopsUser;
+		static $permissions;
+
+		if (!isset($permissions[$gperm_name]) || ($id !== null && !isset($permissions[$gperm_name][$id]))) {
+			$smartModule = $this->handler->getModuleInfo();
+
+			if (is_object($smartModule)) {
+
+				//Get group permissions handler
+				$gpermHandler = xoops_getHandler('groupperm');
+
+				//Get user's groups
+				$groups = is_object($xoopsUser) ? $xoopsUser->getGroups() : array(XOOPS_GROUP_ANONYMOUS);
+
+				//Get all allowed item ids in this module and for this user's groups
+				$userpermissions          = $gpermHandler->getItemIds($gperm_name, $groups, $smartModule->getVar('mid'));
+				$permissions[$gperm_name] = $userpermissions;
+			}
+		}
+
+		//Return the permission array
+		return isset($permissions[$gperm_name]) ? $permissions[$gperm_name] : array();
+	}
+
+	/**
+	 * @param $id
+	 */
+	public function storeAllPermissionsForId($id)
+	{
+		foreach ($this->handler->getPermissions() as $permission) {
+			$this->saveItem_Permissions($_POST[$permission['perm_name']], $id, $permission['perm_name']);
+		}
+	}
+
+	/**
+	 * Saves permissions for the selected item
+	 *
+	 *  saveItem_Permissions()
+	 *
+	 * @param  array  $groups    : group with granted permission
+	 * @param  int    $itemid    categoryID on which we are setting permissions for Categories and Forums
+	 * @param  string $perm_name : name of the permission
+	 * @return bool   : TRUE if the no errors occured
+	 */
+
+	public function saveItem_Permissions($groups, $itemid, $perm_name)
+	{
+		$smartModule = $this->handler->getModuleInfo();
+
+		$result       = true;
+		$module_id    = $smartModule->getVar('mid');
+		$gpermHandler = xoops_getHandler('groupperm');
+
+		// First, if the permissions are already there, delete them
+		$gpermHandler->deleteByModule($module_id, $perm_name, $itemid);
+		//echo "itemid: $itemid - perm: $perm_name - modid: $module_id";
+		//exit;
+		// Save the new permissions
+
+		if (count($groups) > 0) {
+			foreach ($groups as $group_id) {
+				$gpermHandler->addRight($perm_name, $itemid, $group_id, $module_id);
+			}
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Delete all permission for a specific item
+	 *
+	 *  deletePermissions()
+	 *
+	 * @param  integer $itemid : id of the item for which to delete the permissions
+	 * @param          $gperm_name
+	 * @return bool:   TRUE if the no errors occured
+	 */
+	public function deletePermissions($itemid, $gperm_name)
+	{
+		global $xoopsModule;
+
+		$smartModule =& smartsection_getModuleInfo();
+
+		$result       = true;
+		$module_id    = $smartModule->getVar('mid');
+		$gpermHandler = xoops_getHandler('groupperm');
+
+		$gpermHandler->deleteByModule($module_id, $gperm_name, $itemid);
+
+		return $result;
+	}
+
+	/**
+	 * Checks if the user has access to a specific permission on a given object
+	 *
+	 * @param  string $gperm_name   name of the permission to test
+	 * @param  int    $gperm_itemid id of the object to check
+	 * @return boolean: TRUE if user has access, FALSE if not
+	 **/
+	public function accessGranted($gperm_name, $gperm_itemid)
+	{
+		global $xoopsUser;
+
+		$gperm_groupid = is_object($xoopsUser) ? $xoopsUser->getGroups() : array(XOOPS_GROUP_ANONYMOUS);
+		$smartModule   = $this->handler->getModuleInfo();
+		$gperm_modid   = $smartModule->getVar('mid');
+
+		//Get group permissions handler
+		$gpermHandler = xoops_getHandler('groupperm');
+
+		return $gpermHandler->checkRight($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid);
+	}
 }

class/smartprinterfriendly.php

Indentation +51 added lines, -51 removed lines

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