mambax7 / smartobject

class/adsense.php

Doc Comments +2 added lines, -2 removed lines

@@ -92,7 +92,7 @@ 
     /**
      * @param  string $key
      * @param  string $format
-     * @return mixed
+     * @return string
      */
     public function getVar($key, $format = 's')
     {
@@ -157,7 +157,7 @@ 
     }
 
     /**
-     * @return mixed|string
+     * @return string
      */
     public function generateTag()
     {

Indentation +253 added lines, -253 removed lines

@@ -36,87 +36,87 @@ 
  */
 class SmartobjectAdsense extends SmartObject
 {
-    /**
-     * SmartobjectAdsense constructor.
-     */
-    public function __construct()
-    {
-        $this->quickInitVar('adsenseid', XOBJ_DTYPE_INT, true);
-        $this->quickInitVar('description', XOBJ_DTYPE_TXTAREA, true, _CO_SOBJECT_ADSENSE_DESCRIPTION, _CO_SOBJECT_ADSENSE_DESCRIPTION_DSC);
-        $this->quickInitVar('client_id', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_CLIENT_ID, _CO_SOBJECT_ADSENSE_CLIENT_ID_DSC);
-        $this->quickInitVar('tag', XOBJ_DTYPE_TXTBOX, false, _CO_SOBJECT_ADSENSE_TAG, _CO_SOBJECT_ADSENSE_TAG_DSC);
-        $this->quickInitVar('format', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_FORMAT, _CO_SOBJECT_ADSENSE_FORMAT_DSC);
-        $this->quickInitVar('border_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_BORDER_COLOR, _CO_SOBJECT_ADSENSE_BORDER_COLOR_DSC);
-        $this->quickInitVar('background_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_BACKGROUND_COLOR, _CO_SOBJECT_ADSENSE_BORDER_COLOR_DSC);
-        $this->quickInitVar('link_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_LINK_COLOR, _CO_SOBJECT_ADSENSE_LINK_COLOR_DSC);
-        $this->quickInitVar('url_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_URL_COLOR, _CO_SOBJECT_ADSENSE_URL_COLOR_DSC);
-        $this->quickInitVar('text_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_TEXT_COLOR, _CO_SOBJECT_ADSENSE_TEXT_COLOR_DSC);
-        $this->quickInitVar('style', XOBJ_DTYPE_TXTAREA, false, _CO_SOBJECT_ADSENSE_STYLE, _CO_SOBJECT_ADSENSE_STYLE_DSC);
-
-        $this->setControl('format', array(
-            'handler' => 'adsense',
-            'method'  => 'getFormats'
-        ));
-
-        $this->setControl('border_color', array(
-            'name'      => 'text',
-            'size'      => 6,
-            'maxlength' => 6
-        ));
-
-        $this->setControl('background_color', array(
-            'name'      => 'text',
-            'size'      => 6,
-            'maxlength' => 6
-        ));
-
-        $this->setControl('link_color', array(
-            'name'      => 'text',
-            'size'      => 6,
-            'maxlength' => 6
-        ));
-
-        $this->setControl('url_color', array(
-            'name'      => 'text',
-            'size'      => 6,
-            'maxlength' => 6
-        ));
-
-        $this->setControl('text_color', array(
-            'name'      => 'text',
-            'size'      => 6,
-            'maxlength' => 6
-        ));
-    }
-
-    /**
-     * @param  string $key
-     * @param  string $format
-     * @return mixed
-     */
-    public function getVar($key, $format = 's')
-    {
-        if ($format === 's' && in_array($key, array())) {
-            //            return call_user_func(array($this, $key));
-            return $this->{$key}();
-        }
-
-        return parent::getVar($key, $format);
-    }
-
-    /**
-     * @return string
-     */
-    public function render()
-    {
-        global $smartobjectAdsenseHandler;
-        if ($this->getVar('style', 'n') != '') {
-            $ret = '<div style="' . $this->getVar('style', 'n') . '">';
-        } else {
-            $ret = '<div>';
-        }
-
-        $ret .= '<script type="text/javascript"><!--
+	/**
+	 * SmartobjectAdsense constructor.
+	 */
+	public function __construct()
+	{
+		$this->quickInitVar('adsenseid', XOBJ_DTYPE_INT, true);
+		$this->quickInitVar('description', XOBJ_DTYPE_TXTAREA, true, _CO_SOBJECT_ADSENSE_DESCRIPTION, _CO_SOBJECT_ADSENSE_DESCRIPTION_DSC);
+		$this->quickInitVar('client_id', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_CLIENT_ID, _CO_SOBJECT_ADSENSE_CLIENT_ID_DSC);
+		$this->quickInitVar('tag', XOBJ_DTYPE_TXTBOX, false, _CO_SOBJECT_ADSENSE_TAG, _CO_SOBJECT_ADSENSE_TAG_DSC);
+		$this->quickInitVar('format', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_FORMAT, _CO_SOBJECT_ADSENSE_FORMAT_DSC);
+		$this->quickInitVar('border_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_BORDER_COLOR, _CO_SOBJECT_ADSENSE_BORDER_COLOR_DSC);
+		$this->quickInitVar('background_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_BACKGROUND_COLOR, _CO_SOBJECT_ADSENSE_BORDER_COLOR_DSC);
+		$this->quickInitVar('link_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_LINK_COLOR, _CO_SOBJECT_ADSENSE_LINK_COLOR_DSC);
+		$this->quickInitVar('url_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_URL_COLOR, _CO_SOBJECT_ADSENSE_URL_COLOR_DSC);
+		$this->quickInitVar('text_color', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_ADSENSE_TEXT_COLOR, _CO_SOBJECT_ADSENSE_TEXT_COLOR_DSC);
+		$this->quickInitVar('style', XOBJ_DTYPE_TXTAREA, false, _CO_SOBJECT_ADSENSE_STYLE, _CO_SOBJECT_ADSENSE_STYLE_DSC);
+
+		$this->setControl('format', array(
+			'handler' => 'adsense',
+			'method'  => 'getFormats'
+		));
+
+		$this->setControl('border_color', array(
+			'name'      => 'text',
+			'size'      => 6,
+			'maxlength' => 6
+		));
+
+		$this->setControl('background_color', array(
+			'name'      => 'text',
+			'size'      => 6,
+			'maxlength' => 6
+		));
+
+		$this->setControl('link_color', array(
+			'name'      => 'text',
+			'size'      => 6,
+			'maxlength' => 6
+		));
+
+		$this->setControl('url_color', array(
+			'name'      => 'text',
+			'size'      => 6,
+			'maxlength' => 6
+		));
+
+		$this->setControl('text_color', array(
+			'name'      => 'text',
+			'size'      => 6,
+			'maxlength' => 6
+		));
+	}
+
+	/**
+	 * @param  string $key
+	 * @param  string $format
+	 * @return mixed
+	 */
+	public function getVar($key, $format = 's')
+	{
+		if ($format === 's' && in_array($key, array())) {
+			//            return call_user_func(array($this, $key));
+			return $this->{$key}();
+		}
+
+		return parent::getVar($key, $format);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function render()
+	{
+		global $smartobjectAdsenseHandler;
+		if ($this->getVar('style', 'n') != '') {
+			$ret = '<div style="' . $this->getVar('style', 'n') . '">';
+		} else {
+			$ret = '<div>';
+		}
+
+		$ret .= '<script type="text/javascript"><!--
 google_ad_client = "' . $this->getVar('client_id', 'n') . '";
 google_ad_width = ' . $smartobjectAdsenseHandler->adFormats[$this->getVar('format', 'n')]['width'] . ';
 google_ad_height = ' . $smartobjectAdsenseHandler->adFormats[$this->getVar('format', 'n')]['height'] . ';
@@ -134,66 +134,66 @@ 
 </script>
 </div>';
 
-        return $ret;
-    }
-
-    /**
-     * @return string
-     */
-    public function getXoopsCode()
-    {
-        $ret = '[adsense]' . $this->getVar('tag', 'n') . '[/adsense]';
-
-        return $ret;
-    }
-
-    /**
-     * @param $var
-     * @return bool
-     */
-    public function emptyString($var)
-    {
-        return (strlen($var) > 0);
-    }
-
-    /**
-     * @return mixed|string
-     */
-    public function generateTag()
-    {
-        $title = rawurlencode(strtolower($this->getVar('description', 'e')));
-        $title = xoops_substr($title, 0, 10, '');
-        // Transformation des ponctuations
-        //                 Tab     Space      !        "        #        %        &        '        (        )        ,        /       :        ;        <        =        >        ?        @        [        \        ]        ^        {        |        }        ~       .
-        $pattern = array('/%09/', '/%20/', '/%21/', '/%22/', '/%23/', '/%25/', '/%26/', '/%27/', '/%28/', '/%29/', '/%2C/', '/%2F/', '/%3A/', '/%3B/', '/%3C/', '/%3D/', '/%3E/', '/%3F/', '/%40/', '/%5B/', '/%5C/', '/%5D/', '/%5E/', '/%7B/', '/%7C/', '/%7D/', '/%7E/', "/\./");
-        $rep_pat = array('-', '-', '-', '-', '-', '-100', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-at-', '-', '-', '-', '-', '-', '-', '-', '-', '-');
-        $title   = preg_replace($pattern, $rep_pat, $title);
-
-        // Transformation des caract�res accentu�s
-        //                  °        è        é        ê        ë        ç        à        â        ä        î        ï        ù        ü        û        ô        ö
-        $pattern = array('/%B0/', '/%E8/', '/%E9/', '/%EA/', '/%EB/', '/%E7/', '/%E0/', '/%E2/', '/%E4/', '/%EE/', '/%EF/', '/%F9/', '/%FC/', '/%FB/', '/%F4/', '/%F6/');
-        $rep_pat = array('-', 'e', 'e', 'e', 'e', 'c', 'a', 'a', 'a', 'i', 'i', 'u', 'u', 'u', 'o', 'o');
-        $title   = preg_replace($pattern, $rep_pat, $title);
-
-        $tableau = explode('-', $title); // Transforme la chaine de caract�res en tableau
-        $tableau = array_filter($tableau, array($this, 'emptyString')); // Supprime les chaines vides du tableau
-        $title   = implode('-', $tableau); // Transforme un tableau en chaine de caract�res s�par� par un tiret
-
-        $title = $title . time();
-        $title = md5($title);
-
-        return $title;
-    }
-
-    /**
-     * @return string
-     */
-    public function getCloneLink()
-    {
-        $ret = '<a href="' . SMARTOBJECT_URL . 'admin/adsense.php?op=clone&adsenseid=' . $this->getVar('adsenseid') . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'editcopy.png" alt="' . _CO_SOBJECT_ADSENSE_CLONE . '" title="' . _CO_SOBJECT_ADSENSE_CLONE . '" /></a>';
-
-        return $ret;
-    }
+		return $ret;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getXoopsCode()
+	{
+		$ret = '[adsense]' . $this->getVar('tag', 'n') . '[/adsense]';
+
+		return $ret;
+	}
+
+	/**
+	 * @param $var
+	 * @return bool
+	 */
+	public function emptyString($var)
+	{
+		return (strlen($var) > 0);
+	}
+
+	/**
+	 * @return mixed|string
+	 */
+	public function generateTag()
+	{
+		$title = rawurlencode(strtolower($this->getVar('description', 'e')));
+		$title = xoops_substr($title, 0, 10, '');
+		// Transformation des ponctuations
+		//                 Tab     Space      !        "        #        %        &        '        (        )        ,        /       :        ;        <        =        >        ?        @        [        \        ]        ^        {        |        }        ~       .
+		$pattern = array('/%09/', '/%20/', '/%21/', '/%22/', '/%23/', '/%25/', '/%26/', '/%27/', '/%28/', '/%29/', '/%2C/', '/%2F/', '/%3A/', '/%3B/', '/%3C/', '/%3D/', '/%3E/', '/%3F/', '/%40/', '/%5B/', '/%5C/', '/%5D/', '/%5E/', '/%7B/', '/%7C/', '/%7D/', '/%7E/', "/\./");
+		$rep_pat = array('-', '-', '-', '-', '-', '-100', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-at-', '-', '-', '-', '-', '-', '-', '-', '-', '-');
+		$title   = preg_replace($pattern, $rep_pat, $title);
+
+		// Transformation des caract�res accentu�s
+		//                  °        è        é        ê        ë        ç        à        â        ä        î        ï        ù        ü        û        ô        ö
+		$pattern = array('/%B0/', '/%E8/', '/%E9/', '/%EA/', '/%EB/', '/%E7/', '/%E0/', '/%E2/', '/%E4/', '/%EE/', '/%EF/', '/%F9/', '/%FC/', '/%FB/', '/%F4/', '/%F6/');
+		$rep_pat = array('-', 'e', 'e', 'e', 'e', 'c', 'a', 'a', 'a', 'i', 'i', 'u', 'u', 'u', 'o', 'o');
+		$title   = preg_replace($pattern, $rep_pat, $title);
+
+		$tableau = explode('-', $title); // Transforme la chaine de caract�res en tableau
+		$tableau = array_filter($tableau, array($this, 'emptyString')); // Supprime les chaines vides du tableau
+		$title   = implode('-', $tableau); // Transforme un tableau en chaine de caract�res s�par� par un tiret
+
+		$title = $title . time();
+		$title = md5($title);
+
+		return $title;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCloneLink()
+	{
+		$ret = '<a href="' . SMARTOBJECT_URL . 'admin/adsense.php?op=clone&adsenseid=' . $this->getVar('adsenseid') . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'editcopy.png" alt="' . _CO_SOBJECT_ADSENSE_CLONE . '" title="' . _CO_SOBJECT_ADSENSE_CLONE . '" /></a>';
+
+		return $ret;
+	}
 }
 
 /**
@@ -201,116 +201,116 @@ 
  */
 class SmartobjectAdsenseHandler extends SmartPersistableObjectHandler
 {
-    public $adFormats;
-    public $adFormatsList;
-    public $objects = false;
-
-    /**
-     * SmartobjectAdsenseHandler constructor.
-     * @param object|XoopsDatabase $db
-     */
-    public function __construct($db)
-    {
-        parent::__construct($db, 'adsense', 'adsenseid', 'description', '', 'smartobject');
-        $this->adFormats     = array();
-        $this->adFormatsList = array();
-
-        $this->adFormats['728x90_as']['caption'] = '728 X 90 Leaderboard';
-        $this->adFormats['728x90_as']['width']   = 728;
-        $this->adFormats['728x90_as']['height']  = 90;
-        $this->adFormatsList['728x90_as']        = $this->adFormats['728x90_as']['caption'];
-
-        $this->adFormats['468x60_as']['caption'] = '468 X 60 Banner';
-        $this->adFormats['468x60_as']['width']   = 468;
-        $this->adFormats['468x60_as']['height']  = 60;
-        $this->adFormatsList['468x60_as']        = $this->adFormats['468x60_as']['caption'];
-
-        $this->adFormats['234x60_as']['caption'] = '234 X 60 Half Banner';
-        $this->adFormats['234x60_as']['width']   = 234;
-        $this->adFormats['234x60_as']['height']  = 60;
-        $this->adFormatsList['234x60_as']        = $this->adFormats['234x60_as']['caption'];
-
-        $this->adFormats['120x600_as']['caption'] = '120 X 600 Skyscraper';
-        $this->adFormats['120x600_as']['width']   = 120;
-        $this->adFormats['120x600_as']['height']  = 600;
-        $this->adFormatsList['120x600_as']        = $this->adFormats['120x600_as']['caption'];
-
-        $this->adFormats['160x600_as']['caption'] = '160 X 600 Wide Skyscraper';
-        $this->adFormats['160x600_as']['width']   = 160;
-        $this->adFormats['160x600_as']['height']  = 600;
-        $this->adFormatsList['160x600_as']        = $this->adFormats['160x600_as']['caption'];
-
-        $this->adFormats['120x240_as']['caption'] = '120 X 240 Vertical Banner';
-        $this->adFormats['120x240_as']['width']   = 120;
-        $this->adFormats['120x240_as']['height']  = 240;
-        $this->adFormatsList['120x240_as']        = $this->adFormats['120x240_as']['caption'];
-
-        $this->adFormats['336x280_as']['caption'] = '336 X 280 Large Rectangle';
-        $this->adFormats['336x280_as']['width']   = 136;
-        $this->adFormats['336x280_as']['height']  = 280;
-        $this->adFormatsList['336x280_as']        = $this->adFormats['336x280_as']['caption'];
-
-        $this->adFormats['300x250_as']['caption'] = '300 X 250 Medium Rectangle';
-        $this->adFormats['300x250_as']['width']   = 300;
-        $this->adFormats['300x250_as']['height']  = 250;
-        $this->adFormatsList['300x250_as']        = $this->adFormats['300x250_as']['caption'];
-
-        $this->adFormats['250x250_as']['caption'] = '250 X 250 Square';
-        $this->adFormats['250x250_as']['width']   = 250;
-        $this->adFormats['250x250_as']['height']  = 250;
-        $this->adFormatsList['250x250_as']        = $this->adFormats['250x250_as']['caption'];
-
-        $this->adFormats['200x200_as']['caption'] = '200 X 200 Small Square';
-        $this->adFormats['200x200_as']['width']   = 200;
-        $this->adFormats['200x200_as']['height']  = 200;
-        $this->adFormatsList['200x200_as']        = $this->adFormats['200x200_as']['caption'];
-
-        $this->adFormats['180x150_as']['caption'] = '180 X 150 Small Rectangle';
-        $this->adFormats['180x150_as']['width']   = 180;
-        $this->adFormats['180x150_as']['height']  = 150;
-        $this->adFormatsList['180x150_as']        = $this->adFormats['180x150_as']['caption'];
-
-        $this->adFormats['125x125_as']['caption'] = '125 X 125 Button';
-        $this->adFormats['125x125_as']['width']   = 125;
-        $this->adFormats['125x125_as']['height']  = 125;
-        $this->adFormatsList['125x125_as']        = $this->adFormats['125x125_as']['caption'];
-    }
-
-    /**
-     * @return array
-     */
-    public function getFormats()
-    {
-        return $this->adFormatsList;
-    }
-
-    /**
-     * @param $obj
-     * @return bool
-     */
-    public function beforeSave(&$obj)
-    {
-        if ($obj->getVar('tag') == '') {
-            $obj->setVar('tag', $title = $obj->generateTag());
-        }
-
-        return true;
-    }
-
-    /**
-     * @return array|bool
-     */
-    public function getAdsensesByTag()
-    {
-        if (!$this->objects) {
-            $adsensesObj = $this->getObjects(null, true);
-            $ret         = array();
-            foreach ($adsensesObj as $adsenseObj) {
-                $ret[$adsenseObj->getVar('tag')] = $adsenseObj;
-            }
-            $this->objects = $ret;
-        }
-
-        return $this->objects;
-    }
+	public $adFormats;
+	public $adFormatsList;
+	public $objects = false;
+
+	/**
+	 * SmartobjectAdsenseHandler constructor.
+	 * @param object|XoopsDatabase $db
+	 */
+	public function __construct($db)
+	{
+		parent::__construct($db, 'adsense', 'adsenseid', 'description', '', 'smartobject');
+		$this->adFormats     = array();
+		$this->adFormatsList = array();
+
+		$this->adFormats['728x90_as']['caption'] = '728 X 90 Leaderboard';
+		$this->adFormats['728x90_as']['width']   = 728;
+		$this->adFormats['728x90_as']['height']  = 90;
+		$this->adFormatsList['728x90_as']        = $this->adFormats['728x90_as']['caption'];
+
+		$this->adFormats['468x60_as']['caption'] = '468 X 60 Banner';
+		$this->adFormats['468x60_as']['width']   = 468;
+		$this->adFormats['468x60_as']['height']  = 60;
+		$this->adFormatsList['468x60_as']        = $this->adFormats['468x60_as']['caption'];
+
+		$this->adFormats['234x60_as']['caption'] = '234 X 60 Half Banner';
+		$this->adFormats['234x60_as']['width']   = 234;
+		$this->adFormats['234x60_as']['height']  = 60;
+		$this->adFormatsList['234x60_as']        = $this->adFormats['234x60_as']['caption'];
+
+		$this->adFormats['120x600_as']['caption'] = '120 X 600 Skyscraper';
+		$this->adFormats['120x600_as']['width']   = 120;
+		$this->adFormats['120x600_as']['height']  = 600;
+		$this->adFormatsList['120x600_as']        = $this->adFormats['120x600_as']['caption'];
+
+		$this->adFormats['160x600_as']['caption'] = '160 X 600 Wide Skyscraper';
+		$this->adFormats['160x600_as']['width']   = 160;
+		$this->adFormats['160x600_as']['height']  = 600;
+		$this->adFormatsList['160x600_as']        = $this->adFormats['160x600_as']['caption'];
+
+		$this->adFormats['120x240_as']['caption'] = '120 X 240 Vertical Banner';
+		$this->adFormats['120x240_as']['width']   = 120;
+		$this->adFormats['120x240_as']['height']  = 240;
+		$this->adFormatsList['120x240_as']        = $this->adFormats['120x240_as']['caption'];
+
+		$this->adFormats['336x280_as']['caption'] = '336 X 280 Large Rectangle';
+		$this->adFormats['336x280_as']['width']   = 136;
+		$this->adFormats['336x280_as']['height']  = 280;
+		$this->adFormatsList['336x280_as']        = $this->adFormats['336x280_as']['caption'];
+
+		$this->adFormats['300x250_as']['caption'] = '300 X 250 Medium Rectangle';
+		$this->adFormats['300x250_as']['width']   = 300;
+		$this->adFormats['300x250_as']['height']  = 250;
+		$this->adFormatsList['300x250_as']        = $this->adFormats['300x250_as']['caption'];
+
+		$this->adFormats['250x250_as']['caption'] = '250 X 250 Square';
+		$this->adFormats['250x250_as']['width']   = 250;
+		$this->adFormats['250x250_as']['height']  = 250;
+		$this->adFormatsList['250x250_as']        = $this->adFormats['250x250_as']['caption'];
+
+		$this->adFormats['200x200_as']['caption'] = '200 X 200 Small Square';
+		$this->adFormats['200x200_as']['width']   = 200;
+		$this->adFormats['200x200_as']['height']  = 200;
+		$this->adFormatsList['200x200_as']        = $this->adFormats['200x200_as']['caption'];
+
+		$this->adFormats['180x150_as']['caption'] = '180 X 150 Small Rectangle';
+		$this->adFormats['180x150_as']['width']   = 180;
+		$this->adFormats['180x150_as']['height']  = 150;
+		$this->adFormatsList['180x150_as']        = $this->adFormats['180x150_as']['caption'];
+
+		$this->adFormats['125x125_as']['caption'] = '125 X 125 Button';
+		$this->adFormats['125x125_as']['width']   = 125;
+		$this->adFormats['125x125_as']['height']  = 125;
+		$this->adFormatsList['125x125_as']        = $this->adFormats['125x125_as']['caption'];
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getFormats()
+	{
+		return $this->adFormatsList;
+	}
+
+	/**
+	 * @param $obj
+	 * @return bool
+	 */
+	public function beforeSave(&$obj)
+	{
+		if ($obj->getVar('tag') == '') {
+			$obj->setVar('tag', $title = $obj->generateTag());
+		}
+
+		return true;
+	}
+
+	/**
+	 * @return array|bool
+	 */
+	public function getAdsensesByTag()
+	{
+		if (!$this->objects) {
+			$adsensesObj = $this->getObjects(null, true);
+			$ret         = array();
+			foreach ($adsensesObj as $adsenseObj) {
+				$ret[$adsenseObj->getVar('tag')] = $adsenseObj;
+			}
+			$this->objects = $ret;
+		}
+
+		return $this->objects;
+	}
 }

class/customtag.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
     }
 
     /**
-     * @return mixed|string
+     * @return string
      */
     public function generateTag()
     {

Indentation +192 added lines, -192 removed lines

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

Spacing +1 added lines, -1 removed lines

@@ -221,7 +221,7 @@
             $criteria->add($criteria_language);
 
             $smartobjectPermissionsHandler = new SmartObjectPermissionHandler($this);
-            $granted_ids                     = $smartobjectPermissionsHandler->getGrantedItems('view');
+            $granted_ids = $smartobjectPermissionsHandler->getGrantedItems('view');
 
             if ($granted_ids && count($granted_ids) > 0) {
                 $criteria->add(new Criteria('customtagid', '(' . implode(', ', $granted_ids) . ')', 'IN'));

class/form/elements/smartformuploadelement.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +18 added lines, -18 removed lines

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

class/form/smartobjectform.php

Doc Comments +2 added lines, -2 removed lines

@@ -306,8 +306,8 @@
     }
 
     /**
-     * @param      $form_name
-     * @param      $form_caption
+     * @param      string $form_name
+     * @param      string $form_caption
      * @param bool $submit_button_caption
      */
     public function createButtons($form_name, $form_caption, $submit_button_caption = false)

Indentation +782 added lines, -782 removed lines

@@ -30,776 +30,776 @@ 
  */
 class SmartObjectForm extends XoopsThemeForm
 {
-    public $targetObject           = null;
-    public $form_fields            = null;
-    public $_cancel_js_action      = false;
-    public $_custom_button         = false;
-    public $_captcha               = false;
-    public $_form_name             = false;
-    public $_form_caption          = false;
-    public $_submit_button_caption = false;
-
-    /**
-     * SmartobjectForm constructor.
-     * @param string $target
-     * @param string $form_name
-     * @param string $form_caption
-     * @param string $form_action
-     * @param null   $form_fields
-     * @param bool   $submit_button_caption
-     * @param bool   $cancel_js_action
-     * @param bool   $captcha
-     */
-    public function __construct(&$target, $form_name, $form_caption, $form_action, $form_fields = null, $submit_button_caption = false, $cancel_js_action = false, $captcha = false)
-    {
-        $this->targetObject           =& $target;
-        $this->form_fields            = $form_fields;
-        $this->_cancel_js_action      = $cancel_js_action;
-        $this->_captcha               = $captcha;
-        $this->_form_name             = $form_name;
-        $this->_form_caption          = $form_caption;
-        $this->_submit_button_caption = $submit_button_caption;
-
-        if (!isset($form_action)) {
-            $form_action = xoops_getenv('PHP_SELF');
-        }
-
-        $this->XoopsForm($form_caption, $form_name, $form_action);
-        $this->setExtra('enctype="multipart/form-data"');
-
-        $this->createElements();
-
-        if ($captcha) {
-            $this->addCaptcha();
-        }
-
-        $this->createPermissionControls();
-
-        $this->createButtons($form_name, $form_caption, $submit_button_caption);
-    }
-
-    public function addCaptcha()
-    {
-        include_once(SMARTOBJECT_ROOT_PATH . 'include/captcha/formcaptcha.php');
-        $this->addElement(new XoopsFormCaptcha(), true);
-    }
-
-    /**
-     * @param      $name
-     * @param      $caption
-     * @param bool $onclick
-     */
-    public function addCustomButton($name, $caption, $onclick = false)
-    {
-        $custom_button_array    = array(
-            'name'    => $name,
-            'caption' => $caption,
-            'onclick' => $onclick
-        );
-        $this->_custom_button[] = $custom_button_array;
-    }
-
-    /**
-     * Add an element to the form
-     *
-     * @param object      &$formElement reference to a {@link XoopsFormElement}
-     * @param bool        $key
-     * @param bool        $var
-     * @param bool|string $required     is this a "required" element?
-     */
-    public function addElement(&$formElement, $key = false, $var = false, $required = 'notset')
-    {
-        if ($key) {
-            if ($this->targetObject->vars[$key]['readonly']) {
-                $formElement->setExtra('disabled="disabled"');
-                $formElement->setName($key . '-readonly');
-                // Since this element is disable, we still want to pass it's value in the form
-                $hidden = new XoopsFormHidden($key, $this->targetObject->vars[$key]['value']);
-                $this->addElement($hidden);
-            }
-            $formElement->setDescription($var['form_dsc']);
-            if (isset($this->targetObject->controls[$key]['onSelect'])) {
-                $hidden = new XoopsFormHidden('changedField', false);
-                $this->addElement($hidden);
-                $otherExtra      = isset($var['form_extra']) ? $var['form_extra'] : '';
-                $onchangedString = "this.form.elements.changedField.value='$key'; this.form.elements.op.value='changedField'; submit()";
-                $formElement->setExtra('onchange="' . $onchangedString . '"' . ' ' . $otherExtra);
-            } else {
-                if (isset($var['form_extra'])) {
-                    $formElement->setExtra($var['form_extra']);
-                }
-            }
-            $controls = $this->targetObject->controls;
-            if (isset($controls[$key]['js'])) {
-                $formElement->customValidationCode[] = $controls[$key]['js'];
-            }
-            parent::addElement($formElement, $required === 'notset' ? $var['required'] : $required);
-        } else {
-            parent::addElement($formElement, $required === 'notset' ? false : true);
-        }
-        unset($formElement);
-    }
-
-    public function createElements()
-    {
-        $controls = $this->targetObject->controls;
-        $vars     = $this->targetObject->vars;
-        foreach ($vars as $key => $var) {
-
-            // If $displayOnForm is false OR this is the primary key, it doesn't
-            // need to be displayed, then we only create an hidden field
-            if ($key == $this->targetObject->handler->keyName || !$var['displayOnForm']) {
-                $elementToAdd = new XoopsFormHidden($key, $var['value']);
-                $this->addElement($elementToAdd, $key, $var, false);
-                unset($elementToAdd);
-                // If not, the we need to create the proper form control for this fields
-            } else {
-                // If this field has a specific control, we will use it
-
-                if ($key === 'parentid') {
-                    /**
-                     * Why this ?
-                     */
-                }
-                if (isset($controls[$key])) {
-                    /* If the control has name, it's because it's an object already present in the script
+	public $targetObject           = null;
+	public $form_fields            = null;
+	public $_cancel_js_action      = false;
+	public $_custom_button         = false;
+	public $_captcha               = false;
+	public $_form_name             = false;
+	public $_form_caption          = false;
+	public $_submit_button_caption = false;
+
+	/**
+	 * SmartobjectForm constructor.
+	 * @param string $target
+	 * @param string $form_name
+	 * @param string $form_caption
+	 * @param string $form_action
+	 * @param null   $form_fields
+	 * @param bool   $submit_button_caption
+	 * @param bool   $cancel_js_action
+	 * @param bool   $captcha
+	 */
+	public function __construct(&$target, $form_name, $form_caption, $form_action, $form_fields = null, $submit_button_caption = false, $cancel_js_action = false, $captcha = false)
+	{
+		$this->targetObject           =& $target;
+		$this->form_fields            = $form_fields;
+		$this->_cancel_js_action      = $cancel_js_action;
+		$this->_captcha               = $captcha;
+		$this->_form_name             = $form_name;
+		$this->_form_caption          = $form_caption;
+		$this->_submit_button_caption = $submit_button_caption;
+
+		if (!isset($form_action)) {
+			$form_action = xoops_getenv('PHP_SELF');
+		}
+
+		$this->XoopsForm($form_caption, $form_name, $form_action);
+		$this->setExtra('enctype="multipart/form-data"');
+
+		$this->createElements();
+
+		if ($captcha) {
+			$this->addCaptcha();
+		}
+
+		$this->createPermissionControls();
+
+		$this->createButtons($form_name, $form_caption, $submit_button_caption);
+	}
+
+	public function addCaptcha()
+	{
+		include_once(SMARTOBJECT_ROOT_PATH . 'include/captcha/formcaptcha.php');
+		$this->addElement(new XoopsFormCaptcha(), true);
+	}
+
+	/**
+	 * @param      $name
+	 * @param      $caption
+	 * @param bool $onclick
+	 */
+	public function addCustomButton($name, $caption, $onclick = false)
+	{
+		$custom_button_array    = array(
+			'name'    => $name,
+			'caption' => $caption,
+			'onclick' => $onclick
+		);
+		$this->_custom_button[] = $custom_button_array;
+	}
+
+	/**
+	 * Add an element to the form
+	 *
+	 * @param object      &$formElement reference to a {@link XoopsFormElement}
+	 * @param bool        $key
+	 * @param bool        $var
+	 * @param bool|string $required     is this a "required" element?
+	 */
+	public function addElement(&$formElement, $key = false, $var = false, $required = 'notset')
+	{
+		if ($key) {
+			if ($this->targetObject->vars[$key]['readonly']) {
+				$formElement->setExtra('disabled="disabled"');
+				$formElement->setName($key . '-readonly');
+				// Since this element is disable, we still want to pass it's value in the form
+				$hidden = new XoopsFormHidden($key, $this->targetObject->vars[$key]['value']);
+				$this->addElement($hidden);
+			}
+			$formElement->setDescription($var['form_dsc']);
+			if (isset($this->targetObject->controls[$key]['onSelect'])) {
+				$hidden = new XoopsFormHidden('changedField', false);
+				$this->addElement($hidden);
+				$otherExtra      = isset($var['form_extra']) ? $var['form_extra'] : '';
+				$onchangedString = "this.form.elements.changedField.value='$key'; this.form.elements.op.value='changedField'; submit()";
+				$formElement->setExtra('onchange="' . $onchangedString . '"' . ' ' . $otherExtra);
+			} else {
+				if (isset($var['form_extra'])) {
+					$formElement->setExtra($var['form_extra']);
+				}
+			}
+			$controls = $this->targetObject->controls;
+			if (isset($controls[$key]['js'])) {
+				$formElement->customValidationCode[] = $controls[$key]['js'];
+			}
+			parent::addElement($formElement, $required === 'notset' ? $var['required'] : $required);
+		} else {
+			parent::addElement($formElement, $required === 'notset' ? false : true);
+		}
+		unset($formElement);
+	}
+
+	public function createElements()
+	{
+		$controls = $this->targetObject->controls;
+		$vars     = $this->targetObject->vars;
+		foreach ($vars as $key => $var) {
+
+			// If $displayOnForm is false OR this is the primary key, it doesn't
+			// need to be displayed, then we only create an hidden field
+			if ($key == $this->targetObject->handler->keyName || !$var['displayOnForm']) {
+				$elementToAdd = new XoopsFormHidden($key, $var['value']);
+				$this->addElement($elementToAdd, $key, $var, false);
+				unset($elementToAdd);
+				// If not, the we need to create the proper form control for this fields
+			} else {
+				// If this field has a specific control, we will use it
+
+				if ($key === 'parentid') {
+					/**
+					 * Why this ?
+					 */
+				}
+				if (isset($controls[$key])) {
+					/* If the control has name, it's because it's an object already present in the script
                      * for example, "user"
                      * If the field does not have a name, than we will use a "select" (ie XoopsFormSelect)
                      */
-                    if (!isset($controls[$key]['name']) || !$controls[$key]['name']) {
-                        $controls[$key]['name'] = 'select';
-                    }
-
-                    $form_select = $this->getControl($controls[$key]['name'], $key);
-
-                    // Adding on the form, the control for this field
-                    $this->addElement($form_select, $key, $var);
-                    unset($form_select);
-
-                    // If this field don't have a specific control, we will use the standard one, depending on its data type
-                } else {
-                    switch ($var['data_type']) {
-
-                        case XOBJ_DTYPE_TXTBOX:
-
-                            $form_text = $this->getControl('text', $key);
-                            $this->addElement($form_text, $key, $var);
-                            unset($form_text);
-                            break;
-
-                        case XOBJ_DTYPE_INT:
-                            $this->targetObject->setControl($key, array(
-                                'name' => 'text',
-                                'size' => '5'
-                            ));
-                            $form_text = $this->getControl('text', $key);
-                            $this->addElement($form_text, $key, $var);
-                            unset($form_text);
-                            break;
-
-                        case XOBJ_DTYPE_FLOAT:
-                            $this->targetObject->setControl($key, array(
-                                'name' => 'text',
-                                'size' => '5'
-                            ));
-                            $form_text = $this->getControl('text', $key);
-                            $this->addElement($form_text, $key, $var);
-                            unset($form_text);
-                            break;
-
-                        case XOBJ_DTYPE_LTIME:
-                            $form_date_time = $this->getControl('date_time', $key);
-                            $this->addElement($form_date_time, $key, $var);
-                            unset($form_date_time);
-                            break;
-
-                        case XOBJ_DTYPE_STIME:
-                            $form_date_time = $this->getControl('date', $key);
-                            $this->addElement($form_date_time, $key, $var);
-                            unset($form_date_time);
-                            break;
-
-                        case XOBJ_DTYPE_TIME_ONLY:
-                            $form_time = $this->getControl('time', $key);
-                            $this->addElement($form_time, $key, $var);
-                            unset($form_time);
-                            break;
-
-                        case XOBJ_DTYPE_CURRENCY:
-                            $this->targetObject->setControl($key, array(
-                                'name' => 'text',
-                                'size' => '15'
-                            ));
-                            $form_currency = $this->getControl('text', $key);
-                            $this->addElement($form_currency, $key, $var);
-                            unset($form_currency);
-                            break;
-
-                        case XOBJ_DTYPE_URLLINK:
-                            $form_urllink = $this->getControl('urllink', $key);
-                            $this->addElement($form_urllink, $key, $var);
-                            unset($form_urllink);
-                            break;
-
-                        case XOBJ_DTYPE_FILE:
-                            $form_file = $this->getControl('richfile', $key);
-                            $this->addElement($form_file, $key, $var);
-                            unset($form_file);
-                            break;
-
-                        case XOBJ_DTYPE_TXTAREA:
-
-                            $form_text_area = $this->getTextArea($key, $var);
-                            $this->addElement($form_text_area, $key, $var);
-                            unset($form_text_area);
-                            break;
-
-                        case XOBJ_DTYPE_ARRAY:
-                            // TODO: To come...
-                            break;
-                        case XOBJ_DTYPE_SOURCE:
-                            // TODO: To come...
-                            break;
-                        case XOBJ_DTYPE_FORM_SECTION:
-                            $section_control = new SmartFormSection($key, $var['value']);
-                            $this->addElement($section_control, $key, $var);
-                            unset($section_control);
-                            break;
-                        case XOBJ_DTYPE_FORM_SECTION_CLOSE:
-                            $section_control = new SmartFormSectionClose($key, $var['value']);
-                            $this->addElement($section_control, $key, $var);
-                            unset($section_control);
-                            break;
-                    }
-                }
-            }
-        }
-        // Add an hidden field to store the URL of the page before this form
-        $this->addElement(new XoopsFormHidden('smart_page_before_form', smart_get_page_before_form()));
-    }
-
-    public function createPermissionControls()
-    {
-        $smartModuleConfig = $this->targetObject->handler->getModuleConfig();
-
-        $permissions = $this->targetObject->handler->getPermissions();
-
-        if ($permissions) {
-            $memberHandler = xoops_getHandler('member');
-            $group_list     = $memberHandler->getGroupList();
-            asort($group_list);
-            foreach ($permissions as $permission) {
-                if ($this->targetObject->isNew()) {
-                    if (isset($smartModuleConfig['def_perm_' . $permission['perm_name']])) {
-                        $groups_value = $smartModuleConfig['def_perm_' . $permission['perm_name']];
-                    }
-                } else {
-                    $groups_value = $this->targetObject->getGroupPerm($permission['perm_name']);
-                }
-                $groups_select = new XoopsFormSelect($permission['caption'], $permission['perm_name'], $groups_value, 4, true);
-                $groups_select->setDescription($permission['description']);
-                $groups_select->addOptionArray($group_list);
-                $this->addElement($groups_select);
-                unset($groups_select);
-            }
-        }
-    }
-
-    /**
-     * @param      $form_name
-     * @param      $form_caption
-     * @param bool $submit_button_caption
-     */
-    public function createButtons($form_name, $form_caption, $submit_button_caption = false)
-    {
-        $button_tray = new XoopsFormElementTray('', '');
-        $button_tray->addElement(new XoopsFormHidden('op', $form_name));
-        if (!$submit_button_caption) {
-            if ($this->targetObject->isNew()) {
-                $butt_create = new XoopsFormButton('', 'create_button', _CO_SOBJECT_CREATE, 'submit');
-            } else {
-                $butt_create = new XoopsFormButton('', 'modify_button', _CO_SOBJECT_MODIFY, 'submit');
-            }
-        } else {
-            $butt_create = new XoopsFormButton('', 'modify_button', $submit_button_caption, 'submit');
-        }
-        $butt_create->setExtra('onclick="this.form.elements.op.value=\'' . $form_name . '\'"');
-        $button_tray->addElement($butt_create);
-
-        //creating custom buttons
-        if ($this->_custom_button) {
-            foreach ($this->_custom_button as $custom_button) {
-                $butt_custom = new XoopsFormButton('', $custom_button['name'], $custom_button['caption'], 'submit');
-                if ($custom_button['onclick']) {
-                    $butt_custom->setExtra('onclick="' . $custom_button['onclick'] . '"');
-                }
-                $button_tray->addElement($butt_custom);
-                unset($butt_custom);
-            }
-        }
-
-        // creating the "cancel" button
-        $butt_cancel = new XoopsFormButton('', 'cancel_button', _CO_SOBJECT_CANCEL, 'button');
-        if ($this->_cancel_js_action) {
-            $butt_cancel->setExtra('onclick="' . $this->_cancel_js_action . '"');
-        } else {
-            $butt_cancel->setExtra('onclick="history.go(-1)"');
-        }
-        $button_tray->addElement($butt_cancel);
-
-        $this->addElement($button_tray);
-    }
-
-    /**
-     * @param $controlName
-     * @param $key
-     * @return XoopsFormLabel
-     */
-    public function getControl($controlName, $key)
-    {
-        switch ($controlName) {
-            case 'check':
-                include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformcheckelement.php');
-                $control    = $this->targetObject->getControl($key);
-                $controlObj = new SmartFormCheckElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
-                $controlObj->addOptionArray($control['options']);
-
-                return $controlObj;
-                break;
-
-            case 'color':
-                $control    = $this->targetObject->getControl($key);
-                $controlObj = new XoopsFormColorPicker($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
-
-                return $controlObj;
-                break;
-
-            case 'radio':
-                $control = $this->targetObject->getControl($key);
-
-                $controlObj = new XoopsFormRadio($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
-                $controlObj->addOptionArray($control['options']);
-
-                return $controlObj;
-                break;
-
-            case 'label':
-                return new XoopsFormLabel($this->targetObject->vars[$key]['form_caption'], $this->targetObject->getVar($key));
-                break;
-
-            case 'textarea':
-                return $this->getTextArea($key);
-
-            case 'theme':
-                return $this->getThemeSelect($key, $this->targetObject->vars[$key]);
-
-            case 'theme_multi':
-                return $this->getThemeSelect($key, $this->targetObject->vars[$key], true);
-                break;
-
-            case 'timezone':
-                return new XoopsFormSelectTimezone($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
-                break;
-
-            case 'group':
-                return new XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 1, false);
-                break;
-
-            case 'group_multi':
-                return new XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true);
-                break;
-
-            /*case 'user':
+					if (!isset($controls[$key]['name']) || !$controls[$key]['name']) {
+						$controls[$key]['name'] = 'select';
+					}
+
+					$form_select = $this->getControl($controls[$key]['name'], $key);
+
+					// Adding on the form, the control for this field
+					$this->addElement($form_select, $key, $var);
+					unset($form_select);
+
+					// If this field don't have a specific control, we will use the standard one, depending on its data type
+				} else {
+					switch ($var['data_type']) {
+
+						case XOBJ_DTYPE_TXTBOX:
+
+							$form_text = $this->getControl('text', $key);
+							$this->addElement($form_text, $key, $var);
+							unset($form_text);
+							break;
+
+						case XOBJ_DTYPE_INT:
+							$this->targetObject->setControl($key, array(
+								'name' => 'text',
+								'size' => '5'
+							));
+							$form_text = $this->getControl('text', $key);
+							$this->addElement($form_text, $key, $var);
+							unset($form_text);
+							break;
+
+						case XOBJ_DTYPE_FLOAT:
+							$this->targetObject->setControl($key, array(
+								'name' => 'text',
+								'size' => '5'
+							));
+							$form_text = $this->getControl('text', $key);
+							$this->addElement($form_text, $key, $var);
+							unset($form_text);
+							break;
+
+						case XOBJ_DTYPE_LTIME:
+							$form_date_time = $this->getControl('date_time', $key);
+							$this->addElement($form_date_time, $key, $var);
+							unset($form_date_time);
+							break;
+
+						case XOBJ_DTYPE_STIME:
+							$form_date_time = $this->getControl('date', $key);
+							$this->addElement($form_date_time, $key, $var);
+							unset($form_date_time);
+							break;
+
+						case XOBJ_DTYPE_TIME_ONLY:
+							$form_time = $this->getControl('time', $key);
+							$this->addElement($form_time, $key, $var);
+							unset($form_time);
+							break;
+
+						case XOBJ_DTYPE_CURRENCY:
+							$this->targetObject->setControl($key, array(
+								'name' => 'text',
+								'size' => '15'
+							));
+							$form_currency = $this->getControl('text', $key);
+							$this->addElement($form_currency, $key, $var);
+							unset($form_currency);
+							break;
+
+						case XOBJ_DTYPE_URLLINK:
+							$form_urllink = $this->getControl('urllink', $key);
+							$this->addElement($form_urllink, $key, $var);
+							unset($form_urllink);
+							break;
+
+						case XOBJ_DTYPE_FILE:
+							$form_file = $this->getControl('richfile', $key);
+							$this->addElement($form_file, $key, $var);
+							unset($form_file);
+							break;
+
+						case XOBJ_DTYPE_TXTAREA:
+
+							$form_text_area = $this->getTextArea($key, $var);
+							$this->addElement($form_text_area, $key, $var);
+							unset($form_text_area);
+							break;
+
+						case XOBJ_DTYPE_ARRAY:
+							// TODO: To come...
+							break;
+						case XOBJ_DTYPE_SOURCE:
+							// TODO: To come...
+							break;
+						case XOBJ_DTYPE_FORM_SECTION:
+							$section_control = new SmartFormSection($key, $var['value']);
+							$this->addElement($section_control, $key, $var);
+							unset($section_control);
+							break;
+						case XOBJ_DTYPE_FORM_SECTION_CLOSE:
+							$section_control = new SmartFormSectionClose($key, $var['value']);
+							$this->addElement($section_control, $key, $var);
+							unset($section_control);
+							break;
+					}
+				}
+			}
+		}
+		// Add an hidden field to store the URL of the page before this form
+		$this->addElement(new XoopsFormHidden('smart_page_before_form', smart_get_page_before_form()));
+	}
+
+	public function createPermissionControls()
+	{
+		$smartModuleConfig = $this->targetObject->handler->getModuleConfig();
+
+		$permissions = $this->targetObject->handler->getPermissions();
+
+		if ($permissions) {
+			$memberHandler = xoops_getHandler('member');
+			$group_list     = $memberHandler->getGroupList();
+			asort($group_list);
+			foreach ($permissions as $permission) {
+				if ($this->targetObject->isNew()) {
+					if (isset($smartModuleConfig['def_perm_' . $permission['perm_name']])) {
+						$groups_value = $smartModuleConfig['def_perm_' . $permission['perm_name']];
+					}
+				} else {
+					$groups_value = $this->targetObject->getGroupPerm($permission['perm_name']);
+				}
+				$groups_select = new XoopsFormSelect($permission['caption'], $permission['perm_name'], $groups_value, 4, true);
+				$groups_select->setDescription($permission['description']);
+				$groups_select->addOptionArray($group_list);
+				$this->addElement($groups_select);
+				unset($groups_select);
+			}
+		}
+	}
+
+	/**
+	 * @param      $form_name
+	 * @param      $form_caption
+	 * @param bool $submit_button_caption
+	 */
+	public function createButtons($form_name, $form_caption, $submit_button_caption = false)
+	{
+		$button_tray = new XoopsFormElementTray('', '');
+		$button_tray->addElement(new XoopsFormHidden('op', $form_name));
+		if (!$submit_button_caption) {
+			if ($this->targetObject->isNew()) {
+				$butt_create = new XoopsFormButton('', 'create_button', _CO_SOBJECT_CREATE, 'submit');
+			} else {
+				$butt_create = new XoopsFormButton('', 'modify_button', _CO_SOBJECT_MODIFY, 'submit');
+			}
+		} else {
+			$butt_create = new XoopsFormButton('', 'modify_button', $submit_button_caption, 'submit');
+		}
+		$butt_create->setExtra('onclick="this.form.elements.op.value=\'' . $form_name . '\'"');
+		$button_tray->addElement($butt_create);
+
+		//creating custom buttons
+		if ($this->_custom_button) {
+			foreach ($this->_custom_button as $custom_button) {
+				$butt_custom = new XoopsFormButton('', $custom_button['name'], $custom_button['caption'], 'submit');
+				if ($custom_button['onclick']) {
+					$butt_custom->setExtra('onclick="' . $custom_button['onclick'] . '"');
+				}
+				$button_tray->addElement($butt_custom);
+				unset($butt_custom);
+			}
+		}
+
+		// creating the "cancel" button
+		$butt_cancel = new XoopsFormButton('', 'cancel_button', _CO_SOBJECT_CANCEL, 'button');
+		if ($this->_cancel_js_action) {
+			$butt_cancel->setExtra('onclick="' . $this->_cancel_js_action . '"');
+		} else {
+			$butt_cancel->setExtra('onclick="history.go(-1)"');
+		}
+		$button_tray->addElement($butt_cancel);
+
+		$this->addElement($button_tray);
+	}
+
+	/**
+	 * @param $controlName
+	 * @param $key
+	 * @return XoopsFormLabel
+	 */
+	public function getControl($controlName, $key)
+	{
+		switch ($controlName) {
+			case 'check':
+				include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformcheckelement.php');
+				$control    = $this->targetObject->getControl($key);
+				$controlObj = new SmartFormCheckElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
+				$controlObj->addOptionArray($control['options']);
+
+				return $controlObj;
+				break;
+
+			case 'color':
+				$control    = $this->targetObject->getControl($key);
+				$controlObj = new XoopsFormColorPicker($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
+
+				return $controlObj;
+				break;
+
+			case 'radio':
+				$control = $this->targetObject->getControl($key);
+
+				$controlObj = new XoopsFormRadio($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
+				$controlObj->addOptionArray($control['options']);
+
+				return $controlObj;
+				break;
+
+			case 'label':
+				return new XoopsFormLabel($this->targetObject->vars[$key]['form_caption'], $this->targetObject->getVar($key));
+				break;
+
+			case 'textarea':
+				return $this->getTextArea($key);
+
+			case 'theme':
+				return $this->getThemeSelect($key, $this->targetObject->vars[$key]);
+
+			case 'theme_multi':
+				return $this->getThemeSelect($key, $this->targetObject->vars[$key], true);
+				break;
+
+			case 'timezone':
+				return new XoopsFormSelectTimezone($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
+				break;
+
+			case 'group':
+				return new XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 1, false);
+				break;
+
+			case 'group_multi':
+				return new XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true);
+				break;
+
+			/*case 'user':
              return new XoopsFormSelectUser($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 1, false);
              break;*/
 
-            case 'user_multi':
-                return new XoopsFormSelectUser($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true);
-                break;
-
-            case 'password':
-                return new XoopsFormPassword($this->targetObject->vars[$key]['form_caption'], $key, 50, 255, $this->targetObject->getVar($key, 'e'));
-                break;
-
-            case 'country':
-                return new XoopsFormSelectCountry($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key, 'e'));
-                break;
-
-            case 'urllink':
-                include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformurllinkelement.php');
-
-                return new SmartFormUrlLinkElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getUrlLinkObj($key));
-                break;
-
-            case 'richfile':
-                include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformrichfileelement.php');
-
-                return new SmartFormRichFileElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getFileObj($key));
-                break;
-            case 'section':
-                include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsection.php');
-
-                return new SmartFormSection($key, $this->targetObject->vars[$key]['form_caption']);
-                break;
-
-            default:
-                $classname = 'SmartForm' . ucfirst($controlName) . 'Element';
-                if (!class_exists($classname)) {
-                    if (file_exists(SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php')) {
-                        include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php');
-                    } else {
-                        // perhaps this is a control created by the module
-                        $moduleName             = $this->targetObject->handler->_moduleName;
-                        $moduleFormElementsPath = $this->targetObject->handler->_modulePath . 'class/form/elements/';
-                        $classname              = ucfirst($moduleName) . ucfirst($controlName) . 'Element';
-                        $classFileName          = strtolower($classname) . '.php';
-
-                        if (file_exists($moduleFormElementsPath . $classFileName)) {
-                            include_once($moduleFormElementsPath . $classFileName);
-                        } else {
-                            trigger_error($classname . ' Not found', E_USER_WARNING);
-
-                            return new XoopsFormLabel(); //Empty object
-                        }
-                    }
-                }
-
-                return new $classname($this->targetObject, $key);
-                break;
-        }
-    }
-
-    /**
-     * @param $key
-     * @return XoopsFormDhtmlTextArea|XoopsFormEditor|XoopsFormFckeditor|XoopsFormTextArea|XoopsFormTinyTextArea
-     */
-    public function getTextArea($key)
-    {
-        $var = $this->targetObject->vars[$key];
-
-        // if no control has been created, let's create a default one
-        if (!isset($this->targetObject->controls[$key])) {
-            $control = array(
-                'name'        => 'textarea',
-                'itemHandler' => false,
-                'method'      => false,
-                'module'      => false,
-                'form_editor' => 'default'
-            );
-        } else {
-            $control = $this->targetObject->controls[$key];
-        }
-        $xoops22 = smart_isXoops22();
-
-        $form_editor = isset($control['form_editor']) ? $control['form_editor'] : 'textarea';
-        /**
-         * If the editor is 'default', retreive the default editor of this module
-         */
-        if ($form_editor === 'default') {
-            global $xoopsModuleConfig;
-            $form_editor = isset($xoopsModuleConfig['default_editor']) ? $xoopsModuleConfig['default_editor'] : 'textarea';
-        }
-
-        $caption = $var['form_caption'];
-        $name    = $key;
-
-        $value = $this->targetObject->getVar($key);
-
-        $value = $this->targetObject->getValueFor($key, true);
-
-        $editor_configs          = array();
-        $editor_configs['name']  = $name;
-        $editor_configs['value'] = $value;
-        if ($form_editor !== 'textarea') {
-            $editor_configs['rows'] = 35;
-            $editor_configs['cols'] = 60;
-        }
-
-        if (isset($control['rows'])) {
-            $editor_configs['rows'] = $control['rows'];
-        }
-        if (isset($control['cols'])) {
-            $editor_configs['cols'] = $control['cols'];
-        }
-
-        $editor_configs['width']  = '100%';
-        $editor_configs['height'] = '400px';
-
-        $dhtml            = true;
-        $xoopseditorclass = XOOPS_ROOT_PATH . '/class/xoopsform/formeditor.php';
-
-        if (file_exists($xoopseditorclass)) {
-            include_once($xoopseditorclass);
-            $editor = new XoopsFormEditor($caption, $form_editor, $editor_configs, $nohtml = false, $onfailure = 'textarea');
-        } else {
-            switch ($form_editor) {
-
-                case 'tiny':
-                    if (!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php')) {
-                            include_once(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php');
-                            $editor = new XoopsFormTinyTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '300px'), true);
-                        } else {
-                            if ($dhtml) {
-                                $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
-                            } else {
-                                $editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
-                            }
-                        }
-                    } else {
-                        $editor = new XoopsFormEditor($caption, 'tinyeditor', $editor_configs);
-                    }
-                    break;
-
-                case 'dhtmltextarea':
-                case 'dhtmltext':
-                    $editor = new XoopsFormDhtmlTextArea($var['form_caption'], $key, $this->targetObject->getVar($key, 'e'), 20, 60);
-                    if ($var['form_dsc']) {
-                        $editor->setDescription($var['form_dsc']);
-                    }
-                    break;
-
-                case 'fckeditor':
-                    if (!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/fckeditor/formfckeditor.php')) {
-                            include_once(XOOPS_ROOT_PATH . '/class/xoopseditor/fckeditor/formfckeditor.php');
-                            $editor = new XoopsFormFckeditor(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '300px'), true);
-                        } else {
-                            if ($dhtml) {
-                                $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
-                            } else {
-                                $editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
-                            }
-                        }
-                    } else {
-                        $editor = new XoopsFormEditor($caption, 'fckeditor', $editor_configs);
-                    }
-                    break;
-
-                case 'inbetween':
-                    if (!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/inbetween/forminbetweentextarea.php')) {
-                            include_once(XOOPS_ROOT_PATH . '/class/xoopseditor/inbetween/forminbetweentextarea.php');
-                            $editor = new XoopsFormInbetweenTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '300px'), true);
-                        } else {
-                            if ($dhtml) {
-                                $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
-                            } else {
-                                $editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
-                            }
-                        }
-                    } else {
-                        $editor = new XoopsFormEditor($caption, 'inbetween', $editor_configs);
-                    }
-                    break;
-
-                case 'koivi':
-                    if (!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
-                            include_once(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php');
-                            $editor = new XoopsFormWysiwygTextArea($caption, $name, $value, '100%', '400px');
-                        } else {
-                            if ($dhtml) {
-                                $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
-                            } else {
-                                $editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
-                            }
-                        }
-                    } else {
-                        $editor = new XoopsFormEditor($caption, 'koivi', $editor_configs);
-                    }
-                    break;
-
-                case 'spaw':
-                    if (!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . '/class/spaw/formspaw.php')) {
-                            include_once(XOOPS_ROOT_PATH . '/class/spaw/formspaw.php');
-                            $editor = new XoopsFormSpaw($caption, $name, $value);
-                        }
-                    } else {
-                        $editor = new XoopsFormEditor($caption, 'spaw', $editor_configs);
-                    }
-                    break;
-
-                case 'htmlarea':
-                    if (!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
-                            include_once(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php');
-                            $editor = new XoopsFormHtmlarea($caption, $name, $value);
-                        }
-                    } else {
-                        $editor = new XoopsFormEditor($caption, 'htmlarea', $editor_configs);
-                    }
-                    break;
-
-                default:
-                case 'textarea':
-                    $form_rows = isset($control['rows']) ? $control['rows'] : 5;
-                    $form_cols = isset($control['cols']) ? $control['cols'] : 60;
-
-                    $editor = new XoopsFormTextArea($var['form_caption'], $key, $this->targetObject->getVar($key, 'e'), $form_rows, $form_cols);
-                    if ($var['form_dsc']) {
-                        $editor->setDescription($var['form_dsc']);
-                    }
-                    break;
-
-            }
-        }
-
-        return $editor;
-    }
-
-    /**
-     * @param       $key
-     * @param       $var
-     * @param  bool $multiple
-     * @return XoopsFormSelect
-     */
-    public function getThemeSelect($key, $var, $multiple = false)
-    {
-        $size         = $multiple ? 5 : 1;
-        $theme_select = new XoopsFormSelect($var['form_caption'], $key, $this->targetObject->getVar($key), $size, $multiple);
-
-        $handle  = opendir(XOOPS_THEME_PATH . '/');
-        $dirlist = array();
-        while (false !== ($file = readdir($handle))) {
-            if (is_dir(XOOPS_THEME_PATH . '/' . $file) && !preg_match("/^[.]{1,2}$/", $file) && strtolower($file) !== 'cvs') {
-                $dirlist[$file] = $file;
-            }
-        }
-        closedir($handle);
-        if (!empty($dirlist)) {
-            asort($dirlist);
-            $theme_select->addOptionArray($dirlist);
-        }
-
-        return $theme_select;
-    }
-
-    /**
-     * @param $keyname
-     * @return bool
-     */
-    public function &getElementById($keyname)
-    {
-        foreach ($this->_elements as $eleObj) {
-            if ($eleObj->getName() == $keyname) {
-                $ret =& $eleObj;
-                break;
-            }
-        }
-
-        return isset($ret) ? $ret : false;
-    }
-
-    /**
-     * create HTML to output the form as a theme-enabled table with validation.
-     *
-     * @return string
-     */
-    public function render()
-    {
-        $required = $this->getRequired();
-        $ret      = "
+			case 'user_multi':
+				return new XoopsFormSelectUser($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true);
+				break;
+
+			case 'password':
+				return new XoopsFormPassword($this->targetObject->vars[$key]['form_caption'], $key, 50, 255, $this->targetObject->getVar($key, 'e'));
+				break;
+
+			case 'country':
+				return new XoopsFormSelectCountry($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key, 'e'));
+				break;
+
+			case 'urllink':
+				include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformurllinkelement.php');
+
+				return new SmartFormUrlLinkElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getUrlLinkObj($key));
+				break;
+
+			case 'richfile':
+				include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformrichfileelement.php');
+
+				return new SmartFormRichFileElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getFileObj($key));
+				break;
+			case 'section':
+				include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsection.php');
+
+				return new SmartFormSection($key, $this->targetObject->vars[$key]['form_caption']);
+				break;
+
+			default:
+				$classname = 'SmartForm' . ucfirst($controlName) . 'Element';
+				if (!class_exists($classname)) {
+					if (file_exists(SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php')) {
+						include_once(SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php');
+					} else {
+						// perhaps this is a control created by the module
+						$moduleName             = $this->targetObject->handler->_moduleName;
+						$moduleFormElementsPath = $this->targetObject->handler->_modulePath . 'class/form/elements/';
+						$classname              = ucfirst($moduleName) . ucfirst($controlName) . 'Element';
+						$classFileName          = strtolower($classname) . '.php';
+
+						if (file_exists($moduleFormElementsPath . $classFileName)) {
+							include_once($moduleFormElementsPath . $classFileName);
+						} else {
+							trigger_error($classname . ' Not found', E_USER_WARNING);
+
+							return new XoopsFormLabel(); //Empty object
+						}
+					}
+				}
+
+				return new $classname($this->targetObject, $key);
+				break;
+		}
+	}
+
+	/**
+	 * @param $key
+	 * @return XoopsFormDhtmlTextArea|XoopsFormEditor|XoopsFormFckeditor|XoopsFormTextArea|XoopsFormTinyTextArea
+	 */
+	public function getTextArea($key)
+	{
+		$var = $this->targetObject->vars[$key];
+
+		// if no control has been created, let's create a default one
+		if (!isset($this->targetObject->controls[$key])) {
+			$control = array(
+				'name'        => 'textarea',
+				'itemHandler' => false,
+				'method'      => false,
+				'module'      => false,
+				'form_editor' => 'default'
+			);
+		} else {
+			$control = $this->targetObject->controls[$key];
+		}
+		$xoops22 = smart_isXoops22();
+
+		$form_editor = isset($control['form_editor']) ? $control['form_editor'] : 'textarea';
+		/**
+		 * If the editor is 'default', retreive the default editor of this module
+		 */
+		if ($form_editor === 'default') {
+			global $xoopsModuleConfig;
+			$form_editor = isset($xoopsModuleConfig['default_editor']) ? $xoopsModuleConfig['default_editor'] : 'textarea';
+		}
+
+		$caption = $var['form_caption'];
+		$name    = $key;
+
+		$value = $this->targetObject->getVar($key);
+
+		$value = $this->targetObject->getValueFor($key, true);
+
+		$editor_configs          = array();
+		$editor_configs['name']  = $name;
+		$editor_configs['value'] = $value;
+		if ($form_editor !== 'textarea') {
+			$editor_configs['rows'] = 35;
+			$editor_configs['cols'] = 60;
+		}
+
+		if (isset($control['rows'])) {
+			$editor_configs['rows'] = $control['rows'];
+		}
+		if (isset($control['cols'])) {
+			$editor_configs['cols'] = $control['cols'];
+		}
+
+		$editor_configs['width']  = '100%';
+		$editor_configs['height'] = '400px';
+
+		$dhtml            = true;
+		$xoopseditorclass = XOOPS_ROOT_PATH . '/class/xoopsform/formeditor.php';
+
+		if (file_exists($xoopseditorclass)) {
+			include_once($xoopseditorclass);
+			$editor = new XoopsFormEditor($caption, $form_editor, $editor_configs, $nohtml = false, $onfailure = 'textarea');
+		} else {
+			switch ($form_editor) {
+
+				case 'tiny':
+					if (!$xoops22) {
+						if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php')) {
+							include_once(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php');
+							$editor = new XoopsFormTinyTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '300px'), true);
+						} else {
+							if ($dhtml) {
+								$editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
+							} else {
+								$editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
+							}
+						}
+					} else {
+						$editor = new XoopsFormEditor($caption, 'tinyeditor', $editor_configs);
+					}
+					break;
+
+				case 'dhtmltextarea':
+				case 'dhtmltext':
+					$editor = new XoopsFormDhtmlTextArea($var['form_caption'], $key, $this->targetObject->getVar($key, 'e'), 20, 60);
+					if ($var['form_dsc']) {
+						$editor->setDescription($var['form_dsc']);
+					}
+					break;
+
+				case 'fckeditor':
+					if (!$xoops22) {
+						if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/fckeditor/formfckeditor.php')) {
+							include_once(XOOPS_ROOT_PATH . '/class/xoopseditor/fckeditor/formfckeditor.php');
+							$editor = new XoopsFormFckeditor(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '300px'), true);
+						} else {
+							if ($dhtml) {
+								$editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
+							} else {
+								$editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
+							}
+						}
+					} else {
+						$editor = new XoopsFormEditor($caption, 'fckeditor', $editor_configs);
+					}
+					break;
+
+				case 'inbetween':
+					if (!$xoops22) {
+						if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/inbetween/forminbetweentextarea.php')) {
+							include_once(XOOPS_ROOT_PATH . '/class/xoopseditor/inbetween/forminbetweentextarea.php');
+							$editor = new XoopsFormInbetweenTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '300px'), true);
+						} else {
+							if ($dhtml) {
+								$editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
+							} else {
+								$editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
+							}
+						}
+					} else {
+						$editor = new XoopsFormEditor($caption, 'inbetween', $editor_configs);
+					}
+					break;
+
+				case 'koivi':
+					if (!$xoops22) {
+						if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
+							include_once(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php');
+							$editor = new XoopsFormWysiwygTextArea($caption, $name, $value, '100%', '400px');
+						} else {
+							if ($dhtml) {
+								$editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
+							} else {
+								$editor = new XoopsFormTextArea($caption, $name, $value, 7, 60);
+							}
+						}
+					} else {
+						$editor = new XoopsFormEditor($caption, 'koivi', $editor_configs);
+					}
+					break;
+
+				case 'spaw':
+					if (!$xoops22) {
+						if (is_readable(XOOPS_ROOT_PATH . '/class/spaw/formspaw.php')) {
+							include_once(XOOPS_ROOT_PATH . '/class/spaw/formspaw.php');
+							$editor = new XoopsFormSpaw($caption, $name, $value);
+						}
+					} else {
+						$editor = new XoopsFormEditor($caption, 'spaw', $editor_configs);
+					}
+					break;
+
+				case 'htmlarea':
+					if (!$xoops22) {
+						if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
+							include_once(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php');
+							$editor = new XoopsFormHtmlarea($caption, $name, $value);
+						}
+					} else {
+						$editor = new XoopsFormEditor($caption, 'htmlarea', $editor_configs);
+					}
+					break;
+
+				default:
+				case 'textarea':
+					$form_rows = isset($control['rows']) ? $control['rows'] : 5;
+					$form_cols = isset($control['cols']) ? $control['cols'] : 60;
+
+					$editor = new XoopsFormTextArea($var['form_caption'], $key, $this->targetObject->getVar($key, 'e'), $form_rows, $form_cols);
+					if ($var['form_dsc']) {
+						$editor->setDescription($var['form_dsc']);
+					}
+					break;
+
+			}
+		}
+
+		return $editor;
+	}
+
+	/**
+	 * @param       $key
+	 * @param       $var
+	 * @param  bool $multiple
+	 * @return XoopsFormSelect
+	 */
+	public function getThemeSelect($key, $var, $multiple = false)
+	{
+		$size         = $multiple ? 5 : 1;
+		$theme_select = new XoopsFormSelect($var['form_caption'], $key, $this->targetObject->getVar($key), $size, $multiple);
+
+		$handle  = opendir(XOOPS_THEME_PATH . '/');
+		$dirlist = array();
+		while (false !== ($file = readdir($handle))) {
+			if (is_dir(XOOPS_THEME_PATH . '/' . $file) && !preg_match("/^[.]{1,2}$/", $file) && strtolower($file) !== 'cvs') {
+				$dirlist[$file] = $file;
+			}
+		}
+		closedir($handle);
+		if (!empty($dirlist)) {
+			asort($dirlist);
+			$theme_select->addOptionArray($dirlist);
+		}
+
+		return $theme_select;
+	}
+
+	/**
+	 * @param $keyname
+	 * @return bool
+	 */
+	public function &getElementById($keyname)
+	{
+		foreach ($this->_elements as $eleObj) {
+			if ($eleObj->getName() == $keyname) {
+				$ret =& $eleObj;
+				break;
+			}
+		}
+
+		return isset($ret) ? $ret : false;
+	}
+
+	/**
+	 * create HTML to output the form as a theme-enabled table with validation.
+	 *
+	 * @return string
+	 */
+	public function render()
+	{
+		$required = $this->getRequired();
+		$ret      = "
             <form name='" . $this->getName() . "' id='" . $this->getName() . "' action='" . $this->getAction() . "' method='" . $this->getMethod() . "' onsubmit='return xoopsFormValidate_" . $this->getName() . "(this);'" . $this->getExtra() . ">
             <table width='100%' class='outer' cellspacing='1'>
             <tr><th colspan='2'>" . $this->getTitle() . '</th></tr>
         ';
-        $hidden   = '';
-        $class    = 'even';
-        foreach ($this->getElements() as $ele) {
-            if (!is_object($ele)) {
-                $ret .= $ele;
-            } elseif (!$ele->isHidden()) {
-                //$class = ( $class == 'even' ) ? 'odd': 'even';
-                $ret .= "<tr id='" . $ele->getName() . "' valign='top' align='left'><td class='head'>" . $ele->getCaption();
-                if ($ele->getDescription() != '') {
-                    $ret .= '<br /><br /><span style="font-weight: normal;">' . $ele->getDescription() . '</span>';
-                }
-                $ret .= "</td><td class='$class'>" . $ele->render() . "</td></tr>\n";
-            } else {
-                $hidden .= $ele->render();
-            }
-        }
-        $ret .= "</table>\n$hidden\n</form>\n";
-        $ret .= $this->renderValidationJS(true);
-
-        return $ret;
-    }
-
-    /**
-     * assign to smarty form template instead of displaying directly
-     *
-     * @param object &$tpl reference to a {@link Smarty} object
-     * @param bool   $smartyName
-     * @see     Smarty
-     */
-    public function assign(&$tpl, $smartyName = false)
-    {
-        $i        = 0;
-        $elements = array();
-        foreach ($this->getElements() as $ele) {
-            $n                             = ($ele->getName() != '') ? $ele->getName() : $i;
-            $elements[$n]['name']          = $ele->getName();
-            $elements[$n]['caption']       = $ele->getCaption();
-            $elements[$n]['body']          = $ele->render();
-            $elements[$n]['hidden']        = $ele->isHidden();
-            $elements[$n]['section']       = strtolower(get_class($ele)) == strtolower('SmartFormSection');
-            $elements[$n]['section_close'] = get_class($ele) === 'SmartFormSectionClose';
-            $elements[$n]['hide']          = isset($this->targetObject->vars[$n]['hide']) ? $this->targetObject->vars[$n]['hide'] : false;
-            if ($ele->getDescription() != '') {
-                $elements[$n]['description'] = $ele->getDescription();
-            }
-            ++$i;
-        }
-        $js = $this->renderValidationJS();
-        if (!$smartyName) {
-            $smartyName = $this->getName();
-        }
-
-        $tpl->assign($smartyName, array(
-            'title'      => $this->getTitle(),
-            'name'       => $this->getName(),
-            'action'     => $this->getAction(),
-            'method'     => $this->getMethod(),
-            'extra'      => 'onsubmit="return xoopsFormValidate_' . $this->getName() . '(this);"' . $this->getExtra(),
-            'javascript' => $js,
-            'elements'   => $elements
-        ));
-    }
-
-    /**
-     * @param  bool $withtags
-     * @return string
-     */
-    public function renderValidationJS($withtags = true)
-    {
-        $js = '';
-        if ($withtags) {
-            $js .= "\n<!-- Start Form Validation JavaScript //-->\n<script type='text/javascript'>\n<!--//\n";
-        }
-        $myts     = MyTextSanitizer::getInstance();
-        $formname = $this->getName();
-        $js .= "function xoopsFormValidate_{$formname}(myform) {";
-        // First, output code to check required elements
-        $elements =& $this->getRequired();
-        foreach ($elements as $elt) {
-            $eltname    = $elt->getName();
-            $eltcaption = trim($elt->getCaption());
-            $eltmsg     = empty($eltcaption) ? sprintf(_FORM_ENTER, $eltname) : sprintf(_FORM_ENTER, $eltcaption);
-            $eltmsg     = str_replace('"', '\"', stripslashes($eltmsg));
-            if (strtolower(get_class($elt)) === 'xoopsformradio') {
-                $js .= 'var myOption = -1;';
-                $js .= "for (i=myform.{$eltname}.length-1; i > -1; i--) {
+		$hidden   = '';
+		$class    = 'even';
+		foreach ($this->getElements() as $ele) {
+			if (!is_object($ele)) {
+				$ret .= $ele;
+			} elseif (!$ele->isHidden()) {
+				//$class = ( $class == 'even' ) ? 'odd': 'even';
+				$ret .= "<tr id='" . $ele->getName() . "' valign='top' align='left'><td class='head'>" . $ele->getCaption();
+				if ($ele->getDescription() != '') {
+					$ret .= '<br /><br /><span style="font-weight: normal;">' . $ele->getDescription() . '</span>';
+				}
+				$ret .= "</td><td class='$class'>" . $ele->render() . "</td></tr>\n";
+			} else {
+				$hidden .= $ele->render();
+			}
+		}
+		$ret .= "</table>\n$hidden\n</form>\n";
+		$ret .= $this->renderValidationJS(true);
+
+		return $ret;
+	}
+
+	/**
+	 * assign to smarty form template instead of displaying directly
+	 *
+	 * @param object &$tpl reference to a {@link Smarty} object
+	 * @param bool   $smartyName
+	 * @see     Smarty
+	 */
+	public function assign(&$tpl, $smartyName = false)
+	{
+		$i        = 0;
+		$elements = array();
+		foreach ($this->getElements() as $ele) {
+			$n                             = ($ele->getName() != '') ? $ele->getName() : $i;
+			$elements[$n]['name']          = $ele->getName();
+			$elements[$n]['caption']       = $ele->getCaption();
+			$elements[$n]['body']          = $ele->render();
+			$elements[$n]['hidden']        = $ele->isHidden();
+			$elements[$n]['section']       = strtolower(get_class($ele)) == strtolower('SmartFormSection');
+			$elements[$n]['section_close'] = get_class($ele) === 'SmartFormSectionClose';
+			$elements[$n]['hide']          = isset($this->targetObject->vars[$n]['hide']) ? $this->targetObject->vars[$n]['hide'] : false;
+			if ($ele->getDescription() != '') {
+				$elements[$n]['description'] = $ele->getDescription();
+			}
+			++$i;
+		}
+		$js = $this->renderValidationJS();
+		if (!$smartyName) {
+			$smartyName = $this->getName();
+		}
+
+		$tpl->assign($smartyName, array(
+			'title'      => $this->getTitle(),
+			'name'       => $this->getName(),
+			'action'     => $this->getAction(),
+			'method'     => $this->getMethod(),
+			'extra'      => 'onsubmit="return xoopsFormValidate_' . $this->getName() . '(this);"' . $this->getExtra(),
+			'javascript' => $js,
+			'elements'   => $elements
+		));
+	}
+
+	/**
+	 * @param  bool $withtags
+	 * @return string
+	 */
+	public function renderValidationJS($withtags = true)
+	{
+		$js = '';
+		if ($withtags) {
+			$js .= "\n<!-- Start Form Validation JavaScript //-->\n<script type='text/javascript'>\n<!--//\n";
+		}
+		$myts     = MyTextSanitizer::getInstance();
+		$formname = $this->getName();
+		$js .= "function xoopsFormValidate_{$formname}(myform) {";
+		// First, output code to check required elements
+		$elements =& $this->getRequired();
+		foreach ($elements as $elt) {
+			$eltname    = $elt->getName();
+			$eltcaption = trim($elt->getCaption());
+			$eltmsg     = empty($eltcaption) ? sprintf(_FORM_ENTER, $eltname) : sprintf(_FORM_ENTER, $eltcaption);
+			$eltmsg     = str_replace('"', '\"', stripslashes($eltmsg));
+			if (strtolower(get_class($elt)) === 'xoopsformradio') {
+				$js .= 'var myOption = -1;';
+				$js .= "for (i=myform.{$eltname}.length-1; i > -1; i--) {
                     if (myform.{$eltname}[i].checked) {
                         myOption = i; i = -1;
                     }
                 }
                 if (myOption == -1) {
                     window.alert(\"{$eltmsg}\"); myform.{$eltname}[0].focus(); return false; }\n";
-            } elseif (strtolower(get_class($elt)) === 'smartformselect_multielement') {
-                $js .= 'var hasSelections = false;';
-                $js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
+			} elseif (strtolower(get_class($elt)) === 'smartformselect_multielement') {
+				$js .= 'var hasSelections = false;';
+				$js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
                     if (myform['{$eltname}[]'].options[i].selected) {
                         hasSelections = true;
                     }
@@ -807,11 +807,11 @@ 
                 }
                 if (hasSelections == false) {
                     window.alert(\"{$eltmsg}\"); myform['{$eltname}[]'].options[0].focus(); return false; }\n";
-            } elseif (strtolower(get_class($elt)) === 'xoopsformcheckbox' || strtolower(get_class($elt)) === 'smartformcheckelement') {
-                $js .= 'var hasSelections = false;';
-                //sometimes, there is an implicit '[]', sometimes not
-                if (strpos($eltname, '[') === false) {
-                    $js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
+			} elseif (strtolower(get_class($elt)) === 'xoopsformcheckbox' || strtolower(get_class($elt)) === 'smartformcheckelement') {
+				$js .= 'var hasSelections = false;';
+				//sometimes, there is an implicit '[]', sometimes not
+				if (strpos($eltname, '[') === false) {
+					$js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
                         if (myform['{$eltname}[]'][i].checked) {
                             hasSelections = true;
                         }
@@ -819,8 +819,8 @@ 
                     }
                     if (hasSelections == false) {
                         window.alert(\"{$eltmsg}\"); myform['{$eltname}[]'][0].focus(); return false; }\n";
-                } else {
-                    $js .= "for (var i = 0; i < myform['{$eltname}'].length; i++) {
+				} else {
+					$js .= "for (var i = 0; i < myform['{$eltname}'].length; i++) {
                         if (myform['{$eltname}'][i].checked) {
                             hasSelections = true;
                         }
@@ -828,25 +828,25 @@ 
                     }
                     if (hasSelections == false) {
                         window.alert(\"{$eltmsg}\"); myform['{$eltname}'][0].focus(); return false; }\n";
-                }
-            } else {
-                $js .= "if ( myform.{$eltname}.value == \"\" ) " . "{ window.alert(\"{$eltmsg}\"); myform.{$eltname}.focus(); return false; }\n";
-            }
-        }
-        // Now, handle custom validation code
-        $elements =& $this->getElements(true);
-        foreach ($elements as $elt) {
-            if (method_exists($elt, 'renderValidationJS') && strtolower(get_class($elt)) !== 'xoopsformcheckbox') {
-                if ($eltjs = $elt->renderValidationJS()) {
-                    $js .= $eltjs . "\n";
-                }
-            }
-        }
-        $js .= "return true;\n}\n";
-        if ($withtags) {
-            $js .= "//--></script>\n<!-- 'End Form Validation JavaScript' //-->\n";
-        }
-
-        return $js;
-    }
+				}
+			} else {
+				$js .= "if ( myform.{$eltname}.value == \"\" ) " . "{ window.alert(\"{$eltmsg}\"); myform.{$eltname}.focus(); return false; }\n";
+			}
+		}
+		// Now, handle custom validation code
+		$elements =& $this->getElements(true);
+		foreach ($elements as $elt) {
+			if (method_exists($elt, 'renderValidationJS') && strtolower(get_class($elt)) !== 'xoopsformcheckbox') {
+				if ($eltjs = $elt->renderValidationJS()) {
+					$js .= $eltjs . "\n";
+				}
+			}
+		}
+		$js .= "return true;\n}\n";
+		if ($withtags) {
+			$js .= "//--></script>\n<!-- 'End Form Validation JavaScript' //-->\n";
+		}
+
+		return $js;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -52,7 +52,7 @@ 
      */
     public function __construct(&$target, $form_name, $form_caption, $form_action, $form_fields = null, $submit_button_caption = false, $cancel_js_action = false, $captcha = false)
     {
-        $this->targetObject           =& $target;
+        $this->targetObject           = & $target;
         $this->form_fields            = $form_fields;
         $this->_cancel_js_action      = $cancel_js_action;
         $this->_captcha               = $captcha;
@@ -91,7 +91,7 @@ 
      */
     public function addCustomButton($name, $caption, $onclick = false)
     {
-        $custom_button_array    = array(
+        $custom_button_array = array(
             'name'    => $name,
             'caption' => $caption,
             'onclick' => $onclick
@@ -286,7 +286,7 @@ 
 
         if ($permissions) {
             $memberHandler = xoops_getHandler('member');
-            $group_list     = $memberHandler->getGroupList();
+            $group_list = $memberHandler->getGroupList();
             asort($group_list);
             foreach ($permissions as $permission) {
                 if ($this->targetObject->isNew()) {
@@ -684,7 +684,7 @@ 
     {
         foreach ($this->_elements as $eleObj) {
             if ($eleObj->getName() == $keyname) {
-                $ret =& $eleObj;
+                $ret = & $eleObj;
                 break;
             }
         }
@@ -782,7 +782,7 @@ 
         $formname = $this->getName();
         $js .= "function xoopsFormValidate_{$formname}(myform) {";
         // First, output code to check required elements
-        $elements =& $this->getRequired();
+        $elements = & $this->getRequired();
         foreach ($elements as $elt) {
             $eltname    = $elt->getName();
             $eltcaption = trim($elt->getCaption());
@@ -834,7 +834,7 @@ 
             }
         }
         // Now, handle custom validation code
-        $elements =& $this->getElements(true);
+        $elements = & $this->getElements(true);
         foreach ($elements as $elt) {
             if (method_exists($elt, 'renderValidationJS') && strtolower(get_class($elt)) !== 'xoopsformcheckbox') {
                 if ($eltjs = $elt->renderValidationJS()) {

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

@@ -46,227 +46,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 =& 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 =& 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 +3 added lines, -3 removed lines

@@ -105,7 +105,7 @@ 
 
         global $xoopsConfig;
 
-        $configHandler  = xoops_getHandler('config');
+        $configHandler = xoops_getHandler('config');
         $xoopsConfigUser = $configHandler->getConfigsByCat(XOOPS_CONF_USER);
         switch ($xoopsConfigUser['activation_type']) {
             case 0:
@@ -151,7 +151,7 @@ 
 
         if ($notifyUser) {
             // send some notifications
-            $xoopsMailer =& getMailer();
+            $xoopsMailer = & getMailer();
             $xoopsMailer->useMail();
             $xoopsMailer->setTemplateDir(SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/mail_template');
             $xoopsMailer->setTemplate('smartobject_notify_user_added_by_admin.tpl');
@@ -265,7 +265,7 @@ 
     {
         static $randCalled = false;
         if (!$randCalled) {
-            mt_srand((double)microtime() * 1000000);
+            mt_srand((double) microtime() * 1000000);
             $randCalled = true;
         }
     }

class/smartdbupdater.php

Doc Comments +3 added lines, -3 removed lines

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

Indentation +831 added lines, -831 removed lines

@@ -1,32 +1,32 @@ 
 <?php
 /**
- * Contains the classes for updating database tables
- *
- * @license GNU
- * @author  marcan <marcan@smartfactory.ca>
- * @link    http://www.smartfactory.ca The SmartFactory
- * @package SmartObject
- */
+	 * Contains the classes for updating database tables
+	 *
+	 * @license GNU
+	 * @author  marcan <marcan@smartfactory.ca>
+	 * @link    http://www.smartfactory.ca The SmartFactory
+	 * @package SmartObject
+	 */
 /**
- * SmartDbTable class
- *
- * Information about an individual table
- *
- * @package SmartObject
- * @author  marcan <marcan@smartfactory.ca>
- * @link    http://www.smartfactory.ca The SmartFactory
- */
+	 * SmartDbTable class
+	 *
+	 * Information about an individual table
+	 *
+	 * @package SmartObject
+	 * @author  marcan <marcan@smartfactory.ca>
+	 * @link    http://www.smartfactory.ca The SmartFactory
+	 */
 // defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 if (!defined('SMARTOBJECT_ROOT_PATH')) {
-    include_once(XOOPS_ROOT_PATH . '/modules/smartobject/include/common.php');
+	include_once(XOOPS_ROOT_PATH . '/modules/smartobject/include/common.php');
 }
 /**
- * Include the language constants for the SmartObjectDBUpdater
- */
+	 * Include the language constants for the SmartObjectDBUpdater
+	 */
 global $xoopsConfig;
 $common_file = SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/smartdbupdater.php';
 if (!file_exists($common_file)) {
-    $common_file = SMARTOBJECT_ROOT_PATH . 'language/english/smartdbupdater.php';
+	$common_file = SMARTOBJECT_ROOT_PATH . 'language/english/smartdbupdater.php';
 }
 include($common_file);
 
@@ -35,500 +35,500 @@ 
  */
 class SmartDbTable
 {
-    /**
-     * @var string $_name name of the table
-     */
-    public $_name;
-    /**
-     * @var string $_structure structure of the table
-     */
-    public $_structure;
-
-    /**
-     * @var array $_data containing valued of each records to be added
-     */
-    public $_data;
-
-    /**
-     * @var array $_alteredFields containing fields to be altered
-     */
-    public $_alteredFields;
-
-    /**
-     * @var array $_newFields containing new fields to be added
-     */
-    public $_newFields;
-
-    /**
-     * @var array $_droppedFields containing fields to be dropped
-     */
-    public $_droppedFields;
-
-    /**
-     * @var array $_flagForDrop flag table to drop it
-     */
-    public $_flagForDrop = false;
-
-    /**
-     * @var array $_updatedFields containing fields which values will be updated
-     */
-    public $_updatedFields;
-
-    /**
-     * @var array $_updatedFields containing fields which values will be updated
-     */ //felix
-    public $_updatedWhere;
-
-    public $_existingFieldsArray = false;
-
-    /**
-     * Constructor
-     *
-     * @param string $name name of the table
-     *
-     */
-    public function __construct($name)
-    {
-        $this->_name = $name;
-        $this->_data = array();
-    }
-
-    /**
-     * Return the table name, prefixed with site table prefix
-     *
-     * @return string table name
-     *
-     */
-    public function name()
-    {
-        global $xoopsDB;
-
-        return $xoopsDB->prefix($this->_name);
-    }
-
-    /**
-     * Checks if the table already exists in the database
-     *
-     * @return bool TRUE if it exists, FALSE if not
-     *
-     */
-    public function exists()
-    {
-        return smart_TableExists($this->_name);
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getExistingFieldsArray()
-    {
-        global $xoopsDB;
-        $result = $xoopsDB->query('SHOW COLUMNS FROM ' . $this->name());
-        while ($existing_field = $xoopsDB->fetchArray($result)) {
-            $fields[$existing_field['Field']] = $existing_field['Type'];
-            if ($existing_field['Null'] !== 'YES') {
-                $fields[$existing_field['Field']] .= ' NOT NULL';
-            }
-            if ($existing_field['Extra']) {
-                $fields[$existing_field['Field']] .= ' ' . $existing_field['Extra'];
-            }
-            if (!($existing_field['Default'] === null) && ($existing_field['Default'] || $existing_field['Default'] == '' || $existing_field['Default'] == 0)) {
-                $fields[$existing_field['Field']] .= " default '" . $existing_field['Default'] . "'";
-            }
-        }
-
-        return $fields;
-    }
-
-    /**
-     * @param $field
-     * @return bool
-     */
-    public function fieldExists($field)
-    {
-        $existingFields = $this->getExistingFieldsArray();
-
-        return isset($existingFields[$field]);
-    }
-
-    /**
-     * Set the table structure
-     *
-     * Example:
-     *
-     *      $table->setStructure("`transactionid` int(11) NOT NULL auto_increment,
-     *                `date` int(11) NOT NULL default '0',
-     *                `status` int(1) NOT NULL default '-1',
-     *                `itemid` int(11) NOT NULL default '0',
-     *                `uid` int(11) NOT NULL default '0',
-     *                `price` float NOT NULL default '0',
-     *                `currency` varchar(100) NOT NULL default '',
-     *                PRIMARY KEY  (`transactionid`)");
-     *
-     * @param string $structure table structure
-     *
-     */
-    public function setStructure($structure)
-    {
-        $this->_structure = $structure;
-    }
-
-    /**
-     * Return the table structure
-     *
-     * @return string table structure
-     *
-     */
-    public function getStructure()
-    {
-        return sprintf($this->_structure, $this->name());
-    }
-
-    /**
-     * Add values of a record to be added
-     *
-     * @param string $data values of a record
-     *
-     */
-    public function setData($data)
-    {
-        $this->_data[] = $data;
-    }
-
-    /**
-     * Get the data array
-     *
-     * @return array containing the records values to be added
-     *
-     */
-    public function getData()
-    {
-        return $this->_data;
-    }
-
-    /**
-     * Use to insert data in a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function addData()
-    {
-        global $xoopsDB;
-        foreach ($this->getData() as $data) {
-            $query = sprintf('INSERT INTO %s VALUES (%s)', $this->name(), $data);
-            $ret   = $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA_ERR, $this->name()) . '<br />';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA, $this->name()) . '<br />';
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Add a field to be added
-     *
-     * @param string $name       name of the field
-     * @param string $properties properties of the field
-     * @param bool   $newname
-     * @param bool   $showerror
-     */
-    public function addAlteredField($name, $properties, $newname = false, $showerror = true)
-    {
-        $field['name']          = $name;
-        $field['properties']    = $properties;
-        $field['showerror']     = $showerror;
-        $field['newname']       = $newname;
-        $this->_alteredFields[] = $field;
-    }
-    /**
-     * Invert values 0 to 1 and 1 to 0
-     *
-     * @param string $name name of the field
-     * @param        $newValue
-     * @param        $oldValue
-     * @internal param string $old old propertie
-     * @internal param string $new new propertie
-     */ //felix
-    public function addUpdatedWhere($name, $newValue, $oldValue)
-    {
-        $field['name']         = $name;
-        $field['value']        = $newValue;
-        $field['where']        = $oldValue;
-        $this->_updatedWhere[] = $field;
-    }
-
-    /**
-     * Add new field of a record to be added
-     *
-     * @param string $name       name of the field
-     * @param string $properties properties of the field
-     *
-     */
-    public function addNewField($name, $properties)
-    {
-        $field['name']       = $name;
-        $field['properties'] = $properties;
-        $this->_newFields[]  = $field;
-    }
-
-    /**
-     * Get fields that need to be altered
-     *
-     * @return array fields that need to be altered
-     *
-     */
-    public function getAlteredFields()
-    {
-        return $this->_alteredFields;
-    }
-
-    /**
-     * Add field for which the value will be updated
-     *
-     * @param string $name  name of the field
-     * @param string $value value to be set
-     *
-     */
-    public function addUpdatedField($name, $value)
-    {
-        $field['name']          = $name;
-        $field['value']         = $value;
-        $this->_updatedFields[] = $field;
-    }
-
-    /**
-     * Get new fields to be added
-     *
-     * @return array fields to be added
-     *
-     */
-    public function getNewFields()
-    {
-        return $this->_newFields;
-    }
-
-    /**
-     * Get fields which values need to be updated
-     *
-     * @return array fields which values need to be updated
-     *
-     */
-    public function getUpdatedFields()
-    {
-        return $this->_updatedFields;
-    }
-    /**
-     * Get fields which values need to be updated
-     *
-     * @return array fields which values need to be updated
-     *
-     */ //felix
-    public function getUpdatedWhere()
-    {
-        return $this->_updatedWhere;
-    }
-
-    /**
-     * Add values of a record to be added
-     *
-     * @param string $name name of the field
-     *
-     */
-    public function addDroppedField($name)
-    {
-        $this->_droppedFields[] = $name;
-    }
-
-    /**
-     * Get fields that need to be dropped
-     *
-     * @return array fields that need to be dropped
-     *
-     */
-    public function getDroppedFields()
-    {
-        return $this->_droppedFields;
-    }
-
-    /**
-     * Set the flag to drop the table
-     *
-     */
-    public function setFlagForDrop()
-    {
-        $this->_flagForDrop = true;
-    }
-
-    /**
-     * Use to create a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function createTable()
-    {
-        global $xoopsDB;
-        $query = $this->getStructure();
-        $query = 'CREATE TABLE `' . $this->name() . '` (' . $query . ") ENGINE=MyISAM COMMENT='The SmartFactory <www.smartfactory.ca>'";
-        //xoops_debug($query);
-        $ret = $xoopsDB->query($query);
-        if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
-        } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE, $this->name()) . '<br />';
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to drop a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function dropTable()
-    {
-        global $xoopsDB;
-        $query = sprintf('DROP TABLE %s', $this->name());
-        $ret   = $xoopsDB->query($query);
-        if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
-
-            return false;
-        } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE, $this->name()) . '<br />';
-
-            return true;
-        }
-    }
-
-    /**
-     * Use to alter a table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function alterTable()
-    {
-        global $xoopsDB;
-        $ret = true;
-
-        foreach ($this->getAlteredFields() as $alteredField) {
-            if (!$alteredField['newname']) {
-                $alteredField['newname'] = $alteredField['name'];
-            }
-
-            $query = sprintf('ALTER TABLE `%s` CHANGE `%s` `%s` %s', $this->name(), $alteredField['name'], $alteredField['newname'], $alteredField['properties']);
-            $ret   = $ret && $xoopsDB->query($query);
-            if ($alteredField['showerror']) {
-                if (!$ret) {
-                    echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
-                } else {
-                    echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()) . '<br />';
-                }
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to add new fileds in the table
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function addNewFields()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getNewFields() as $newField) {
-            $query = sprintf('ALTER TABLE `%s` ADD `%s` %s', $this->name(), $newField['name'], $newField['properties']);
-            //echo $query;
-            $ret = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD_ERR, $newField['name'], $this->name()) . '<br />';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD, $newField['name'], $this->name()) . '<br />';
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to update fields values
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function updateFieldsValues()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getUpdatedFields() as $updatedField) {
-            $query = sprintf('UPDATE %s SET %s = %s', $this->name(), $updatedField['name'], $updatedField['value']);
-            $ret   = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br />';
-            }
-        }
-
-        return $ret;
-    }
-    /**
-     * Use to update fields values
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */ //felix
-    public function updateWhereValues()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getUpdatedWhere() as $updatedWhere) {
-            $query = sprintf('UPDATE %s SET %s = %s WHERE %s  %s', $this->name(), $updatedWhere['name'], $updatedWhere['value'], $updatedWhere['name'], $updatedWhere['where']);
-            //echo $query."<br>";
-            $ret = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br />';
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Use to drop fields
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function dropFields()
-    {
-        global $xoopsDB;
-        $ret = true;
-        foreach ($this->getDroppedFields() as $droppedField) {
-            $query = sprintf('ALTER TABLE %s DROP %s', $this->name(), $droppedField);
-            $ret   = $ret && $xoopsDB->query($query);
-            if (!$ret) {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD_ERR, $droppedField, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
-            } else {
-                echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD, $droppedField, $this->name()) . '<br />';
-            }
-        }
-
-        return $ret;
-    }
+	/**
+	 * @var string $_name name of the table
+	 */
+	public $_name;
+	/**
+	 * @var string $_structure structure of the table
+	 */
+	public $_structure;
+
+	/**
+	 * @var array $_data containing valued of each records to be added
+	 */
+	public $_data;
+
+	/**
+	 * @var array $_alteredFields containing fields to be altered
+	 */
+	public $_alteredFields;
+
+	/**
+	 * @var array $_newFields containing new fields to be added
+	 */
+	public $_newFields;
+
+	/**
+	 * @var array $_droppedFields containing fields to be dropped
+	 */
+	public $_droppedFields;
+
+	/**
+	 * @var array $_flagForDrop flag table to drop it
+	 */
+	public $_flagForDrop = false;
+
+	/**
+	 * @var array $_updatedFields containing fields which values will be updated
+	 */
+	public $_updatedFields;
+
+	/**
+	 * @var array $_updatedFields containing fields which values will be updated
+	 */ //felix
+	public $_updatedWhere;
+
+	public $_existingFieldsArray = false;
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $name name of the table
+	 *
+	 */
+	public function __construct($name)
+	{
+		$this->_name = $name;
+		$this->_data = array();
+	}
+
+	/**
+	 * Return the table name, prefixed with site table prefix
+	 *
+	 * @return string table name
+	 *
+	 */
+	public function name()
+	{
+		global $xoopsDB;
+
+		return $xoopsDB->prefix($this->_name);
+	}
+
+	/**
+	 * Checks if the table already exists in the database
+	 *
+	 * @return bool TRUE if it exists, FALSE if not
+	 *
+	 */
+	public function exists()
+	{
+		return smart_TableExists($this->_name);
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getExistingFieldsArray()
+	{
+		global $xoopsDB;
+		$result = $xoopsDB->query('SHOW COLUMNS FROM ' . $this->name());
+		while ($existing_field = $xoopsDB->fetchArray($result)) {
+			$fields[$existing_field['Field']] = $existing_field['Type'];
+			if ($existing_field['Null'] !== 'YES') {
+				$fields[$existing_field['Field']] .= ' NOT NULL';
+			}
+			if ($existing_field['Extra']) {
+				$fields[$existing_field['Field']] .= ' ' . $existing_field['Extra'];
+			}
+			if (!($existing_field['Default'] === null) && ($existing_field['Default'] || $existing_field['Default'] == '' || $existing_field['Default'] == 0)) {
+				$fields[$existing_field['Field']] .= " default '" . $existing_field['Default'] . "'";
+			}
+		}
+
+		return $fields;
+	}
+
+	/**
+	 * @param $field
+	 * @return bool
+	 */
+	public function fieldExists($field)
+	{
+		$existingFields = $this->getExistingFieldsArray();
+
+		return isset($existingFields[$field]);
+	}
+
+	/**
+	 * Set the table structure
+	 *
+	 * Example:
+	 *
+	 *      $table->setStructure("`transactionid` int(11) NOT NULL auto_increment,
+	 *                `date` int(11) NOT NULL default '0',
+	 *                `status` int(1) NOT NULL default '-1',
+	 *                `itemid` int(11) NOT NULL default '0',
+	 *                `uid` int(11) NOT NULL default '0',
+	 *                `price` float NOT NULL default '0',
+	 *                `currency` varchar(100) NOT NULL default '',
+	 *                PRIMARY KEY  (`transactionid`)");
+	 *
+	 * @param string $structure table structure
+	 *
+	 */
+	public function setStructure($structure)
+	{
+		$this->_structure = $structure;
+	}
+
+	/**
+	 * Return the table structure
+	 *
+	 * @return string table structure
+	 *
+	 */
+	public function getStructure()
+	{
+		return sprintf($this->_structure, $this->name());
+	}
+
+	/**
+	 * Add values of a record to be added
+	 *
+	 * @param string $data values of a record
+	 *
+	 */
+	public function setData($data)
+	{
+		$this->_data[] = $data;
+	}
+
+	/**
+	 * Get the data array
+	 *
+	 * @return array containing the records values to be added
+	 *
+	 */
+	public function getData()
+	{
+		return $this->_data;
+	}
+
+	/**
+	 * Use to insert data in a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function addData()
+	{
+		global $xoopsDB;
+		foreach ($this->getData() as $data) {
+			$query = sprintf('INSERT INTO %s VALUES (%s)', $this->name(), $data);
+			$ret   = $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA_ERR, $this->name()) . '<br />';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_ADD_DATA, $this->name()) . '<br />';
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Add a field to be added
+	 *
+	 * @param string $name       name of the field
+	 * @param string $properties properties of the field
+	 * @param bool   $newname
+	 * @param bool   $showerror
+	 */
+	public function addAlteredField($name, $properties, $newname = false, $showerror = true)
+	{
+		$field['name']          = $name;
+		$field['properties']    = $properties;
+		$field['showerror']     = $showerror;
+		$field['newname']       = $newname;
+		$this->_alteredFields[] = $field;
+	}
+	/**
+	 * Invert values 0 to 1 and 1 to 0
+	 *
+	 * @param string $name name of the field
+	 * @param        $newValue
+	 * @param        $oldValue
+	 * @internal param string $old old propertie
+	 * @internal param string $new new propertie
+	 */ //felix
+	public function addUpdatedWhere($name, $newValue, $oldValue)
+	{
+		$field['name']         = $name;
+		$field['value']        = $newValue;
+		$field['where']        = $oldValue;
+		$this->_updatedWhere[] = $field;
+	}
+
+	/**
+	 * Add new field of a record to be added
+	 *
+	 * @param string $name       name of the field
+	 * @param string $properties properties of the field
+	 *
+	 */
+	public function addNewField($name, $properties)
+	{
+		$field['name']       = $name;
+		$field['properties'] = $properties;
+		$this->_newFields[]  = $field;
+	}
+
+	/**
+	 * Get fields that need to be altered
+	 *
+	 * @return array fields that need to be altered
+	 *
+	 */
+	public function getAlteredFields()
+	{
+		return $this->_alteredFields;
+	}
+
+	/**
+	 * Add field for which the value will be updated
+	 *
+	 * @param string $name  name of the field
+	 * @param string $value value to be set
+	 *
+	 */
+	public function addUpdatedField($name, $value)
+	{
+		$field['name']          = $name;
+		$field['value']         = $value;
+		$this->_updatedFields[] = $field;
+	}
+
+	/**
+	 * Get new fields to be added
+	 *
+	 * @return array fields to be added
+	 *
+	 */
+	public function getNewFields()
+	{
+		return $this->_newFields;
+	}
+
+	/**
+	 * Get fields which values need to be updated
+	 *
+	 * @return array fields which values need to be updated
+	 *
+	 */
+	public function getUpdatedFields()
+	{
+		return $this->_updatedFields;
+	}
+	/**
+	 * Get fields which values need to be updated
+	 *
+	 * @return array fields which values need to be updated
+	 *
+	 */ //felix
+	public function getUpdatedWhere()
+	{
+		return $this->_updatedWhere;
+	}
+
+	/**
+	 * Add values of a record to be added
+	 *
+	 * @param string $name name of the field
+	 *
+	 */
+	public function addDroppedField($name)
+	{
+		$this->_droppedFields[] = $name;
+	}
+
+	/**
+	 * Get fields that need to be dropped
+	 *
+	 * @return array fields that need to be dropped
+	 *
+	 */
+	public function getDroppedFields()
+	{
+		return $this->_droppedFields;
+	}
+
+	/**
+	 * Set the flag to drop the table
+	 *
+	 */
+	public function setFlagForDrop()
+	{
+		$this->_flagForDrop = true;
+	}
+
+	/**
+	 * Use to create a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function createTable()
+	{
+		global $xoopsDB;
+		$query = $this->getStructure();
+		$query = 'CREATE TABLE `' . $this->name() . '` (' . $query . ") ENGINE=MyISAM COMMENT='The SmartFactory <www.smartfactory.ca>'";
+		//xoops_debug($query);
+		$ret = $xoopsDB->query($query);
+		if (!$ret) {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
+		} else {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CREATE_TABLE, $this->name()) . '<br />';
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to drop a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function dropTable()
+	{
+		global $xoopsDB;
+		$query = sprintf('DROP TABLE %s', $this->name());
+		$ret   = $xoopsDB->query($query);
+		if (!$ret) {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
+
+			return false;
+		} else {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROP_TABLE, $this->name()) . '<br />';
+
+			return true;
+		}
+	}
+
+	/**
+	 * Use to alter a table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function alterTable()
+	{
+		global $xoopsDB;
+		$ret = true;
+
+		foreach ($this->getAlteredFields() as $alteredField) {
+			if (!$alteredField['newname']) {
+				$alteredField['newname'] = $alteredField['name'];
+			}
+
+			$query = sprintf('ALTER TABLE `%s` CHANGE `%s` `%s` %s', $this->name(), $alteredField['name'], $alteredField['newname'], $alteredField['properties']);
+			$ret   = $ret && $xoopsDB->query($query);
+			if ($alteredField['showerror']) {
+				if (!$ret) {
+					echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
+				} else {
+					echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()) . '<br />';
+				}
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to add new fileds in the table
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function addNewFields()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getNewFields() as $newField) {
+			$query = sprintf('ALTER TABLE `%s` ADD `%s` %s', $this->name(), $newField['name'], $newField['properties']);
+			//echo $query;
+			$ret = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD_ERR, $newField['name'], $this->name()) . '<br />';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_NEWFIELD, $newField['name'], $this->name()) . '<br />';
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to update fields values
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function updateFieldsValues()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getUpdatedFields() as $updatedField) {
+			$query = sprintf('UPDATE %s SET %s = %s', $this->name(), $updatedField['name'], $updatedField['value']);
+			$ret   = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br />';
+			}
+		}
+
+		return $ret;
+	}
+	/**
+	 * Use to update fields values
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */ //felix
+	public function updateWhereValues()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getUpdatedWhere() as $updatedWhere) {
+			$query = sprintf('UPDATE %s SET %s = %s WHERE %s  %s', $this->name(), $updatedWhere['name'], $updatedWhere['value'], $updatedWhere['name'], $updatedWhere['where']);
+			//echo $query."<br>";
+			$ret = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br />';
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Use to drop fields
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function dropFields()
+	{
+		global $xoopsDB;
+		$ret = true;
+		foreach ($this->getDroppedFields() as $droppedField) {
+			$query = sprintf('ALTER TABLE %s DROP %s', $this->name(), $droppedField);
+			$ret   = $ret && $xoopsDB->query($query);
+			if (!$ret) {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD_ERR, $droppedField, $this->name()) . ' (' . $xoopsDB->error() . ')<br />';
+			} else {
+				echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_DROPFIELD, $droppedField, $this->name()) . '<br />';
+			}
+		}
+
+		return $ret;
+	}
 }
 
 /**
@@ -542,328 +542,328 @@ 
  */
 class SmartobjectDbupdater
 {
-    public $_dbTypesArray;
-
-    /**
-     * SmartobjectDbupdater constructor.
-     */
-    public function __construct()
-    {
-        $this->_dbTypesArray[XOBJ_DTYPE_TXTBOX]       = 'varchar(255)';
-        $this->_dbTypesArray[XOBJ_DTYPE_TXTAREA]      = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_INT]          = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_URL]          = 'varchar(255)';
-        $this->_dbTypesArray[XOBJ_DTYPE_EMAIL]        = 'varchar(255)';
-        $this->_dbTypesArray[XOBJ_DTYPE_ARRAY]        = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_OTHER]        = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_SOURCE]       = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_STIME]        = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_MTIME]        = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_LTIME]        = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_SIMPLE_ARRAY] = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_CURRENCY]     = 'text';
-        $this->_dbTypesArray[XOBJ_DTYPE_FLOAT]        = 'float';
-        $this->_dbTypesArray[XOBJ_DTYPE_TIME_ONLY]    = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_URLLINK]      = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_FILE]         = 'int(11)';
-        $this->_dbTypesArray[XOBJ_DTYPE_IMAGE]        = 'varchar(255)';
-    }
-
-    /**
-     * Use to execute a general query
-     *
-     * @param string $query   query that will be executed
-     * @param string $goodmsg message displayed on success
-     * @param string $badmsg  message displayed on error
-     *
-     * @return bool true if success, false if an error occured
-     *
-     */
-    public function runQuery($query, $goodmsg, $badmsg)
-    {
-        global $xoopsDB;
-        $ret = $xoopsDB->query($query);
-        if (!$ret) {
-            echo "&nbsp;&nbsp;$badmsg<br />";
-
-            return false;
-        } else {
-            echo "&nbsp;&nbsp;$goodmsg<br />";
-
-            return true;
-        }
-    }
-
-    /**
-     * Use to rename a table
-     *
-     * @param string $from name of the table to rename
-     * @param string $to   new name of the renamed table
-     *
-     * @return bool true if success, false if an error occured
-     */
-    public function renameTable($from, $to)
-    {
-        global $xoopsDB;
-        $from  = $xoopsDB->prefix($from);
-        $to    = $xoopsDB->prefix($to);
-        $query = sprintf('ALTER TABLE %s RENAME %s', $from, $to);
-        $ret   = $xoopsDB->query($query);
-        if (!$ret) {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE_ERR, $from) . '<br />';
-
-            return false;
-        } else {
-            echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE, $from, $to) . '<br />';
-
-            return true;
-        }
-    }
-
-    /**
-     * Use to update a table
-     *
-     * @param object $table {@link SmartDbTable} that will be updated
-     *
-     * @see SmartDbTable
-     *
-     * @return bool true if success, false if an error occured
-     */
-    public function updateTable($table)
-    {
-        global $xoopsDB;
-        $ret = true;
-        // If table has a structure, create the table
-        if ($table->getStructure()) {
-            $ret = $table->createTable() && $ret;
-        }
-        // If table is flag for drop, drop it
-        if ($table->_flagForDrop) {
-            $ret = $table->dropTable() && $ret;
-        }
-        // If table has data, insert it
-        if ($table->getData()) {
-            $ret = $table->addData() && $ret;
-        }
-        // If table has new fields to be added, add them
-        if ($table->getNewFields()) {
-            $ret = $table->addNewFields() && $ret;
-        }
-        // If table has altered field, alter the table
-        if ($table->getAlteredFields()) {
-            $ret = $table->alterTable() && $ret;
-        }
-        // If table has updated field values, update the table
-        if ($table->getUpdatedFields()) {
-            $ret = $table->updateFieldsValues($table) && $ret;
-        }
-        // If table has dropped field, alter the table
-        if ($table->getDroppedFields()) {
-            $ret = $table->dropFields($table) && $ret;
-        }
-        //felix
-        // If table has updated field values, update the table
-        if ($table->getUpdatedWhere()) {
-            $ret = $table->UpdateWhereValues($table) && $ret;
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param $module
-     * @param $item
-     */
-    public function automaticUpgrade($module, $item)
-    {
-        if (is_array($item)) {
-            foreach ($item as $v) {
-                $this->upgradeObjectItem($module, $v);
-            }
-        } else {
-            $this->upgradeObjectItem($module, $item);
-        }
-    }
-
-    /**
-     * @param $var
-     * @return string
-     */
-    public function getFieldTypeFromVar($var)
-    {
-        $ret = isset($this->_dbTypesArray[$var['data_type']]) ? $this->_dbTypesArray[$var['data_type']] : 'text';
-
-        return $ret;
-    }
-
-    /**
-     * @param       $var
-     * @param  bool $key
-     * @return string
-     */
-    public function getFieldDefaultFromVar($var, $key = false)
-    {
-        if ($var['value']) {
-            return $var['value'];
-        } else {
-            if (in_array($var['data_type'], array(
-                XOBJ_DTYPE_INT,
-                XOBJ_DTYPE_STIME,
-                XOBJ_DTYPE_MTIME,
-                XOBJ_DTYPE_LTIME,
-                XOBJ_DTYPE_TIME_ONLY,
-                XOBJ_DTYPE_URLLINK,
-                XOBJ_DTYPE_FILE
-            ))) {
-                return '0';
-            } else {
-                return '';
-            }
-        }
-    }
-
-    /**
-     * @param $module
-     * @param $item
-     * @return bool
-     */
-    public function upgradeObjectItem($module, $item)
-    {
-        $moduleHandler = xoops_getModuleHandler($item, $module);
-        if (!$moduleHandler) {
-            return false;
-        }
-
-        $table      = new SmartDbTable($module . '_' . $item);
-        $object     = $moduleHandler->create();
-        $objectVars = $object->getVars();
-
-        if (!$table->exists()) {
-            // table was never created, let's do it
-            $structure = '';
-            foreach ($objectVars as $key => $var) {
-                if ($var['persistent']) {
-                    $type = $this->getFieldTypeFromVar($var);
-                    if ($key == $moduleHandler->keyName) {
-                        $extra = 'auto_increment';
-                    } else {
-                        $default = $this->getFieldDefaultFromVar($var);
-                        $extra   = "default '$default'
+	public $_dbTypesArray;
+
+	/**
+	 * SmartobjectDbupdater constructor.
+	 */
+	public function __construct()
+	{
+		$this->_dbTypesArray[XOBJ_DTYPE_TXTBOX]       = 'varchar(255)';
+		$this->_dbTypesArray[XOBJ_DTYPE_TXTAREA]      = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_INT]          = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_URL]          = 'varchar(255)';
+		$this->_dbTypesArray[XOBJ_DTYPE_EMAIL]        = 'varchar(255)';
+		$this->_dbTypesArray[XOBJ_DTYPE_ARRAY]        = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_OTHER]        = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_SOURCE]       = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_STIME]        = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_MTIME]        = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_LTIME]        = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_SIMPLE_ARRAY] = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_CURRENCY]     = 'text';
+		$this->_dbTypesArray[XOBJ_DTYPE_FLOAT]        = 'float';
+		$this->_dbTypesArray[XOBJ_DTYPE_TIME_ONLY]    = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_URLLINK]      = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_FILE]         = 'int(11)';
+		$this->_dbTypesArray[XOBJ_DTYPE_IMAGE]        = 'varchar(255)';
+	}
+
+	/**
+	 * Use to execute a general query
+	 *
+	 * @param string $query   query that will be executed
+	 * @param string $goodmsg message displayed on success
+	 * @param string $badmsg  message displayed on error
+	 *
+	 * @return bool true if success, false if an error occured
+	 *
+	 */
+	public function runQuery($query, $goodmsg, $badmsg)
+	{
+		global $xoopsDB;
+		$ret = $xoopsDB->query($query);
+		if (!$ret) {
+			echo "&nbsp;&nbsp;$badmsg<br />";
+
+			return false;
+		} else {
+			echo "&nbsp;&nbsp;$goodmsg<br />";
+
+			return true;
+		}
+	}
+
+	/**
+	 * Use to rename a table
+	 *
+	 * @param string $from name of the table to rename
+	 * @param string $to   new name of the renamed table
+	 *
+	 * @return bool true if success, false if an error occured
+	 */
+	public function renameTable($from, $to)
+	{
+		global $xoopsDB;
+		$from  = $xoopsDB->prefix($from);
+		$to    = $xoopsDB->prefix($to);
+		$query = sprintf('ALTER TABLE %s RENAME %s', $from, $to);
+		$ret   = $xoopsDB->query($query);
+		if (!$ret) {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE_ERR, $from) . '<br />';
+
+			return false;
+		} else {
+			echo '&nbsp;&nbsp;' . sprintf(_SDU_MSG_RENAME_TABLE, $from, $to) . '<br />';
+
+			return true;
+		}
+	}
+
+	/**
+	 * Use to update a table
+	 *
+	 * @param object $table {@link SmartDbTable} that will be updated
+	 *
+	 * @see SmartDbTable
+	 *
+	 * @return bool true if success, false if an error occured
+	 */
+	public function updateTable($table)
+	{
+		global $xoopsDB;
+		$ret = true;
+		// If table has a structure, create the table
+		if ($table->getStructure()) {
+			$ret = $table->createTable() && $ret;
+		}
+		// If table is flag for drop, drop it
+		if ($table->_flagForDrop) {
+			$ret = $table->dropTable() && $ret;
+		}
+		// If table has data, insert it
+		if ($table->getData()) {
+			$ret = $table->addData() && $ret;
+		}
+		// If table has new fields to be added, add them
+		if ($table->getNewFields()) {
+			$ret = $table->addNewFields() && $ret;
+		}
+		// If table has altered field, alter the table
+		if ($table->getAlteredFields()) {
+			$ret = $table->alterTable() && $ret;
+		}
+		// If table has updated field values, update the table
+		if ($table->getUpdatedFields()) {
+			$ret = $table->updateFieldsValues($table) && $ret;
+		}
+		// If table has dropped field, alter the table
+		if ($table->getDroppedFields()) {
+			$ret = $table->dropFields($table) && $ret;
+		}
+		//felix
+		// If table has updated field values, update the table
+		if ($table->getUpdatedWhere()) {
+			$ret = $table->UpdateWhereValues($table) && $ret;
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param $module
+	 * @param $item
+	 */
+	public function automaticUpgrade($module, $item)
+	{
+		if (is_array($item)) {
+			foreach ($item as $v) {
+				$this->upgradeObjectItem($module, $v);
+			}
+		} else {
+			$this->upgradeObjectItem($module, $item);
+		}
+	}
+
+	/**
+	 * @param $var
+	 * @return string
+	 */
+	public function getFieldTypeFromVar($var)
+	{
+		$ret = isset($this->_dbTypesArray[$var['data_type']]) ? $this->_dbTypesArray[$var['data_type']] : 'text';
+
+		return $ret;
+	}
+
+	/**
+	 * @param       $var
+	 * @param  bool $key
+	 * @return string
+	 */
+	public function getFieldDefaultFromVar($var, $key = false)
+	{
+		if ($var['value']) {
+			return $var['value'];
+		} else {
+			if (in_array($var['data_type'], array(
+				XOBJ_DTYPE_INT,
+				XOBJ_DTYPE_STIME,
+				XOBJ_DTYPE_MTIME,
+				XOBJ_DTYPE_LTIME,
+				XOBJ_DTYPE_TIME_ONLY,
+				XOBJ_DTYPE_URLLINK,
+				XOBJ_DTYPE_FILE
+			))) {
+				return '0';
+			} else {
+				return '';
+			}
+		}
+	}
+
+	/**
+	 * @param $module
+	 * @param $item
+	 * @return bool
+	 */
+	public function upgradeObjectItem($module, $item)
+	{
+		$moduleHandler = xoops_getModuleHandler($item, $module);
+		if (!$moduleHandler) {
+			return false;
+		}
+
+		$table      = new SmartDbTable($module . '_' . $item);
+		$object     = $moduleHandler->create();
+		$objectVars = $object->getVars();
+
+		if (!$table->exists()) {
+			// table was never created, let's do it
+			$structure = '';
+			foreach ($objectVars as $key => $var) {
+				if ($var['persistent']) {
+					$type = $this->getFieldTypeFromVar($var);
+					if ($key == $moduleHandler->keyName) {
+						$extra = 'auto_increment';
+					} else {
+						$default = $this->getFieldDefaultFromVar($var);
+						$extra   = "default '$default'
 ";
-                    }
-                    $structure .= "`$key` $type not null $extra,
+					}
+					$structure .= "`$key` $type not null $extra,
 ";
-                }
-            }
-            $structure .= 'PRIMARY KEY  (`' . $moduleHandler->keyName . '`)
+				}
+			}
+			$structure .= 'PRIMARY KEY  (`' . $moduleHandler->keyName . '`)
 ';
-            $table->setStructure($structure);
-            if (!$this->updateTable($table)) {
-                /**
-                 * @todo trap the errors
-                 */
-            }
-        } else {
-            $existingFieldsArray = $table->getExistingFieldsArray();
-            foreach ($objectVars as $key => $var) {
-                if ($var['persistent']) {
-                    if (!isset($existingFieldsArray[$key])) {
-                        // the fiels does not exist, let's create it
-                        $type    = $this->getFieldTypeFromVar($var);
-                        $default = $this->getFieldDefaultFromVar($var);
-                        $table->addNewField($key, "$type not null default '$default'");
-                    } else {
-                        // if field already exists, let's check if the definition is correct
-                        $definition = strtolower($existingFieldsArray[$key]);
-                        $type       = $this->getFieldTypeFromVar($var);
-                        if ($key == $moduleHandler->keyName) {
-                            $extra = 'auto_increment';
-                        } else {
-                            $default = $this->getFieldDefaultFromVar($var, $key);
-                            $extra   = "default '$default'";
-                        }
-                        $actual_definition = "$type not null $extra";
-                        if ($definition != $actual_definition) {
-                            $table->addAlteredField($key, $actual_definition);
-                        }
-                    }
-                }
-            }
-
-            // check to see if there are some unused fields left in the table
-            foreach ($existingFieldsArray as $key => $v) {
-                if (!isset($objectVars[$key]) || !$objectVars[$key]['persistent']) {
-                    $table->addDroppedField($key);
-                }
-            }
-
-            if (!$this->updateTable($table)) {
-                /**
-                 * @todo trap the errors
-                 */
-            }
-        }
-    }
-
-    /**
-     * @param $module
-     * @return bool
-     */
-    public function moduleUpgrade(&$module)
-    {
-        $dirname = $module->getVar('dirname');
-
-        ob_start();
-
-        $table = new SmartDbTable($dirname . '_meta');
-        if (!$table->exists()) {
-            $table->setStructure("
+			$table->setStructure($structure);
+			if (!$this->updateTable($table)) {
+				/**
+				 * @todo trap the errors
+				 */
+			}
+		} else {
+			$existingFieldsArray = $table->getExistingFieldsArray();
+			foreach ($objectVars as $key => $var) {
+				if ($var['persistent']) {
+					if (!isset($existingFieldsArray[$key])) {
+						// the fiels does not exist, let's create it
+						$type    = $this->getFieldTypeFromVar($var);
+						$default = $this->getFieldDefaultFromVar($var);
+						$table->addNewField($key, "$type not null default '$default'");
+					} else {
+						// if field already exists, let's check if the definition is correct
+						$definition = strtolower($existingFieldsArray[$key]);
+						$type       = $this->getFieldTypeFromVar($var);
+						if ($key == $moduleHandler->keyName) {
+							$extra = 'auto_increment';
+						} else {
+							$default = $this->getFieldDefaultFromVar($var, $key);
+							$extra   = "default '$default'";
+						}
+						$actual_definition = "$type not null $extra";
+						if ($definition != $actual_definition) {
+							$table->addAlteredField($key, $actual_definition);
+						}
+					}
+				}
+			}
+
+			// check to see if there are some unused fields left in the table
+			foreach ($existingFieldsArray as $key => $v) {
+				if (!isset($objectVars[$key]) || !$objectVars[$key]['persistent']) {
+					$table->addDroppedField($key);
+				}
+			}
+
+			if (!$this->updateTable($table)) {
+				/**
+				 * @todo trap the errors
+				 */
+			}
+		}
+	}
+
+	/**
+	 * @param $module
+	 * @return bool
+	 */
+	public function moduleUpgrade(&$module)
+	{
+		$dirname = $module->getVar('dirname');
+
+		ob_start();
+
+		$table = new SmartDbTable($dirname . '_meta');
+		if (!$table->exists()) {
+			$table->setStructure("
               `metakey` varchar(50) NOT NULL default '',
               `metavalue` varchar(255) NOT NULL default '',
               PRIMARY KEY (`metakey`)");
-            $table->setData("'version',0");
-            if (!$this->updateTable($table)) {
-                /**
-                 * @todo trap the errors
-                 */
-            }
-        }
-
-        $dbVersion = smart_GetMeta('version', $dirname);
-        if (!$dbVersion) {
-            $dbVersion = 0;
-        }
-        $newDbVersion = constant(strtoupper($dirname . '_db_version')) ?: 0;
-        echo 'Database version: ' . $dbVersion . '<br />';
-        echo 'New database version: ' . $newDbVersion . '<br />';
-
-        if ($newDbVersion > $dbVersion) {
-            for ($i = $dbVersion + 1; $i <= $newDbVersion; ++$i) {
-                $upgrade_function = $dirname . '_db_upgrade_' . $i;
-                if (function_exists($upgrade_function)) {
-                    $upgrade_function();
-                }
-            }
-        }
-
-        echo '<code>' . _SDU_UPDATE_UPDATING_DATABASE . '<br />';
-
-        // if there is a function to execute for this DB version, let's do it
-        //$function_
-
-        $module_info = smart_getModuleInfo($dirname);
-        $this->automaticUpgrade($dirname, $module_info->modinfo['object_items']);
-
-        echo '</code>';
-
-        $feedback = ob_get_clean();
-        if (method_exists($module, 'setMessage')) {
-            $module->setMessage($feedback);
-        } else {
-            echo $feedback;
-        }
-        smart_SetMeta('version', $newDbVersion, $dirname); //Set meta version to current
-
-        return true;
-    }
+			$table->setData("'version',0");
+			if (!$this->updateTable($table)) {
+				/**
+				 * @todo trap the errors
+				 */
+			}
+		}
+
+		$dbVersion = smart_GetMeta('version', $dirname);
+		if (!$dbVersion) {
+			$dbVersion = 0;
+		}
+		$newDbVersion = constant(strtoupper($dirname . '_db_version')) ?: 0;
+		echo 'Database version: ' . $dbVersion . '<br />';
+		echo 'New database version: ' . $newDbVersion . '<br />';
+
+		if ($newDbVersion > $dbVersion) {
+			for ($i = $dbVersion + 1; $i <= $newDbVersion; ++$i) {
+				$upgrade_function = $dirname . '_db_upgrade_' . $i;
+				if (function_exists($upgrade_function)) {
+					$upgrade_function();
+				}
+			}
+		}
+
+		echo '<code>' . _SDU_UPDATE_UPDATING_DATABASE . '<br />';
+
+		// if there is a function to execute for this DB version, let's do it
+		//$function_
+
+		$module_info = smart_getModuleInfo($dirname);
+		$this->automaticUpgrade($dirname, $module_info->modinfo['object_items']);
+
+		echo '</code>';
+
+		$feedback = ob_get_clean();
+		if (method_exists($module, 'setMessage')) {
+			$module->setMessage($feedback);
+		} else {
+			echo $feedback;
+		}
+		smart_SetMeta('version', $newDbVersion, $dirname); //Set meta version to current
+
+		return true;
+	}
 }

class/smartexport.php

Doc Comments +2 added lines, -2 removed lines

@@ -197,7 +197,7 @@ 
     /**
      * @param $val
      * @param $separator
-     * @param $trimFunction
+     * @param false|string $trimFunction
      * @return mixed|string
      */
     public function valToCsvHelper($val, $separator, $trimFunction)
@@ -248,7 +248,7 @@ 
     }
 
     /**
-     * @param $content
+     * @param string $content
      */
     public function saveExportFile($content)
     {

Indentation +265 added lines, -265 removed lines

@@ -1,12 +1,12 @@ 
 <?php
 /**
- * Contains the classes for easily exporting data
- *
- * @license GNU
- * @author  marcan <marcan@smartfactory.ca>
- * @link    http://www.smartfactory.ca The SmartFactory
- * @package SmartObject
- */
+	 * Contains the classes for easily exporting data
+	 *
+	 * @license GNU
+	 * @author  marcan <marcan@smartfactory.ca>
+	 * @link    http://www.smartfactory.ca The SmartFactory
+	 * @package SmartObject
+	 */
 
 /**
  * SmartObjectExport class
@@ -19,110 +19,110 @@ 
  */
 class SmartObjectExport
 {
-    public $handler;
-    public $criteria;
-    public $fields;
-    public $format;
-    public $filename;
-    public $filepath;
-    public $options;
-    public $outputMethods = false;
-    public $notDisplayFields;
+	public $handler;
+	public $criteria;
+	public $fields;
+	public $format;
+	public $filename;
+	public $filepath;
+	public $options;
+	public $outputMethods = false;
+	public $notDisplayFields;
 
-    /**
-     * Constructor
-     *
-     * @param object      $objectHandler SmartObjectHandler handling the data we want to export
-     * @param object      $criteria      containing the criteria of the query fetching the objects to be exported
-     * @param array|bool  $fields        fields to be exported. If FALSE then all fields will be exported
-     * @param bool|string $filename      name of the file to be created
-     * @param bool|string $filepath      path where the file will be saved
-     * @param string      $format        format of the ouputed export. Currently only supports CSV
-     * @param array|bool  $options       options of the format to be exported in
-     */
-    public function __construct($objectHandler, $criteria = null, $fields = false, $filename = false, $filepath = false, $format = 'csv', $options = false)
-    {
-        $this->handler          = $objectHandler;
-        $this->criteria         = $criteria;
-        $this->fields           = $fields;
-        $this->filename         = $filename;
-        $this->format           = $format;
-        $this->options          = $options;
-        $this->notDisplayFields = false;
-    }
+	/**
+	 * Constructor
+	 *
+	 * @param object      $objectHandler SmartObjectHandler handling the data we want to export
+	 * @param object      $criteria      containing the criteria of the query fetching the objects to be exported
+	 * @param array|bool  $fields        fields to be exported. If FALSE then all fields will be exported
+	 * @param bool|string $filename      name of the file to be created
+	 * @param bool|string $filepath      path where the file will be saved
+	 * @param string      $format        format of the ouputed export. Currently only supports CSV
+	 * @param array|bool  $options       options of the format to be exported in
+	 */
+	public function __construct($objectHandler, $criteria = null, $fields = false, $filename = false, $filepath = false, $format = 'csv', $options = false)
+	{
+		$this->handler          = $objectHandler;
+		$this->criteria         = $criteria;
+		$this->fields           = $fields;
+		$this->filename         = $filename;
+		$this->format           = $format;
+		$this->options          = $options;
+		$this->notDisplayFields = false;
+	}
 
-    /**
-     * Renders the export
-     * @param $filename
-     */
-    public function render($filename)
-    {
-        $this->filename = $filename;
+	/**
+	 * Renders the export
+	 * @param $filename
+	 */
+	public function render($filename)
+	{
+		$this->filename = $filename;
 
-        $objects        = $this->handler->getObjects($this->criteria);
-        $rows           = array();
-        $columnsHeaders = array();
-        $firstObject    = true;
-        foreach ($objects as $object) {
-            $row = array();
-            foreach ($object->vars as $key => $var) {
-                if ((!$this->fields || in_array($key, $this->fields)) && !in_array($key, $this->notDisplayFields)) {
-                    if ($this->outputMethods && isset($this->outputMethods[$key]) && method_exists($object, $this->outputMethods[$key])) {
-                        $method    = $this->outputMethods[$key];
-                        $row[$key] = $object->$method();
-                    } else {
-                        $row[$key] = $object->getVar($key);
-                    }
-                    if ($firstObject) {
-                        // then set the columnsHeaders array as well
-                        $columnsHeaders[$key] = $var['form_caption'];
-                    }
-                }
-            }
-            $firstObject = false;
-            $rows[]      = $row;
-            unset($row);
-        }
-        $data                   = array();
-        $data['rows']           = $rows;
-        $data['columnsHeaders'] = $columnsHeaders;
-        $smartExportRenderer    = new SmartExportRenderer($data, $this->filename, $this->filepath, $this->format, $this->options);
-        $smartExportRenderer->execute();
-    }
+		$objects        = $this->handler->getObjects($this->criteria);
+		$rows           = array();
+		$columnsHeaders = array();
+		$firstObject    = true;
+		foreach ($objects as $object) {
+			$row = array();
+			foreach ($object->vars as $key => $var) {
+				if ((!$this->fields || in_array($key, $this->fields)) && !in_array($key, $this->notDisplayFields)) {
+					if ($this->outputMethods && isset($this->outputMethods[$key]) && method_exists($object, $this->outputMethods[$key])) {
+						$method    = $this->outputMethods[$key];
+						$row[$key] = $object->$method();
+					} else {
+						$row[$key] = $object->getVar($key);
+					}
+					if ($firstObject) {
+						// then set the columnsHeaders array as well
+						$columnsHeaders[$key] = $var['form_caption'];
+					}
+				}
+			}
+			$firstObject = false;
+			$rows[]      = $row;
+			unset($row);
+		}
+		$data                   = array();
+		$data['rows']           = $rows;
+		$data['columnsHeaders'] = $columnsHeaders;
+		$smartExportRenderer    = new SmartExportRenderer($data, $this->filename, $this->filepath, $this->format, $this->options);
+		$smartExportRenderer->execute();
+	}
 
-    /**
-     * Set an array contaning the alternate methods to use instead of the default getVar()
-     *
-     * $outputMethods array example: 'uid' => 'getUserName'...
-     * @param $outputMethods
-     */
-    public function setOuptutMethods($outputMethods)
-    {
-        $this->outputMethods = $outputMethods;
-    }
+	/**
+	 * Set an array contaning the alternate methods to use instead of the default getVar()
+	 *
+	 * $outputMethods array example: 'uid' => 'getUserName'...
+	 * @param $outputMethods
+	 */
+	public function setOuptutMethods($outputMethods)
+	{
+		$this->outputMethods = $outputMethods;
+	}
 
-    /*
+	/*
      * Set an array of fields that we don't want in export
      */
-    /**
-     * @param $fields
-     */
-    public function setNotDisplayFields($fields)
-    {
-        if (!$this->notDisplayFields) {
-            if (is_array($fields)) {
-                $this->notDisplayFields = $fields;
-            } else {
-                $this->notDisplayFields = array($fields);
-            }
-        } else {
-            if (is_array($fields)) {
-                $this->notDisplayFields = array_merge($this->notDisplayFields, $fields);
-            } else {
-                $this->notDisplayFields[] = $fields;
-            }
-        }
-    }
+	/**
+	 * @param $fields
+	 */
+	public function setNotDisplayFields($fields)
+	{
+		if (!$this->notDisplayFields) {
+			if (is_array($fields)) {
+				$this->notDisplayFields = $fields;
+			} else {
+				$this->notDisplayFields = array($fields);
+			}
+		} else {
+			if (is_array($fields)) {
+				$this->notDisplayFields = array_merge($this->notDisplayFields, $fields);
+			} else {
+				$this->notDisplayFields[] = $fields;
+			}
+		}
+	}
 }
 
 /**
@@ -136,181 +136,181 @@ 
  */
 class SmartExportRenderer
 {
-    public $data;
-    public $format;
-    public $filename;
-    public $filepath;
-    public $options;
+	public $data;
+	public $format;
+	public $filename;
+	public $filepath;
+	public $options;
 
-    /**
-     * Constructor
-     *
-     * @param array       $data     contains the data to be exported
-     * @param bool|string $filename name of the file in which the exported data will be saved
-     * @param bool|string $filepath path where the file will be saved
-     * @param string      $format   format of the ouputed export. Currently only supports CSV
-     * @param array       $options  options of the format to be exported in
-     */
-    public function __construct($data, $filename = false, $filepath = false, $format = 'csv', $options = array('separator' => ';'))
-    {
-        $this->data     = $data;
-        $this->format   = $format;
-        $this->filename = $filename;
-        $this->filepath = $filepath;
-        $this->options  = $options;
-    }
+	/**
+	 * Constructor
+	 *
+	 * @param array       $data     contains the data to be exported
+	 * @param bool|string $filename name of the file in which the exported data will be saved
+	 * @param bool|string $filepath path where the file will be saved
+	 * @param string      $format   format of the ouputed export. Currently only supports CSV
+	 * @param array       $options  options of the format to be exported in
+	 */
+	public function __construct($data, $filename = false, $filepath = false, $format = 'csv', $options = array('separator' => ';'))
+	{
+		$this->data     = $data;
+		$this->format   = $format;
+		$this->filename = $filename;
+		$this->filepath = $filepath;
+		$this->options  = $options;
+	}
 
-    /**
-     * @param         $dataArray
-     * @param         $separator
-     * @param  string $trim
-     * @param  bool   $removeEmptyLines
-     * @return string
-     */
-    public function arrayToCsvString($dataArray, $separator, $trim = 'both', $removeEmptyLines = true)
-    {
-        if (!is_array($dataArray) || empty($dataArray)) {
-            return '';
-        }
-        switch ($trim) {
-            case 'none':
-                $trimFunction = false;
-                break;
-            case 'left':
-                $trimFunction = 'ltrim';
-                break;
-            case 'right':
-                $trimFunction = 'rtrim';
-                break;
-            default: //'both':
-                $trimFunction = 'trim';
-                break;
-        }
-        $ret = array();
-        foreach ($dataArray as $key => $field) {
-            $ret[$key] = $this->valToCsvHelper($field, $separator, $trimFunction);
-        }
+	/**
+	 * @param         $dataArray
+	 * @param         $separator
+	 * @param  string $trim
+	 * @param  bool   $removeEmptyLines
+	 * @return string
+	 */
+	public function arrayToCsvString($dataArray, $separator, $trim = 'both', $removeEmptyLines = true)
+	{
+		if (!is_array($dataArray) || empty($dataArray)) {
+			return '';
+		}
+		switch ($trim) {
+			case 'none':
+				$trimFunction = false;
+				break;
+			case 'left':
+				$trimFunction = 'ltrim';
+				break;
+			case 'right':
+				$trimFunction = 'rtrim';
+				break;
+			default: //'both':
+				$trimFunction = 'trim';
+				break;
+		}
+		$ret = array();
+		foreach ($dataArray as $key => $field) {
+			$ret[$key] = $this->valToCsvHelper($field, $separator, $trimFunction);
+		}
 
-        return implode($separator, $ret);
-    }
+		return implode($separator, $ret);
+	}
 
-    /**
-     * @param $val
-     * @param $separator
-     * @param $trimFunction
-     * @return mixed|string
-     */
-    public function valToCsvHelper($val, $separator, $trimFunction)
-    {
-        if ($trimFunction) {
-            $val = $trimFunction ($val);
-        }
-        //If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
-        $needQuote = false;
-        do {
-            if (strpos($val, '"') !== false) {
-                $val       = str_replace('"', '""', $val);
-                $needQuote = true;
-                break;
-            }
-            if (strpos($val, $separator) !== false) {
-                $needQuote = true;
-                break;
-            }
-            if ((strpos($val, "\n") !== false) || (strpos($val, "\r") !== false)) { // \r is for mac
-                $needQuote = true;
-                break;
-            }
-        } while (false);
-        if ($needQuote) {
-            $val = '"' . $val . '"';
-        }
+	/**
+	 * @param $val
+	 * @param $separator
+	 * @param $trimFunction
+	 * @return mixed|string
+	 */
+	public function valToCsvHelper($val, $separator, $trimFunction)
+	{
+		if ($trimFunction) {
+			$val = $trimFunction ($val);
+		}
+		//If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
+		$needQuote = false;
+		do {
+			if (strpos($val, '"') !== false) {
+				$val       = str_replace('"', '""', $val);
+				$needQuote = true;
+				break;
+			}
+			if (strpos($val, $separator) !== false) {
+				$needQuote = true;
+				break;
+			}
+			if ((strpos($val, "\n") !== false) || (strpos($val, "\r") !== false)) { // \r is for mac
+				$needQuote = true;
+				break;
+			}
+		} while (false);
+		if ($needQuote) {
+			$val = '"' . $val . '"';
+		}
 
-        return $val;
-    }
+		return $val;
+	}
 
-    public function execute()
-    {
-        $exportFileData = '';
+	public function execute()
+	{
+		$exportFileData = '';
 
-        switch ($this->format) {
-            case 'csv':
-                $separator = isset($this->options['separator']) ? $this->options['separator'] : ';';
-                $firstRow  = implode($separator, $this->data['columnsHeaders']);
-                $exportFileData .= $firstRow . "\r\n";
+		switch ($this->format) {
+			case 'csv':
+				$separator = isset($this->options['separator']) ? $this->options['separator'] : ';';
+				$firstRow  = implode($separator, $this->data['columnsHeaders']);
+				$exportFileData .= $firstRow . "\r\n";
 
-                foreach ($this->data['rows'] as $cols) {
-                    $exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
-                }
-                break;
-        }
-        $this->saveExportFile($exportFileData);
-    }
+				foreach ($this->data['rows'] as $cols) {
+					$exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
+				}
+				break;
+		}
+		$this->saveExportFile($exportFileData);
+	}
 
-    /**
-     * @param $content
-     */
-    public function saveExportFile($content)
-    {
-        switch ($this->format) {
-            case 'csv':
-                $this->saveCsv($content);
-                break;
-        }
-    }
+	/**
+	 * @param $content
+	 */
+	public function saveExportFile($content)
+	{
+		switch ($this->format) {
+			case 'csv':
+				$this->saveCsv($content);
+				break;
+		}
+	}
 
-    /**
-     * @param $content
-     */
-    public function saveCsv($content)
-    {
-        if (!$this->filepath) {
-            $this->filepath = XOOPS_UPLOAD_PATH . '/';
-        }
-        if (!$this->filename) {
-            $this->filename .= time();
-            $this->filename .= '.csv';
-        }
+	/**
+	 * @param $content
+	 */
+	public function saveCsv($content)
+	{
+		if (!$this->filepath) {
+			$this->filepath = XOOPS_UPLOAD_PATH . '/';
+		}
+		if (!$this->filename) {
+			$this->filename .= time();
+			$this->filename .= '.csv';
+		}
 
-        $fullFileName = $this->filepath . $this->filename;
+		$fullFileName = $this->filepath . $this->filename;
 
-        if (!$handle = fopen($fullFileName, 'a+')) {
-            trigger_error('Unable to open ' . $fullFileName, E_USER_WARNING);
-        } elseif (fwrite($handle, $content) === false) {
-            trigger_error('Unable to write in ' . $fullFileName, E_USER_WARNING);
-        } else {
-            $mimeType  = 'text/csv';
-            $file      = strrev($this->filename);
-            $temp_name = strtolower(strrev(substr($file, 0, strpos($file, '--'))));
-            if ($temp_name == '') {
-                $file_name = $this->filename;
-            } else {
-                $file_name = $temp_name;
-            }
-            $fullFileName = $this->filepath . stripslashes(trim($this->filename));
+		if (!$handle = fopen($fullFileName, 'a+')) {
+			trigger_error('Unable to open ' . $fullFileName, E_USER_WARNING);
+		} elseif (fwrite($handle, $content) === false) {
+			trigger_error('Unable to write in ' . $fullFileName, E_USER_WARNING);
+		} else {
+			$mimeType  = 'text/csv';
+			$file      = strrev($this->filename);
+			$temp_name = strtolower(strrev(substr($file, 0, strpos($file, '--'))));
+			if ($temp_name == '') {
+				$file_name = $this->filename;
+			} else {
+				$file_name = $temp_name;
+			}
+			$fullFileName = $this->filepath . stripslashes(trim($this->filename));
 
-            if (ini_get('zlib.output_compression')) {
-                ini_set('zlib.output_compression', 'Off');
-            }
+			if (ini_get('zlib.output_compression')) {
+				ini_set('zlib.output_compression', 'Off');
+			}
 
-            header('Pragma: public');
-            header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
-            header('Cache-Control: private', false);
-            header('Content-Transfer-Encoding: binary');
-            if (isset($mimeType)) {
-                header('Content-Type: ' . $mimeType);
-            }
+			header('Pragma: public');
+			header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
+			header('Cache-Control: private', false);
+			header('Content-Transfer-Encoding: binary');
+			if (isset($mimeType)) {
+				header('Content-Type: ' . $mimeType);
+			}
 
-            header('Content-Disposition: attachment; filename=' . $file_name);
+			header('Content-Disposition: attachment; filename=' . $file_name);
 
-            if (isset($mimeType) && false !== strpos($mimeType, 'text/')) {
-                $fp = fopen($fullFileName, 'r');
-            } else {
-                $fp = fopen($fullFileName, 'rb');
-            }
-            fpassthru($fp);
-            exit();
-        }
-        fclose($handle);
-    }
+			if (isset($mimeType) && false !== strpos($mimeType, 'text/')) {
+				$fp = fopen($fullFileName, 'r');
+			} else {
+				$fp = fopen($fullFileName, 'rb');
+			}
+			fpassthru($fp);
+			exit();
+		}
+		fclose($handle);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -203,7 +203,7 @@
     public function valToCsvHelper($val, $separator, $trimFunction)
     {
         if ($trimFunction) {
-            $val = $trimFunction ($val);
+            $val = $trimFunction($val);
         }
         //If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
         $needQuote = false;

class/smartmetagen.php

Doc Comments +5 added lines, -5 removed lines

@@ -165,7 +165,7 @@ 
     }
 
     /**
-     * @param $keywords
+     * @param string|boolean $keywords
      */
     public function setKeywords($keywords)
     {
@@ -173,7 +173,7 @@ 
     }
 
     /**
-     * @param $categoryPath
+     * @param boolean $categoryPath
      */
     public function setCategoryPath($categoryPath)
     {
@@ -182,7 +182,7 @@ 
     }
 
     /**
-     * @param $description
+     * @param boolean $description
      */
     public function setDescription($description)
     {
@@ -242,8 +242,8 @@ 
     }
 
     /**
-     * @param $text
-     * @param $minChar
+     * @param string $text
+     * @param integer $minChar
      * @return array
      */
     public function findMetaKeywords($text, $minChar)

Indentation +304 added lines, -304 removed lines

@@ -18,276 +18,276 @@ 
  */
 class SmartMetaGen
 {
-    public $_myts;
-
-    public $_title;
-    public $_original_title;
-    public $_keywords;
-    public $_meta_description;
-    public $_categoryPath;
-    public $_description;
-    public $_minChar = 4;
-
-    /**
-     * SmartMetaGen constructor.
-     * @param      $title
-     * @param bool $keywords
-     * @param bool $description
-     * @param bool $categoryPath
-     */
-    public function __construct($title, $keywords = false, $description = false, $categoryPath = false)
-    {
-        $this->_myts = MyTextSanitizer::getInstance();
-        $this->setCategoryPath($categoryPath);
-        $this->setTitle($title);
-        $this->setDescription($description);
-
-        if (!$keywords) {
-            $keywords = $this->createMetaKeywords();
-        }
-
-        /*      $myts = MyTextSanitizer::getInstance();
+	public $_myts;
+
+	public $_title;
+	public $_original_title;
+	public $_keywords;
+	public $_meta_description;
+	public $_categoryPath;
+	public $_description;
+	public $_minChar = 4;
+
+	/**
+	 * SmartMetaGen constructor.
+	 * @param      $title
+	 * @param bool $keywords
+	 * @param bool $description
+	 * @param bool $categoryPath
+	 */
+	public function __construct($title, $keywords = false, $description = false, $categoryPath = false)
+	{
+		$this->_myts = MyTextSanitizer::getInstance();
+		$this->setCategoryPath($categoryPath);
+		$this->setTitle($title);
+		$this->setDescription($description);
+
+		if (!$keywords) {
+			$keywords = $this->createMetaKeywords();
+		}
+
+		/*      $myts = MyTextSanitizer::getInstance();
          if (method_exists($myts, 'formatForML')) {
          $keywords = $myts->formatForML($keywords);
          $description = $myts->formatForML($description);
          }
          */
-        $this->setKeywords($keywords);
-    }
-
-    /**
-     * Return true if the string is length > 0
-     *
-     * @credit psylove
-     *
-     * @var    string $string Chaine de caract�re
-     * @return boolean
-     */
-    public function emptyString($var)
-    {
-        return (strlen($var) > 0);
-    }
-
-    /**
-     * Create a title for the short_url field of an article
-     *
-     * @credit psylove
-     *
-     * @var    string      $title title of the article
-     * @param  bool|string $withExt
-     * @return string      sort_url for the article
-     */
-    public function generateSeoTitle($title = '', $withExt = true)
-    {
-        // Transformation de la chaine en minuscule
-        // Codage de la chaine afin d'�viter les erreurs 500 en cas de caract�res impr�vus
-        $title = rawurlencode(strtolower($title));
-
-        // Transformation des ponctuations
-        //                 Tab     Space      !        "        #        %        &        '        (        )        ,        /       :        ;        <        =        >        ?        @        [        \        ]        ^        {        |        }        ~       .
-        $pattern = array('/%09/', '/%20/', '/%21/', '/%22/', '/%23/', '/%25/', '/%26/', '/%27/', '/%28/', '/%29/', '/%2C/', '/%2F/', '/%3A/', '/%3B/', '/%3C/', '/%3D/', '/%3E/', '/%3F/', '/%40/', '/%5B/', '/%5C/', '/%5D/', '/%5E/', '/%7B/', '/%7C/', '/%7D/', '/%7E/', "/\./");
-        $rep_pat = array('-', '-', '-', '-', '-', '-100', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-at-', '-', '-', '-', '-', '-', '-', '-', '-', '-');
-        $title   = preg_replace($pattern, $rep_pat, $title);
-
-        // Transformation des caract�res accentu�s
-        //                  °        è        é        ê        ë        ç        à        â        ä        î        ï        ù        ü        û        ô        ö
-        $pattern = array('/%B0/', '/%E8/', '/%E9/', '/%EA/', '/%EB/', '/%E7/', '/%E0/', '/%E2/', '/%E4/', '/%EE/', '/%EF/', '/%F9/', '/%FC/', '/%FB/', '/%F4/', '/%F6/');
-        $rep_pat = array('-', 'e', 'e', 'e', 'e', 'c', 'a', 'a', 'a', 'i', 'i', 'u', 'u', 'u', 'o', 'o');
-        $title   = preg_replace($pattern, $rep_pat, $title);
-
-        $tableau = explode('-', $title); // Transforme la chaine de caract�res en tableau
-        $tableau = array_filter($tableau, array($this, 'emptyString')); // Supprime les chaines vides du tableau
-        $title   = implode('-', $tableau); // Transforme un tableau en chaine de caract�res s�par� par un tiret
-
-        if (count($title) > 0) {
-            if ($withExt) {
-                $title .= '.html';
-            }
-
-            return $title;
-        } else {
-            return '';
-        }
-    }
-
-    /**
-     * @param $document
-     * @return mixed
-     */
-    public function html2text($document)
-    {
-        return smart_html2text($document);
-    }
-
-    /**
-     * @param $title
-     */
-    public function setTitle($title)
-    {
-        global $xoopsModule, $xoopsModuleConfig;
-        $this->_title          = $this->html2text($title);
-        $this->_title          = $this->purifyText($this->_title);
-        $this->_original_title = $this->_title;
-
-        $moduleName = $xoopsModule->getVar('name');
-
-        $titleTag = array();
-
-        $show_mod_name_breadcrumb = isset($xoopsModuleConfig['show_mod_name_breadcrumb']) ? $xoopsModuleConfig['show_mod_name_breadcrumb'] : true;
-
-        if ($moduleName && $show_mod_name_breadcrumb) {
-            $titleTag['module'] = $moduleName;
-        }
-
-        if (isset($this->_title) && ($this->_title != '') && (strtoupper($this->_title) != strtoupper($moduleName))) {
-            $titleTag['title'] = $this->_title;
-        }
-
-        if (isset($this->_categoryPath) && ($this->_categoryPath != '')) {
-            $titleTag['category'] = $this->_categoryPath;
-        }
-
-        $ret = isset($titleTag['title']) ? $titleTag['title'] : '';
-
-        if (isset($titleTag['category']) && $titleTag['category'] != '') {
-            if ($ret != '') {
-                $ret .= ' - ';
-            }
-            $ret .= $titleTag['category'];
-        }
-        if (isset($titleTag['module']) && $titleTag['module'] !== '') {
-            if ($ret != '') {
-                $ret .= ' - ';
-            }
-            $ret .= $titleTag['module'];
-        }
-        $this->_title = $ret;
-    }
-
-    /**
-     * @param $keywords
-     */
-    public function setKeywords($keywords)
-    {
-        $this->_keywords = $keywords;
-    }
-
-    /**
-     * @param $categoryPath
-     */
-    public function setCategoryPath($categoryPath)
-    {
-        $categoryPath        = $this->html2text($categoryPath);
-        $this->_categoryPath = $categoryPath;
-    }
-
-    /**
-     * @param $description
-     */
-    public function setDescription($description)
-    {
-        if (!$description) {
-            global $xoopsModuleConfig;
-            if (isset($xoopsModuleConfig['module_meta_description'])) {
-                $description = $xoopsModuleConfig['module_meta_description'];
-            }
-        }
-
-        $description = $this->html2text($description);
-        $description = $this->purifyText($description);
-
-        $description = preg_replace("/([^\r\n])\r\n([^\r\n])/", "\\1 \\2", $description);
-        $description = preg_replace("/[\r\n]*\r\n[\r\n]*/", "\r\n\r\n", $description);
-        $description = preg_replace('/[ ]* [ ]*/', ' ', $description);
-        $description = stripslashes($description);
-
-        $this->_description      = $description;
-        $this->_meta_description = $this->createMetaDescription();
-    }
-
-    public function createTitleTag()
-    {
-    }
-
-    /**
-     * @param       $text
-     * @param  bool $keyword
-     * @return mixed|string
-     */
-    public function purifyText($text, $keyword = false)
-    {
-        return smart_purifyText($text, $keyword);
-    }
-
-    /**
-     * @param  int $maxWords
-     * @return string
-     */
-    public function createMetaDescription($maxWords = 100)
-    {
-        $words = array();
-        $words = explode(' ', $this->_description);
-
-        // Only keep $maxWords words
-        $newWords = array();
-        $i        = 0;
-
-        while ($i < $maxWords - 1 && $i < count($words)) {
-            $newWords[] = $words[$i];
-            ++$i;
-        }
-        $ret = implode(' ', $newWords);
-
-        return $ret;
-    }
-
-    /**
-     * @param $text
-     * @param $minChar
-     * @return array
-     */
-    public function findMetaKeywords($text, $minChar)
-    {
-        $keywords = array();
-
-        $text = $this->purifyText($text);
-        $text = $this->html2text($text);
-
-        $text = preg_replace("/([^\r\n])\r\n([^\r\n])/", "\\1 \\2", $text);
-        $text = preg_replace("/[\r\n]*\r\n[\r\n]*/", "\r\n\r\n", $text);
-        $text = preg_replace('/[ ]* [ ]*/', ' ', $text);
-        $text = stripslashes($text);
-        $text =
-
-        $originalKeywords = preg_split('/[^a-zA-Z\'"-]+/', $text, -1, PREG_SPLIT_NO_EMPTY);
-
-        foreach ($originalKeywords as $originalKeyword) {
-            $secondRoundKeywords = explode("'", $originalKeyword);
-            foreach ($secondRoundKeywords as $secondRoundKeyword) {
-                if (strlen($secondRoundKeyword) >= $minChar) {
-                    if (!in_array($secondRoundKeyword, $keywords)) {
-                        $keywords[] = trim($secondRoundKeyword);
-                    }
-                }
-            }
-        }
-
-        return $keywords;
-    }
-
-    /**
-     * @return string
-     */
-    public function createMetaKeywords()
-    {
-        global $xoopsModuleConfig;
-        $keywords = $this->findMetaKeywords($this->_original_title . ' ' . $this->_description, $this->_minChar);
-        if (isset($xoopsModuleConfig) && isset($xoopsModuleConfig['moduleMetaKeywords']) && $xoopsModuleConfig['moduleMetaKeywords'] != '') {
-            $moduleKeywords = explode(',', $xoopsModuleConfig['moduleMetaKeywords']);
-            $keywords       = array_merge($keywords, $moduleKeywords);
-        }
-
-        /* Commenting this out as it may cause problem on XOOPS ML websites
+		$this->setKeywords($keywords);
+	}
+
+	/**
+	 * Return true if the string is length > 0
+	 *
+	 * @credit psylove
+	 *
+	 * @var    string $string Chaine de caract�re
+	 * @return boolean
+	 */
+	public function emptyString($var)
+	{
+		return (strlen($var) > 0);
+	}
+
+	/**
+	 * Create a title for the short_url field of an article
+	 *
+	 * @credit psylove
+	 *
+	 * @var    string      $title title of the article
+	 * @param  bool|string $withExt
+	 * @return string      sort_url for the article
+	 */
+	public function generateSeoTitle($title = '', $withExt = true)
+	{
+		// Transformation de la chaine en minuscule
+		// Codage de la chaine afin d'�viter les erreurs 500 en cas de caract�res impr�vus
+		$title = rawurlencode(strtolower($title));
+
+		// Transformation des ponctuations
+		//                 Tab     Space      !        "        #        %        &        '        (        )        ,        /       :        ;        <        =        >        ?        @        [        \        ]        ^        {        |        }        ~       .
+		$pattern = array('/%09/', '/%20/', '/%21/', '/%22/', '/%23/', '/%25/', '/%26/', '/%27/', '/%28/', '/%29/', '/%2C/', '/%2F/', '/%3A/', '/%3B/', '/%3C/', '/%3D/', '/%3E/', '/%3F/', '/%40/', '/%5B/', '/%5C/', '/%5D/', '/%5E/', '/%7B/', '/%7C/', '/%7D/', '/%7E/', "/\./");
+		$rep_pat = array('-', '-', '-', '-', '-', '-100', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-at-', '-', '-', '-', '-', '-', '-', '-', '-', '-');
+		$title   = preg_replace($pattern, $rep_pat, $title);
+
+		// Transformation des caract�res accentu�s
+		//                  °        è        é        ê        ë        ç        à        â        ä        î        ï        ù        ü        û        ô        ö
+		$pattern = array('/%B0/', '/%E8/', '/%E9/', '/%EA/', '/%EB/', '/%E7/', '/%E0/', '/%E2/', '/%E4/', '/%EE/', '/%EF/', '/%F9/', '/%FC/', '/%FB/', '/%F4/', '/%F6/');
+		$rep_pat = array('-', 'e', 'e', 'e', 'e', 'c', 'a', 'a', 'a', 'i', 'i', 'u', 'u', 'u', 'o', 'o');
+		$title   = preg_replace($pattern, $rep_pat, $title);
+
+		$tableau = explode('-', $title); // Transforme la chaine de caract�res en tableau
+		$tableau = array_filter($tableau, array($this, 'emptyString')); // Supprime les chaines vides du tableau
+		$title   = implode('-', $tableau); // Transforme un tableau en chaine de caract�res s�par� par un tiret
+
+		if (count($title) > 0) {
+			if ($withExt) {
+				$title .= '.html';
+			}
+
+			return $title;
+		} else {
+			return '';
+		}
+	}
+
+	/**
+	 * @param $document
+	 * @return mixed
+	 */
+	public function html2text($document)
+	{
+		return smart_html2text($document);
+	}
+
+	/**
+	 * @param $title
+	 */
+	public function setTitle($title)
+	{
+		global $xoopsModule, $xoopsModuleConfig;
+		$this->_title          = $this->html2text($title);
+		$this->_title          = $this->purifyText($this->_title);
+		$this->_original_title = $this->_title;
+
+		$moduleName = $xoopsModule->getVar('name');
+
+		$titleTag = array();
+
+		$show_mod_name_breadcrumb = isset($xoopsModuleConfig['show_mod_name_breadcrumb']) ? $xoopsModuleConfig['show_mod_name_breadcrumb'] : true;
+
+		if ($moduleName && $show_mod_name_breadcrumb) {
+			$titleTag['module'] = $moduleName;
+		}
+
+		if (isset($this->_title) && ($this->_title != '') && (strtoupper($this->_title) != strtoupper($moduleName))) {
+			$titleTag['title'] = $this->_title;
+		}
+
+		if (isset($this->_categoryPath) && ($this->_categoryPath != '')) {
+			$titleTag['category'] = $this->_categoryPath;
+		}
+
+		$ret = isset($titleTag['title']) ? $titleTag['title'] : '';
+
+		if (isset($titleTag['category']) && $titleTag['category'] != '') {
+			if ($ret != '') {
+				$ret .= ' - ';
+			}
+			$ret .= $titleTag['category'];
+		}
+		if (isset($titleTag['module']) && $titleTag['module'] !== '') {
+			if ($ret != '') {
+				$ret .= ' - ';
+			}
+			$ret .= $titleTag['module'];
+		}
+		$this->_title = $ret;
+	}
+
+	/**
+	 * @param $keywords
+	 */
+	public function setKeywords($keywords)
+	{
+		$this->_keywords = $keywords;
+	}
+
+	/**
+	 * @param $categoryPath
+	 */
+	public function setCategoryPath($categoryPath)
+	{
+		$categoryPath        = $this->html2text($categoryPath);
+		$this->_categoryPath = $categoryPath;
+	}
+
+	/**
+	 * @param $description
+	 */
+	public function setDescription($description)
+	{
+		if (!$description) {
+			global $xoopsModuleConfig;
+			if (isset($xoopsModuleConfig['module_meta_description'])) {
+				$description = $xoopsModuleConfig['module_meta_description'];
+			}
+		}
+
+		$description = $this->html2text($description);
+		$description = $this->purifyText($description);
+
+		$description = preg_replace("/([^\r\n])\r\n([^\r\n])/", "\\1 \\2", $description);
+		$description = preg_replace("/[\r\n]*\r\n[\r\n]*/", "\r\n\r\n", $description);
+		$description = preg_replace('/[ ]* [ ]*/', ' ', $description);
+		$description = stripslashes($description);
+
+		$this->_description      = $description;
+		$this->_meta_description = $this->createMetaDescription();
+	}
+
+	public function createTitleTag()
+	{
+	}
+
+	/**
+	 * @param       $text
+	 * @param  bool $keyword
+	 * @return mixed|string
+	 */
+	public function purifyText($text, $keyword = false)
+	{
+		return smart_purifyText($text, $keyword);
+	}
+
+	/**
+	 * @param  int $maxWords
+	 * @return string
+	 */
+	public function createMetaDescription($maxWords = 100)
+	{
+		$words = array();
+		$words = explode(' ', $this->_description);
+
+		// Only keep $maxWords words
+		$newWords = array();
+		$i        = 0;
+
+		while ($i < $maxWords - 1 && $i < count($words)) {
+			$newWords[] = $words[$i];
+			++$i;
+		}
+		$ret = implode(' ', $newWords);
+
+		return $ret;
+	}
+
+	/**
+	 * @param $text
+	 * @param $minChar
+	 * @return array
+	 */
+	public function findMetaKeywords($text, $minChar)
+	{
+		$keywords = array();
+
+		$text = $this->purifyText($text);
+		$text = $this->html2text($text);
+
+		$text = preg_replace("/([^\r\n])\r\n([^\r\n])/", "\\1 \\2", $text);
+		$text = preg_replace("/[\r\n]*\r\n[\r\n]*/", "\r\n\r\n", $text);
+		$text = preg_replace('/[ ]* [ ]*/', ' ', $text);
+		$text = stripslashes($text);
+		$text =
+
+		$originalKeywords = preg_split('/[^a-zA-Z\'"-]+/', $text, -1, PREG_SPLIT_NO_EMPTY);
+
+		foreach ($originalKeywords as $originalKeyword) {
+			$secondRoundKeywords = explode("'", $originalKeyword);
+			foreach ($secondRoundKeywords as $secondRoundKeyword) {
+				if (strlen($secondRoundKeyword) >= $minChar) {
+					if (!in_array($secondRoundKeyword, $keywords)) {
+						$keywords[] = trim($secondRoundKeyword);
+					}
+				}
+			}
+		}
+
+		return $keywords;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function createMetaKeywords()
+	{
+		global $xoopsModuleConfig;
+		$keywords = $this->findMetaKeywords($this->_original_title . ' ' . $this->_description, $this->_minChar);
+		if (isset($xoopsModuleConfig) && isset($xoopsModuleConfig['moduleMetaKeywords']) && $xoopsModuleConfig['moduleMetaKeywords'] != '') {
+			$moduleKeywords = explode(',', $xoopsModuleConfig['moduleMetaKeywords']);
+			$keywords       = array_merge($keywords, $moduleKeywords);
+		}
+
+		/* Commenting this out as it may cause problem on XOOPS ML websites
          $return_keywords = array();
 
          // Cleaning for duplicate keywords
@@ -297,43 +297,43 @@ 
          }
          }*/
 
-        // Only take the first 90 keywords
-        $newKeywords = array();
-        $i           = 0;
-        while ($i < 90 - 1 && isset($keywords[$i])) {
-            $newKeywords[] = $keywords[$i];
-            ++$i;
-        }
-        $ret = implode(', ', $newKeywords);
-
-        return $ret;
-    }
-
-    public function autoBuildMeta_keywords()
-    {
-    }
-
-    public function buildAutoMetaTags()
-    {
-        global $xoopsModule, $xoopsModuleConfig;
-
-        $this->_keywords         = $this->createMetaKeywords();
-        $this->_meta_description = $this->createMetaDescription();
-        $this->_title            = $this->createTitleTag();
-    }
-
-    public function createMetaTags()
-    {
-        global $xoopsTpl, $xoTheme;
-
-        if (is_object($xoTheme)) {
-            $xoTheme->addMeta('meta', 'keywords', $this->_keywords);
-            $xoTheme->addMeta('meta', 'description', $this->_description);
-            $xoTheme->addMeta('meta', 'title', $this->_title);
-        } else {
-            $xoopsTpl->assign('xoops_meta_keywords', $this->_keywords);
-            $xoopsTpl->assign('xoops_meta_description', $this->_description);
-        }
-        $xoopsTpl->assign('xoops_pagetitle', $this->_title);
-    }
+		// Only take the first 90 keywords
+		$newKeywords = array();
+		$i           = 0;
+		while ($i < 90 - 1 && isset($keywords[$i])) {
+			$newKeywords[] = $keywords[$i];
+			++$i;
+		}
+		$ret = implode(', ', $newKeywords);
+
+		return $ret;
+	}
+
+	public function autoBuildMeta_keywords()
+	{
+	}
+
+	public function buildAutoMetaTags()
+	{
+		global $xoopsModule, $xoopsModuleConfig;
+
+		$this->_keywords         = $this->createMetaKeywords();
+		$this->_meta_description = $this->createMetaDescription();
+		$this->_title            = $this->createTitleTag();
+	}
+
+	public function createMetaTags()
+	{
+		global $xoopsTpl, $xoTheme;
+
+		if (is_object($xoTheme)) {
+			$xoTheme->addMeta('meta', 'keywords', $this->_keywords);
+			$xoTheme->addMeta('meta', 'description', $this->_description);
+			$xoTheme->addMeta('meta', 'title', $this->_title);
+		} else {
+			$xoopsTpl->assign('xoops_meta_keywords', $this->_keywords);
+			$xoopsTpl->assign('xoops_meta_description', $this->_description);
+		}
+		$xoopsTpl->assign('xoops_pagetitle', $this->_title);
+	}
 }

class/smartobject.php

Doc Comments +9 added lines, -9 removed lines

@@ -164,7 +164,7 @@ 
     }
 
     /**
-     * @param        $key
+     * @param        string $key
      * @param        $data_type
      * @param bool   $itemName
      * @param string $form_caption
@@ -192,7 +192,7 @@ 
      * @param bool   $required     set to TRUE if this variable needs to have a value set before storing the object in the table
      * @param string $form_caption caption of this variable in a {@link SmartobjectForm} and title of a column in a  {@link SmartObjectTable}
      * @param string $form_dsc     description of this variable in a {@link SmartobjectForm}
-     * @param mixed  $value        default value of this variable
+     * @param string|false  $value        default value of this variable
      */
     public function quickInitVar($key, $data_type, $required = false, $form_caption = '', $form_dsc = '', $value = null)
     {
@@ -201,7 +201,7 @@ 
     }
 
     /**
-     * @param        $varname
+     * @param        string $varname
      * @param bool   $displayOnForm
      * @param string $default
      */
@@ -457,7 +457,7 @@ 
     /**
      * add an error
      *
-     * @param      $err_str
+     * @param      string $err_str
      * @param bool $prefix
      * @internal param string $value error to add
      * @access   public
@@ -719,8 +719,8 @@ 
 
     /**
      * @param $key
-     * @param $info
-     * @param $value
+     * @param string $info
+     * @param boolean $value
      */
     public function setVarInfo($key, $info, $value)
     {
@@ -728,7 +728,7 @@ 
     }
 
     /**
-     * @param       $key
+     * @param       string $key
      * @param  bool $editor
      * @return string
      */
@@ -905,7 +905,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')
     {
@@ -1208,7 +1208,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      */
     public function hideFieldFromForm($key)
     {

Indentation +1359 added lines, -1359 removed lines

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

Spacing +12 added lines, -12 removed lines

@@ -421,7 +421,7 @@ 
     public function toArray()
     {
         $ret  = array();
-        $vars =& $this->getVars();
+        $vars = & $this->getVars();
         foreach ($vars as $key => $var) {
             $value     = $this->getVar($key);
             $ret[$key] = $value;
@@ -538,7 +538,7 @@ 
         }
 
         $smartPermissionsHandler = new SmartobjectPermissionHandler($this->handler);
-        $ret                      = $smartPermissionsHandler->getGrantedGroups($group_perm, $this->id());
+        $ret = $smartPermissionsHandler->getGrantedGroups($group_perm, $this->id());
 
         if (count($ret) == 0) {
             return false;
@@ -797,8 +797,8 @@ 
                             $this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
                             continue;
                         }
-                        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;
                         }
                         if (!$v['not_gpc']) {
@@ -827,7 +827,7 @@ 
                         break;
                     case XOBJ_DTYPE_INT:
                     case XOBJ_DTYPE_TIME_ONLY:
-                        $cleanv = (int)$cleanv;
+                        $cleanv = (int) $cleanv;
                         break;
 
                     case XOBJ_DTYPE_CURRENCY:
@@ -860,7 +860,7 @@ 
                             $cleanv = 'http://' . $cleanv;
                         }
                         if (!$v['not_gpc']) {
-                            $cleanv =& $ts->stripSlashesGPC($cleanv);
+                            $cleanv = & $ts->stripSlashesGPC($cleanv);
                         }
                         break;
                     case XOBJ_DTYPE_SIMPLE_ARRAY:
@@ -872,7 +872,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);
                         }
@@ -881,7 +881,7 @@ 
                         break;
                 }
             }
-            $this->cleanVars[$k] =& $cleanv;
+            $this->cleanVars[$k] = & $cleanv;
             unset($cleanv);
         }
         if (count($this->_errors) > 0) {
@@ -1099,10 +1099,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)) {
@@ -1361,7 +1361,7 @@ 
     public function getUrlLinkObj($key)
     {
         $smartobjectLinkurlHandler = xoops_getModuleHandler('urllink', 'smartobject');
-        $urllinkid                   = $this->getVar($key) != null ? $this->getVar($key) : 0;
+        $urllinkid = $this->getVar($key) != null ? $this->getVar($key) : 0;
         if ($urllinkid != 0) {
             return $smartobjectLinkurlHandler->get($urllinkid);
         } else {
@@ -1387,7 +1387,7 @@ 
     public function getFileObj($key)
     {
         $smartobjectFileHandler = xoops_getModuleHandler('file', 'smartobject');
-        $fileid                   = $this->getVar($key) != null ? $this->getVar($key) : 0;
+        $fileid = $this->getVar($key) != null ? $this->getVar($key) : 0;
         if ($fileid != 0) {
             return $smartobjectFileHandler->get($fileid);
         } else {