mambax7 / smartobject

class/member.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +200 added lines, -200 removed lines

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

Spacing +9 added lines, -9 removed lines

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

class/smartobject.php

Doc Comments +9 added lines, -9 removed lines

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

Indentation +1404 added lines, -1404 removed lines

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

Spacing +19 added lines, -19 removed lines

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

class/smartobjecthandler.php

Doc Comments +2 added lines, -2 removed lines

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

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;
+		}
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -146,16 +146,16 @@ 
 
         $this->_itemname      = $itemname;
         $this->_moduleName    = $modulename;
-        $this->table          = $db->prefix($modulename . '_' . $itemname);
+        $this->table          = $db->prefix($modulename.'_'.$itemname);
         $this->keyName        = $keyname;
-        $this->className      = ucfirst($modulename) . ucfirst($itemname);
+        $this->className      = ucfirst($modulename).ucfirst($itemname);
         $this->identifierName = $idenfierName;
         $this->summaryName    = $summaryName;
-        $this->_page          = $itemname . '.php';
-        $this->_modulePath    = XOOPS_ROOT_PATH . '/modules/' . $this->_moduleName . '/';
-        $this->_moduleUrl     = XOOPS_URL . '/modules/' . $this->_moduleName . '/';
-        $this->_uploadPath    = XOOPS_UPLOAD_PATH . '/' . $this->_moduleName . '/';
-        $this->_uploadUrl     = XOOPS_UPLOAD_URL . '/' . $this->_moduleName . '/';
+        $this->_page          = $itemname.'.php';
+        $this->_modulePath    = XOOPS_ROOT_PATH.'/modules/'.$this->_moduleName.'/';
+        $this->_moduleUrl     = XOOPS_URL.'/modules/'.$this->_moduleName.'/';
+        $this->_uploadPath    = XOOPS_UPLOAD_PATH.'/'.$this->_moduleName.'/';
+        $this->_uploadUrl     = XOOPS_UPLOAD_URL.'/'.$this->_moduleName.'/';
     }
 
     /**
@@ -178,7 +178,7 @@ 
      */
     public function addPermission($perm_name, $caption, $description = false)
     {
-        require_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectpermission.php';
+        require_once SMARTOBJECT_ROOT_PATH.'class/smartobjectpermission.php';
 
         $this->permissionsArray[] = array(
             'perm_name'   => $perm_name,
@@ -197,7 +197,7 @@ 
         $smartPermissionsHandler = new SmartobjectPermissionHandler($this);
         $grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
         if (count($grantedItems) > 0) {
-            $criteria->add(new Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
+            $criteria->add(new Criteria($this->keyName, '('.implode(', ', $grantedItems).')', 'IN'));
 
             return true;
         } else {
@@ -253,7 +253,7 @@ 
      */
     public function getImageUrl()
     {
-        return $this->_uploadUrl . $this->_itemname . '/';
+        return $this->_uploadUrl.$this->_itemname.'/';
     }
 
     /**
@@ -261,12 +261,12 @@ 
      */
     public function getImagePath()
     {
-        $dir = $this->_uploadPath . $this->_itemname;
+        $dir = $this->_uploadPath.$this->_itemname;
         if (!file_exists($dir)) {
             smart_admin_mkdir($dir);
         }
 
-        return $dir . '/';
+        return $dir.'/';
     }
 
     /**
@@ -359,13 +359,13 @@ 
         if ($this->generalSQL) {
             $sql = $this->generalSQL;
         } elseif (!$sql) {
-            $sql = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT * FROM '.$this->table.' AS '.$this->_itemname;
         }
 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -394,12 +394,12 @@ 
         $ret = array();
 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby) {
                 $sql .= $criteria->getGroupby();
             }
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
         }
         if ($debug) {
@@ -472,18 +472,18 @@ 
             $obj->assignVars($myrow);
             if (!$id_as_key) {
                 if ($as_object) {
-                    $ret[] =& $obj;
+                    $ret[] = & $obj;
                 } else {
                     $ret[] = $obj->toArray();
                 }
             } else {
                 if ($as_object) {
-                    $value =& $obj;
+                    $value = & $obj;
                 } else {
                     $value = $obj->toArray();
                 }
                 if ($id_as_key === 'parentid') {
-                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] =& $value;
+                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] = & $value;
                 } else {
                     $ret[$obj->getVar($this->keyName)] = $value;
                 }
@@ -526,15 +526,15 @@ 
             $criteria->setSort($this->getIdentifierName());
         }
 
-        $sql = 'SELECT ' . (is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
+        $sql = 'SELECT '.(is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
         if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->getIdentifierName();
+            $sql .= ', '.$this->getIdentifierName();
         }
-        $sql .= ' FROM ' . $this->table . ' AS ' . $this->_itemname;
+        $sql .= ' FROM '.$this->table.' AS '.$this->_itemname;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -571,7 +571,7 @@ 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
             if ($criteria->groupby !== '') {
                 $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+                $field   = $criteria->groupby.', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
             }
         }
         /**
@@ -582,10 +582,10 @@ 
             $sql = $this->generalSQL;
             $sql = str_replace('SELECT *', 'SELECT COUNT(*)', $sql);
         } else {
-            $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table.' AS '.$this->_itemname;
         }
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby !== '') {
                 $sql .= $criteria->getGroupby();
             }
@@ -628,13 +628,13 @@ 
         if (is_array($this->keyName)) {
             $clause = array();
             for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                $clause[] = $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
             }
             $whereclause = implode(' AND ', $clause);
         } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+            $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
         }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+        $sql = 'DELETE FROM '.$this->table.' WHERE '.$whereclause;
         if (false !== $force) {
             $result = $this->db->queryF($sql);
         } else {
@@ -695,7 +695,7 @@ 
              * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
              */
             if (!is_a($obj, $this->className)) {
-                $obj->setError(get_class($obj) . ' Differs from ' . $this->className);
+                $obj->setError(get_class($obj).' Differs from '.$this->className);
 
                 return false;
             }
@@ -756,7 +756,7 @@ 
         $fieldsToStoreInDB = array();
         foreach ($obj->cleanVars as $k => $v) {
             if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
-                $cleanvars[$k] = (int)$v;
+                $cleanvars[$k] = (int) $v;
             } elseif (is_array($v)) {
                 $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
             } else {
@@ -769,13 +769,13 @@ 
         if ($obj->isNew()) {
             if (!is_array($this->keyName)) {
                 if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+                    $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq');
                 }
             }
 
-            $sql = 'INSERT INTO ' . $this->table . ' (' . implode(',', array_keys($fieldsToStoreInDB)) . ') VALUES (' . implode(',', array_values($fieldsToStoreInDB)) . ')';
+            $sql = 'INSERT INTO '.$this->table.' ('.implode(',', array_keys($fieldsToStoreInDB)).') VALUES ('.implode(',', array_values($fieldsToStoreInDB)).')';
         } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
+            $sql = 'UPDATE '.$this->table.' SET';
             foreach ($fieldsToStoreInDB as $key => $value) {
                 if ((!is_array($this->keyName) && $key == $this->keyName)
                     || (is_array($this->keyName)
@@ -785,7 +785,7 @@ 
                 if (isset($notfirst)) {
                     $sql .= ',';
                 }
-                $sql      .= ' ' . $key . ' = ' . $value;
+                $sql .= ' '.$key.' = '.$value;
                 $notfirst = true;
             }
             if (is_array($this->keyName)) {
@@ -794,12 +794,12 @@ 
                     if ($i > 0) {
                         $whereclause .= ' AND ';
                     }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                    $whereclause .= $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
                 }
             } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+                $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
             }
-            $sql .= ' WHERE ' . $whereclause;
+            $sql .= ' WHERE '.$whereclause;
         }
 
         if ($debug) {
@@ -872,7 +872,7 @@ 
      */
     public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = null, $force = false)
     {
-        $set_clause = $fieldname . ' = ';
+        $set_clause = $fieldname.' = ';
         if (is_numeric($fieldvalue)) {
             $set_clause .= $fieldvalue;
         } elseif (is_array($fieldvalue)) {
@@ -880,9 +880,9 @@ 
         } else {
             $set_clause .= $this->db->quoteString($fieldvalue);
         }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+        $sql = 'UPDATE '.$this->table.' SET '.$set_clause;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
         }
         if (false != $force) {
             $result = $this->db->queryF($sql);
@@ -906,8 +906,8 @@ 
     public function deleteAll(CriteriaElement $criteria = null)
     {
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql = 'DELETE FROM '.$this->table;
+            $sql .= ' '.$criteria->renderWhere();
             if (!$this->db->query($sql)) {
                 return false;
             }
@@ -940,7 +940,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->_moduleName . '_' . $this->_itemname;
+        $ret = $this->_moduleName.'_'.$this->_itemname;
 
         return $ret;
     }
@@ -952,7 +952,7 @@ 
     {
         if (isset($object->vars['counter'])) {
             $new_counter = $object->getVar('counter') + 1;
-            $sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
+            $sql         = 'UPDATE '.$this->table.' SET counter='.$new_counter.' WHERE '.$this->keyName.'='.$object->id();
             $this->query($sql, null, true);
         }
     }
@@ -996,7 +996,7 @@ 
     public function getIdentifierName($withprefix = true)
     {
         if ($withprefix) {
-            return $this->_itemname . '.' . $this->identifierName;
+            return $this->_itemname.'.'.$this->identifierName;
         } else {
             return $this->identifierName;
         }

class/smartobjecttable.php

Doc Comments +4 added lines, -4 removed lines

@@ -31,7 +31,7 @@ 
 
     /**
      * SmartObjectColumn constructor.
-     * @param        $keyname
+     * @param        string $keyname
      * @param string $align
      * @param bool   $width
      * @param bool   $customMethodForValue
@@ -193,7 +193,7 @@ 
     }
 
     /**
-     * @param $columnObj
+     * @param SmartObjectColumn $columnObj
      */
     public function addColumn($columnObj)
     {
@@ -201,8 +201,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $location
+     * @param string $name
+     * @param string $location
      * @param $value
      */
     public function addIntroButton($name, $location, $value)

Indentation +879 added lines, -879 removed lines

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

Spacing +43 added lines, -43 removed lines

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

include/projax/classes/JavaScript.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
 
     /**
      * @param $javascript
-     * @return mixed|string
+     * @return string
      */
     public function escape($javascript)
     {
@@ -48,7 +48,7 @@ 
 
     /**
      * @param         $name
-     * @param         $function
+     * @param         string $function
      * @param  null   $html_options
      * @return string
      */

Indentation +75 added lines, -75 removed lines

@@ -15,90 +15,90 @@
  */
 class JavaScript
 {
-    /**
-     * @param         $name
-     * @param  null   $function
-     * @return string
-     */
-    public function button_to_function($name, $function = null)
-    {
-        return '<input type="button" value="' . $name . '" onclick="' . $function . '">';
-    }
+	/**
+	 * @param         $name
+	 * @param  null   $function
+	 * @return string
+	 */
+	public function button_to_function($name, $function = null)
+	{
+		return '<input type="button" value="' . $name . '" onclick="' . $function . '">';
+	}
 
-    /**
-     * @param $javascript
-     * @return mixed|string
-     */
-    public function escape($javascript)
-    {
-        $javascript = addslashes($javascript);
-        $javascript = str_replace(array("\r\n", "\n", "\r"), array("\n"), $javascript);
+	/**
+	 * @param $javascript
+	 * @return mixed|string
+	 */
+	public function escape($javascript)
+	{
+		$javascript = addslashes($javascript);
+		$javascript = str_replace(array("\r\n", "\n", "\r"), array("\n"), $javascript);
 
-        return $javascript;
-    }
+		return $javascript;
+	}
 
-    /**
-     * @param $content
-     * @return string
-     */
-    public function tag($content)
-    {
-        return '<script type="text/javascript">' . $content . '</script>';
-    }
+	/**
+	 * @param $content
+	 * @return string
+	 */
+	public function tag($content)
+	{
+		return '<script type="text/javascript">' . $content . '</script>';
+	}
 
-    /**
-     * @param         $name
-     * @param         $function
-     * @param  null   $html_options
-     * @return string
-     */
-    public function link_to_function($name, $function, $html_options = null)
-    {
-        return '<a href="' . (isset($html_options['href']) ? $html_options['href'] : '#') . '" onclick="' . (isset($html_options['onclick']) ? $html_options['onclick'] . ';' : '') . $function . '; return false;">' . $name . '</a>';
-    }
+	/**
+	 * @param         $name
+	 * @param         $function
+	 * @param  null   $html_options
+	 * @return string
+	 */
+	public function link_to_function($name, $function, $html_options = null)
+	{
+		return '<a href="' . (isset($html_options['href']) ? $html_options['href'] : '#') . '" onclick="' . (isset($html_options['onclick']) ? $html_options['onclick'] . ';' : '') . $function . '; return false;">' . $name . '</a>';
+	}
 
-    /////////////////////////////////////////////////////////////////////////////////////
-    //                             Private functions
-    /////////////////////////////////////////////////////////////////////////////////////
+	/////////////////////////////////////////////////////////////////////////////////////
+	//                             Private functions
+	/////////////////////////////////////////////////////////////////////////////////////
 
-    /**
-     * @param $option
-     * @return string
-     */
-    public function _array_or_string_for_javascript($option)
-    {
-        $return_val = '';
-        if (is_array($option)) {
-            foreach ($option as $value) {
-                if (!empty($return_val)) {
-                    $ret_val .= ', ';
-                }
-                $return_val .= $value;
-            }
+	/**
+	 * @param $option
+	 * @return string
+	 */
+	public function _array_or_string_for_javascript($option)
+	{
+		$return_val = '';
+		if (is_array($option)) {
+			foreach ($option as $value) {
+				if (!empty($return_val)) {
+					$ret_val .= ', ';
+				}
+				$return_val .= $value;
+			}
 
-            return '[' . $return_val . ']';
-        }
+			return '[' . $return_val . ']';
+		}
 
-        return "'$option'";
-    }
+		return "'$option'";
+	}
 
-    /**
-     * @param $options
-     * @return string
-     */
-    public function _options_for_javascript($options)
-    {
-        $return_val = '';
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function _options_for_javascript($options)
+	{
+		$return_val = '';
 
-        if (is_array($options)) {
-            foreach ($options as $var => $val) {
-                if (!empty($return_val)) {
-                    $return_val .= ', ';
-                }
-                $return_val .= "$var:$val";
-            }
-        }
+		if (is_array($options)) {
+			foreach ($options as $var => $val) {
+				if (!empty($return_val)) {
+					$return_val .= ', ';
+				}
+				$return_val .= "$var:$val";
+			}
+		}
 
-        return '{' . $return_val . '}';
-    }
+		return '{' . $return_val . '}';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -22,7 +22,7 @@ 
      */
     public function button_to_function($name, $function = null)
     {
-        return '<input type="button" value="' . $name . '" onclick="' . $function . '">';
+        return '<input type="button" value="'.$name.'" onclick="'.$function.'">';
     }
 
     /**
@@ -43,7 +43,7 @@ 
      */
     public function tag($content)
     {
-        return '<script type="text/javascript">' . $content . '</script>';
+        return '<script type="text/javascript">'.$content.'</script>';
     }
 
     /**
@@ -54,7 +54,7 @@ 
      */
     public function link_to_function($name, $function, $html_options = null)
     {
-        return '<a href="' . (isset($html_options['href']) ? $html_options['href'] : '#') . '" onclick="' . (isset($html_options['onclick']) ? $html_options['onclick'] . ';' : '') . $function . '; return false;">' . $name . '</a>';
+        return '<a href="'.(isset($html_options['href']) ? $html_options['href'] : '#').'" onclick="'.(isset($html_options['onclick']) ? $html_options['onclick'].';' : '').$function.'; return false;">'.$name.'</a>';
     }
 
     /////////////////////////////////////////////////////////////////////////////////////
@@ -76,7 +76,7 @@ 
                 $return_val .= $value;
             }
 
-            return '[' . $return_val . ']';
+            return '['.$return_val.']';
         }
 
         return "'$option'";
@@ -99,6 +99,6 @@ 
             }
         }
 
-        return '{' . $return_val . '}';
+        return '{'.$return_val.'}';
     }
 }

include/projax/classes/Prototype.php

Doc Comments +3 added lines, -3 removed lines

@@ -212,7 +212,7 @@ 
     }
 
     /**
-     * @param         $klass
+     * @param         string $klass
      * @param         $name
      * @param  null   $options
      * @return string
@@ -311,7 +311,7 @@ 
     }
 
     /**
-     * @param $variable
+     * @param string $variable
      * @param $value
      * @return string
      */
@@ -321,7 +321,7 @@ 
     }
 
     /**
-     * @param         $function
+     * @param         string $function
      * @param  null   $args
      * @return string
      */

Indentation +448 added lines, -448 removed lines

@@ -15,452 +15,452 @@
  */
 class Prototype extends JavaScript
 {
-    public $CALLBACKS = array(
-        'uninitialized',
-        'loading',
-        'loaded',
-        'interactive',
-        'complete',
-        'failure',
-        'success'
-    );
-
-    public $AJAX_OPTIONS = array(
-        'before',
-        'after',
-        'condition',
-        'url',
-        'asynchronous',
-        'method',
-        'insertion',
-        'position',
-        'form',
-        'with',
-        'update',
-        'script',
-        'uninitialized',
-        'loading',
-        'loaded',
-        'interactive',
-        'complete',
-        'failure',
-        'success'
-    );
-
-    /**
-     * @return string
-     */
-    public function evaluate_remote_response()
-    {
-        return 'eval(request.responseText)';
-    }
-
-    /**
-     * @param $options
-     * @return string
-     */
-    public function form_remote_tag($options)
-    {
-        $options['form'] = true;
-
-        return '<form action="' . $options['url'] . '" onsubmit="' . $this->remote_function($options) . '; return false;" method="' . (isset($options['method']) ? $options['method'] : 'post') . '"  >';
-    }
-
-    /**
-     * @param         $name
-     * @param  null   $options
-     * @param  null   $html_options
-     * @return string
-     */
-    public function link_to_remote($name, $options = null, $html_options = null)
-    {
-        return $this->link_to_function($name, $this->remote_function($options), $html_options);
-    }
-
-    /**
-     * @param         $field_id
-     * @param  null   $options
-     * @return string
-     */
-    public function observe_field($field_id, $options = null)
-    {
-        if (isset($options['frequency']) && $options['frequency'] > 0) {
-            return $this->_build_observer('Form.Element.Observer', $field_id, $options);
-        } else {
-            return $this->_build_observer('Form.Element.EventObserver', $field_id, $options);
-        }
-    }
-
-    /**
-     * @param         $form_id
-     * @param  null   $options
-     * @return string
-     */
-    public function observe_form($form_id, $options = null)
-    {
-        if (isset($options['frequency'])) {
-            return $this->_build_observer('Form.Observer', $form_id, $options);
-        } else {
-            return $this->_build_observer('Form.EventObserver', $form_id, $options);
-        }
-    }
-
-    /**
-     * @param  null $options
-     * @return string
-     */
-    public function periodically_call_remote($options = null)
-    {
-        $frequency = isset($options['frequency']) ? $options['frequency'] : 10;
-        $code      = 'new PeriodicalExecuter(function() {' . $this->remote_function($options) . '},' . $frequency . ')';
-
-        return $code;
-    }
-
-    /**
-     * @param $options
-     * @return string
-     */
-    public function remote_function($options)
-    {
-        $javascript_options = $this->_options_for_ajax($options);
-
-        $update = '';
-
-        if (isset($options['update']) && is_array($options['update'])) {
-            $update = isset($options['update']['success']) ? 'success: ' . $options['update']['success'] : '';
-            $update .= empty($update) ? '' : ',';
-            $update .= isset($options['update']['failure']) ? 'failure: ' . $options['update']['failure'] : '';
-        } else {
-            $update .= isset($options['update']) ? $options['update'] : '';
-        }
-
-        $ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\'' . $update . '\',';
-
-        $ajax_function .= "'" . $options['url'] . "'";
-        $ajax_function .= ',' . $javascript_options . ')';
-
-        $ajax_function = isset($options['before']) ? $options['before'] . ';' . $ajax_function : $ajax_function;
-        $ajax_function = isset($options['after']) ? $ajax_function . ';' . $options['after'] : $ajax_function;
-        $ajax_function = isset($options['condition']) ? 'if (' . $options['condition'] . ') {' . $ajax_function . '}' : $ajax_function;
-        $ajax_function = isset($options['confirm']) ? 'if ( confirm(\'' . $options['confirm'] . '\' ) ) { ' . $ajax_function . ' } ' : $ajax_function;
-
-        return $ajax_function;
-    }
-
-    /**
-     * @param $name
-     * @param $value
-     * @param $options
-     * @return string
-     */
-    public function submit_to_remote($name, $value, $options)
-    {
-        if (isset($options['with'])) {
-            $options['with'] = 'Form.serialize(this.form)';
-        }
-
-        return '<input type="button" onclick="' . $this->remote_function($options) . '" name="' . $name . '" value ="' . $value . '">';
-    }
-
-    /**
-     * @param      $element_id
-     * @param null $options
-     * @param      $block
-     */
-    public function update_element_function($element_id, $options = null, $block)
-    {
-        $content = isset($options['content']) ? $options['content'] : '';
-        $content = $this->escape($content);
-    }
-
-    /**
-     * @param $block
-     */
-    public function update_page($block)
-    {
-    }
-
-    /**
-     * @param $block
-     * @return string
-     */
-    public function update_page_tag(& $block)
-    {
-        return $this->tag($block);
-    }
-
-    /////////////////////////////////////////////////////////////////////////////////////
-    //                             Private functions
-    /////////////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * @param $options
-     * @return array
-     */
-    public function _build_callbacks($options)
-    {
-        $callbacks = array();
-        foreach ($options as $callback => $code) {
-            if (in_array($callback, $this->CALLBACKS)) {
-                $name             = 'on' . ucfirst($callback);
-                $callbacks[$name] = 'function(request){' . $code . '}';
-            }
-        }
-
-        return $callbacks;
-    }
-
-    /**
-     * @param         $klass
-     * @param         $name
-     * @param  null   $options
-     * @return string
-     */
-    public function _build_observer($klass, $name, $options = null)
-    {
-        if (isset($options['with']) && false === strpos($options['with'], '=')) {
-            $options['with'] = '\'' . $options['with'] . '=\' + value';
-        } elseif (isset($options['with']) && isset($options['update'])) {
-            $options['with'] = 'value';
-        }
-
-        $callback = $options['function'] ?: $this->remote_function($options);
-
-        $javascript = "new $klass('$name', ";
-        $javascript .= isset($options['frequency']) ? $options['frequency'] . ', ' : '';
-        $javascript .= 'function (element,value) { ';
-        $javascript .= $callback;
-        $javascript .= isset($options['on']) ? ', ' . $options['on'] : '';
-        $javascript .= '})';
-
-        return $javascript;
-    }
-
-    /**
-     * @param $method
-     * @return string
-     */
-    public function _method_option_to_s($method)
-    {
-        return strstr($method, "'") ? $method : "'$method'";
-    }
-
-    /**
-     * @param $options
-     * @return string
-     */
-    public function _options_for_ajax($options)
-    {
-        $js_options = is_array($options) ? $this->_build_callbacks($options) : array();
-
-        if (isset($options['type']) && $option['type'] === 'synchronous') {
-            $js_options['asynchronous'] = 'false';
-        }
-
-        if (isset($options['method'])) {
-            $js_options['method'] = $this->_method_option_to_s($options['method']);
-        }
-
-        if (isset($options['position'])) {
-            $js_options['insertion'] = 'Insertion.' . ucfirst($options['position']);
-        }
-
-        $js_options['evalScripts'] = isset($options['script']) ? $options['script'] : 'true';
-
-        if (isset($options['form'])) {
-            $js_options['parameters'] = 'Form.serialize(this)';
-        } elseif (isset($options['parameters'])) {
-            $js_options['parameters'] = 'Form.serialize(\'' . $options['submit'] . '\')';
-        } elseif (isset($options['with'])) {
-            $js_options['parameters'] = $options['with'];
-        }
-
-        return $this->_options_for_javascript($js_options);
-    }
-
-    /////////////////////////////////////////////////////////////////////////////////////
-    //                            Mergerd Javascript Generator helpers
-    /////////////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * @param $javascript
-     */
-    public function dump($javascript)
-    {
-        echo $javascript;
-    }
-
-    /**
-     * @param         $id
-     * @param  null   $extend
-     * @return string
-     */
-    public function ID($id, $extend = null)
-    {
-        return "$('$id')" . (!empty($extend)) ? '.' . $extend . '()' : '';
-    }
-
-    /**
-     * @param $message
-     * @return string
-     */
-    public function alert($message)
-    {
-        return $this->call('alert', $message);
-    }
-
-    /**
-     * @param $variable
-     * @param $value
-     * @return string
-     */
-    public function assign($variable, $value)
-    {
-        return "$variable = $value;";
-    }
-
-    /**
-     * @param         $function
-     * @param  null   $args
-     * @return string
-     */
-    public function call($function, $args = null)
-    {
-        $arg_str = '';
-        if (is_array($args)) {
-            foreach ($args as $arg) {
-                if (!empty($arg_str)) {
-                    $arg_str .= ', ';
-                }
-                if (is_string($arg)) {
-                    $arg_str .= "'$arg'";
-                } else {
-                    $arg_str .= $arg;
-                }
-            }
-        } else {
-            if (is_string($args)) {
-                $arg_str .= "'$args'";
-            } else {
-                $arg_str .= $args;
-            }
-        }
-
-        return "$function($arg_str)";
-    }
-
-    /**
-     * @param  int    $seconds
-     * @param  string $script
-     * @return string
-     */
-    public function delay($seconds = 1, $script = '')
-    {
-        return "setTimeout( function() { $script } , " . ($seconds * 1000) . ' )';
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function hide($id)
-    {
-        return $this->call('Element.hide', $id);
-    }
-
-    /**
-     * @param         $position
-     * @param         $id
-     * @param  null   $options_for_render
-     * @return string
-     */
-    public function insert_html($position, $id, $options_for_render = null)
-    {
-        $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
-
-        return $this->call('new Insertion.' . ucfirst($position), $args);
-    }
-
-    /**
-     * @param $location
-     * @return string
-     */
-    public function redirect_to($location)
-    {
-        return $this->assign('window.location.href', $location);
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function remove($id)
-    {
-        if (is_array($id)) {
-            $arr_str = '';
-            foreach ($id as $obj) {
-                if (!empty($arg_str)) {
-                    $arg_str .= ', ';
-                }
-                $arg_str .= "'$arg'";
-            }
-
-            return "$A[$arg_str].each(Element.remove)";
-        } else {
-            return "Element.remove('$id')";
-        }
-    }
-
-    /**
-     * @param $id
-     * @param $options_for_render
-     * @return string
-     */
-    public function replace($id, $options_for_render)
-    {
-        $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
-
-        return $this->call('Element.replace', $args);
-    }
-
-    /**
-     * @param $id
-     * @param $options_for_render
-     * @return string
-     */
-    public function replace_html($id, $options_for_render)
-    {
-        $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
-
-        return $this->call('Element.update', $args);
-    }
-
-    /**
-     * @param         $pattern
-     * @param  null   $extend
-     * @return string
-     */
-    public function select($pattern, $extend = null)
-    {
-        return "$$('$pattern')" . (!empty($extend)) ? '.' . $extend : '';
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function show($id)
-    {
-        return $this->call('Element.show', $id);
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function toggle($id)
-    {
-        return $this->call('Element.toggle', $id);
-    }
+	public $CALLBACKS = array(
+		'uninitialized',
+		'loading',
+		'loaded',
+		'interactive',
+		'complete',
+		'failure',
+		'success'
+	);
+
+	public $AJAX_OPTIONS = array(
+		'before',
+		'after',
+		'condition',
+		'url',
+		'asynchronous',
+		'method',
+		'insertion',
+		'position',
+		'form',
+		'with',
+		'update',
+		'script',
+		'uninitialized',
+		'loading',
+		'loaded',
+		'interactive',
+		'complete',
+		'failure',
+		'success'
+	);
+
+	/**
+	 * @return string
+	 */
+	public function evaluate_remote_response()
+	{
+		return 'eval(request.responseText)';
+	}
+
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function form_remote_tag($options)
+	{
+		$options['form'] = true;
+
+		return '<form action="' . $options['url'] . '" onsubmit="' . $this->remote_function($options) . '; return false;" method="' . (isset($options['method']) ? $options['method'] : 'post') . '"  >';
+	}
+
+	/**
+	 * @param         $name
+	 * @param  null   $options
+	 * @param  null   $html_options
+	 * @return string
+	 */
+	public function link_to_remote($name, $options = null, $html_options = null)
+	{
+		return $this->link_to_function($name, $this->remote_function($options), $html_options);
+	}
+
+	/**
+	 * @param         $field_id
+	 * @param  null   $options
+	 * @return string
+	 */
+	public function observe_field($field_id, $options = null)
+	{
+		if (isset($options['frequency']) && $options['frequency'] > 0) {
+			return $this->_build_observer('Form.Element.Observer', $field_id, $options);
+		} else {
+			return $this->_build_observer('Form.Element.EventObserver', $field_id, $options);
+		}
+	}
+
+	/**
+	 * @param         $form_id
+	 * @param  null   $options
+	 * @return string
+	 */
+	public function observe_form($form_id, $options = null)
+	{
+		if (isset($options['frequency'])) {
+			return $this->_build_observer('Form.Observer', $form_id, $options);
+		} else {
+			return $this->_build_observer('Form.EventObserver', $form_id, $options);
+		}
+	}
+
+	/**
+	 * @param  null $options
+	 * @return string
+	 */
+	public function periodically_call_remote($options = null)
+	{
+		$frequency = isset($options['frequency']) ? $options['frequency'] : 10;
+		$code      = 'new PeriodicalExecuter(function() {' . $this->remote_function($options) . '},' . $frequency . ')';
+
+		return $code;
+	}
+
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function remote_function($options)
+	{
+		$javascript_options = $this->_options_for_ajax($options);
+
+		$update = '';
+
+		if (isset($options['update']) && is_array($options['update'])) {
+			$update = isset($options['update']['success']) ? 'success: ' . $options['update']['success'] : '';
+			$update .= empty($update) ? '' : ',';
+			$update .= isset($options['update']['failure']) ? 'failure: ' . $options['update']['failure'] : '';
+		} else {
+			$update .= isset($options['update']) ? $options['update'] : '';
+		}
+
+		$ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\'' . $update . '\',';
+
+		$ajax_function .= "'" . $options['url'] . "'";
+		$ajax_function .= ',' . $javascript_options . ')';
+
+		$ajax_function = isset($options['before']) ? $options['before'] . ';' . $ajax_function : $ajax_function;
+		$ajax_function = isset($options['after']) ? $ajax_function . ';' . $options['after'] : $ajax_function;
+		$ajax_function = isset($options['condition']) ? 'if (' . $options['condition'] . ') {' . $ajax_function . '}' : $ajax_function;
+		$ajax_function = isset($options['confirm']) ? 'if ( confirm(\'' . $options['confirm'] . '\' ) ) { ' . $ajax_function . ' } ' : $ajax_function;
+
+		return $ajax_function;
+	}
+
+	/**
+	 * @param $name
+	 * @param $value
+	 * @param $options
+	 * @return string
+	 */
+	public function submit_to_remote($name, $value, $options)
+	{
+		if (isset($options['with'])) {
+			$options['with'] = 'Form.serialize(this.form)';
+		}
+
+		return '<input type="button" onclick="' . $this->remote_function($options) . '" name="' . $name . '" value ="' . $value . '">';
+	}
+
+	/**
+	 * @param      $element_id
+	 * @param null $options
+	 * @param      $block
+	 */
+	public function update_element_function($element_id, $options = null, $block)
+	{
+		$content = isset($options['content']) ? $options['content'] : '';
+		$content = $this->escape($content);
+	}
+
+	/**
+	 * @param $block
+	 */
+	public function update_page($block)
+	{
+	}
+
+	/**
+	 * @param $block
+	 * @return string
+	 */
+	public function update_page_tag(& $block)
+	{
+		return $this->tag($block);
+	}
+
+	/////////////////////////////////////////////////////////////////////////////////////
+	//                             Private functions
+	/////////////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * @param $options
+	 * @return array
+	 */
+	public function _build_callbacks($options)
+	{
+		$callbacks = array();
+		foreach ($options as $callback => $code) {
+			if (in_array($callback, $this->CALLBACKS)) {
+				$name             = 'on' . ucfirst($callback);
+				$callbacks[$name] = 'function(request){' . $code . '}';
+			}
+		}
+
+		return $callbacks;
+	}
+
+	/**
+	 * @param         $klass
+	 * @param         $name
+	 * @param  null   $options
+	 * @return string
+	 */
+	public function _build_observer($klass, $name, $options = null)
+	{
+		if (isset($options['with']) && false === strpos($options['with'], '=')) {
+			$options['with'] = '\'' . $options['with'] . '=\' + value';
+		} elseif (isset($options['with']) && isset($options['update'])) {
+			$options['with'] = 'value';
+		}
+
+		$callback = $options['function'] ?: $this->remote_function($options);
+
+		$javascript = "new $klass('$name', ";
+		$javascript .= isset($options['frequency']) ? $options['frequency'] . ', ' : '';
+		$javascript .= 'function (element,value) { ';
+		$javascript .= $callback;
+		$javascript .= isset($options['on']) ? ', ' . $options['on'] : '';
+		$javascript .= '})';
+
+		return $javascript;
+	}
+
+	/**
+	 * @param $method
+	 * @return string
+	 */
+	public function _method_option_to_s($method)
+	{
+		return strstr($method, "'") ? $method : "'$method'";
+	}
+
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function _options_for_ajax($options)
+	{
+		$js_options = is_array($options) ? $this->_build_callbacks($options) : array();
+
+		if (isset($options['type']) && $option['type'] === 'synchronous') {
+			$js_options['asynchronous'] = 'false';
+		}
+
+		if (isset($options['method'])) {
+			$js_options['method'] = $this->_method_option_to_s($options['method']);
+		}
+
+		if (isset($options['position'])) {
+			$js_options['insertion'] = 'Insertion.' . ucfirst($options['position']);
+		}
+
+		$js_options['evalScripts'] = isset($options['script']) ? $options['script'] : 'true';
+
+		if (isset($options['form'])) {
+			$js_options['parameters'] = 'Form.serialize(this)';
+		} elseif (isset($options['parameters'])) {
+			$js_options['parameters'] = 'Form.serialize(\'' . $options['submit'] . '\')';
+		} elseif (isset($options['with'])) {
+			$js_options['parameters'] = $options['with'];
+		}
+
+		return $this->_options_for_javascript($js_options);
+	}
+
+	/////////////////////////////////////////////////////////////////////////////////////
+	//                            Mergerd Javascript Generator helpers
+	/////////////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * @param $javascript
+	 */
+	public function dump($javascript)
+	{
+		echo $javascript;
+	}
+
+	/**
+	 * @param         $id
+	 * @param  null   $extend
+	 * @return string
+	 */
+	public function ID($id, $extend = null)
+	{
+		return "$('$id')" . (!empty($extend)) ? '.' . $extend . '()' : '';
+	}
+
+	/**
+	 * @param $message
+	 * @return string
+	 */
+	public function alert($message)
+	{
+		return $this->call('alert', $message);
+	}
+
+	/**
+	 * @param $variable
+	 * @param $value
+	 * @return string
+	 */
+	public function assign($variable, $value)
+	{
+		return "$variable = $value;";
+	}
+
+	/**
+	 * @param         $function
+	 * @param  null   $args
+	 * @return string
+	 */
+	public function call($function, $args = null)
+	{
+		$arg_str = '';
+		if (is_array($args)) {
+			foreach ($args as $arg) {
+				if (!empty($arg_str)) {
+					$arg_str .= ', ';
+				}
+				if (is_string($arg)) {
+					$arg_str .= "'$arg'";
+				} else {
+					$arg_str .= $arg;
+				}
+			}
+		} else {
+			if (is_string($args)) {
+				$arg_str .= "'$args'";
+			} else {
+				$arg_str .= $args;
+			}
+		}
+
+		return "$function($arg_str)";
+	}
+
+	/**
+	 * @param  int    $seconds
+	 * @param  string $script
+	 * @return string
+	 */
+	public function delay($seconds = 1, $script = '')
+	{
+		return "setTimeout( function() { $script } , " . ($seconds * 1000) . ' )';
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function hide($id)
+	{
+		return $this->call('Element.hide', $id);
+	}
+
+	/**
+	 * @param         $position
+	 * @param         $id
+	 * @param  null   $options_for_render
+	 * @return string
+	 */
+	public function insert_html($position, $id, $options_for_render = null)
+	{
+		$args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
+
+		return $this->call('new Insertion.' . ucfirst($position), $args);
+	}
+
+	/**
+	 * @param $location
+	 * @return string
+	 */
+	public function redirect_to($location)
+	{
+		return $this->assign('window.location.href', $location);
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function remove($id)
+	{
+		if (is_array($id)) {
+			$arr_str = '';
+			foreach ($id as $obj) {
+				if (!empty($arg_str)) {
+					$arg_str .= ', ';
+				}
+				$arg_str .= "'$arg'";
+			}
+
+			return "$A[$arg_str].each(Element.remove)";
+		} else {
+			return "Element.remove('$id')";
+		}
+	}
+
+	/**
+	 * @param $id
+	 * @param $options_for_render
+	 * @return string
+	 */
+	public function replace($id, $options_for_render)
+	{
+		$args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
+
+		return $this->call('Element.replace', $args);
+	}
+
+	/**
+	 * @param $id
+	 * @param $options_for_render
+	 * @return string
+	 */
+	public function replace_html($id, $options_for_render)
+	{
+		$args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
+
+		return $this->call('Element.update', $args);
+	}
+
+	/**
+	 * @param         $pattern
+	 * @param  null   $extend
+	 * @return string
+	 */
+	public function select($pattern, $extend = null)
+	{
+		return "$$('$pattern')" . (!empty($extend)) ? '.' . $extend : '';
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function show($id)
+	{
+		return $this->call('Element.show', $id);
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function toggle($id)
+	{
+		return $this->call('Element.toggle', $id);
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -63,7 +63,7 @@ 
     {
         $options['form'] = true;
 
-        return '<form action="' . $options['url'] . '" onsubmit="' . $this->remote_function($options) . '; return false;" method="' . (isset($options['method']) ? $options['method'] : 'post') . '"  >';
+        return '<form action="'.$options['url'].'" onsubmit="'.$this->remote_function($options).'; return false;" method="'.(isset($options['method']) ? $options['method'] : 'post').'"  >';
     }
 
     /**
@@ -112,7 +112,7 @@ 
     public function periodically_call_remote($options = null)
     {
         $frequency = isset($options['frequency']) ? $options['frequency'] : 10;
-        $code      = 'new PeriodicalExecuter(function() {' . $this->remote_function($options) . '},' . $frequency . ')';
+        $code      = 'new PeriodicalExecuter(function() {'.$this->remote_function($options).'},'.$frequency.')';
 
         return $code;
     }
@@ -128,22 +128,22 @@ 
         $update = '';
 
         if (isset($options['update']) && is_array($options['update'])) {
-            $update = isset($options['update']['success']) ? 'success: ' . $options['update']['success'] : '';
+            $update = isset($options['update']['success']) ? 'success: '.$options['update']['success'] : '';
             $update .= empty($update) ? '' : ',';
-            $update .= isset($options['update']['failure']) ? 'failure: ' . $options['update']['failure'] : '';
+            $update .= isset($options['update']['failure']) ? 'failure: '.$options['update']['failure'] : '';
         } else {
             $update .= isset($options['update']) ? $options['update'] : '';
         }
 
-        $ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\'' . $update . '\',';
+        $ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\''.$update.'\',';
 
-        $ajax_function .= "'" . $options['url'] . "'";
-        $ajax_function .= ',' . $javascript_options . ')';
+        $ajax_function .= "'".$options['url']."'";
+        $ajax_function .= ','.$javascript_options.')';
 
-        $ajax_function = isset($options['before']) ? $options['before'] . ';' . $ajax_function : $ajax_function;
-        $ajax_function = isset($options['after']) ? $ajax_function . ';' . $options['after'] : $ajax_function;
-        $ajax_function = isset($options['condition']) ? 'if (' . $options['condition'] . ') {' . $ajax_function . '}' : $ajax_function;
-        $ajax_function = isset($options['confirm']) ? 'if ( confirm(\'' . $options['confirm'] . '\' ) ) { ' . $ajax_function . ' } ' : $ajax_function;
+        $ajax_function = isset($options['before']) ? $options['before'].';'.$ajax_function : $ajax_function;
+        $ajax_function = isset($options['after']) ? $ajax_function.';'.$options['after'] : $ajax_function;
+        $ajax_function = isset($options['condition']) ? 'if ('.$options['condition'].') {'.$ajax_function.'}' : $ajax_function;
+        $ajax_function = isset($options['confirm']) ? 'if ( confirm(\''.$options['confirm'].'\' ) ) { '.$ajax_function.' } ' : $ajax_function;
 
         return $ajax_function;
     }
@@ -160,7 +160,7 @@ 
             $options['with'] = 'Form.serialize(this.form)';
         }
 
-        return '<input type="button" onclick="' . $this->remote_function($options) . '" name="' . $name . '" value ="' . $value . '">';
+        return '<input type="button" onclick="'.$this->remote_function($options).'" name="'.$name.'" value ="'.$value.'">';
     }
 
     /**
@@ -203,8 +203,8 @@ 
         $callbacks = array();
         foreach ($options as $callback => $code) {
             if (in_array($callback, $this->CALLBACKS)) {
-                $name             = 'on' . ucfirst($callback);
-                $callbacks[$name] = 'function(request){' . $code . '}';
+                $name             = 'on'.ucfirst($callback);
+                $callbacks[$name] = 'function(request){'.$code.'}';
             }
         }
 
@@ -220,7 +220,7 @@ 
     public function _build_observer($klass, $name, $options = null)
     {
         if (isset($options['with']) && false === strpos($options['with'], '=')) {
-            $options['with'] = '\'' . $options['with'] . '=\' + value';
+            $options['with'] = '\''.$options['with'].'=\' + value';
         } elseif (isset($options['with']) && isset($options['update'])) {
             $options['with'] = 'value';
         }
@@ -228,10 +228,10 @@ 
         $callback = $options['function'] ?: $this->remote_function($options);
 
         $javascript = "new $klass('$name', ";
-        $javascript .= isset($options['frequency']) ? $options['frequency'] . ', ' : '';
+        $javascript .= isset($options['frequency']) ? $options['frequency'].', ' : '';
         $javascript .= 'function (element,value) { ';
         $javascript .= $callback;
-        $javascript .= isset($options['on']) ? ', ' . $options['on'] : '';
+        $javascript .= isset($options['on']) ? ', '.$options['on'] : '';
         $javascript .= '})';
 
         return $javascript;
@@ -263,7 +263,7 @@ 
         }
 
         if (isset($options['position'])) {
-            $js_options['insertion'] = 'Insertion.' . ucfirst($options['position']);
+            $js_options['insertion'] = 'Insertion.'.ucfirst($options['position']);
         }
 
         $js_options['evalScripts'] = isset($options['script']) ? $options['script'] : 'true';
@@ -271,7 +271,7 @@ 
         if (isset($options['form'])) {
             $js_options['parameters'] = 'Form.serialize(this)';
         } elseif (isset($options['parameters'])) {
-            $js_options['parameters'] = 'Form.serialize(\'' . $options['submit'] . '\')';
+            $js_options['parameters'] = 'Form.serialize(\''.$options['submit'].'\')';
         } elseif (isset($options['with'])) {
             $js_options['parameters'] = $options['with'];
         }
@@ -298,7 +298,7 @@ 
      */
     public function ID($id, $extend = null)
     {
-        return "$('$id')" . (!empty($extend)) ? '.' . $extend . '()' : '';
+        return "$('$id')".(!empty($extend)) ? '.'.$extend.'()' : '';
     }
 
     /**
@@ -357,7 +357,7 @@ 
      */
     public function delay($seconds = 1, $script = '')
     {
-        return "setTimeout( function() { $script } , " . ($seconds * 1000) . ' )';
+        return "setTimeout( function() { $script } , ".($seconds * 1000).' )';
     }
 
     /**
@@ -379,7 +379,7 @@ 
     {
         $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
 
-        return $this->call('new Insertion.' . ucfirst($position), $args);
+        return $this->call('new Insertion.'.ucfirst($position), $args);
     }
 
     /**
@@ -443,7 +443,7 @@ 
      */
     public function select($pattern, $extend = null)
     {
-        return "$$('$pattern')" . (!empty($extend)) ? '.' . $extend : '';
+        return "$$('$pattern')".(!empty($extend)) ? '.'.$extend : '';
     }
 
     /**

include/projax_/classes/JavaScript.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
 
     /**
      * @param $javascript
-     * @return mixed|string
+     * @return string
      */
     public function escape($javascript)
     {
@@ -48,7 +48,7 @@ 
 
     /**
      * @param         $name
-     * @param         $function
+     * @param         string $function
      * @param  null   $html_options
      * @return string
      */

Indentation +75 added lines, -75 removed lines

@@ -15,90 +15,90 @@
  */
 class JavaScript
 {
-    /**
-     * @param         $name
-     * @param  null   $function
-     * @return string
-     */
-    public function button_to_function($name, $function = null)
-    {
-        return '<input type="button" value="' . $name . '" onclick="' . $function . '">';
-    }
+	/**
+	 * @param         $name
+	 * @param  null   $function
+	 * @return string
+	 */
+	public function button_to_function($name, $function = null)
+	{
+		return '<input type="button" value="' . $name . '" onclick="' . $function . '">';
+	}
 
-    /**
-     * @param $javascript
-     * @return mixed|string
-     */
-    public function escape($javascript)
-    {
-        $javascript = addslashes($javascript);
-        $javascript = str_replace(array("\r\n", "\n", "\r"), array("\n"), $javascript);
+	/**
+	 * @param $javascript
+	 * @return mixed|string
+	 */
+	public function escape($javascript)
+	{
+		$javascript = addslashes($javascript);
+		$javascript = str_replace(array("\r\n", "\n", "\r"), array("\n"), $javascript);
 
-        return $javascript;
-    }
+		return $javascript;
+	}
 
-    /**
-     * @param $content
-     * @return string
-     */
-    public function tag($content)
-    {
-        return '<script type="text/javascript">' . $content . '</script>';
-    }
+	/**
+	 * @param $content
+	 * @return string
+	 */
+	public function tag($content)
+	{
+		return '<script type="text/javascript">' . $content . '</script>';
+	}
 
-    /**
-     * @param         $name
-     * @param         $function
-     * @param  null   $html_options
-     * @return string
-     */
-    public function link_to_function($name, $function, $html_options = null)
-    {
-        return '<a href="' . (isset($html_options['href']) ? $html_options['href'] : '#') . '" onclick="' . (isset($html_options['onclick']) ? $html_options['onclick'] . ';' : '') . $function . '; return false;">' . $name . '</a>';
-    }
+	/**
+	 * @param         $name
+	 * @param         $function
+	 * @param  null   $html_options
+	 * @return string
+	 */
+	public function link_to_function($name, $function, $html_options = null)
+	{
+		return '<a href="' . (isset($html_options['href']) ? $html_options['href'] : '#') . '" onclick="' . (isset($html_options['onclick']) ? $html_options['onclick'] . ';' : '') . $function . '; return false;">' . $name . '</a>';
+	}
 
-    /////////////////////////////////////////////////////////////////////////////////////
-    //                             Private functions
-    /////////////////////////////////////////////////////////////////////////////////////
+	/////////////////////////////////////////////////////////////////////////////////////
+	//                             Private functions
+	/////////////////////////////////////////////////////////////////////////////////////
 
-    /**
-     * @param $option
-     * @return string
-     */
-    public function _array_or_string_for_javascript($option)
-    {
-        $return_val = '';
-        if (is_array($option)) {
-            foreach ($option as $value) {
-                if (!empty($return_val)) {
-                    $ret_val .= ', ';
-                }
-                $return_val .= $value;
-            }
+	/**
+	 * @param $option
+	 * @return string
+	 */
+	public function _array_or_string_for_javascript($option)
+	{
+		$return_val = '';
+		if (is_array($option)) {
+			foreach ($option as $value) {
+				if (!empty($return_val)) {
+					$ret_val .= ', ';
+				}
+				$return_val .= $value;
+			}
 
-            return '[' . $return_val . ']';
-        }
+			return '[' . $return_val . ']';
+		}
 
-        return "'$option'";
-    }
+		return "'$option'";
+	}
 
-    /**
-     * @param $options
-     * @return string
-     */
-    public function _options_for_javascript($options)
-    {
-        $return_val = '';
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function _options_for_javascript($options)
+	{
+		$return_val = '';
 
-        if (is_array($options)) {
-            foreach ($options as $var => $val) {
-                if (!empty($return_val)) {
-                    $return_val .= ', ';
-                }
-                $return_val .= "$var:$val";
-            }
-        }
+		if (is_array($options)) {
+			foreach ($options as $var => $val) {
+				if (!empty($return_val)) {
+					$return_val .= ', ';
+				}
+				$return_val .= "$var:$val";
+			}
+		}
 
-        return '{' . $return_val . '}';
-    }
+		return '{' . $return_val . '}';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -22,7 +22,7 @@ 
      */
     public function button_to_function($name, $function = null)
     {
-        return '<input type="button" value="' . $name . '" onclick="' . $function . '">';
+        return '<input type="button" value="'.$name.'" onclick="'.$function.'">';
     }
 
     /**
@@ -43,7 +43,7 @@ 
      */
     public function tag($content)
     {
-        return '<script type="text/javascript">' . $content . '</script>';
+        return '<script type="text/javascript">'.$content.'</script>';
     }
 
     /**
@@ -54,7 +54,7 @@ 
      */
     public function link_to_function($name, $function, $html_options = null)
     {
-        return '<a href="' . (isset($html_options['href']) ? $html_options['href'] : '#') . '" onclick="' . (isset($html_options['onclick']) ? $html_options['onclick'] . ';' : '') . $function . '; return false;">' . $name . '</a>';
+        return '<a href="'.(isset($html_options['href']) ? $html_options['href'] : '#').'" onclick="'.(isset($html_options['onclick']) ? $html_options['onclick'].';' : '').$function.'; return false;">'.$name.'</a>';
     }
 
     /////////////////////////////////////////////////////////////////////////////////////
@@ -76,7 +76,7 @@ 
                 $return_val .= $value;
             }
 
-            return '[' . $return_val . ']';
+            return '['.$return_val.']';
         }
 
         return "'$option'";
@@ -99,6 +99,6 @@ 
             }
         }
 
-        return '{' . $return_val . '}';
+        return '{'.$return_val.'}';
     }
 }

include/projax_/classes/Prototype.php

Doc Comments +3 added lines, -3 removed lines

@@ -212,7 +212,7 @@ 
     }
 
     /**
-     * @param         $klass
+     * @param         string $klass
      * @param         $name
      * @param  null   $options
      * @return string
@@ -311,7 +311,7 @@ 
     }
 
     /**
-     * @param $variable
+     * @param string $variable
      * @param $value
      * @return string
      */
@@ -321,7 +321,7 @@ 
     }
 
     /**
-     * @param         $function
+     * @param         string $function
      * @param  null   $args
      * @return string
      */

Indentation +448 added lines, -448 removed lines

@@ -15,452 +15,452 @@
  */
 class Prototype extends JavaScript
 {
-    public $CALLBACKS = array(
-        'uninitialized',
-        'loading',
-        'loaded',
-        'interactive',
-        'complete',
-        'failure',
-        'success'
-    );
-
-    public $AJAX_OPTIONS = array(
-        'before',
-        'after',
-        'condition',
-        'url',
-        'asynchronous',
-        'method',
-        'insertion',
-        'position',
-        'form',
-        'with',
-        'update',
-        'script',
-        'uninitialized',
-        'loading',
-        'loaded',
-        'interactive',
-        'complete',
-        'failure',
-        'success'
-    );
-
-    /**
-     * @return string
-     */
-    public function evaluate_remote_response()
-    {
-        return 'eval(request.responseText)';
-    }
-
-    /**
-     * @param $options
-     * @return string
-     */
-    public function form_remote_tag($options)
-    {
-        $options['form'] = true;
-
-        return '<form action="' . $options['url'] . '" onsubmit="' . $this->remote_function($options) . '; return false;" method="' . (isset($options['method']) ? $options['method'] : 'post') . '"  >';
-    }
-
-    /**
-     * @param         $name
-     * @param  null   $options
-     * @param  null   $html_options
-     * @return string
-     */
-    public function link_to_remote($name, $options = null, $html_options = null)
-    {
-        return $this->link_to_function($name, $this->remote_function($options), $html_options);
-    }
-
-    /**
-     * @param         $field_id
-     * @param  null   $options
-     * @return string
-     */
-    public function observe_field($field_id, $options = null)
-    {
-        if (isset($options['frequency']) && $options['frequency'] > 0) {
-            return $this->_build_observer('Form.Element.Observer', $field_id, $options);
-        } else {
-            return $this->_build_observer('Form.Element.EventObserver', $field_id, $options);
-        }
-    }
-
-    /**
-     * @param         $form_id
-     * @param  null   $options
-     * @return string
-     */
-    public function observe_form($form_id, $options = null)
-    {
-        if (isset($options['frequency'])) {
-            return $this->_build_observer('Form.Observer', $form_id, $options);
-        } else {
-            return $this->_build_observer('Form.EventObserver', $form_id, $options);
-        }
-    }
-
-    /**
-     * @param  null $options
-     * @return string
-     */
-    public function periodically_call_remote($options = null)
-    {
-        $frequency = isset($options['frequency']) ? $options['frequency'] : 10;
-        $code      = 'new PeriodicalExecuter(function() {' . $this->remote_function($options) . '},' . $frequency . ')';
-
-        return $code;
-    }
-
-    /**
-     * @param $options
-     * @return string
-     */
-    public function remote_function($options)
-    {
-        $javascript_options = $this->_options_for_ajax($options);
-
-        $update = '';
-
-        if (isset($options['update']) && is_array($options['update'])) {
-            $update = isset($options['update']['success']) ? 'success: ' . $options['update']['success'] : '';
-            $update .= empty($update) ? '' : ',';
-            $update .= isset($options['update']['failure']) ? 'failure: ' . $options['update']['failure'] : '';
-        } else {
-            $update .= isset($options['update']) ? $options['update'] : '';
-        }
-
-        $ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\'' . $update . '\',';
-
-        $ajax_function .= "'" . $options['url'] . "'";
-        $ajax_function .= ',' . $javascript_options . ')';
-
-        $ajax_function = isset($options['before']) ? $options['before'] . ';' . $ajax_function : $ajax_function;
-        $ajax_function = isset($options['after']) ? $ajax_function . ';' . $options['after'] : $ajax_function;
-        $ajax_function = isset($options['condition']) ? 'if (' . $options['condition'] . ') {' . $ajax_function . '}' : $ajax_function;
-        $ajax_function = isset($options['confirm']) ? 'if ( confirm(\'' . $options['confirm'] . '\' ) ) { ' . $ajax_function . ' } ' : $ajax_function;
-
-        return $ajax_function;
-    }
-
-    /**
-     * @param $name
-     * @param $value
-     * @param $options
-     * @return string
-     */
-    public function submit_to_remote($name, $value, $options)
-    {
-        if (isset($options['with'])) {
-            $options['with'] = 'Form.serialize(this.form)';
-        }
-
-        return '<input type="button" onclick="' . $this->remote_function($options) . '" name="' . $name . '" value ="' . $value . '">';
-    }
-
-    /**
-     * @param      $element_id
-     * @param null $options
-     * @param      $block
-     */
-    public function update_element_function($element_id, $options = null, $block)
-    {
-        $content = isset($options['content']) ? $options['content'] : '';
-        $content = $this->escape($content);
-    }
-
-    /**
-     * @param $block
-     */
-    public function update_page($block)
-    {
-    }
-
-    /**
-     * @param $block
-     * @return string
-     */
-    public function update_page_tag(& $block)
-    {
-        return $this->tag($block);
-    }
-
-    /////////////////////////////////////////////////////////////////////////////////////
-    //                             Private functions
-    /////////////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * @param $options
-     * @return array
-     */
-    public function _build_callbacks($options)
-    {
-        $callbacks = array();
-        foreach ($options as $callback => $code) {
-            if (in_array($callback, $this->CALLBACKS)) {
-                $name             = 'on' . ucfirst($callback);
-                $callbacks[$name] = 'function(request){' . $code . '}';
-            }
-        }
-
-        return $callbacks;
-    }
-
-    /**
-     * @param         $klass
-     * @param         $name
-     * @param  null   $options
-     * @return string
-     */
-    public function _build_observer($klass, $name, $options = null)
-    {
-        if (isset($options['with']) && false === strpos($options['with'], '=')) {
-            $options['with'] = '\'' . $options['with'] . '=\' + value';
-        } elseif (isset($options['with']) && isset($options['update'])) {
-            $options['with'] = 'value';
-        }
-
-        $callback = $options['function'] ?: $this->remote_function($options);
-
-        $javascript = "new $klass('$name', ";
-        $javascript .= isset($options['frequency']) ? $options['frequency'] . ', ' : '';
-        $javascript .= 'function (element,value) { ';
-        $javascript .= $callback;
-        $javascript .= isset($options['on']) ? ', ' . $options['on'] : '';
-        $javascript .= '})';
-
-        return $javascript;
-    }
-
-    /**
-     * @param $method
-     * @return string
-     */
-    public function _method_option_to_s($method)
-    {
-        return strstr($method, "'") ? $method : "'$method'";
-    }
-
-    /**
-     * @param $options
-     * @return string
-     */
-    public function _options_for_ajax($options)
-    {
-        $js_options = is_array($options) ? $this->_build_callbacks($options) : array();
-
-        if (isset($options['type']) && $option['type'] === 'synchronous') {
-            $js_options['asynchronous'] = 'false';
-        }
-
-        if (isset($options['method'])) {
-            $js_options['method'] = $this->_method_option_to_s($options['method']);
-        }
-
-        if (isset($options['position'])) {
-            $js_options['insertion'] = 'Insertion.' . ucfirst($options['position']);
-        }
-
-        $js_options['evalScripts'] = isset($options['script']) ? $options['script'] : 'true';
-
-        if (isset($options['form'])) {
-            $js_options['parameters'] = 'Form.serialize(this)';
-        } elseif (isset($options['parameters'])) {
-            $js_options['parameters'] = 'Form.serialize(\'' . $options['submit'] . '\')';
-        } elseif (isset($options['with'])) {
-            $js_options['parameters'] = $options['with'];
-        }
-
-        return $this->_options_for_javascript($js_options);
-    }
-
-    /////////////////////////////////////////////////////////////////////////////////////
-    //                            Mergerd Javascript Generator helpers
-    /////////////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * @param $javascript
-     */
-    public function dump($javascript)
-    {
-        echo $javascript;
-    }
-
-    /**
-     * @param         $id
-     * @param  null   $extend
-     * @return string
-     */
-    public function ID($id, $extend = null)
-    {
-        return "$('$id')" . (!empty($extend)) ? '.' . $extend . '()' : '';
-    }
-
-    /**
-     * @param $message
-     * @return string
-     */
-    public function alert($message)
-    {
-        return $this->call('alert', $message);
-    }
-
-    /**
-     * @param $variable
-     * @param $value
-     * @return string
-     */
-    public function assign($variable, $value)
-    {
-        return "$variable = $value;";
-    }
-
-    /**
-     * @param         $function
-     * @param  null   $args
-     * @return string
-     */
-    public function call($function, $args = null)
-    {
-        $arg_str = '';
-        if (is_array($args)) {
-            foreach ($args as $arg) {
-                if (!empty($arg_str)) {
-                    $arg_str .= ', ';
-                }
-                if (is_string($arg)) {
-                    $arg_str .= "'$arg'";
-                } else {
-                    $arg_str .= $arg;
-                }
-            }
-        } else {
-            if (is_string($args)) {
-                $arg_str .= "'$args'";
-            } else {
-                $arg_str .= $args;
-            }
-        }
-
-        return "$function($arg_str)";
-    }
-
-    /**
-     * @param  int    $seconds
-     * @param  string $script
-     * @return string
-     */
-    public function delay($seconds = 1, $script = '')
-    {
-        return "setTimeout( function() { $script } , " . ($seconds * 1000) . ' )';
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function hide($id)
-    {
-        return $this->call('Element.hide', $id);
-    }
-
-    /**
-     * @param         $position
-     * @param         $id
-     * @param  null   $options_for_render
-     * @return string
-     */
-    public function insert_html($position, $id, $options_for_render = null)
-    {
-        $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
-
-        return $this->call('new Insertion.' . ucfirst($position), $args);
-    }
-
-    /**
-     * @param $location
-     * @return string
-     */
-    public function redirect_to($location)
-    {
-        return $this->assign('window.location.href', $location);
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function remove($id)
-    {
-        if (is_array($id)) {
-            $arr_str = '';
-            foreach ($id as $obj) {
-                if (!empty($arg_str)) {
-                    $arg_str .= ', ';
-                }
-                $arg_str .= "'$arg'";
-            }
-
-            return "$A[$arg_str].each(Element.remove)";
-        } else {
-            return "Element.remove('$id')";
-        }
-    }
-
-    /**
-     * @param $id
-     * @param $options_for_render
-     * @return string
-     */
-    public function replace($id, $options_for_render)
-    {
-        $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
-
-        return $this->call('Element.replace', $args);
-    }
-
-    /**
-     * @param $id
-     * @param $options_for_render
-     * @return string
-     */
-    public function replace_html($id, $options_for_render)
-    {
-        $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
-
-        return $this->call('Element.update', $args);
-    }
-
-    /**
-     * @param         $pattern
-     * @param  null   $extend
-     * @return string
-     */
-    public function select($pattern, $extend = null)
-    {
-        return "$$('$pattern')" . (!empty($extend)) ? '.' . $extend : '';
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function show($id)
-    {
-        return $this->call('Element.show', $id);
-    }
-
-    /**
-     * @param $id
-     * @return string
-     */
-    public function toggle($id)
-    {
-        return $this->call('Element.toggle', $id);
-    }
+	public $CALLBACKS = array(
+		'uninitialized',
+		'loading',
+		'loaded',
+		'interactive',
+		'complete',
+		'failure',
+		'success'
+	);
+
+	public $AJAX_OPTIONS = array(
+		'before',
+		'after',
+		'condition',
+		'url',
+		'asynchronous',
+		'method',
+		'insertion',
+		'position',
+		'form',
+		'with',
+		'update',
+		'script',
+		'uninitialized',
+		'loading',
+		'loaded',
+		'interactive',
+		'complete',
+		'failure',
+		'success'
+	);
+
+	/**
+	 * @return string
+	 */
+	public function evaluate_remote_response()
+	{
+		return 'eval(request.responseText)';
+	}
+
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function form_remote_tag($options)
+	{
+		$options['form'] = true;
+
+		return '<form action="' . $options['url'] . '" onsubmit="' . $this->remote_function($options) . '; return false;" method="' . (isset($options['method']) ? $options['method'] : 'post') . '"  >';
+	}
+
+	/**
+	 * @param         $name
+	 * @param  null   $options
+	 * @param  null   $html_options
+	 * @return string
+	 */
+	public function link_to_remote($name, $options = null, $html_options = null)
+	{
+		return $this->link_to_function($name, $this->remote_function($options), $html_options);
+	}
+
+	/**
+	 * @param         $field_id
+	 * @param  null   $options
+	 * @return string
+	 */
+	public function observe_field($field_id, $options = null)
+	{
+		if (isset($options['frequency']) && $options['frequency'] > 0) {
+			return $this->_build_observer('Form.Element.Observer', $field_id, $options);
+		} else {
+			return $this->_build_observer('Form.Element.EventObserver', $field_id, $options);
+		}
+	}
+
+	/**
+	 * @param         $form_id
+	 * @param  null   $options
+	 * @return string
+	 */
+	public function observe_form($form_id, $options = null)
+	{
+		if (isset($options['frequency'])) {
+			return $this->_build_observer('Form.Observer', $form_id, $options);
+		} else {
+			return $this->_build_observer('Form.EventObserver', $form_id, $options);
+		}
+	}
+
+	/**
+	 * @param  null $options
+	 * @return string
+	 */
+	public function periodically_call_remote($options = null)
+	{
+		$frequency = isset($options['frequency']) ? $options['frequency'] : 10;
+		$code      = 'new PeriodicalExecuter(function() {' . $this->remote_function($options) . '},' . $frequency . ')';
+
+		return $code;
+	}
+
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function remote_function($options)
+	{
+		$javascript_options = $this->_options_for_ajax($options);
+
+		$update = '';
+
+		if (isset($options['update']) && is_array($options['update'])) {
+			$update = isset($options['update']['success']) ? 'success: ' . $options['update']['success'] : '';
+			$update .= empty($update) ? '' : ',';
+			$update .= isset($options['update']['failure']) ? 'failure: ' . $options['update']['failure'] : '';
+		} else {
+			$update .= isset($options['update']) ? $options['update'] : '';
+		}
+
+		$ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\'' . $update . '\',';
+
+		$ajax_function .= "'" . $options['url'] . "'";
+		$ajax_function .= ',' . $javascript_options . ')';
+
+		$ajax_function = isset($options['before']) ? $options['before'] . ';' . $ajax_function : $ajax_function;
+		$ajax_function = isset($options['after']) ? $ajax_function . ';' . $options['after'] : $ajax_function;
+		$ajax_function = isset($options['condition']) ? 'if (' . $options['condition'] . ') {' . $ajax_function . '}' : $ajax_function;
+		$ajax_function = isset($options['confirm']) ? 'if ( confirm(\'' . $options['confirm'] . '\' ) ) { ' . $ajax_function . ' } ' : $ajax_function;
+
+		return $ajax_function;
+	}
+
+	/**
+	 * @param $name
+	 * @param $value
+	 * @param $options
+	 * @return string
+	 */
+	public function submit_to_remote($name, $value, $options)
+	{
+		if (isset($options['with'])) {
+			$options['with'] = 'Form.serialize(this.form)';
+		}
+
+		return '<input type="button" onclick="' . $this->remote_function($options) . '" name="' . $name . '" value ="' . $value . '">';
+	}
+
+	/**
+	 * @param      $element_id
+	 * @param null $options
+	 * @param      $block
+	 */
+	public function update_element_function($element_id, $options = null, $block)
+	{
+		$content = isset($options['content']) ? $options['content'] : '';
+		$content = $this->escape($content);
+	}
+
+	/**
+	 * @param $block
+	 */
+	public function update_page($block)
+	{
+	}
+
+	/**
+	 * @param $block
+	 * @return string
+	 */
+	public function update_page_tag(& $block)
+	{
+		return $this->tag($block);
+	}
+
+	/////////////////////////////////////////////////////////////////////////////////////
+	//                             Private functions
+	/////////////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * @param $options
+	 * @return array
+	 */
+	public function _build_callbacks($options)
+	{
+		$callbacks = array();
+		foreach ($options as $callback => $code) {
+			if (in_array($callback, $this->CALLBACKS)) {
+				$name             = 'on' . ucfirst($callback);
+				$callbacks[$name] = 'function(request){' . $code . '}';
+			}
+		}
+
+		return $callbacks;
+	}
+
+	/**
+	 * @param         $klass
+	 * @param         $name
+	 * @param  null   $options
+	 * @return string
+	 */
+	public function _build_observer($klass, $name, $options = null)
+	{
+		if (isset($options['with']) && false === strpos($options['with'], '=')) {
+			$options['with'] = '\'' . $options['with'] . '=\' + value';
+		} elseif (isset($options['with']) && isset($options['update'])) {
+			$options['with'] = 'value';
+		}
+
+		$callback = $options['function'] ?: $this->remote_function($options);
+
+		$javascript = "new $klass('$name', ";
+		$javascript .= isset($options['frequency']) ? $options['frequency'] . ', ' : '';
+		$javascript .= 'function (element,value) { ';
+		$javascript .= $callback;
+		$javascript .= isset($options['on']) ? ', ' . $options['on'] : '';
+		$javascript .= '})';
+
+		return $javascript;
+	}
+
+	/**
+	 * @param $method
+	 * @return string
+	 */
+	public function _method_option_to_s($method)
+	{
+		return strstr($method, "'") ? $method : "'$method'";
+	}
+
+	/**
+	 * @param $options
+	 * @return string
+	 */
+	public function _options_for_ajax($options)
+	{
+		$js_options = is_array($options) ? $this->_build_callbacks($options) : array();
+
+		if (isset($options['type']) && $option['type'] === 'synchronous') {
+			$js_options['asynchronous'] = 'false';
+		}
+
+		if (isset($options['method'])) {
+			$js_options['method'] = $this->_method_option_to_s($options['method']);
+		}
+
+		if (isset($options['position'])) {
+			$js_options['insertion'] = 'Insertion.' . ucfirst($options['position']);
+		}
+
+		$js_options['evalScripts'] = isset($options['script']) ? $options['script'] : 'true';
+
+		if (isset($options['form'])) {
+			$js_options['parameters'] = 'Form.serialize(this)';
+		} elseif (isset($options['parameters'])) {
+			$js_options['parameters'] = 'Form.serialize(\'' . $options['submit'] . '\')';
+		} elseif (isset($options['with'])) {
+			$js_options['parameters'] = $options['with'];
+		}
+
+		return $this->_options_for_javascript($js_options);
+	}
+
+	/////////////////////////////////////////////////////////////////////////////////////
+	//                            Mergerd Javascript Generator helpers
+	/////////////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * @param $javascript
+	 */
+	public function dump($javascript)
+	{
+		echo $javascript;
+	}
+
+	/**
+	 * @param         $id
+	 * @param  null   $extend
+	 * @return string
+	 */
+	public function ID($id, $extend = null)
+	{
+		return "$('$id')" . (!empty($extend)) ? '.' . $extend . '()' : '';
+	}
+
+	/**
+	 * @param $message
+	 * @return string
+	 */
+	public function alert($message)
+	{
+		return $this->call('alert', $message);
+	}
+
+	/**
+	 * @param $variable
+	 * @param $value
+	 * @return string
+	 */
+	public function assign($variable, $value)
+	{
+		return "$variable = $value;";
+	}
+
+	/**
+	 * @param         $function
+	 * @param  null   $args
+	 * @return string
+	 */
+	public function call($function, $args = null)
+	{
+		$arg_str = '';
+		if (is_array($args)) {
+			foreach ($args as $arg) {
+				if (!empty($arg_str)) {
+					$arg_str .= ', ';
+				}
+				if (is_string($arg)) {
+					$arg_str .= "'$arg'";
+				} else {
+					$arg_str .= $arg;
+				}
+			}
+		} else {
+			if (is_string($args)) {
+				$arg_str .= "'$args'";
+			} else {
+				$arg_str .= $args;
+			}
+		}
+
+		return "$function($arg_str)";
+	}
+
+	/**
+	 * @param  int    $seconds
+	 * @param  string $script
+	 * @return string
+	 */
+	public function delay($seconds = 1, $script = '')
+	{
+		return "setTimeout( function() { $script } , " . ($seconds * 1000) . ' )';
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function hide($id)
+	{
+		return $this->call('Element.hide', $id);
+	}
+
+	/**
+	 * @param         $position
+	 * @param         $id
+	 * @param  null   $options_for_render
+	 * @return string
+	 */
+	public function insert_html($position, $id, $options_for_render = null)
+	{
+		$args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
+
+		return $this->call('new Insertion.' . ucfirst($position), $args);
+	}
+
+	/**
+	 * @param $location
+	 * @return string
+	 */
+	public function redirect_to($location)
+	{
+		return $this->assign('window.location.href', $location);
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function remove($id)
+	{
+		if (is_array($id)) {
+			$arr_str = '';
+			foreach ($id as $obj) {
+				if (!empty($arg_str)) {
+					$arg_str .= ', ';
+				}
+				$arg_str .= "'$arg'";
+			}
+
+			return "$A[$arg_str].each(Element.remove)";
+		} else {
+			return "Element.remove('$id')";
+		}
+	}
+
+	/**
+	 * @param $id
+	 * @param $options_for_render
+	 * @return string
+	 */
+	public function replace($id, $options_for_render)
+	{
+		$args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
+
+		return $this->call('Element.replace', $args);
+	}
+
+	/**
+	 * @param $id
+	 * @param $options_for_render
+	 * @return string
+	 */
+	public function replace_html($id, $options_for_render)
+	{
+		$args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
+
+		return $this->call('Element.update', $args);
+	}
+
+	/**
+	 * @param         $pattern
+	 * @param  null   $extend
+	 * @return string
+	 */
+	public function select($pattern, $extend = null)
+	{
+		return "$$('$pattern')" . (!empty($extend)) ? '.' . $extend : '';
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function show($id)
+	{
+		return $this->call('Element.show', $id);
+	}
+
+	/**
+	 * @param $id
+	 * @return string
+	 */
+	public function toggle($id)
+	{
+		return $this->call('Element.toggle', $id);
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -63,7 +63,7 @@ 
     {
         $options['form'] = true;
 
-        return '<form action="' . $options['url'] . '" onsubmit="' . $this->remote_function($options) . '; return false;" method="' . (isset($options['method']) ? $options['method'] : 'post') . '"  >';
+        return '<form action="'.$options['url'].'" onsubmit="'.$this->remote_function($options).'; return false;" method="'.(isset($options['method']) ? $options['method'] : 'post').'"  >';
     }
 
     /**
@@ -112,7 +112,7 @@ 
     public function periodically_call_remote($options = null)
     {
         $frequency = isset($options['frequency']) ? $options['frequency'] : 10;
-        $code      = 'new PeriodicalExecuter(function() {' . $this->remote_function($options) . '},' . $frequency . ')';
+        $code      = 'new PeriodicalExecuter(function() {'.$this->remote_function($options).'},'.$frequency.')';
 
         return $code;
     }
@@ -128,22 +128,22 @@ 
         $update = '';
 
         if (isset($options['update']) && is_array($options['update'])) {
-            $update = isset($options['update']['success']) ? 'success: ' . $options['update']['success'] : '';
+            $update = isset($options['update']['success']) ? 'success: '.$options['update']['success'] : '';
             $update .= empty($update) ? '' : ',';
-            $update .= isset($options['update']['failure']) ? 'failure: ' . $options['update']['failure'] : '';
+            $update .= isset($options['update']['failure']) ? 'failure: '.$options['update']['failure'] : '';
         } else {
             $update .= isset($options['update']) ? $options['update'] : '';
         }
 
-        $ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\'' . $update . '\',';
+        $ajax_function = empty($update) ? 'new Ajax.Request(' : 'new Ajax.Updater(\''.$update.'\',';
 
-        $ajax_function .= "'" . $options['url'] . "'";
-        $ajax_function .= ',' . $javascript_options . ')';
+        $ajax_function .= "'".$options['url']."'";
+        $ajax_function .= ','.$javascript_options.')';
 
-        $ajax_function = isset($options['before']) ? $options['before'] . ';' . $ajax_function : $ajax_function;
-        $ajax_function = isset($options['after']) ? $ajax_function . ';' . $options['after'] : $ajax_function;
-        $ajax_function = isset($options['condition']) ? 'if (' . $options['condition'] . ') {' . $ajax_function . '}' : $ajax_function;
-        $ajax_function = isset($options['confirm']) ? 'if ( confirm(\'' . $options['confirm'] . '\' ) ) { ' . $ajax_function . ' } ' : $ajax_function;
+        $ajax_function = isset($options['before']) ? $options['before'].';'.$ajax_function : $ajax_function;
+        $ajax_function = isset($options['after']) ? $ajax_function.';'.$options['after'] : $ajax_function;
+        $ajax_function = isset($options['condition']) ? 'if ('.$options['condition'].') {'.$ajax_function.'}' : $ajax_function;
+        $ajax_function = isset($options['confirm']) ? 'if ( confirm(\''.$options['confirm'].'\' ) ) { '.$ajax_function.' } ' : $ajax_function;
 
         return $ajax_function;
     }
@@ -160,7 +160,7 @@ 
             $options['with'] = 'Form.serialize(this.form)';
         }
 
-        return '<input type="button" onclick="' . $this->remote_function($options) . '" name="' . $name . '" value ="' . $value . '">';
+        return '<input type="button" onclick="'.$this->remote_function($options).'" name="'.$name.'" value ="'.$value.'">';
     }
 
     /**
@@ -203,8 +203,8 @@ 
         $callbacks = array();
         foreach ($options as $callback => $code) {
             if (in_array($callback, $this->CALLBACKS)) {
-                $name             = 'on' . ucfirst($callback);
-                $callbacks[$name] = 'function(request){' . $code . '}';
+                $name             = 'on'.ucfirst($callback);
+                $callbacks[$name] = 'function(request){'.$code.'}';
             }
         }
 
@@ -220,7 +220,7 @@ 
     public function _build_observer($klass, $name, $options = null)
     {
         if (isset($options['with']) && false === strpos($options['with'], '=')) {
-            $options['with'] = '\'' . $options['with'] . '=\' + value';
+            $options['with'] = '\''.$options['with'].'=\' + value';
         } elseif (isset($options['with']) && isset($options['update'])) {
             $options['with'] = 'value';
         }
@@ -228,10 +228,10 @@ 
         $callback = $options['function'] ?: $this->remote_function($options);
 
         $javascript = "new $klass('$name', ";
-        $javascript .= isset($options['frequency']) ? $options['frequency'] . ', ' : '';
+        $javascript .= isset($options['frequency']) ? $options['frequency'].', ' : '';
         $javascript .= 'function (element,value) { ';
         $javascript .= $callback;
-        $javascript .= isset($options['on']) ? ', ' . $options['on'] : '';
+        $javascript .= isset($options['on']) ? ', '.$options['on'] : '';
         $javascript .= '})';
 
         return $javascript;
@@ -263,7 +263,7 @@ 
         }
 
         if (isset($options['position'])) {
-            $js_options['insertion'] = 'Insertion.' . ucfirst($options['position']);
+            $js_options['insertion'] = 'Insertion.'.ucfirst($options['position']);
         }
 
         $js_options['evalScripts'] = isset($options['script']) ? $options['script'] : 'true';
@@ -271,7 +271,7 @@ 
         if (isset($options['form'])) {
             $js_options['parameters'] = 'Form.serialize(this)';
         } elseif (isset($options['parameters'])) {
-            $js_options['parameters'] = 'Form.serialize(\'' . $options['submit'] . '\')';
+            $js_options['parameters'] = 'Form.serialize(\''.$options['submit'].'\')';
         } elseif (isset($options['with'])) {
             $js_options['parameters'] = $options['with'];
         }
@@ -298,7 +298,7 @@ 
      */
     public function ID($id, $extend = null)
     {
-        return "$('$id')" . (!empty($extend)) ? '.' . $extend . '()' : '';
+        return "$('$id')".(!empty($extend)) ? '.'.$extend.'()' : '';
     }
 
     /**
@@ -357,7 +357,7 @@ 
      */
     public function delay($seconds = 1, $script = '')
     {
-        return "setTimeout( function() { $script } , " . ($seconds * 1000) . ' )';
+        return "setTimeout( function() { $script } , ".($seconds * 1000).' )';
     }
 
     /**
@@ -379,7 +379,7 @@ 
     {
         $args = array_merge(array($id), (is_array($options_for_render) ? $options_for_render : array($options_for_render)));
 
-        return $this->call('new Insertion.' . ucfirst($position), $args);
+        return $this->call('new Insertion.'.ucfirst($position), $args);
     }
 
     /**
@@ -443,7 +443,7 @@ 
      */
     public function select($pattern, $extend = null)
     {
-        return "$$('$pattern')" . (!empty($extend)) ? '.' . $extend : '';
+        return "$$('$pattern')".(!empty($extend)) ? '.'.$extend : '';
     }
 
     /**

language/english/common.php

Indentation +3 added lines, -3 removed lines

@@ -152,11 +152,11 @@
 define('_CO_SOBJECT_UPLOAD_IMAGE', 'Upload a new image:');
 define('_CO_SOBJECT_VERSION_HISTORY', 'Version History');
 define('_CO_SOBJECT_WARNING_BETA',
-       'This module comes as is, without any guarantees whatsoever. This module is BETA, meaning it is still under active development. This release is meant for <b>testing purposes only</b> and we <b>strongly</b> recommend that you do not use it on a live website or in a production environment.');
+	   'This module comes as is, without any guarantees whatsoever. This module is BETA, meaning it is still under active development. This release is meant for <b>testing purposes only</b> and we <b>strongly</b> recommend that you do not use it on a live website or in a production environment.');
 define('_CO_SOBJECT_WARNING_FINAL',
-       'This module comes as is, without any guarantees whatsoever. Although this module is not beta, it is still under active development. This release can be used in a live website or a production environment, but its use is under your own responsibility, which means the author is not responsible.');
+	   'This module comes as is, without any guarantees whatsoever. Although this module is not beta, it is still under active development. This release can be used in a live website or a production environment, but its use is under your own responsibility, which means the author is not responsible.');
 define('_CO_SOBJECT_WARNING_RC',
-       'This module comes as is, without any guarantees whatsoever. This module is a Release Candidate and should not be used on a production web site. The module is still under active development and its use is under your own responsibility, which means the author is not responsible.');
+	   'This module comes as is, without any guarantees whatsoever. This module is a Release Candidate and should not be used on a production web site. The module is still under active development and its use is under your own responsibility, which means the author is not responsible.');
 define('_CO_SOBJECT_WEIGHT_FORM_CAPTION', 'Weight');
 define('_CO_SOBJECT_WEIGHT_FORM_DSC', '');