mambax7 / smartobject

plugins/xcgal.php

Indentation +6 added lines, -6 removed lines

@@ -9,12 +9,12 @@
 
 function smartobject_plugin_xcgal()
 {
-    global $xoopsConfig;
+	global $xoopsConfig;
 
-    $pluginInfo                              = [];
-    $pluginInfo['items']['album']['caption'] = 'Album';
-    $pluginInfo['items']['item']['url']      = 'thumbnails.php?album=%u';
-    $pluginInfo['items']['item']['request']  = 'album';
+	$pluginInfo                              = [];
+	$pluginInfo['items']['album']['caption'] = 'Album';
+	$pluginInfo['items']['item']['url']      = 'thumbnails.php?album=%u';
+	$pluginInfo['items']['item']['request']  = 'album';
 
-    return $pluginInfo;
+	return $pluginInfo;
 }

plugins/smartsection.php

Indentation +8 added lines, -8 removed lines

@@ -9,15 +9,15 @@
 
 function smartobject_plugin_smartsection()
 {
-    $pluginInfo = [];
+	$pluginInfo = [];
 
-    $pluginInfo['items']['item']['caption'] = 'Article';
-    $pluginInfo['items']['item']['url']     = 'item.php?itemid=%u';
-    $pluginInfo['items']['item']['request'] = 'itemid';
+	$pluginInfo['items']['item']['caption'] = 'Article';
+	$pluginInfo['items']['item']['url']     = 'item.php?itemid=%u';
+	$pluginInfo['items']['item']['request'] = 'itemid';
 
-    $pluginInfo['items']['category']['caption'] = 'Category';
-    $pluginInfo['items']['category']['url']     = 'category.php?categoryid=%u';
-    $pluginInfo['items']['category']['request'] = 'categoryid';
+	$pluginInfo['items']['category']['caption'] = 'Category';
+	$pluginInfo['items']['category']['url']     = 'category.php?categoryid=%u';
+	$pluginInfo['items']['category']['request'] = 'categoryid';
 
-    return $pluginInfo;
+	return $pluginInfo;
 }

class/BaseSmartObject.php

Doc Comments +9 added lines, -9 removed lines

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

Indentation +1404 added lines, -1404 removed lines

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

Spacing +16 added lines, -16 removed lines

@@ -17,7 +17,7 @@ 
 
 // defined('XOOPS_ROOT_PATH') || die('Restricted access');
 
-require_once XOOPS_ROOT_PATH . '/modules/smartobject/include/common.php';
+require_once XOOPS_ROOT_PATH.'/modules/smartobject/include/common.php';
 
 if (!defined('XOBJ_DTYPE_SIMPLE_ARRAY')) {
     define('XOBJ_DTYPE_SIMPLE_ARRAY', 101);
@@ -116,7 +116,7 @@ 
      */
     public function closeSection($section_name)
     {
-        $this->initVar('close_section_' . $section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
+        $this->initVar('close_section_'.$section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
     }
 
     /**
@@ -154,13 +154,13 @@ 
         }
         parent::initVar($key, $data_type, $value, $required, $maxlength, $options);
         if ($this->handler && (!$form_caption || '' === $form_caption)) {
-            $dyn_form_caption = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key);
+            $dyn_form_caption = strtoupper('_CO_'.$this->handler->_moduleName.'_'.$this->handler->_itemname.'_'.$key);
             if (defined($dyn_form_caption)) {
                 $form_caption = constant($dyn_form_caption);
             }
         }
         if ($this->handler && (!$form_dsc || '' === $form_dsc)) {
-            $dyn_form_dsc = strtoupper('_CO_' . $this->handler->_moduleName . '_' . $this->handler->_itemname . '_' . $key . '_DSC');
+            $dyn_form_dsc = strtoupper('_CO_'.$this->handler->_moduleName.'_'.$this->handler->_itemname.'_'.$key.'_DSC');
             if (defined($dyn_form_dsc)) {
                 $form_dsc = constant($dyn_form_dsc);
             }
@@ -456,7 +456,7 @@ 
     public function toArray()
     {
         $ret  = [];
-        $vars =& $this->getVars();
+        $vars = & $this->getVars();
         foreach ($vars as $key => $var) {
             $value     = $this->getVar($key);
             $ret[$key] = $value;
@@ -505,7 +505,7 @@ 
             }
         } else {
             if ($prefix) {
-                $err_str = '[' . $prefix . '] ' . $err_str;
+                $err_str = '['.$prefix.'] '.$err_str;
             }
             parent::setErrors($err_str);
         }
@@ -789,7 +789,7 @@ 
             /** @var Smartmedia\Helper $helper */
             $helper = Smartmedia\Helper::getInstance();
 
-            $form_editor = null !==($helper->getConfig('default_editor')) ? $helper->getConfig('default_editor') : 'textarea';
+            $form_editor = null !== ($helper->getConfig('default_editor')) ? $helper->getConfig('default_editor') : 'textarea';
         }
 
         if ($editor) {
@@ -836,8 +836,8 @@ 
                             $this->setErrors(sprintf(_XOBJ_ERR_REQUIRED, $k));
                             continue 2;
                         }
-                        if (isset($v['maxlength']) && strlen($cleanv) > (int)$v['maxlength']) {
-                            $this->setErrors(sprintf(_XOBJ_ERR_SHORTERTHAN, $k, (int)$v['maxlength']));
+                        if (isset($v['maxlength']) && strlen($cleanv) > (int) $v['maxlength']) {
+                            $this->setErrors(sprintf(_XOBJ_ERR_SHORTERTHAN, $k, (int) $v['maxlength']));
                             continue 2;
                         }
                         if (!$v['not_gpc']) {
@@ -866,7 +866,7 @@ 
                         break;
                     case XOBJ_DTYPE_INT:
                     case XOBJ_DTYPE_TIME_ONLY:
-                        $cleanv = (int)$cleanv;
+                        $cleanv = (int) $cleanv;
                         break;
 
                     case XOBJ_DTYPE_CURRENCY:
@@ -897,10 +897,10 @@ 
                             continue 2;
                         }
                         if ('' !== $cleanv && !preg_match("/^http[s]*:\/\//i", $cleanv)) {
-                            $cleanv = 'http://' . $cleanv;
+                            $cleanv = 'http://'.$cleanv;
                         }
                         if (!$v['not_gpc']) {
-                            $cleanv =& $ts->stripSlashesGPC($cleanv);
+                            $cleanv = & $ts->stripSlashesGPC($cleanv);
                         }
                         break;
                     case XOBJ_DTYPE_SIMPLE_ARRAY:
@@ -912,7 +912,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);
                         }
@@ -921,7 +921,7 @@ 
                         break;
                 }
             }
-            $this->cleanVars[$k] =& $cleanv;
+            $this->cleanVars[$k] = & $cleanv;
             unset($cleanv);
         }
         if (count($this->_errors) > 0) {
@@ -1146,10 +1146,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)) {

class/Form/Elements/SmartFormUploadElement.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +18 added lines, -18 removed lines

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

Spacing +3 added lines, -3 removed lines

@@ -28,8 +28,8 @@
      */
     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() . "'>";
+        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)

Spacing +34 added lines, -34 removed lines

@@ -25,7 +25,7 @@ 
 use XoopsModules\Smartobject\Form\Elements\SmartFormSectionClose;
 use XoopsModules\Smartobject\Form\Elements\SmartFormUrlLinkElement;
 
-require_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';
+require_once XOOPS_ROOT_PATH.'/class/xoopsformloader.php';
 //require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsection.php';
 //require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsectionclose.php';
 
@@ -70,7 +70,7 @@ 
         $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;
@@ -98,7 +98,7 @@ 
 
     public function addCaptcha()
     {
-        require_once SMARTOBJECT_ROOT_PATH . 'include/captcha/formcaptcha.php';
+        require_once SMARTOBJECT_ROOT_PATH.'include/captcha/formcaptcha.php';
         $this->addElement(new \XoopsFormCaptcha(), true);
     }
 
@@ -109,7 +109,7 @@ 
      */
     public function addCustomButton($name, $caption, $onclick = false)
     {
-        $custom_button_array    = [
+        $custom_button_array = [
             'name'    => $name,
             'caption' => $caption,
             'onclick' => $onclick
@@ -130,7 +130,7 @@ 
         if ($key) {
             if ($this->targetObject->vars[$key]['readonly']) {
                 $formElement->setExtra('disabled="disabled"');
-                $formElement->setName($key . '-readonly');
+                $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);
@@ -141,7 +141,7 @@ 
                 $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);
+                $formElement->setExtra('onchange="'.$onchangedString.'"'.' '.$otherExtra);
             } else {
                 if (isset($var['form_extra'])) {
                     $formElement->setExtra($var['form_extra']);
@@ -308,8 +308,8 @@ 
             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']];
+                    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']);
@@ -341,7 +341,7 @@ 
         } else {
             $butt_create = new \XoopsFormButton('', 'modify_button', $submit_button_caption, 'submit');
         }
-        $butt_create->setExtra('onclick="this.form.elements.op.value=\'' . $form_name . '\'"');
+        $butt_create->setExtra('onclick="this.form.elements.op.value=\''.$form_name.'\'"');
         $button_tray->addElement($butt_create);
 
         //creating custom buttons
@@ -349,7 +349,7 @@ 
             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'] . '"');
+                    $butt_custom->setExtra('onclick="'.$custom_button['onclick'].'"');
                 }
                 $button_tray->addElement($butt_custom);
                 unset($butt_custom);
@@ -359,7 +359,7 @@ 
         // 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 . '"');
+            $butt_cancel->setExtra('onclick="'.$this->_cancel_js_action.'"');
         } else {
             $butt_cancel->setExtra('onclick="history.go(-1)"');
         }
@@ -461,21 +461,21 @@ 
                 break;
 
             default:
-                $classname = 'SmartForm' . ucfirst($controlName) . 'Element';
+                $classname = 'SmartForm'.ucfirst($controlName).'Element';
                 if (!class_exists($classname)) {
-                    if (file_exists(SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php')) {
+                    if (file_exists(SMARTOBJECT_ROOT_PATH.'class/form/elements/'.strtolower($classname).'.php')) {
 //                        require_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';
+                        $moduleFormElementsPath = $this->targetObject->handler->_modulePath.'class/form/elements/';
+                        $classname              = ucfirst($moduleName).ucfirst($controlName).'Element';
+                        $classFileName          = strtolower($classname).'.php';
 
-                        if (file_exists($moduleFormElementsPath . $classFileName)) {
+                        if (file_exists($moduleFormElementsPath.$classFileName)) {
 //                            require_once $moduleFormElementsPath . $classFileName;
                         } else {
-                            trigger_error($classname . ' Not found', E_USER_WARNING);
+                            trigger_error($classname.' Not found', E_USER_WARNING);
 
                             return new \XoopsFormLabel(); //Empty object
                         }
@@ -544,7 +544,7 @@ 
         $editor_configs['height'] = '400px';
 
         $dhtml            = true;
-        $xoopseditorclass = XOOPS_ROOT_PATH . '/class/xoopsform/formeditor.php';
+        $xoopseditorclass = XOOPS_ROOT_PATH.'/class/xoopsform/formeditor.php';
 
         if (file_exists($xoopseditorclass)) {
             require_once $xoopseditorclass;
@@ -554,8 +554,8 @@ 
 
                 case 'tiny':
                     if (!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php')) {
-                            require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php';
+                        if (is_readable(XOOPS_ROOT_PATH.'/class/xoopseditor/tinyeditor/formtinytextarea.php')) {
+                            require_once XOOPS_ROOT_PATH.'/class/xoopseditor/tinyeditor/formtinytextarea.php';
                             $editor = new \XoopsFormTinymce([
                                                                     'caption' => $caption,
                                                                     'name'    => $name,
@@ -662,10 +662,10 @@ 
         $size         = $multiple ? 5 : 1;
         $theme_select = new \XoopsFormSelect($var['form_caption'], $key, $this->targetObject->getVar($key), $size, $multiple);
 
-        $handle  = opendir(XOOPS_THEME_PATH . '/');
+        $handle  = opendir(XOOPS_THEME_PATH.'/');
         $dirlist = [];
         while (false !== ($file = readdir($handle))) {
-            if (is_dir(XOOPS_THEME_PATH . '/' . $file) && !preg_match('/^[.]{1,2}$/', $file)
+            if (is_dir(XOOPS_THEME_PATH.'/'.$file) && !preg_match('/^[.]{1,2}$/', $file)
                 && 'cvs' !== strtolower($file)) {
                 $dirlist[$file] = $file;
             }
@@ -687,7 +687,7 @@ 
     {
         foreach ($this->_elements as $eleObj) {
             if ($eleObj->getName() == $keyname) {
-                $ret =& $eleObj;
+                $ret = & $eleObj;
                 break;
             }
         }
@@ -704,9 +704,9 @@ 
     {
         $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() . ">
+            <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>
+            <tr><th colspan='2'>" . $this->getTitle().'</th></tr>
         ';
         $hidden   = '';
         $class    = 'even';
@@ -715,11 +715,11 @@ 
                 $ret .= $ele;
             } elseif (!$ele->isHidden()) {
                 //$class = ( $class == 'even' ) ? 'odd': 'even';
-                $ret .= "<tr id='" . $ele->getName() . "' valign='top' align='left'><td class='head'>" . $ele->getCaption();
+                $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 .= '<br><br><span style="font-weight: normal;">'.$ele->getDescription().'</span>';
                 }
-                $ret .= "</td><td class='$class'>" . $ele->render() . "</td></tr>\n";
+                $ret .= "</td><td class='$class'>".$ele->render()."</td></tr>\n";
             } else {
                 $hidden .= $ele->render();
             }
@@ -767,7 +767,7 @@ 
             'name'       => $this->getName(),
             'action'     => $this->getAction(),
             'method'     => $this->getMethod(),
-            'extra'      => 'onsubmit="return xoopsFormValidate_' . $this->getName() . '(this);"' . $this->getExtra(),
+            'extra'      => 'onsubmit="return xoopsFormValidate_'.$this->getName().'(this);"'.$this->getExtra(),
             'javascript' => $js,
             'elements'   => $elements
         ]);
@@ -785,7 +785,7 @@ 
         }
         $myts     = \MyTextSanitizer::getInstance();
         $formname = $this->getName();
-        $js       .= "function xoopsFormValidate_{$formname}(myform) {";
+        $js .= "function xoopsFormValidate_{$formname}(myform) {";
         // First, output code to check required elements
         $elements = $this->getRequired();
         foreach ($elements as $elt) {
@@ -836,15 +836,15 @@ 
                         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";
+                $js .= "if ( myform.{$eltname}.value == \"\" ) "."{ window.alert(\"{$eltmsg}\"); myform.{$eltname}.focus(); return false; }\n";
             }
         }
         // Now, handle custom validation code
-        $elements =& $this->getElements(true);
+        $elements = & $this->getElements(true);
         foreach ($elements as $elt) {
             if (method_exists($elt, 'renderValidationJS') && 'xoopsformcheckbox' !== strtolower(get_class($elt))) {
                 if ($eltjs = $elt->renderValidationJS()) {
-                    $js .= $eltjs . "\n";
+                    $js .= $eltjs."\n";
                 }
             }
         }

Indentation +699 added lines, -699 removed lines

@@ -44,549 +44,549 @@ 
  */
 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');
-        }
-
-        parent::__construct($form_caption, $form_name, $form_action, 'post', true);
-        $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()
-    {
-        require_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    = [
-            'name'    => $name,
-            'caption' => $caption,
-            'onclick' => $onclick
-        ];
-        $this->_custom_button[] = $custom_button_array;
-    }
-
-    /**
-     * Add an element to the form
-     *
-     * @param string|XoopsFormElement &$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, 'notset' === $required ? $var['required'] : $required);
-        } else {
-            parent::addElement($formElement, 'notset' === $required ? 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 ('parentid' === $key) {
-                    /**
-                     * 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');
+		}
+
+		parent::__construct($form_caption, $form_name, $form_action, 'post', true);
+		$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()
+	{
+		require_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    = [
+			'name'    => $name,
+			'caption' => $caption,
+			'onclick' => $onclick
+		];
+		$this->_custom_button[] = $custom_button_array;
+	}
+
+	/**
+	 * Add an element to the form
+	 *
+	 * @param string|XoopsFormElement &$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, 'notset' === $required ? $var['required'] : $required);
+		} else {
+			parent::addElement($formElement, 'notset' === $required ? 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 ('parentid' === $key) {
+					/**
+					 * 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, [
-                                '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, [
-                                '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, [
-                                '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', Smartobject\Utility::getPageBeforeForm()));
-    }
-
-    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':
+					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, [
+								'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, [
+								'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, [
+								'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', Smartobject\Utility::getPageBeforeForm()));
+	}
+
+	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':
 //                require_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']);
+				$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;
+				return $controlObj;
+				break;
 
-            case 'color':
-                $control    = $this->targetObject->getControl($key);
-                $controlObj = new \XoopsFormColorPicker($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
+			case 'color':
+				$control    = $this->targetObject->getControl($key);
+				$controlObj = new \XoopsFormColorPicker($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
 
-                return $controlObj;
-                break;
+				return $controlObj;
+				break;
 
-            case 'radio':
-                $control = $this->targetObject->getControl($key);
+			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']);
+				$controlObj = new \XoopsFormRadio($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
+				$controlObj->addOptionArray($control['options']);
 
-                return $controlObj;
-                break;
+				return $controlObj;
+				break;
 
-            case 'label':
-                return new \XoopsFormLabel($this->targetObject->vars[$key]['form_caption'], $this->targetObject->getVar($key));
-                break;
+			case 'label':
+				return new \XoopsFormLabel($this->targetObject->vars[$key]['form_caption'], $this->targetObject->getVar($key));
+				break;
 
-            case 'textarea':
-                return $this->getTextArea($key);
+			case 'textarea':
+				return $this->getTextArea($key);
 
-            case 'theme':
-                return $this->getThemeSelect($key, $this->targetObject->vars[$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 '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 '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':
+				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 'group_multi':
+				return new \XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true);
+				break;
 
-            /*case 'user':
+			/*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 '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 '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 'country':
+				return new \XoopsFormSelectCountry($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key, 'e'));
+				break;
 
-            case 'urllink':
+			case 'urllink':
 //                require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformurllinkelement.php';
 
-                return new SmartFormUrlLinkElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getUrlLinkObj($key));
-                break;
+				return new SmartFormUrlLinkElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getUrlLinkObj($key));
+				break;
 
-            case 'richfile':
+			case 'richfile':
 //                require_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':
+				return new SmartFormRichFileElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getFileObj($key));
+				break;
+			case 'section':
 //                require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsection.php';
 
-                return new SmartFormSection($key, $this->targetObject->vars[$key]['form_caption']);
-                break;
+				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')) {
+			default:
+				$classname = 'SmartForm' . ucfirst($controlName) . 'Element';
+				if (!class_exists($classname)) {
+					if (file_exists(SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php')) {
 //                        require_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)) {
+					} 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)) {
 //                            require_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|\XoopsFormTextArea|\XoopsFormTinymce|\XoopsFormTinymce4
-     */
-    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 = [
-                'name'        => 'textarea',
-                'itemHandler' => false,
-                'method'      => false,
-                'module'      => false,
-                'form_editor' => 'default'
-            ];
-        } else {
-            $control = $this->targetObject->controls[$key];
-        }
-        $xoops22 = Smartobject\Utility::isXoops22();
-
-        $form_editor = isset($control['form_editor']) ? $control['form_editor'] : 'textarea';
-        /**
-         * If the editor is 'default', retreive the default editor of this module
-         */
-        if ('default' === $form_editor) {
-               /** @var Smartobject\Helper $helper */
-            $helper = Smartobject\Helper::getInstance();
-            $form_editor = null !== ($helper->getConfig('default_editor')) ? $helper->getConfig('default_editor') : 'textarea';
-        }
-
-        $caption = $var['form_caption'];
-        $name    = $key;
-
-        $value = $this->targetObject->getVar($key);
-
-        $value = $this->targetObject->getValueFor($key, true);
-
-        $editor_configs          = [];
-        $editor_configs['name']  = $name;
-        $editor_configs['value'] = $value;
-        if ('textarea' !== $form_editor) {
-            $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)) {
-            require_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')) {
-                            require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php';
-                            $editor = new \XoopsFormTinymce([
-                                                                    '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;
+						} 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|\XoopsFormTextArea|\XoopsFormTinymce|\XoopsFormTinymce4
+	 */
+	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 = [
+				'name'        => 'textarea',
+				'itemHandler' => false,
+				'method'      => false,
+				'module'      => false,
+				'form_editor' => 'default'
+			];
+		} else {
+			$control = $this->targetObject->controls[$key];
+		}
+		$xoops22 = Smartobject\Utility::isXoops22();
+
+		$form_editor = isset($control['form_editor']) ? $control['form_editor'] : 'textarea';
+		/**
+		 * If the editor is 'default', retreive the default editor of this module
+		 */
+		if ('default' === $form_editor) {
+			   /** @var Smartobject\Helper $helper */
+			$helper = Smartobject\Helper::getInstance();
+			$form_editor = null !== ($helper->getConfig('default_editor')) ? $helper->getConfig('default_editor') : 'textarea';
+		}
+
+		$caption = $var['form_caption'];
+		$name    = $key;
+
+		$value = $this->targetObject->getVar($key);
+
+		$value = $this->targetObject->getValueFor($key, true);
+
+		$editor_configs          = [];
+		$editor_configs['name']  = $name;
+		$editor_configs['value'] = $value;
+		if ('textarea' !== $form_editor) {
+			$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)) {
+			require_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')) {
+							require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php';
+							$editor = new \XoopsFormTinymce([
+																	'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 'inbetween':
 //                    if (!$xoops22) {
@@ -639,177 +639,177 @@ 
 //                    }
 //                    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 = [];
-        while (false !== ($file = readdir($handle))) {
-            if (is_dir(XOOPS_THEME_PATH . '/' . $file) && !preg_match('/^[.]{1,2}$/', $file)
-                && 'cvs' !== strtolower($file)) {
-                $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      = "
+				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 = [];
+		while (false !== ($file = readdir($handle))) {
+			if (is_dir(XOOPS_THEME_PATH . '/' . $file) && !preg_match('/^[.]{1,2}$/', $file)
+				&& 'cvs' !== strtolower($file)) {
+				$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 \XoopsTpl $tpl
-     *
-     * object
-     * @param bool      $smartyName
-     * @see     Smarty
-     */
-    public function assign(\XoopsTpl $tpl, $smartyName = false)
-    {
-        $i        = 0;
-        $elements = [];
-        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'] = $ele instanceof \XoopsModules\Smartobject\Form\Elements\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, [
-            '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 ('xoopsformradio' === strtolower(get_class($elt))) {
-                $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 \XoopsTpl $tpl
+	 *
+	 * object
+	 * @param bool      $smartyName
+	 * @see     Smarty
+	 */
+	public function assign(\XoopsTpl $tpl, $smartyName = false)
+	{
+		$i        = 0;
+		$elements = [];
+		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'] = $ele instanceof \XoopsModules\Smartobject\Form\Elements\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, [
+			'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 ('xoopsformradio' === strtolower(get_class($elt))) {
+				$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 ('smartformselect_multielement' === strtolower(get_class($elt))) {
-                $js .= 'var hasSelections = false;';
-                $js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
+			} elseif ('smartformselect_multielement' === strtolower(get_class($elt))) {
+				$js .= 'var hasSelections = false;';
+				$js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
                     if (myform['{$eltname}[]'].options[i].selected) {
                         hasSelections = true;
                     }
@@ -817,12 +817,12 @@ 
                 }
                 if (hasSelections === false) {
                     window.alert(\"{$eltmsg}\"); myform['{$eltname}[]'].options[0].focus(); return false; }\n";
-            } elseif ('xoopsformcheckbox' === strtolower(get_class($elt))
-                      || 'smartformcheckelement' === strtolower(get_class($elt))) {
-                $js .= 'var hasSelections = false;';
-                //sometimes, there is an implicit '[]', sometimes not
-                if (false === strpos($eltname, '[')) {
-                    $js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
+			} elseif ('xoopsformcheckbox' === strtolower(get_class($elt))
+					  || 'smartformcheckelement' === strtolower(get_class($elt))) {
+				$js .= 'var hasSelections = false;';
+				//sometimes, there is an implicit '[]', sometimes not
+				if (false === strpos($eltname, '[')) {
+					$js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
                         if (myform['{$eltname}[]'][i].checked) {
                             hasSelections = true;
                         }
@@ -830,8 +830,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;
                         }
@@ -839,25 +839,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') && 'xoopsformcheckbox' !== strtolower(get_class($elt))) {
-                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') && 'xoopsformcheckbox' !== strtolower(get_class($elt))) {
+				if ($eltjs = $elt->renderValidationJS()) {
+					$js .= $eltjs . "\n";
+				}
+			}
+		}
+		$js .= "return true;\n}\n";
+		if ($withtags) {
+			$js .= "//--></script>\n<!-- 'End Form Validation JavaScript' //-->\n";
+		}
+
+		return $js;
+	}
 }

include/captcha/scripts/img.php

Doc Comments +1 added lines, -1 removed lines

@@ -196,7 +196,7 @@
     }
 
     /**
-     * @param         $name
+     * @param         string $name
      * @param  string $extension
      * @return array
      */

Indentation +412 added lines, -412 removed lines

@@ -10,7 +10,7 @@ 
 $xoopsLogger->activated = false;
 
 if (empty(Request::getString('HTTP_REFERER', '', 'SERVER')) || !preg_match('/^' . preg_quote(XOOPS_URL, '/') . '/', Request::getString('HTTP_REFERER', '', 'SERVER'))) {
-    exit();
+	exit();
 }
 
 /**
@@ -18,192 +18,192 @@ 
  */
 class XoopsCaptchaImageHandler
 {
-    public $config = [];
-    //var $mode = "gd"; // GD or bmp
-    public $code;
-    public $invalid = false;
-
-    public $font;
-    public $spacing;
-    public $width;
-    public $height;
-
-    /**
-     * XoopsCaptchaImageHandler constructor.
-     */
-    public function __construct()
-    {
-        if (empty($_SESSION['XoopsCaptcha_name'])) {
-            $this->invalid = true;
-        }
-
-        if (!extension_loaded('gd')) {
-            $this->mode = 'bmp';
-        } else {
-            $required_functions = [
-                'imagecreatetruecolor',
-                'imagecolorallocate',
-                'imagefilledrectangle',
-                'imagejpeg',
-                'imagedestroy',
-                'imageftbbox'
-            ];
-            foreach ($required_functions as $func) {
-                if (!function_exists($func)) {
-                    $this->mode = 'bmp';
-                    break;
-                }
-            }
-        }
-    }
-
-    /**
-     * Loading configs from CAPTCHA class
-     * @param array $config
-     */
-    public function setConfig($config = [])
-    {
-        // Loading default preferences
-        $this->config = $config;
-    }
-
-    public function loadImage()
-    {
-        $this->createCode();
-        $this->setCode();
-        $this->createImage();
-    }
-
-    /**
-     * Create Code
-     */
-    public function createCode()
-    {
-        if ($this->invalid) {
-            return;
-        }
-
-        if ('bmp' === $this->mode) {
-            $this->config['num_chars'] = 4;
-            $this->code                = mt_rand(pow(10, $this->config['num_chars'] - 1), (int)str_pad('9', $this->config['num_chars'], '9'));
-        } else {
-            $this->code = substr(md5(uniqid(mt_rand(), 1)), 0, $this->config['num_chars']);
-            if (!$this->config['casesensitive']) {
-                $this->code = strtoupper($this->code);
-            }
-        }
-    }
-
-    public function setCode()
-    {
-        if ($this->invalid) {
-            return;
-        }
-
-        $_SESSION['XoopsCaptcha_sessioncode'] = (string)$this->code;
-        $maxAttempts                          = (int)(@$_SESSION['XoopsCaptcha_maxattempts']);
-
-        // Increase the attempt records on refresh
-        if (!empty($maxAttempts)) {
-            $_SESSION['XoopsCaptcha_attempt_' . $_SESSION['XoopsCaptcha_name']]++;
-            if ($_SESSION['XoopsCaptcha_attempt_' . $_SESSION['XoopsCaptcha_name']] > $maxAttempts) {
-                $this->invalid = true;
-            }
-        }
-    }
-
-    /**
-     * @param  string $file
-     * @return string|void
-     */
-    public function createImage($file = '')
-    {
-        if ($this->invalid) {
-            header('Content-type: image/gif');
-            readfile(XOOPS_ROOT_PATH . '/images/subject/icon2.gif');
-
-            return;
-        }
-
-        if ('bmp' === $this->mode) {
-            return $this->createImageBmp();
-        } else {
-            return $this->createImageGd();
-        }
-    }
-
-    /**
-     *  Create CAPTCHA iamge with GD
-     *  Originated from DuGris' SecurityImage
-     * @param string $file
-     */
-    //  --------------------------------------------------------------------------- //
-    // Class: SecurityImage 1.5                                                    //
-    // Author: DuGris aka L. Jen <http://www.dugris.info>                           //
-    // Email: DuGris@wanadoo.fr                                                    //
-    // Licence: GNU                                                                 //
-    // Project: XOOPS Project                                                   //
-    //  --------------------------------------------------------------------------- //
-    public function createImageGd($file = '')
-    {
-        $this->loadFont();
-        $this->setImageSize();
-
-        $this->oImage = imagecreatetruecolor($this->width, $this->height);
-        $background   = imagecolorallocate($this->oImage, 255, 255, 255);
-        imagefilledrectangle($this->oImage, 0, 0, $this->width, $this->height, $background);
-
-        switch ($this->config['background_type']) {
-            default:
-            case 0:
-                $this->drawBars();
-                break;
-
-            case 1:
-                $this->drawCircles();
-                break;
-
-            case 2:
-                $this->drawLines();
-                break;
-
-            case 3:
-                $this->drawRectangles();
-                break;
-
-            case 4:
-                $this->drawEllipses();
-                break;
-
-            case 5:
-                $this->drawPolygons();
-                break;
-
-            case 100:
-                $this->createFromFile();
-                break;
-        }
-        $this->drawBorder();
-        $this->drawCode();
-
-        if (empty($file)) {
-            header('Content-type: image/jpeg');
-            imagejpeg($this->oImage);
-        } else {
-            imagejpeg($this->oImage, XOOPS_ROOT_PATH . '/' . $this->config['imagepath'] . '/' . $file . '.jpg');
-        }
-        imagedestroy($this->oImage);
-    }
-
-    /**
-     * @param         $name
-     * @param  string $extension
-     * @return array
-     */
-    public function _getList($name, $extension = '')
-    {
-        $items = [];
-        /*
+	public $config = [];
+	//var $mode = "gd"; // GD or bmp
+	public $code;
+	public $invalid = false;
+
+	public $font;
+	public $spacing;
+	public $width;
+	public $height;
+
+	/**
+	 * XoopsCaptchaImageHandler constructor.
+	 */
+	public function __construct()
+	{
+		if (empty($_SESSION['XoopsCaptcha_name'])) {
+			$this->invalid = true;
+		}
+
+		if (!extension_loaded('gd')) {
+			$this->mode = 'bmp';
+		} else {
+			$required_functions = [
+				'imagecreatetruecolor',
+				'imagecolorallocate',
+				'imagefilledrectangle',
+				'imagejpeg',
+				'imagedestroy',
+				'imageftbbox'
+			];
+			foreach ($required_functions as $func) {
+				if (!function_exists($func)) {
+					$this->mode = 'bmp';
+					break;
+				}
+			}
+		}
+	}
+
+	/**
+	 * Loading configs from CAPTCHA class
+	 * @param array $config
+	 */
+	public function setConfig($config = [])
+	{
+		// Loading default preferences
+		$this->config = $config;
+	}
+
+	public function loadImage()
+	{
+		$this->createCode();
+		$this->setCode();
+		$this->createImage();
+	}
+
+	/**
+	 * Create Code
+	 */
+	public function createCode()
+	{
+		if ($this->invalid) {
+			return;
+		}
+
+		if ('bmp' === $this->mode) {
+			$this->config['num_chars'] = 4;
+			$this->code                = mt_rand(pow(10, $this->config['num_chars'] - 1), (int)str_pad('9', $this->config['num_chars'], '9'));
+		} else {
+			$this->code = substr(md5(uniqid(mt_rand(), 1)), 0, $this->config['num_chars']);
+			if (!$this->config['casesensitive']) {
+				$this->code = strtoupper($this->code);
+			}
+		}
+	}
+
+	public function setCode()
+	{
+		if ($this->invalid) {
+			return;
+		}
+
+		$_SESSION['XoopsCaptcha_sessioncode'] = (string)$this->code;
+		$maxAttempts                          = (int)(@$_SESSION['XoopsCaptcha_maxattempts']);
+
+		// Increase the attempt records on refresh
+		if (!empty($maxAttempts)) {
+			$_SESSION['XoopsCaptcha_attempt_' . $_SESSION['XoopsCaptcha_name']]++;
+			if ($_SESSION['XoopsCaptcha_attempt_' . $_SESSION['XoopsCaptcha_name']] > $maxAttempts) {
+				$this->invalid = true;
+			}
+		}
+	}
+
+	/**
+	 * @param  string $file
+	 * @return string|void
+	 */
+	public function createImage($file = '')
+	{
+		if ($this->invalid) {
+			header('Content-type: image/gif');
+			readfile(XOOPS_ROOT_PATH . '/images/subject/icon2.gif');
+
+			return;
+		}
+
+		if ('bmp' === $this->mode) {
+			return $this->createImageBmp();
+		} else {
+			return $this->createImageGd();
+		}
+	}
+
+	/**
+	 *  Create CAPTCHA iamge with GD
+	 *  Originated from DuGris' SecurityImage
+	 * @param string $file
+	 */
+	//  --------------------------------------------------------------------------- //
+	// Class: SecurityImage 1.5                                                    //
+	// Author: DuGris aka L. Jen <http://www.dugris.info>                           //
+	// Email: DuGris@wanadoo.fr                                                    //
+	// Licence: GNU                                                                 //
+	// Project: XOOPS Project                                                   //
+	//  --------------------------------------------------------------------------- //
+	public function createImageGd($file = '')
+	{
+		$this->loadFont();
+		$this->setImageSize();
+
+		$this->oImage = imagecreatetruecolor($this->width, $this->height);
+		$background   = imagecolorallocate($this->oImage, 255, 255, 255);
+		imagefilledrectangle($this->oImage, 0, 0, $this->width, $this->height, $background);
+
+		switch ($this->config['background_type']) {
+			default:
+			case 0:
+				$this->drawBars();
+				break;
+
+			case 1:
+				$this->drawCircles();
+				break;
+
+			case 2:
+				$this->drawLines();
+				break;
+
+			case 3:
+				$this->drawRectangles();
+				break;
+
+			case 4:
+				$this->drawEllipses();
+				break;
+
+			case 5:
+				$this->drawPolygons();
+				break;
+
+			case 100:
+				$this->createFromFile();
+				break;
+		}
+		$this->drawBorder();
+		$this->drawCode();
+
+		if (empty($file)) {
+			header('Content-type: image/jpeg');
+			imagejpeg($this->oImage);
+		} else {
+			imagejpeg($this->oImage, XOOPS_ROOT_PATH . '/' . $this->config['imagepath'] . '/' . $file . '.jpg');
+		}
+		imagedestroy($this->oImage);
+	}
+
+	/**
+	 * @param         $name
+	 * @param  string $extension
+	 * @return array
+	 */
+	public function _getList($name, $extension = '')
+	{
+		$items = [];
+		/*
          if (@ require_once XOOPS_ROOT_PATH."/Frameworks/art/functions.ini.php") {
          load_functions("cache");
          if ($items = mod_loadCacheFile("captcha_{$name}", "captcha")) {
@@ -211,231 +211,231 @@ 
          }
          }
          */
-        require_once XOOPS_ROOT_PATH . '/class/xoopslists.php';
-        $file_path = $this->config['rootpath'] . "/{$name}";
-        $files     = XoopsLists::getFileListAsArray($file_path);
-        foreach ($files as $item) {
-            if (empty($extension) || preg_match("/(\.{$extension})$/i", $item)) {
-                $items[] = $item;
-            }
-        }
-        if (function_exists('mod_createCacheFile')) {
-            mod_createCacheFile($items, "captcha_{$name}", 'captcha');
-        }
-
-        return $items;
-    }
-
-    public function loadFont()
-    {
-        $fonts      = $this->_getList('fonts', 'ttf');
-        $this->font = $this->config['rootpath'] . '/fonts/' . $fonts[array_rand($fonts)];
-    }
-
-    public function setImageSize()
-    {
-        $MaxCharWidth  = 0;
-        $MaxCharHeight = 0;
-        $oImage        = imagecreatetruecolor(100, 100);
-        $text_color    = imagecolorallocate($oImage, mt_rand(0, 100), mt_rand(0, 100), mt_rand(0, 100));
-        $FontSize      = $this->config['fontsize_max'];
-        for ($Angle = -30; $Angle <= 30; ++$Angle) {
-            for ($i = 65; $i <= 90; ++$i) {
-                $CharDetails   = imageftbbox($FontSize, $Angle, $this->font, chr($i), []);
-                $_MaxCharWidth = abs($CharDetails[0] + $CharDetails[2]);
-                if ($_MaxCharWidth > $MaxCharWidth) {
-                    $MaxCharWidth = $_MaxCharWidth;
-                }
-                $_MaxCharHeight = abs($CharDetails[1] + $CharDetails[5]);
-                if ($_MaxCharHeight > $MaxCharHeight) {
-                    $MaxCharHeight = $_MaxCharHeight;
-                }
-            }
-        }
-        imagedestroy($oImage);
-
-        $this->height  = $MaxCharHeight + 2;
-        $this->spacing = (int)(($this->config['num_chars'] * $MaxCharWidth) / $this->config['num_chars']);
-        $this->width   = ($this->config['num_chars'] * $MaxCharWidth) + ($this->spacing / 2);
-    }
-
-    /**
-     * Return random background
-     *
-     * @return null|string
-     */
-    public function loadBackground()
-    {
-        $RandBackground = null;
-        if ($backgrounds = $this->_getList('backgrounds', '(gif|jpg|png)')) {
-            $RandBackground = $this->config['rootpath'] . '/backgrounds/' . $backgrounds[array_rand($backgrounds)];
-        }
-
-        return $RandBackground;
-    }
-
-    /**
-     * Draw Image background
-     */
-    public function createFromFile()
-    {
-        if ($RandImage = $this->loadBackground()) {
-            $ImageType = @getimagesize($RandImage);
-            switch (@$ImageType[2]) {
-                case 1:
-                    $BackgroundImage = imagecreatefromgif($RandImage);
-                    break;
-
-                case 2:
-                    $BackgroundImage = imagecreatefromjpeg($RandImage);
-                    break;
-
-                case 3:
-                    $BackgroundImage = imagecreatefrompng($RandImage);
-                    break;
-            }
-        }
-        if (!empty($BackgroundImage)) {
-            imagecopyresized($this->oImage, $BackgroundImage, 0, 0, 0, 0, imagesx($this->oImage), imagesy($this->oImage), imagesx($BackgroundImage), imagesy($BackgroundImage));
-            imagedestroy($BackgroundImage);
-        } else {
-            $this->drawBars();
-        }
-    }
-
-    /**
-     * Draw Code
-     */
-    public function drawCode()
-    {
-        for ($i = 0; $i < $this->config['num_chars']; ++$i) {
-            // select random greyscale colour
-            $text_color = imagecolorallocate($this->oImage, mt_rand(0, 100), mt_rand(0, 100), mt_rand(0, 100));
-
-            // write text to image
-            $Angle = mt_rand(10, 30);
-            if ($i % 2) {
-                $Angle = mt_rand(-10, -30);
-            }
-
-            // select random font size
-            $FontSize = mt_rand($this->config['fontsize_min'], $this->config['fontsize_max']);
-
-            $CharDetails = imageftbbox($FontSize, $Angle, $this->font, $this->code[$i], []);
-            $CharHeight  = abs($CharDetails[1] + $CharDetails[5]);
-
-            // calculate character starting coordinates
-            $posX = ($this->spacing / 2) + ($i * $this->spacing);
-            $posY = 2 + ($this->height / 2) + ($CharHeight / 4);
-
-            imagefttext($this->oImage, $FontSize, $Angle, $posX, $posY, $text_color, $this->font, $this->code[$i], []);
-        }
-    }
-
-    /**
-     * Draw Border
-     */
-    public function drawBorder()
-    {
-        $rgb          = mt_rand(50, 150);
-        $border_color = imagecolorallocate($this->oImage, $rgb, $rgb, $rgb);
-        imagerectangle($this->oImage, 0, 0, $this->width - 1, $this->height - 1, $border_color);
-    }
-
-    /**
-     * Draw Circles background
-     */
-    public function drawCircles()
-    {
-        for ($i = 1; $i <= $this->config['background_num']; ++$i) {
-            $randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
-            imagefilledellipse($this->oImage, mt_rand(0, $this->width - 10), mt_rand(0, $this->height - 3), mt_rand(10, 20), mt_rand(20, 30), $randomcolor);
-        }
-    }
-
-    /**
-     * Draw Lines background
-     */
-    public function drawLines()
-    {
-        for ($i = 0; $i < $this->config['background_num']; ++$i) {
-            $randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
-            imageline($this->oImage, mt_rand(0, $this->width), mt_rand(0, $this->height), mt_rand(0, $this->width), mt_rand(0, $this->height), $randomcolor);
-        }
-    }
-
-    /**
-     * Draw Rectangles background
-     */
-    public function drawRectangles()
-    {
-        for ($i = 1; $i <= $this->config['background_num']; ++$i) {
-            $randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
-            imagefilledrectangle($this->oImage, mt_rand(0, $this->width), mt_rand(0, $this->height), mt_rand(0, $this->width), mt_rand(0, $this->height), $randomcolor);
-        }
-    }
-
-    /**
-     * Draw Bars background
-     */
-    public function drawBars()
-    {
-        for ($i = 0; $i <= $this->height;) {
-            $randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
-            imageline($this->oImage, 0, $i, $this->width, $i, $randomcolor);
-            $i += 2.5;
-        }
-        for ($i = 0; $i <= $this->width;) {
-            $randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
-            imageline($this->oImage, $i, 0, $i, $this->height, $randomcolor);
-            $i += 2.5;
-        }
-    }
-
-    /**
-     * Draw Ellipses background
-     */
-    public function drawEllipses()
-    {
-        for ($i = 1; $i <= $this->config['background_num']; ++$i) {
-            $randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
-            imageellipse($this->oImage, mt_rand(0, $this->width), mt_rand(0, $this->height), mt_rand(0, $this->width), mt_rand(0, $this->height), $randomcolor);
-        }
-    }
-
-    /**
-     * Draw polygons background
-     */
-    public function drawPolygons()
-    {
-        for ($i = 1; $i <= $this->config['background_num']; ++$i) {
-            $randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
-            $coords      = [];
-            for ($j = 1; $j <= $this->config['polygon_point']; ++$j) {
-                $coords[] = mt_rand(0, $this->width);
-                $coords[] = mt_rand(0, $this->height);
-            }
-            imagefilledpolygon($this->oImage, $coords, $this->config['polygon_point'], $randomcolor);
-        }
-    }
-
-    /**
-     *  Create CAPTCHA iamge with BMP
-     *  TODO
-     * @param  string $file
-     * @return string
-     */
-    public function createImageBmp($file = '')
-    {
-        $image = '';
-
-        if (empty($file)) {
-            header('Content-type: image/bmp');
-            echo $image;
-        } else {
-            return $image;
-        }
-    }
+		require_once XOOPS_ROOT_PATH . '/class/xoopslists.php';
+		$file_path = $this->config['rootpath'] . "/{$name}";
+		$files     = XoopsLists::getFileListAsArray($file_path);
+		foreach ($files as $item) {
+			if (empty($extension) || preg_match("/(\.{$extension})$/i", $item)) {
+				$items[] = $item;
+			}
+		}
+		if (function_exists('mod_createCacheFile')) {
+			mod_createCacheFile($items, "captcha_{$name}", 'captcha');
+		}
+
+		return $items;
+	}
+
+	public function loadFont()
+	{
+		$fonts      = $this->_getList('fonts', 'ttf');
+		$this->font = $this->config['rootpath'] . '/fonts/' . $fonts[array_rand($fonts)];
+	}
+
+	public function setImageSize()
+	{
+		$MaxCharWidth  = 0;
+		$MaxCharHeight = 0;
+		$oImage        = imagecreatetruecolor(100, 100);
+		$text_color    = imagecolorallocate($oImage, mt_rand(0, 100), mt_rand(0, 100), mt_rand(0, 100));
+		$FontSize      = $this->config['fontsize_max'];
+		for ($Angle = -30; $Angle <= 30; ++$Angle) {
+			for ($i = 65; $i <= 90; ++$i) {
+				$CharDetails   = imageftbbox($FontSize, $Angle, $this->font, chr($i), []);
+				$_MaxCharWidth = abs($CharDetails[0] + $CharDetails[2]);
+				if ($_MaxCharWidth > $MaxCharWidth) {
+					$MaxCharWidth = $_MaxCharWidth;
+				}
+				$_MaxCharHeight = abs($CharDetails[1] + $CharDetails[5]);
+				if ($_MaxCharHeight > $MaxCharHeight) {
+					$MaxCharHeight = $_MaxCharHeight;
+				}
+			}
+		}
+		imagedestroy($oImage);
+
+		$this->height  = $MaxCharHeight + 2;
+		$this->spacing = (int)(($this->config['num_chars'] * $MaxCharWidth) / $this->config['num_chars']);
+		$this->width   = ($this->config['num_chars'] * $MaxCharWidth) + ($this->spacing / 2);
+	}
+
+	/**
+	 * Return random background
+	 *
+	 * @return null|string
+	 */
+	public function loadBackground()
+	{
+		$RandBackground = null;
+		if ($backgrounds = $this->_getList('backgrounds', '(gif|jpg|png)')) {
+			$RandBackground = $this->config['rootpath'] . '/backgrounds/' . $backgrounds[array_rand($backgrounds)];
+		}
+
+		return $RandBackground;
+	}
+
+	/**
+	 * Draw Image background
+	 */
+	public function createFromFile()
+	{
+		if ($RandImage = $this->loadBackground()) {
+			$ImageType = @getimagesize($RandImage);
+			switch (@$ImageType[2]) {
+				case 1:
+					$BackgroundImage = imagecreatefromgif($RandImage);
+					break;
+
+				case 2:
+					$BackgroundImage = imagecreatefromjpeg($RandImage);
+					break;
+
+				case 3:
+					$BackgroundImage = imagecreatefrompng($RandImage);
+					break;
+			}
+		}
+		if (!empty($BackgroundImage)) {
+			imagecopyresized($this->oImage, $BackgroundImage, 0, 0, 0, 0, imagesx($this->oImage), imagesy($this->oImage), imagesx($BackgroundImage), imagesy($BackgroundImage));
+			imagedestroy($BackgroundImage);
+		} else {
+			$this->drawBars();
+		}
+	}
+
+	/**
+	 * Draw Code
+	 */
+	public function drawCode()
+	{
+		for ($i = 0; $i < $this->config['num_chars']; ++$i) {
+			// select random greyscale colour
+			$text_color = imagecolorallocate($this->oImage, mt_rand(0, 100), mt_rand(0, 100), mt_rand(0, 100));
+
+			// write text to image
+			$Angle = mt_rand(10, 30);
+			if ($i % 2) {
+				$Angle = mt_rand(-10, -30);
+			}
+
+			// select random font size
+			$FontSize = mt_rand($this->config['fontsize_min'], $this->config['fontsize_max']);
+
+			$CharDetails = imageftbbox($FontSize, $Angle, $this->font, $this->code[$i], []);
+			$CharHeight  = abs($CharDetails[1] + $CharDetails[5]);
+
+			// calculate character starting coordinates
+			$posX = ($this->spacing / 2) + ($i * $this->spacing);
+			$posY = 2 + ($this->height / 2) + ($CharHeight / 4);
+
+			imagefttext($this->oImage, $FontSize, $Angle, $posX, $posY, $text_color, $this->font, $this->code[$i], []);
+		}
+	}
+
+	/**
+	 * Draw Border
+	 */
+	public function drawBorder()
+	{
+		$rgb          = mt_rand(50, 150);
+		$border_color = imagecolorallocate($this->oImage, $rgb, $rgb, $rgb);
+		imagerectangle($this->oImage, 0, 0, $this->width - 1, $this->height - 1, $border_color);
+	}
+
+	/**
+	 * Draw Circles background
+	 */
+	public function drawCircles()
+	{
+		for ($i = 1; $i <= $this->config['background_num']; ++$i) {
+			$randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
+			imagefilledellipse($this->oImage, mt_rand(0, $this->width - 10), mt_rand(0, $this->height - 3), mt_rand(10, 20), mt_rand(20, 30), $randomcolor);
+		}
+	}
+
+	/**
+	 * Draw Lines background
+	 */
+	public function drawLines()
+	{
+		for ($i = 0; $i < $this->config['background_num']; ++$i) {
+			$randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
+			imageline($this->oImage, mt_rand(0, $this->width), mt_rand(0, $this->height), mt_rand(0, $this->width), mt_rand(0, $this->height), $randomcolor);
+		}
+	}
+
+	/**
+	 * Draw Rectangles background
+	 */
+	public function drawRectangles()
+	{
+		for ($i = 1; $i <= $this->config['background_num']; ++$i) {
+			$randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
+			imagefilledrectangle($this->oImage, mt_rand(0, $this->width), mt_rand(0, $this->height), mt_rand(0, $this->width), mt_rand(0, $this->height), $randomcolor);
+		}
+	}
+
+	/**
+	 * Draw Bars background
+	 */
+	public function drawBars()
+	{
+		for ($i = 0; $i <= $this->height;) {
+			$randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
+			imageline($this->oImage, 0, $i, $this->width, $i, $randomcolor);
+			$i += 2.5;
+		}
+		for ($i = 0; $i <= $this->width;) {
+			$randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
+			imageline($this->oImage, $i, 0, $i, $this->height, $randomcolor);
+			$i += 2.5;
+		}
+	}
+
+	/**
+	 * Draw Ellipses background
+	 */
+	public function drawEllipses()
+	{
+		for ($i = 1; $i <= $this->config['background_num']; ++$i) {
+			$randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
+			imageellipse($this->oImage, mt_rand(0, $this->width), mt_rand(0, $this->height), mt_rand(0, $this->width), mt_rand(0, $this->height), $randomcolor);
+		}
+	}
+
+	/**
+	 * Draw polygons background
+	 */
+	public function drawPolygons()
+	{
+		for ($i = 1; $i <= $this->config['background_num']; ++$i) {
+			$randomcolor = imagecolorallocate($this->oImage, mt_rand(190, 255), mt_rand(190, 255), mt_rand(190, 255));
+			$coords      = [];
+			for ($j = 1; $j <= $this->config['polygon_point']; ++$j) {
+				$coords[] = mt_rand(0, $this->width);
+				$coords[] = mt_rand(0, $this->height);
+			}
+			imagefilledpolygon($this->oImage, $coords, $this->config['polygon_point'], $randomcolor);
+		}
+	}
+
+	/**
+	 *  Create CAPTCHA iamge with BMP
+	 *  TODO
+	 * @param  string $file
+	 * @return string
+	 */
+	public function createImageBmp($file = '')
+	{
+		$image = '';
+
+		if (empty($file)) {
+			header('Content-type: image/bmp');
+			echo $image;
+		} else {
+			return $image;
+		}
+	}
 }
 
 $config       = @include __DIR__ . '/../config.php';

Spacing +15 added lines, -15 removed lines

@@ -5,11 +5,11 @@ 
  * D.J.
  */
 
-include dirname(dirname(dirname(dirname(dirname(__DIR__))))) . '/mainfile.php';
+include dirname(dirname(dirname(dirname(dirname(__DIR__))))).'/mainfile.php';
 error_reporting(0);
 $xoopsLogger->activated = false;
 
-if (empty(Request::getString('HTTP_REFERER', '', 'SERVER')) || !preg_match('/^' . preg_quote(XOOPS_URL, '/') . '/', Request::getString('HTTP_REFERER', '', 'SERVER'))) {
+if (empty(Request::getString('HTTP_REFERER', '', 'SERVER')) || !preg_match('/^'.preg_quote(XOOPS_URL, '/').'/', Request::getString('HTTP_REFERER', '', 'SERVER'))) {
     exit();
 }
 
@@ -85,7 +85,7 @@ 
 
         if ('bmp' === $this->mode) {
             $this->config['num_chars'] = 4;
-            $this->code                = mt_rand(pow(10, $this->config['num_chars'] - 1), (int)str_pad('9', $this->config['num_chars'], '9'));
+            $this->code                = mt_rand(pow(10, $this->config['num_chars'] - 1), (int) str_pad('9', $this->config['num_chars'], '9'));
         } else {
             $this->code = substr(md5(uniqid(mt_rand(), 1)), 0, $this->config['num_chars']);
             if (!$this->config['casesensitive']) {
@@ -100,13 +100,13 @@ 
             return;
         }
 
-        $_SESSION['XoopsCaptcha_sessioncode'] = (string)$this->code;
-        $maxAttempts                          = (int)(@$_SESSION['XoopsCaptcha_maxattempts']);
+        $_SESSION['XoopsCaptcha_sessioncode'] = (string) $this->code;
+        $maxAttempts                          = (int) (@$_SESSION['XoopsCaptcha_maxattempts']);
 
         // Increase the attempt records on refresh
         if (!empty($maxAttempts)) {
-            $_SESSION['XoopsCaptcha_attempt_' . $_SESSION['XoopsCaptcha_name']]++;
-            if ($_SESSION['XoopsCaptcha_attempt_' . $_SESSION['XoopsCaptcha_name']] > $maxAttempts) {
+            $_SESSION['XoopsCaptcha_attempt_'.$_SESSION['XoopsCaptcha_name']]++;
+            if ($_SESSION['XoopsCaptcha_attempt_'.$_SESSION['XoopsCaptcha_name']] > $maxAttempts) {
                 $this->invalid = true;
             }
         }
@@ -120,7 +120,7 @@ 
     {
         if ($this->invalid) {
             header('Content-type: image/gif');
-            readfile(XOOPS_ROOT_PATH . '/images/subject/icon2.gif');
+            readfile(XOOPS_ROOT_PATH.'/images/subject/icon2.gif');
 
             return;
         }
@@ -190,7 +190,7 @@ 
             header('Content-type: image/jpeg');
             imagejpeg($this->oImage);
         } else {
-            imagejpeg($this->oImage, XOOPS_ROOT_PATH . '/' . $this->config['imagepath'] . '/' . $file . '.jpg');
+            imagejpeg($this->oImage, XOOPS_ROOT_PATH.'/'.$this->config['imagepath'].'/'.$file.'.jpg');
         }
         imagedestroy($this->oImage);
     }
@@ -211,8 +211,8 @@ 
          }
          }
          */
-        require_once XOOPS_ROOT_PATH . '/class/xoopslists.php';
-        $file_path = $this->config['rootpath'] . "/{$name}";
+        require_once XOOPS_ROOT_PATH.'/class/xoopslists.php';
+        $file_path = $this->config['rootpath']."/{$name}";
         $files     = XoopsLists::getFileListAsArray($file_path);
         foreach ($files as $item) {
             if (empty($extension) || preg_match("/(\.{$extension})$/i", $item)) {
@@ -229,7 +229,7 @@ 
     public function loadFont()
     {
         $fonts      = $this->_getList('fonts', 'ttf');
-        $this->font = $this->config['rootpath'] . '/fonts/' . $fonts[array_rand($fonts)];
+        $this->font = $this->config['rootpath'].'/fonts/'.$fonts[array_rand($fonts)];
     }
 
     public function setImageSize()
@@ -255,7 +255,7 @@ 
         imagedestroy($oImage);
 
         $this->height  = $MaxCharHeight + 2;
-        $this->spacing = (int)(($this->config['num_chars'] * $MaxCharWidth) / $this->config['num_chars']);
+        $this->spacing = (int) (($this->config['num_chars'] * $MaxCharWidth) / $this->config['num_chars']);
         $this->width   = ($this->config['num_chars'] * $MaxCharWidth) + ($this->spacing / 2);
     }
 
@@ -268,7 +268,7 @@ 
     {
         $RandBackground = null;
         if ($backgrounds = $this->_getList('backgrounds', '(gif|jpg|png)')) {
-            $RandBackground = $this->config['rootpath'] . '/backgrounds/' . $backgrounds[array_rand($backgrounds)];
+            $RandBackground = $this->config['rootpath'].'/backgrounds/'.$backgrounds[array_rand($backgrounds)];
         }
 
         return $RandBackground;
@@ -438,7 +438,7 @@ 
     }
 }
 
-$config       = @include __DIR__ . '/../config.php';
+$config       = @include __DIR__.'/../config.php';
 $imageHandler = new \XoopsCaptchaImageHandler();
 $imageHandler->setConfig($config);
 $imageHandler->loadImage();

admin/admin_header.php

Indentation +2 added lines, -2 removed lines

@@ -41,6 +41,6 @@
 $myts = \MyTextSanitizer::getInstance();
 
 if (!isset($GLOBALS['xoopsTpl']) || !($GLOBALS['xoopsTpl'] instanceof XoopsTpl)) {
-    require_once $GLOBALS['xoops']->path('class/template.php');
-    $xoopsTpl = new \XoopsTpl();
+	require_once $GLOBALS['xoops']->path('class/template.php');
+	$xoopsTpl = new \XoopsTpl();
 }

Spacing +2 added lines, -2 removed lines

@@ -19,11 +19,11 @@
 
 use XoopsModules\Smartobject;
 
-require_once __DIR__ . '/../../../include/cp_header.php';
+require_once __DIR__.'/../../../include/cp_header.php';
 //require_once $GLOBALS['xoops']->path('www/class/xoopsformloader.php');
 
 //require_once __DIR__ . '/../class/Utility.php';
-require_once __DIR__ . '/../include/common.php';
+require_once __DIR__.'/../include/common.php';
 
 $moduleDirName = basename(dirname(__DIR__));
 $helper = Smartobject\Helper::getInstance();

admin/about.php

Spacing +2 added lines, -2 removed lines

@@ -17,11 +17,11 @@
  * @author       XOOPS Development Team
  */
 
-require_once __DIR__ . '/admin_header.php';
+require_once __DIR__.'/admin_header.php';
 xoops_cp_header();
 
 $adminObject->displayNavigation(basename(__FILE__));
 $adminObject::setPaypal('xoopsfoundation@gmail.com');
 $adminObject->displayAbout(false);
 
-require_once __DIR__ . '/admin_footer.php';
+require_once __DIR__.'/admin_footer.php';

preloads/autoloader.php

Indentation +19 added lines, -19 removed lines

@@ -4,29 +4,29 @@
  * @see http://www.php-fig.org/psr/psr-4/examples/
  */
 spl_autoload_register(function ($class) {
-    // project-specific namespace prefix
-    $prefix = 'XoopsModules\\' . ucfirst(basename(dirname(__DIR__)));
+	// project-specific namespace prefix
+	$prefix = 'XoopsModules\\' . ucfirst(basename(dirname(__DIR__)));
 
-    // base directory for the namespace prefix
-    $base_dir = __DIR__ . '/../class/';
+	// base directory for the namespace prefix
+	$base_dir = __DIR__ . '/../class/';
 
-    // does the class use the namespace prefix?
-    $len      = strlen($prefix);
+	// does the class use the namespace prefix?
+	$len      = strlen($prefix);
 
-    if (0 !== strncmp($prefix, $class, $len)) {
-        return;
-    }
+	if (0 !== strncmp($prefix, $class, $len)) {
+		return;
+	}
 
-    // get the relative class name
-    $relative_class = substr($class, $len);
+	// get the relative class name
+	$relative_class = substr($class, $len);
 
-    // replace the namespace prefix with the base directory, replace namespace
-    // separators with directory separators in the relative class name, append
-    // with .php
-    $file           = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
+	// replace the namespace prefix with the base directory, replace namespace
+	// separators with directory separators in the relative class name, append
+	// with .php
+	$file           = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
 
-    // if the file exists, require it
-    if (file_exists($file)) {
-        require $file;
-    }
+	// if the file exists, require it
+	if (file_exists($file)) {
+		require $file;
+	}
 });

Spacing +4 added lines, -4 removed lines

@@ -3,12 +3,12 @@ 
 /**
  * @see http://www.php-fig.org/psr/psr-4/examples/
  */
-spl_autoload_register(function ($class) {
+spl_autoload_register(function($class) {
     // project-specific namespace prefix
-    $prefix = 'XoopsModules\\' . ucfirst(basename(dirname(__DIR__)));
+    $prefix = 'XoopsModules\\'.ucfirst(basename(dirname(__DIR__)));
 
     // base directory for the namespace prefix
-    $base_dir = __DIR__ . '/../class/';
+    $base_dir = __DIR__.'/../class/';
 
     // does the class use the namespace prefix?
     $len      = strlen($prefix);
@@ -23,7 +23,7 @@ 
     // replace the namespace prefix with the base directory, replace namespace
     // separators with directory separators in the relative class name, append
     // with .php
-    $file           = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
+    $file = $base_dir.str_replace('\\', '/', $relative_class).'.php';
 
     // if the file exists, require it
     if (file_exists($file)) {