mambax7 / smartobject

class/smartobject.php

Doc Comments +9 added lines, -9 removed lines

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

Indentation +1360 added lines, -1360 removed lines

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

Spacing +19 added lines, -19 removed lines

@@ -12,9 +12,9 @@ 
 
 // defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/include/common.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/include/common.php';
 
-include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
+include_once SMARTOBJECT_ROOT_PATH.'class/smartobjectcontroller.php';
 
 if (!defined('XOBJ_DTYPE_SIMPLE_ARRAY')) {
     define('XOBJ_DTYPE_SIMPLE_ARRAY', 101);
@@ -113,7 +113,7 @@ 
      */
     public function closeSection($section_name)
     {
-        $this->initVar('close_section_' . $section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
+        $this->initVar('close_section_'.$section_name, XOBJ_DTYPE_FORM_SECTION_CLOSE, '', false, null, '', false, '', '', false, false, true);
     }
 
     /**
@@ -140,13 +140,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);
             }
@@ -410,7 +410,7 @@ 
      */
     public function getForm($form_caption, $form_name, $form_action = false, $submit_button_caption = _CO_SOBJECT_SUBMIT, $cancel_js_action = false, $captcha = false)
     {
-        include_once SMARTOBJECT_ROOT_PATH . 'class/form/smartobjectform.php';
+        include_once SMARTOBJECT_ROOT_PATH.'class/form/smartobjectform.php';
         $form = new SmartobjectForm($this, $form_name, $form_caption, $form_action, null, $submit_button_caption, $cancel_js_action, $captcha);
 
         return $form;
@@ -422,7 +422,7 @@ 
     public function toArray()
     {
         $ret  = array();
-        $vars =& $this->getVars();
+        $vars = & $this->getVars();
         foreach ($vars as $key => $var) {
             $value     = $this->getVar($key);
             $ret[$key] = $value;
@@ -440,7 +440,7 @@ 
         }
 
         // Hightlighting searched words
-        include_once(SMARTOBJECT_ROOT_PATH . 'class/smarthighlighter.php');
+        include_once(SMARTOBJECT_ROOT_PATH.'class/smarthighlighter.php');
         $highlight = smart_getConfig('module_search_highlighter', false, true);
 
         if ($highlight && isset($_GET['keywords'])) {
@@ -471,7 +471,7 @@ 
             }
         } else {
             if ($prefix) {
-                $err_str = '[' . $prefix . '] ' . $err_str;
+                $err_str = '['.$prefix.'] '.$err_str;
             }
             parent::setErrors($err_str);
         }
@@ -798,8 +798,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']) {
@@ -828,7 +828,7 @@ 
                         break;
                     case XOBJ_DTYPE_INT:
                     case XOBJ_DTYPE_TIME_ONLY:
-                        $cleanv = (int)$cleanv;
+                        $cleanv = (int) $cleanv;
                         break;
 
                     case XOBJ_DTYPE_CURRENCY:
@@ -858,10 +858,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:
@@ -873,7 +873,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);
                         }
@@ -882,7 +882,7 @@ 
                         break;
                 }
             }
-            $this->cleanVars[$k] =& $cleanv;
+            $this->cleanVars[$k] = & $cleanv;
             unset($cleanv);
         }
         if (count($this->_errors) > 0) {
@@ -1100,10 +1100,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)) {
@@ -1257,7 +1257,7 @@ 
      */
     public function displaySingleObject($fetchOnly = false, $userSide = false, $actions = array(), $headerAsRow = true)
     {
-        include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectsingleview.php';
+        include_once SMARTOBJECT_ROOT_PATH.'class/smartobjectsingleview.php';
         $singleview = new SmartObjectSingleView($this, $userSide, $actions, $headerAsRow);
         // add all fields mark as displayOnSingleView except the keyid
         foreach ($this->vars as $key => $var) {

class/smartobjectcontroller.php

Doc Comments +6 added lines, -6 removed lines

@@ -123,9 +123,9 @@ 
 
     /**
      * @param        $smartObj
-     * @param        $objectid
-     * @param        $created_success_msg
-     * @param        $modified_success_msg
+     * @param        integer $objectid
+     * @param        string $created_success_msg
+     * @param        string $modified_success_msg
      * @param  bool  $redirect_page
      * @param  bool  $debug
      * @return mixed
@@ -289,7 +289,7 @@ 
      * @param  bool   $confirm_msg
      * @param  string $op
      * @param  bool   $userSide
-     * @return bool
+     * @return boolean|null
      * @internal param string $redir_page redirect page after deleting the object
      */
     public function handleObjectDeletion($confirm_msg = false, $op = 'del', $userSide = false)
@@ -443,7 +443,7 @@ 
     }
 
     /**
-     * @param         $smartObj
+     * @param         SmartMlObject $smartObj
      * @param  bool   $onlyUrl
      * @param  bool   $withimage
      * @return string
@@ -533,7 +533,7 @@ 
     }
 
     /**
-     * @param $smartObj
+     * @param SmartObject $smartObj
      * @return string
      */
     public function getPrintAndMailLink($smartObj)

Indentation +544 added lines, -544 removed lines

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

Spacing +110 added lines, -110 removed lines

@@ -23,8 +23,8 @@ 
  * @credit  Jan Keller Pedersen <mithrandir@xoops.org> - IDG Danmark A/S <www.idg.dk>
  * @link    http://smartfactory.ca The SmartFactory
  */
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobjecthandler.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartobject.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartobjecthandler.php';
 
 /**
  * Class SmartObjectController
@@ -50,15 +50,15 @@ 
         foreach (array_keys($smartObj->vars) as $key) {
             switch ($smartObj->vars[$key]['data_type']) {
                 case XOBJ_DTYPE_IMAGE:
-                    if (isset($_POST['url_' . $key]) && $_POST['url_' . $key] !== '') {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
-                        $smartObj->setVar($key, $_POST['url_' . $key]);
+                    if (isset($_POST['url_'.$key]) && $_POST['url_'.$key] !== '') {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
+                        $smartObj->setVar($key, $_POST['url_'.$key]);
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
                         }
                     }
-                    if (isset($_POST['delete_' . $key]) && $_POST['delete_' . $key] == '1') {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
+                    if (isset($_POST['delete_'.$key]) && $_POST['delete_'.$key] == '1') {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
                         $smartObj->setVar($key, '');
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
@@ -68,10 +68,10 @@ 
 
                 case XOBJ_DTYPE_URLLINK:
                     $linkObj = $smartObj->getUrlLinkObj($key);
-                    $linkObj->setVar('caption', $_POST['caption_' . $key]);
-                    $linkObj->setVar('description', $_POST['desc_' . $key]);
-                    $linkObj->setVar('target', $_POST['target_' . $key]);
-                    $linkObj->setVar('url', $_POST['url_' . $key]);
+                    $linkObj->setVar('caption', $_POST['caption_'.$key]);
+                    $linkObj->setVar('description', $_POST['desc_'.$key]);
+                    $linkObj->setVar('target', $_POST['target_'.$key]);
+                    $linkObj->setVar('url', $_POST['url_'.$key]);
                     if ($linkObj->getVar('url') !== '') {
                         $smartObj->storeUrlLinkObj($linkObj);
                     }
@@ -80,11 +80,11 @@ 
                     break;
 
                 case XOBJ_DTYPE_FILE:
-                    if (!isset($_FILES['upload_' . $key]['name']) || $_FILES['upload_' . $key]['name'] === '') {
+                    if (!isset($_FILES['upload_'.$key]['name']) || $_FILES['upload_'.$key]['name'] === '') {
                         $fileObj = $smartObj->getFileObj($key);
-                        $fileObj->setVar('caption', $_POST['caption_' . $key]);
-                        $fileObj->setVar('description', $_POST['desc_' . $key]);
-                        $fileObj->setVar('url', $_POST['url_' . $key]);
+                        $fileObj->setVar('caption', $_POST['caption_'.$key]);
+                        $fileObj->setVar('description', $_POST['desc_'.$key]);
+                        $fileObj->setVar('url', $_POST['url_'.$key]);
                         if (!($fileObj->getVar('url') === '' && $fileObj->getVar('url') === '' && $fileObj->getVar('url') === '')) {
                             $res = $smartObj->storeFileObj($fileObj);
                             if ($res) {
@@ -107,7 +107,7 @@ 
                         $value = strtotime($_POST[$key]);
                         //if strtotime returns false, the value is already a time stamp
                         if (!$value) {
-                            $value = (int)$_POST[$key];
+                            $value = (int) $_POST[$key];
                         }
                     }
                     $smartObj->setVar($key, $value);
@@ -144,12 +144,12 @@ 
 
         // Check if there were uploaded files
         if (isset($_POST['smart_upload_image']) || isset($_POST['smart_upload_file'])) {
-            include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartuploader.php';
+            include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartuploader.php';
             $uploaderObj = new SmartUploader($smartObj->getImageDir(true), $this->handler->_allowedMimeTypes, $this->handler->_maxFileSize, $this->handler->_maxWidth, $this->handler->_maxHeight);
             foreach ($_FILES as $name => $file_array) {
                 if (isset($file_array['name']) && $file_array['name'] !== '' && in_array(str_replace('upload_', '', $name), array_keys($smartObj->vars))) {
                     if ($uploaderObj->fetchMedia($name)) {
-                        $uploaderObj->setTargetFileName(time() . '_' . $uploaderObj->getMediaName());
+                        $uploaderObj->setTargetFileName(time().'_'.$uploaderObj->getMediaName());
                         if ($uploaderObj->upload()) {
                             // Find the related field in the SmartObject
                             $related_field   = str_replace('upload_', '', $name);
@@ -158,14 +158,14 @@ 
                             if ($smartObj->vars[$related_field]['data_type'] === XOBJ_DTYPE_FILE) {
                                 $object_fileurl = $smartObj->getUploadDir();
                                 $fileObj        = $smartObj->getFileObj($related_field);
-                                $fileObj->setVar('url', $object_fileurl . $uploaderObj->getSavedFileName());
-                                $fileObj->setVar('caption', $_POST['caption_' . $related_field]);
-                                $fileObj->setVar('description', $_POST['desc_' . $related_field]);
+                                $fileObj->setVar('url', $object_fileurl.$uploaderObj->getSavedFileName());
+                                $fileObj->setVar('caption', $_POST['caption_'.$related_field]);
+                                $fileObj->setVar('description', $_POST['desc_'.$related_field]);
                                 $smartObj->storeFileObj($fileObj);
                                 //todo: catch errors
                                 $smartObj->setVar($related_field, $fileObj->getVar('fileid'));
                             } else {
-                                $old_file = $smartObj->getUploadDir(true) . $smartObj->getVar($related_field);
+                                $old_file = $smartObj->getUploadDir(true).$smartObj->getVar($related_field);
                                 unlink($old_file);
                                 $smartObj->setVar($related_field, $uploaderObj->getSavedFileName());
                             }
@@ -196,7 +196,7 @@ 
             return $smartObj;
         } else {
             if (!$storeResult) {
-                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR.$smartObj->getHtmlErrors());
             }
 
             $redirect_page = $redirect_page ?: smart_get_page_before_form();
@@ -220,7 +220,7 @@ 
      */
     public function storeFromDefaultForm($created_success_msg, $modified_success_msg, $redirect_page = false, $debug = false, $x_param = false)
     {
-        $objectid = isset($_POST[$this->handler->keyName]) ? (int)$_POST[$this->handler->keyName] : 0;
+        $objectid = isset($_POST[$this->handler->keyName]) ? (int) $_POST[$this->handler->keyName] : 0;
         if ($debug) {
             if ($x_param) {
                 $smartObj = $this->handler->getD($objectid, true, $x_param);
@@ -296,7 +296,7 @@ 
     {
         global $smart_previous_page;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -306,7 +306,7 @@ 
         $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
                 exit;
             }
 
@@ -336,7 +336,7 @@ 
     {
         global $smart_previous_page, $xoopsTpl;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -346,7 +346,7 @@ 
         $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
                 exit;
             }
 
@@ -375,22 +375,22 @@ 
      */
     public function getAdminViewItemLink(SmartObject $smartObj, $onlyUrl = false, $withimage = false)
     {
-        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=view&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret = $this->handler->_moduleUrl.'admin/'.$this->handler->_page.'?op=view&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "viewmag.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_ADMIN_VIEW .
-                   "'  title='" .
-                   _CO_SOBJECT_ADMIN_VIEW .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "viewmag.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_ADMIN_VIEW.
+                   "'  title='".
+                   _CO_SOBJECT_ADMIN_VIEW.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -412,31 +412,31 @@ 
         $seoIncludeId = true;
 
         if ($seoMode === 'rewrite') {
-            $ret = XOOPS_URL .
-                   '/' .
-                   $seoModuleName .
-                   '.' .
-                   $this->handler->_itemname .
-                   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
-                   '/' .
-                   $smartObj->getVar('short_url') .
+            $ret = XOOPS_URL.
+                   '/'.
+                   $seoModuleName.
+                   '.'.
+                   $this->handler->_itemname.
+                   ($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').
+                   '/'.
+                   $smartObj->getVar('short_url').
                    '.html';
         } elseif ($seoMode === 'pathinfo') {
-            $ret = SMARTOBJECT_URL .
-                   'seo.php/' .
-                   $seoModuleName .
-                   '.' .
-                   $this->handler->_itemname .
-                   ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') .
-                   '/' .
-                   $smartObj->getVar('short_url') .
+            $ret = SMARTOBJECT_URL.
+                   'seo.php/'.
+                   $seoModuleName.
+                   '.'.
+                   $this->handler->_itemname.
+                   ($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').
+                   '/'.
+                   $smartObj->getVar('short_url').
                    '.html';
         } else {
-            $ret = $this->handler->_moduleUrl . $this->handler->_page . '?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+            $ret = $this->handler->_moduleUrl.$this->handler->_page.'?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         }
 
         if (!$onlyUrl) {
-            $ret = "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+            $ret = "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
         }
 
         return $ret;
@@ -450,30 +450,30 @@ 
      */
     public function getEditLanguageLink($smartObj, $onlyUrl = false, $withimage = true)
     {
-        $ret = $this->handler->_moduleUrl .
-               'admin/' .
-               $this->handler->_page .
-               '?op=mod&' .
-               $this->handler->keyName .
-               '=' .
-               $smartObj->getVar($this->handler->keyName) .
-               '&language=' .
+        $ret = $this->handler->_moduleUrl.
+               'admin/'.
+               $this->handler->_page.
+               '?op=mod&'.
+               $this->handler->keyName.
+               '='.
+               $smartObj->getVar($this->handler->keyName).
+               '&language='.
                $smartObj->getVar('language');
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "wizard.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_LANGUAGE_MODIFY .
-                   "'  title='" .
-                   _CO_SOBJECT_LANGUAGE_MODIFY .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "wizard.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_LANGUAGE_MODIFY.
+                   "'  title='".
+                   _CO_SOBJECT_LANGUAGE_MODIFY.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -486,22 +486,22 @@ 
     public function getEditItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=mod&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "edit.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_MODIFY .
-                   "'  title='" .
-                   _CO_SOBJECT_MODIFY .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "edit.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_MODIFY.
+                   "'  title='".
+                   _CO_SOBJECT_MODIFY.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -514,22 +514,22 @@ 
     public function getDeleteItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=del&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=del&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" .
-                   $ret .
-                   "'><img src='" .
-                   SMARTOBJECT_IMAGES_ACTIONS_URL .
-                   "editdelete.png' style='vertical-align: middle;' alt='" .
-                   _CO_SOBJECT_DELETE .
-                   "'  title='" .
-                   _CO_SOBJECT_DELETE .
+            return "<a href='".
+                   $ret.
+                   "'><img src='".
+                   SMARTOBJECT_IMAGES_ACTIONS_URL.
+                   "editdelete.png' style='vertical-align: middle;' alt='".
+                   _CO_SOBJECT_DELETE.
+                   "'  title='".
+                   _CO_SOBJECT_DELETE.
                    "'/></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -540,28 +540,28 @@ 
     {
         global $xoopsConfig;
 
-        $printlink = $this->handler->_moduleUrl . 'print.php?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        $js        = "javascript:openWithSelfMain('" . $printlink . "', 'smartpopup', 700, 519);";
-        $printlink = '<a href="' . $js . '"><img  src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'fileprint.png" alt="" style="vertical-align: middle;"/></a>';
+        $printlink = $this->handler->_moduleUrl.'print.php?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
+        $js        = "javascript:openWithSelfMain('".$printlink."', 'smartpopup', 700, 519);";
+        $printlink = '<a href="'.$js.'"><img  src="'.SMARTOBJECT_IMAGES_ACTIONS_URL.'fileprint.png" alt="" style="vertical-align: middle;"/></a>';
 
         $smartModule = smart_getModuleInfo($smartObj->handler->_moduleName);
         $link        = smart_getCurrentPage();
         $mid         = $smartModule->getVar('mid');
-        $friendlink  = "<a href=\"javascript:openWithSelfMain('" .
-                       SMARTOBJECT_URL .
-                       'sendlink.php?link=' .
-                       $link .
-                       '&amp;mid=' .
-                       $mid .
-                       "', ',',',',',','sendmessage', 674, 500);\"><img src=\"" .
-                       SMARTOBJECT_IMAGES_ACTIONS_URL .
-                       "mail_send.png\"  alt=\"" .
-                       _CO_SOBJECT_EMAIL .
-                       "\" title=\"" .
-                       _CO_SOBJECT_EMAIL .
+        $friendlink  = "<a href=\"javascript:openWithSelfMain('".
+                       SMARTOBJECT_URL.
+                       'sendlink.php?link='.
+                       $link.
+                       '&amp;mid='.
+                       $mid.
+                       "', ',',',',',','sendmessage', 674, 500);\"><img src=\"".
+                       SMARTOBJECT_IMAGES_ACTIONS_URL.
+                       "mail_send.png\"  alt=\"".
+                       _CO_SOBJECT_EMAIL.
+                       "\" title=\"".
+                       _CO_SOBJECT_EMAIL.
                        "\" style=\"vertical-align: middle;\"/></a>";
 
-        $ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';
+        $ret = '<span id="smartobject_print_button">'.$printlink.'&nbsp;</span>'.'<span id="smartobject_mail_button">'.$friendlink.'</span>';
 
         return $ret;
     }
@@ -571,7 +571,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;
+        $ret = $this->handler->_moduleName.'_'.$this->handler->_itemname;
 
         return $ret;
     }

class/smartobjecthandler.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,10 +132,10 @@ 
      *
      * @param XoopsDatabase $db           {@link XoopsDatabase}
      *                                           object
-     * @param                      $itemname
+     * @param                      string $itemname
      * @param string               $keyname      Name of the table key that uniquely identify each {@link SmartObject}
      * @param string               $idenfierName Name of the field which properly identify the {@link SmartObject}
-     * @param                      $summaryName
+     * @param                      string $summaryName
      * @param                      $modulename
      * @internal param string $tablename Name of the table use to store this <a href='psi_element://SmartObject'>SmartObject</a>
      * @internal param Name $string of the class derived from <a href='psi_element://SmartObject'>SmartObject</a> and which this handler is handling and which this handler is handling
@@ -191,7 +191,7 @@ 
 
     /**
      * @param $criteria
-     * @param $perm_name
+     * @param boolean $perm_name
      * @return bool
      */
     public function setGrantedObjectsCriteria(&$criteria, $perm_name)
@@ -375,7 +375,7 @@ 
     }
 
     /**
-     * @param        $sql
+     * @param        string $sql
      * @param        $criteria
      * @param  bool  $force
      * @param  bool  $debug

Indentation +966 added lines, -966 removed lines

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

Spacing +49 added lines, -49 removed lines

@@ -148,16 +148,16 @@ 
 
         $this->_itemname      = $itemname;
         $this->_moduleName    = $modulename;
-        $this->table          = $db->prefix($modulename . '_' . $itemname);
+        $this->table          = $db->prefix($modulename.'_'.$itemname);
         $this->keyName        = $keyname;
-        $this->className      = ucfirst($modulename) . ucfirst($itemname);
+        $this->className      = ucfirst($modulename).ucfirst($itemname);
         $this->identifierName = $idenfierName;
         $this->summaryName    = $summaryName;
-        $this->_page          = $itemname . '.php';
-        $this->_modulePath    = XOOPS_ROOT_PATH . '/modules/' . $this->_moduleName . '/';
-        $this->_moduleUrl     = XOOPS_URL . '/modules/' . $this->_moduleName . '/';
-        $this->_uploadPath    = XOOPS_UPLOAD_PATH . '/' . $this->_moduleName . '/';
-        $this->_uploadUrl     = XOOPS_UPLOAD_URL . '/' . $this->_moduleName . '/';
+        $this->_page          = $itemname.'.php';
+        $this->_modulePath    = XOOPS_ROOT_PATH.'/modules/'.$this->_moduleName.'/';
+        $this->_moduleUrl     = XOOPS_URL.'/modules/'.$this->_moduleName.'/';
+        $this->_uploadPath    = XOOPS_UPLOAD_PATH.'/'.$this->_moduleName.'/';
+        $this->_uploadUrl     = XOOPS_UPLOAD_URL.'/'.$this->_moduleName.'/';
     }
 
     /**
@@ -180,7 +180,7 @@ 
      */
     public function addPermission($perm_name, $caption, $description = false)
     {
-        include_once(SMARTOBJECT_ROOT_PATH . 'class/smartobjectpermission.php');
+        include_once(SMARTOBJECT_ROOT_PATH.'class/smartobjectpermission.php');
 
         $this->permissionsArray[] = array(
             'perm_name'   => $perm_name,
@@ -199,7 +199,7 @@ 
         $smartPermissionsHandler = new SmartobjectPermissionHandler($this);
         $grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
         if (count($grantedItems) > 0) {
-            $criteria->add(new Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
+            $criteria->add(new Criteria($this->keyName, '('.implode(', ', $grantedItems).')', 'IN'));
 
             return true;
         } else {
@@ -235,7 +235,7 @@ 
         $obj = new $this->className($this);
         $obj->setImageDir($this->getImageUrl(), $this->getImagePath());
         if (!$obj->handler) {
-            $obj->handler =& $this;
+            $obj->handler = & $this;
         }
 
         if ($isNew === true) {
@@ -250,7 +250,7 @@ 
      */
     public function getImageUrl()
     {
-        return $this->_uploadUrl . $this->_itemname . '/';
+        return $this->_uploadUrl.$this->_itemname.'/';
     }
 
     /**
@@ -258,12 +258,12 @@ 
      */
     public function getImagePath()
     {
-        $dir = $this->_uploadPath . $this->_itemname;
+        $dir = $this->_uploadPath.$this->_itemname;
         if (!file_exists($dir)) {
             smart_admin_mkdir($dir);
         }
 
-        return $dir . '/';
+        return $dir.'/';
     }
 
     /**
@@ -351,13 +351,13 @@ 
         if ($this->generalSQL) {
             $sql = $this->generalSQL;
         } elseif (!$sql) {
-            $sql = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT * FROM '.$this->table.' AS '.$this->_itemname;
         }
 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -386,12 +386,12 @@ 
         $ret = array();
 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby) {
                 $sql .= $criteria->getGroupby();
             }
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
         }
         if ($debug) {
@@ -464,18 +464,18 @@ 
             $obj->assignVars($myrow);
             if (!$id_as_key) {
                 if ($as_object) {
-                    $ret[] =& $obj;
+                    $ret[] = & $obj;
                 } else {
                     $ret[] = $obj->toArray();
                 }
             } else {
                 if ($as_object) {
-                    $value =& $obj;
+                    $value = & $obj;
                 } else {
                     $value = $obj->toArray();
                 }
                 if ($id_as_key === 'parentid') {
-                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] =& $value;
+                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] = & $value;
                 } else {
                     $ret[$obj->getVar($this->keyName)] = $value;
                 }
@@ -518,15 +518,15 @@ 
             $criteria->setSort($this->getIdentifierName());
         }
 
-        $sql = 'SELECT ' . (is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
+        $sql = 'SELECT '.(is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
         if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->getIdentifierName();
+            $sql .= ', '.$this->getIdentifierName();
         }
-        $sql .= ' FROM ' . $this->table . ' AS ' . $this->_itemname;
+        $sql .= ' FROM '.$this->table.' AS '.$this->_itemname;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->getSort() !== '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -563,7 +563,7 @@ 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
             if ($criteria->groupby !== '') {
                 $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+                $field   = $criteria->groupby.', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
             }
         }
         /**
@@ -574,10 +574,10 @@ 
             $sql = $this->generalSQL;
             $sql = str_replace('SELECT *', 'SELECT COUNT(*)', $sql);
         } else {
-            $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table.' AS '.$this->_itemname;
         }
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby !== '') {
                 $sql .= $criteria->getGroupby();
             }
@@ -620,13 +620,13 @@ 
         if (is_array($this->keyName)) {
             $clause = array();
             for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                $clause[] = $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
             }
             $whereclause = implode(' AND ', $clause);
         } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+            $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
         }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+        $sql = 'DELETE FROM '.$this->table.' WHERE '.$whereclause;
         if (false !== $force) {
             $result = $this->db->queryF($sql);
         } else {
@@ -687,7 +687,7 @@ 
              * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
              */
             if (!is_a($obj, $this->className)) {
-                $obj->setError(get_class($obj) . ' Differs from ' . $this->className);
+                $obj->setError(get_class($obj).' Differs from '.$this->className);
 
                 return false;
             }
@@ -748,7 +748,7 @@ 
         $fieldsToStoreInDB = array();
         foreach ($obj->cleanVars as $k => $v) {
             if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
-                $cleanvars[$k] = (int)$v;
+                $cleanvars[$k] = (int) $v;
             } elseif (is_array($v)) {
                 $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
             } else {
@@ -761,13 +761,13 @@ 
         if ($obj->isNew()) {
             if (!is_array($this->keyName)) {
                 if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+                    $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq');
                 }
             }
 
-            $sql = 'INSERT INTO ' . $this->table . ' (' . implode(',', array_keys($fieldsToStoreInDB)) . ') VALUES (' . implode(',', array_values($fieldsToStoreInDB)) . ')';
+            $sql = 'INSERT INTO '.$this->table.' ('.implode(',', array_keys($fieldsToStoreInDB)).') VALUES ('.implode(',', array_values($fieldsToStoreInDB)).')';
         } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
+            $sql = 'UPDATE '.$this->table.' SET';
             foreach ($fieldsToStoreInDB as $key => $value) {
                 if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
                     continue;
@@ -775,7 +775,7 @@ 
                 if (isset($notfirst)) {
                     $sql .= ',';
                 }
-                $sql .= ' ' . $key . ' = ' . $value;
+                $sql .= ' '.$key.' = '.$value;
                 $notfirst = true;
             }
             if (is_array($this->keyName)) {
@@ -784,12 +784,12 @@ 
                     if ($i > 0) {
                         $whereclause .= ' AND ';
                     }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                    $whereclause .= $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
                 }
             } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+                $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
             }
-            $sql .= ' WHERE ' . $whereclause;
+            $sql .= ' WHERE '.$whereclause;
         }
 
         if ($debug) {
@@ -862,7 +862,7 @@ 
      */
     public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = null, $force = false)
     {
-        $set_clause = $fieldname . ' = ';
+        $set_clause = $fieldname.' = ';
         if (is_numeric($fieldvalue)) {
             $set_clause .= $fieldvalue;
         } elseif (is_array($fieldvalue)) {
@@ -870,9 +870,9 @@ 
         } else {
             $set_clause .= $this->db->quoteString($fieldvalue);
         }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+        $sql = 'UPDATE '.$this->table.' SET '.$set_clause;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
         }
         if (false != $force) {
             $result = $this->db->queryF($sql);
@@ -896,8 +896,8 @@ 
     public function deleteAll(CriteriaElement $criteria = null)
     {
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql = 'DELETE FROM '.$this->table;
+            $sql .= ' '.$criteria->renderWhere();
             if (!$this->db->query($sql)) {
                 return false;
             }
@@ -930,7 +930,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->_moduleName . '_' . $this->_itemname;
+        $ret = $this->_moduleName.'_'.$this->_itemname;
 
         return $ret;
     }
@@ -942,7 +942,7 @@ 
     {
         if (isset($object->vars['counter'])) {
             $new_counter = $object->getVar('counter') + 1;
-            $sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
+            $sql         = 'UPDATE '.$this->table.' SET counter='.$new_counter.' WHERE '.$this->keyName.'='.$object->id();
             $this->query($sql, null, true);
         }
     }
@@ -986,7 +986,7 @@ 
     public function getIdentifierName($withprefix = true)
     {
         if ($withprefix) {
-            return $this->_itemname . '.' . $this->identifierName;
+            return $this->_itemname.'.'.$this->identifierName;
         } else {
             return $this->identifierName;
         }

class/smartobjectpermission.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
      */
     /**
      * @param        $gperm_name
-     * @param  null  $id
+     * @param  integer  $id
      * @return array
      */
     public function getGrantedGroups($gperm_name, $id = null)

Indentation +198 added lines, -198 removed lines

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

class/smartobjectsregistry.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
     /**
      * Access the only instance of this class
      *
-     * @return XoopsObject
+     * @return SmartObjectsRegistry
      *
      * @static
      * @staticvar   object

Indentation +153 added lines, -153 removed lines

@@ -13,169 +13,169 @@
  */
 class SmartObjectsRegistry
 {
-    public $_registryArray;
+	public $_registryArray;
 
-    /**
-     * Access the only instance of this class
-     *
-     * @return XoopsObject
-     *
-     * @static
-     * @staticvar   object
-     */
-    public static function getInstance()
-    {
-        static $instance;
-        if (null === $instance) {
-            $instance = new static();
-        }
+	/**
+	 * Access the only instance of this class
+	 *
+	 * @return XoopsObject
+	 *
+	 * @static
+	 * @staticvar   object
+	 */
+	public static function getInstance()
+	{
+		static $instance;
+		if (null === $instance) {
+			$instance = new static();
+		}
 
-        return $instance;
-    }
+		return $instance;
+	}
 
-    /**
-     * Adding objects to the registry
-     *
-     * @param  SmartPersistableObjectHandler $handler  of the objects to add
-     * @param  bool|CriteriaCompo            $criteria to pass to the getObjects method of the handler (with id_as_key)
-     * @return FALSE                         if an error occured
-     */
-    public function addObjectsFromHandler(&$handler, $criteria = false)
-    {
-        if (method_exists($handler, 'getObjects')) {
-            $objects                                                                     = $handler->getObjects($criteria, true);
-            $this->_registryArray['objects'][$handler->_moduleName][$handler->_itemname] = $objects;
+	/**
+	 * Adding objects to the registry
+	 *
+	 * @param  SmartPersistableObjectHandler $handler  of the objects to add
+	 * @param  bool|CriteriaCompo            $criteria to pass to the getObjects method of the handler (with id_as_key)
+	 * @return FALSE                         if an error occured
+	 */
+	public function addObjectsFromHandler(&$handler, $criteria = false)
+	{
+		if (method_exists($handler, 'getObjects')) {
+			$objects                                                                     = $handler->getObjects($criteria, true);
+			$this->_registryArray['objects'][$handler->_moduleName][$handler->_itemname] = $objects;
 
-            return $objects;
-        } else {
-            return false;
-        }
-    }
+			return $objects;
+		} else {
+			return false;
+		}
+	}
 
-    /**
-     * Adding objects to the registry from an item name
-     * This method will fetch the handler of the item / module and call the addObjectsFromHandler
-     *
-     * @param  string             $item       name of the item
-     * @param  bool|string        $modulename name of the module
-     * @param  bool|CriteriaCompo $criteria   to pass to the getObjects method of the handler (with id_as_key)
-     * @return FALSE              if an error occured
-     */
-    public function addObjectsFromItemName($item, $modulename = false, $criteria = false)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        $objectHandler = xoops_getModuleHandler($item, $modulename);
+	/**
+	 * Adding objects to the registry from an item name
+	 * This method will fetch the handler of the item / module and call the addObjectsFromHandler
+	 *
+	 * @param  string             $item       name of the item
+	 * @param  bool|string        $modulename name of the module
+	 * @param  bool|CriteriaCompo $criteria   to pass to the getObjects method of the handler (with id_as_key)
+	 * @return FALSE              if an error occured
+	 */
+	public function addObjectsFromItemName($item, $modulename = false, $criteria = false)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		$objectHandler = xoops_getModuleHandler($item, $modulename);
 
-        if (method_exists($objectHandler, 'getObjects')) {
-            $objects                                                                                 = $objectHandler->getObjects($criteria, true);
-            $this->_registryArray['objects'][$objectHandler->_moduleName][$objectHandler->_itemname] = $objects;
+		if (method_exists($objectHandler, 'getObjects')) {
+			$objects                                                                                 = $objectHandler->getObjects($criteria, true);
+			$this->_registryArray['objects'][$objectHandler->_moduleName][$objectHandler->_itemname] = $objects;
 
-            return $objects;
-        } else {
-            return false;
-        }
-    }
+			return $objects;
+		} else {
+			return false;
+		}
+	}
 
-    /**
-     * Fetching objects from the registry
-     *
-     * @param string $itemname
-     * @param string $modulename
-     *
-     * @return the requested objects or FALSE if they don't exists in the registry
-     */
-    public function getObjects($itemname, $modulename)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        if (isset($this->_registryArray['objects'][$modulename][$itemname])) {
-            return $this->_registryArray['objects'][$modulename][$itemname];
-        } else {
-            // if they were not in registry, let's fetch them and add them to the reigistry
-            $moduleHandler = xoops_getModuleHandler($itemname, $modulename);
-            if (method_exists($moduleHandler, 'getObjects')) {
-                $objects = $moduleHandler->getObjects();
-            }
-            $this->_registryArray['objects'][$modulename][$itemname] = $objects;
+	/**
+	 * Fetching objects from the registry
+	 *
+	 * @param string $itemname
+	 * @param string $modulename
+	 *
+	 * @return the requested objects or FALSE if they don't exists in the registry
+	 */
+	public function getObjects($itemname, $modulename)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		if (isset($this->_registryArray['objects'][$modulename][$itemname])) {
+			return $this->_registryArray['objects'][$modulename][$itemname];
+		} else {
+			// if they were not in registry, let's fetch them and add them to the reigistry
+			$moduleHandler = xoops_getModuleHandler($itemname, $modulename);
+			if (method_exists($moduleHandler, 'getObjects')) {
+				$objects = $moduleHandler->getObjects();
+			}
+			$this->_registryArray['objects'][$modulename][$itemname] = $objects;
 
-            return $objects;
-        }
-    }
+			return $objects;
+		}
+	}
 
-    /**
-     * Fetching objects from the registry, as a list: objectid => identifier
-     *
-     * @param string $itemname
-     * @param string $modulename
-     *
-     * @return the requested objects or FALSE if they don't exists in the registry
-     */
-    public function getList($itemname, $modulename)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        if (isset($this->_registryArray['list'][$modulename][$itemname])) {
-            return $this->_registryArray['list'][$modulename][$itemname];
-        } else {
-            // if they were not in registry, let's fetch them and add them to the reigistry
-            $moduleHandler = xoops_getModuleHandler($itemname, $modulename);
-            if (method_exists($moduleHandler, 'getList')) {
-                $objects = $moduleHandler->getList();
-            }
-            $this->_registryArray['list'][$modulename][$itemname] = $objects;
+	/**
+	 * Fetching objects from the registry, as a list: objectid => identifier
+	 *
+	 * @param string $itemname
+	 * @param string $modulename
+	 *
+	 * @return the requested objects or FALSE if they don't exists in the registry
+	 */
+	public function getList($itemname, $modulename)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		if (isset($this->_registryArray['list'][$modulename][$itemname])) {
+			return $this->_registryArray['list'][$modulename][$itemname];
+		} else {
+			// if they were not in registry, let's fetch them and add them to the reigistry
+			$moduleHandler = xoops_getModuleHandler($itemname, $modulename);
+			if (method_exists($moduleHandler, 'getList')) {
+				$objects = $moduleHandler->getList();
+			}
+			$this->_registryArray['list'][$modulename][$itemname] = $objects;
 
-            return $objects;
-        }
-    }
+			return $objects;
+		}
+	}
 
-    /**
-     * Retreive a single object
-     *
-     * @param string $itemname
-     * @param string $key
-     *
-     * @param  bool $modulename
-     * @return the  requestd object or FALSE if they don't exists in the registry
-     */
-    public function getSingleObject($itemname, $key, $modulename = false)
-    {
-        if (!$modulename) {
-            global $xoopsModule;
-            if (!is_object($xoopsModule)) {
-                return false;
-            } else {
-                $modulename = $xoopsModule->dirname();
-            }
-        }
-        if (isset($this->_registryArray['objects'][$modulename][$itemname][$key])) {
-            return $this->_registryArray['objects'][$modulename][$itemname][$key];
-        } else {
-            $objectHandler = xoops_getModuleHandler($itemname, $modulename);
-            $object        = $objectHandler->get($key);
-            if (!$object->isNew()) {
-                return $object;
-            } else {
-                return false;
-            }
-        }
-    }
+	/**
+	 * Retreive a single object
+	 *
+	 * @param string $itemname
+	 * @param string $key
+	 *
+	 * @param  bool $modulename
+	 * @return the  requestd object or FALSE if they don't exists in the registry
+	 */
+	public function getSingleObject($itemname, $key, $modulename = false)
+	{
+		if (!$modulename) {
+			global $xoopsModule;
+			if (!is_object($xoopsModule)) {
+				return false;
+			} else {
+				$modulename = $xoopsModule->dirname();
+			}
+		}
+		if (isset($this->_registryArray['objects'][$modulename][$itemname][$key])) {
+			return $this->_registryArray['objects'][$modulename][$itemname][$key];
+		} else {
+			$objectHandler = xoops_getModuleHandler($itemname, $modulename);
+			$object        = $objectHandler->get($key);
+			if (!$object->isNew()) {
+				return $object;
+			} else {
+				return false;
+			}
+		}
+	}
 }

include/functions.php

Doc Comments +13 added lines, -13 removed lines

@@ -325,7 +325,7 @@ 
 }
 
 /**
- * @param              $key
+ * @param              string $key
  * @param  bool        $moduleName
  * @param  string      $default
  * @return null|string
@@ -387,7 +387,7 @@ 
 
 /**
  * Thanks to the NewBB2 Development Team
- * @param $target
+ * @param string $target
  * @return bool
  */
 function smart_admin_mkdir($target)
@@ -540,7 +540,7 @@ 
 
 /**
  * @param $dirname
- * @return bool
+ * @return boolean|null
  */
 function smart_deleteFile($dirname)
 {
@@ -755,7 +755,7 @@ 
 }
 
 /**
- * @param $name
+ * @param string $name
  */
 function smart_close_collapsable($name)
 {
@@ -765,7 +765,7 @@ 
 }
 
 /**
- * @param     $name
+ * @param     string $name
  * @param     $value
  * @param int $time
  */
@@ -779,7 +779,7 @@ 
 }
 
 /**
- * @param         $name
+ * @param         string $name
  * @param  string $default
  * @return string
  */
@@ -938,7 +938,7 @@ 
 }
 
 /**
- * @param $src
+ * @param string $src
  */
 function smart_addScript($src)
 {
@@ -1115,8 +1115,8 @@ 
 }
 
 /**
- * @param $module
- * @param $file
+ * @param string $module
+ * @param string $file
  */
 function smart_loadLanguageFile($module, $file)
 {
@@ -1232,7 +1232,7 @@ 
  * This function should be able to cover almost all floats that appear in an european environment.
  * @param            $str
  * @param  bool      $set
- * @return float|int
+ * @return double
  */
 function smart_getfloat($str, $set = false)
 {
@@ -1267,7 +1267,7 @@ 
 /**
  * @param                         $var
  * @param  bool                   $currencyObj
- * @return float|int|mixed|string
+ * @return string
  */
 function smart_currency($var, $currencyObj = false)
 {
@@ -1295,7 +1295,7 @@ 
 
 /**
  * @param $var
- * @return float|int|mixed|string
+ * @return string
  */
 function smart_float($var)
 {
@@ -1343,7 +1343,7 @@ 
 /**
  * @param $moduleName
  * @param $items
- * @return array
+ * @return string[]
  */
 function smart_getTablesArray($moduleName, $items)
 {

Indentation +733 added lines, -733 removed lines

@@ -11,9 +11,9 @@ 
 
 function smart_get_css_link($cssfile)
 {
-    $ret = '<link rel="stylesheet" type="text/css" href="' . $cssfile . '" />';
+	$ret = '<link rel="stylesheet" type="text/css" href="' . $cssfile . '" />';
 
-    return $ret;
+	return $ret;
 }
 
 /**
@@ -21,9 +21,9 @@ 
  */
 function smart_get_page_before_form()
 {
-    global $smart_previous_page;
+	global $smart_previous_page;
 
-    return isset($_POST['smart_page_before_form']) ? $_POST['smart_page_before_form'] : $smart_previous_page;
+	return isset($_POST['smart_page_before_form']) ? $_POST['smart_page_before_form'] : $smart_previous_page;
 }
 
 /**
@@ -34,29 +34,29 @@ 
  */
 function smart_userIsAdmin($module = false)
 {
-    global $xoopsUser;
-    static $smart_isAdmin;
-    if (!$module) {
-        global $xoopsModule;
-        $module = $xoopsModule->getVar('dirname');
-    }
-    if (isset($smart_isAdmin[$module])) {
-        return $smart_isAdmin[$module];
-    }
-    if (!$xoopsUser) {
-        $smart_isAdmin[$module] = false;
-
-        return $smart_isAdmin[$module];
-    }
-    $smart_isAdmin[$module] = false;
-    $smartModule            = smart_getModuleInfo($module);
-    if (!is_object($smartModule)) {
-        return false;
-    }
-    $module_id              = $smartModule->getVar('mid');
-    $smart_isAdmin[$module] = $xoopsUser->isAdmin($module_id);
-
-    return $smart_isAdmin[$module];
+	global $xoopsUser;
+	static $smart_isAdmin;
+	if (!$module) {
+		global $xoopsModule;
+		$module = $xoopsModule->getVar('dirname');
+	}
+	if (isset($smart_isAdmin[$module])) {
+		return $smart_isAdmin[$module];
+	}
+	if (!$xoopsUser) {
+		$smart_isAdmin[$module] = false;
+
+		return $smart_isAdmin[$module];
+	}
+	$smart_isAdmin[$module] = false;
+	$smartModule            = smart_getModuleInfo($module);
+	if (!is_object($smartModule)) {
+		return false;
+	}
+	$module_id              = $smartModule->getVar('mid');
+	$smart_isAdmin[$module] = $xoopsUser->isAdmin($module_id);
+
+	return $smart_isAdmin[$module];
 }
 
 /**
@@ -64,13 +64,13 @@ 
  */
 function smart_isXoops22()
 {
-    $xoops22 = false;
-    $xv      = str_replace('XOOPS ', '', XOOPS_VERSION);
-    if (substr($xv, 2, 1) == '2') {
-        $xoops22 = true;
-    }
+	$xoops22 = false;
+	$xv      = str_replace('XOOPS ', '', XOOPS_VERSION);
+	if (substr($xv, 2, 1) == '2') {
+		$xoops22 = true;
+	}
 
-    return $xoops22;
+	return $xoops22;
 }
 
 /**
@@ -81,34 +81,34 @@ 
  */
 function smart_getModuleName($withLink = true, $forBreadCrumb = false, $moduleName = false)
 {
-    if (!$moduleName) {
-        global $xoopsModule;
-        $moduleName = $xoopsModule->getVar('dirname');
-    }
-    $smartModule       = smart_getModuleInfo($moduleName);
-    $smartModuleConfig = smart_getModuleConfig($moduleName);
-    if (!isset($smartModule)) {
-        return '';
-    }
-
-    if ($forBreadCrumb && (isset($smartModuleConfig['show_mod_name_breadcrumb']) && !$smartModuleConfig['show_mod_name_breadcrumb'])) {
-        return '';
-    }
-    if (!$withLink) {
-        return $smartModule->getVar('name');
-    } else {
-        $seoMode = smart_getModuleModeSEO($moduleName);
-        if ($seoMode === 'rewrite') {
-            $seoModuleName = smart_getModuleNameForSEO($moduleName);
-            $ret           = XOOPS_URL . '/' . $seoModuleName . '/';
-        } elseif ($seoMode === 'pathinfo') {
-            $ret = XOOPS_URL . '/modules/' . $moduleName . '/seo.php/' . $seoModuleName . '/';
-        } else {
-            $ret = XOOPS_URL . '/modules/' . $moduleName . '/';
-        }
-
-        return '<a href="' . $ret . '">' . $smartModule->getVar('name') . '</a>';
-    }
+	if (!$moduleName) {
+		global $xoopsModule;
+		$moduleName = $xoopsModule->getVar('dirname');
+	}
+	$smartModule       = smart_getModuleInfo($moduleName);
+	$smartModuleConfig = smart_getModuleConfig($moduleName);
+	if (!isset($smartModule)) {
+		return '';
+	}
+
+	if ($forBreadCrumb && (isset($smartModuleConfig['show_mod_name_breadcrumb']) && !$smartModuleConfig['show_mod_name_breadcrumb'])) {
+		return '';
+	}
+	if (!$withLink) {
+		return $smartModule->getVar('name');
+	} else {
+		$seoMode = smart_getModuleModeSEO($moduleName);
+		if ($seoMode === 'rewrite') {
+			$seoModuleName = smart_getModuleNameForSEO($moduleName);
+			$ret           = XOOPS_URL . '/' . $seoModuleName . '/';
+		} elseif ($seoMode === 'pathinfo') {
+			$ret = XOOPS_URL . '/modules/' . $moduleName . '/seo.php/' . $seoModuleName . '/';
+		} else {
+			$ret = XOOPS_URL . '/modules/' . $moduleName . '/';
+		}
+
+		return '<a href="' . $ret . '">' . $smartModule->getVar('name') . '</a>';
+	}
 }
 
 /**
@@ -117,14 +117,14 @@ 
  */
 function smart_getModuleNameForSEO($moduleName = false)
 {
-    $smartModule       = smart_getModuleInfo($moduleName);
-    $smartModuleConfig = smart_getModuleConfig($moduleName);
-    if (isset($smartModuleConfig['seo_module_name'])) {
-        return $smartModuleConfig['seo_module_name'];
-    }
-    $ret = smart_getModuleName(false, false, $moduleName);
-
-    return strtolower($ret);
+	$smartModule       = smart_getModuleInfo($moduleName);
+	$smartModuleConfig = smart_getModuleConfig($moduleName);
+	if (isset($smartModuleConfig['seo_module_name'])) {
+		return $smartModuleConfig['seo_module_name'];
+	}
+	$ret = smart_getModuleName(false, false, $moduleName);
+
+	return strtolower($ret);
 }
 
 /**
@@ -133,10 +133,10 @@ 
  */
 function smart_getModuleModeSEO($moduleName = false)
 {
-    $smartModule       = smart_getModuleInfo($moduleName);
-    $smartModuleConfig = smart_getModuleConfig($moduleName);
+	$smartModule       = smart_getModuleInfo($moduleName);
+	$smartModuleConfig = smart_getModuleConfig($moduleName);
 
-    return isset($smartModuleConfig['seo_mode']) ? $smartModuleConfig['seo_mode'] : false;
+	return isset($smartModuleConfig['seo_mode']) ? $smartModuleConfig['seo_mode'] : false;
 }
 
 /**
@@ -145,10 +145,10 @@ 
  */
 function smart_getModuleIncludeIdSEO($moduleName = false)
 {
-    $smartModule       = smart_getModuleInfo($moduleName);
-    $smartModuleConfig = smart_getModuleConfig($moduleName);
+	$smartModule       = smart_getModuleInfo($moduleName);
+	$smartModuleConfig = smart_getModuleConfig($moduleName);
 
-    return !empty($smartModuleConfig['seo_inc_id']);
+	return !empty($smartModuleConfig['seo_inc_id']);
 }
 
 /**
@@ -157,26 +157,26 @@ 
  */
 function smart_getenv($key)
 {
-    $ret = '';
-    $ret = isset($_SERVER[$key]) ? $_SERVER[$key] : (isset($_ENV[$key]) ? $_ENV[$key] : '');
+	$ret = '';
+	$ret = isset($_SERVER[$key]) ? $_SERVER[$key] : (isset($_ENV[$key]) ? $_ENV[$key] : '');
 
-    return $ret;
+	return $ret;
 }
 
 function smart_xoops_cp_header()
 {
-    xoops_cp_header();
-    global $xoopsModule, $xoopsConfig;
-    /**
-     * include SmartObject admin language file
-     */
-    $fileName = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php';
-    if (file_exists($fileName)) {
-        include_once $fileName;
-    } else {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/admin.php';
-    }
-    ?>
+	xoops_cp_header();
+	global $xoopsModule, $xoopsConfig;
+	/**
+	 * include SmartObject admin language file
+	 */
+	$fileName = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php';
+	if (file_exists($fileName)) {
+		include_once $fileName;
+	} else {
+		include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/admin.php';
+	}
+	?>
     <script type='text/javascript'>
         <!--
         var smart_url = '<?php echo SMARTOBJECT_URL ?>';
@@ -189,14 +189,14 @@ 
         src='<?php echo SMARTOBJECT_URL ?>include/smart.js'></script>
     <?php
 
-    /**
-     * Include the admin language constants for the SmartObject Framework
-     */
-    $admin_file = SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/admin.php';
-    if (!file_exists($admin_file)) {
-        $admin_file = SMARTOBJECT_ROOT_PATH . 'language/english/admin.php';
-    }
-    include_once($admin_file);
+	/**
+	 * Include the admin language constants for the SmartObject Framework
+	 */
+	$admin_file = SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/admin.php';
+	if (!file_exists($admin_file)) {
+		$admin_file = SMARTOBJECT_ROOT_PATH . 'language/english/admin.php';
+	}
+	include_once($admin_file);
 }
 
 /**
@@ -210,21 +210,21 @@ 
  */
 function smart_TableExists($table)
 {
-    $bRetVal = false;
-    //Verifies that a MySQL table exists
-    $xoopsDB  = XoopsDatabaseFactory::getDatabaseConnection();
-    $realname = $xoopsDB->prefix($table);
-    $sql      = 'SHOW TABLES FROM ' . XOOPS_DB_NAME;
-    $ret      = $xoopsDB->queryF($sql);
-    while (list($m_table) = $xoopsDB->fetchRow($ret)) {
-        if ($m_table == $realname) {
-            $bRetVal = true;
-            break;
-        }
-    }
-    $xoopsDB->freeRecordSet($ret);
-
-    return $bRetVal;
+	$bRetVal = false;
+	//Verifies that a MySQL table exists
+	$xoopsDB  = XoopsDatabaseFactory::getDatabaseConnection();
+	$realname = $xoopsDB->prefix($table);
+	$sql      = 'SHOW TABLES FROM ' . XOOPS_DB_NAME;
+	$ret      = $xoopsDB->queryF($sql);
+	while (list($m_table) = $xoopsDB->fetchRow($ret)) {
+		if ($m_table == $realname) {
+			$bRetVal = true;
+			break;
+		}
+	}
+	$xoopsDB->freeRecordSet($ret);
+
+	return $bRetVal;
 }
 
 /**
@@ -239,19 +239,19 @@ 
  */
 function smart_GetMeta($key, $moduleName = false)
 {
-    if (!$moduleName) {
-        $moduleName = smart_getCurrentModuleName();
-    }
-    $xoopsDB = XoopsDatabaseFactory::getDatabaseConnection();
-    $sql     = sprintf('SELECT metavalue FROM %s WHERE metakey=%s', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($key));
-    $ret     = $xoopsDB->query($sql);
-    if (!$ret) {
-        $value = false;
-    } else {
-        list($value) = $xoopsDB->fetchRow($ret);
-    }
-
-    return $value;
+	if (!$moduleName) {
+		$moduleName = smart_getCurrentModuleName();
+	}
+	$xoopsDB = XoopsDatabaseFactory::getDatabaseConnection();
+	$sql     = sprintf('SELECT metavalue FROM %s WHERE metakey=%s', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($key));
+	$ret     = $xoopsDB->query($sql);
+	if (!$ret) {
+		$value = false;
+	} else {
+		list($value) = $xoopsDB->fetchRow($ret);
+	}
+
+	return $value;
 }
 
 /**
@@ -259,12 +259,12 @@ 
  */
 function smart_getCurrentModuleName()
 {
-    global $xoopsModule;
-    if (is_object($xoopsModule)) {
-        return $xoopsModule->getVar('dirname');
-    } else {
-        return false;
-    }
+	global $xoopsModule;
+	if (is_object($xoopsModule)) {
+		return $xoopsModule->getVar('dirname');
+	} else {
+		return false;
+	}
 }
 
 /**
@@ -280,22 +280,22 @@ 
  */
 function smart_SetMeta($key, $value, $moduleName = false)
 {
-    if (!$moduleName) {
-        $moduleName = smart_getCurrentModuleName();
-    }
-    $xoopsDB = XoopsDatabaseFactory::getDatabaseConnection();
-    $ret     = smart_GetMeta($key, $moduleName);
-    if ($ret === '0' || $ret > 0) {
-        $sql = sprintf('UPDATE %s SET metavalue = %s WHERE metakey = %s', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($value), $xoopsDB->quoteString($key));
-    } else {
-        $sql = sprintf('INSERT INTO %s (metakey, metavalue) VALUES (%s, %s)', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($key), $xoopsDB->quoteString($value));
-    }
-    $ret = $xoopsDB->queryF($sql);
-    if (!$ret) {
-        return false;
-    }
-
-    return true;
+	if (!$moduleName) {
+		$moduleName = smart_getCurrentModuleName();
+	}
+	$xoopsDB = XoopsDatabaseFactory::getDatabaseConnection();
+	$ret     = smart_GetMeta($key, $moduleName);
+	if ($ret === '0' || $ret > 0) {
+		$sql = sprintf('UPDATE %s SET metavalue = %s WHERE metakey = %s', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($value), $xoopsDB->quoteString($key));
+	} else {
+		$sql = sprintf('INSERT INTO %s (metakey, metavalue) VALUES (%s, %s)', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($key), $xoopsDB->quoteString($value));
+	}
+	$ret = $xoopsDB->queryF($sql);
+	if (!$ret) {
+		return false;
+	}
+
+	return true;
 }
 
 // Thanks to Mithrandir:-)
@@ -308,20 +308,20 @@ 
  */
 function smart_substr($str, $start, $length, $trimmarker = '...')
 {
-    // if the string is empty, let's get out ;-)
-    if ($str === '') {
-        return $str;
-    }
-    // reverse a string that is shortened with '' as trimmarker
-    $reversed_string = strrev(xoops_substr($str, $start, $length, ''));
-    // find first space in reversed string
-    $position_of_space = strpos($reversed_string, ' ', 0);
-    // truncate the original string to a length of $length
-    // minus the position of the last space
-    // plus the length of the $trimmarker
-    $truncated_string = xoops_substr($str, $start, $length - $position_of_space + strlen($trimmarker), $trimmarker);
-
-    return $truncated_string;
+	// if the string is empty, let's get out ;-)
+	if ($str === '') {
+		return $str;
+	}
+	// reverse a string that is shortened with '' as trimmarker
+	$reversed_string = strrev(xoops_substr($str, $start, $length, ''));
+	// find first space in reversed string
+	$position_of_space = strpos($reversed_string, ' ', 0);
+	// truncate the original string to a length of $length
+	// minus the position of the last space
+	// plus the length of the $trimmarker
+	$truncated_string = xoops_substr($str, $start, $length - $position_of_space + strlen($trimmarker), $trimmarker);
+
+	return $truncated_string;
 }
 
 /**
@@ -332,19 +332,19 @@ 
  */
 function smart_getConfig($key, $moduleName = false, $default = 'default_is_undefined')
 {
-    if (!$moduleName) {
-        $moduleName = smart_getCurrentModuleName();
-    }
-    $configs = smart_getModuleConfig($moduleName);
-    if (isset($configs[$key])) {
-        return $configs[$key];
-    } else {
-        if ($default === 'default_is_undefined') {
-            return null;
-        } else {
-            return $default;
-        }
-    }
+	if (!$moduleName) {
+		$moduleName = smart_getCurrentModuleName();
+	}
+	$configs = smart_getModuleConfig($moduleName);
+	if (isset($configs[$key])) {
+		return $configs[$key];
+	} else {
+		if ($default === 'default_is_undefined') {
+			return null;
+		} else {
+			return $default;
+		}
+	}
 }
 
 /**
@@ -357,32 +357,32 @@ 
  */
 function smart_copyr($source, $dest)
 {
-    // Simple copy for a file
-    if (is_file($source)) {
-        return copy($source, $dest);
-    }
-    // Make destination directory
-    if (!is_dir($dest)) {
-        mkdir($dest);
-    }
-    // Loop through the folder
-    $dir = dir($source);
-    while (false !== $entry = $dir->read()) {
-        // Skip pointers
-        if ($entry === '.' || $entry === '..') {
-            continue;
-        }
-        // Deep copy directories
-        if (is_dir("$source/$entry") && ($dest !== "$source/$entry")) {
-            copyr("$source/$entry", "$dest/$entry");
-        } else {
-            copy("$source/$entry", "$dest/$entry");
-        }
-    }
-    // Clean up
-    $dir->close();
-
-    return true;
+	// Simple copy for a file
+	if (is_file($source)) {
+		return copy($source, $dest);
+	}
+	// Make destination directory
+	if (!is_dir($dest)) {
+		mkdir($dest);
+	}
+	// Loop through the folder
+	$dir = dir($source);
+	while (false !== $entry = $dir->read()) {
+		// Skip pointers
+		if ($entry === '.' || $entry === '..') {
+			continue;
+		}
+		// Deep copy directories
+		if (is_dir("$source/$entry") && ($dest !== "$source/$entry")) {
+			copyr("$source/$entry", "$dest/$entry");
+		} else {
+			copy("$source/$entry", "$dest/$entry");
+		}
+	}
+	// Clean up
+	$dir->close();
+
+	return true;
 }
 
 /**
@@ -392,26 +392,26 @@ 
  */
 function smart_admin_mkdir($target)
 {
-    // http://www.php.net/manual/en/function.mkdir.php
-    // saint at corenova.com
-    // bart at cdasites dot com
-    if (is_dir($target) || empty($target)) {
-        return true; // best case check first
-    }
-    if (file_exists($target) && !is_dir($target)) {
-        return false;
-    }
-    if (smart_admin_mkdir(substr($target, 0, strrpos($target, '/')))) {
-        if (!file_exists($target)) {
-            $res = mkdir($target, 0777); // crawl back up & create dir tree
-            smart_admin_chmod($target);
-
-            return $res;
-        }
-    }
-    $res = is_dir($target);
-
-    return $res;
+	// http://www.php.net/manual/en/function.mkdir.php
+	// saint at corenova.com
+	// bart at cdasites dot com
+	if (is_dir($target) || empty($target)) {
+		return true; // best case check first
+	}
+	if (file_exists($target) && !is_dir($target)) {
+		return false;
+	}
+	if (smart_admin_mkdir(substr($target, 0, strrpos($target, '/')))) {
+		if (!file_exists($target)) {
+			$res = mkdir($target, 0777); // crawl back up & create dir tree
+			smart_admin_chmod($target);
+
+			return $res;
+		}
+	}
+	$res = is_dir($target);
+
+	return $res;
 }
 
 /**
@@ -422,7 +422,7 @@ 
  */
 function smart_admin_chmod($target, $mode = 0777)
 {
-    return @ chmod($target, $mode);
+	return @ chmod($target, $mode);
 }
 
 /**
@@ -433,31 +433,31 @@ 
  */
 function smart_imageResize($src, $maxWidth, $maxHeight)
 {
-    $width  = '';
-    $height = '';
-    $type   = '';
-    $attr   = '';
-    if (file_exists($src)) {
-        list($width, $height, $type, $attr) = getimagesize($src);
-        if ($width > $maxWidth) {
-            $originalWidth = $width;
-            $width         = $maxWidth;
-            $height        = $width * $height / $originalWidth;
-        }
-        if ($height > $maxHeight) {
-            $originalHeight = $height;
-            $height         = $maxHeight;
-            $width          = $height * $width / $originalHeight;
-        }
-        $attr = " width='$width' height='$height'";
-    }
-
-    return array(
-        $width,
-        $height,
-        $type,
-        $attr
-    );
+	$width  = '';
+	$height = '';
+	$type   = '';
+	$attr   = '';
+	if (file_exists($src)) {
+		list($width, $height, $type, $attr) = getimagesize($src);
+		if ($width > $maxWidth) {
+			$originalWidth = $width;
+			$width         = $maxWidth;
+			$height        = $width * $height / $originalWidth;
+		}
+		if ($height > $maxHeight) {
+			$originalHeight = $height;
+			$height         = $maxHeight;
+			$width          = $height * $width / $originalHeight;
+		}
+		$attr = " width='$width' height='$height'";
+	}
+
+	return array(
+		$width,
+		$height,
+		$type,
+		$attr
+	);
 }
 
 /**
@@ -466,34 +466,34 @@ 
  */
 function smart_getModuleInfo($moduleName = false)
 {
-    static $smartModules;
-    if (isset($smartModules[$moduleName])) {
-        $ret =& $smartModules[$moduleName];
-
-        return $ret;
-    }
-    global $xoopsModule;
-    if (!$moduleName) {
-        if (isset($xoopsModule) && is_object($xoopsModule)) {
-            $smartModules[$xoopsModule->getVar('dirname')] = $xoopsModule;
-
-            return $smartModules[$xoopsModule->getVar('dirname')];
-        }
-    }
-    if (!isset($smartModules[$moduleName])) {
-        if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $moduleName) {
-            $smartModules[$moduleName] = $xoopsModule;
-        } else {
-            $hModule = xoops_getHandler('module');
-            if ($moduleName !== 'xoops') {
-                $smartModules[$moduleName] = $hModule->getByDirname($moduleName);
-            } else {
-                $smartModules[$moduleName] = $hModule->getByDirname('system');
-            }
-        }
-    }
-
-    return $smartModules[$moduleName];
+	static $smartModules;
+	if (isset($smartModules[$moduleName])) {
+		$ret =& $smartModules[$moduleName];
+
+		return $ret;
+	}
+	global $xoopsModule;
+	if (!$moduleName) {
+		if (isset($xoopsModule) && is_object($xoopsModule)) {
+			$smartModules[$xoopsModule->getVar('dirname')] = $xoopsModule;
+
+			return $smartModules[$xoopsModule->getVar('dirname')];
+		}
+	}
+	if (!isset($smartModules[$moduleName])) {
+		if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $moduleName) {
+			$smartModules[$moduleName] = $xoopsModule;
+		} else {
+			$hModule = xoops_getHandler('module');
+			if ($moduleName !== 'xoops') {
+				$smartModules[$moduleName] = $hModule->getByDirname($moduleName);
+			} else {
+				$smartModules[$moduleName] = $hModule->getByDirname('system');
+			}
+		}
+	}
+
+	return $smartModules[$moduleName];
 }
 
 /**
@@ -502,40 +502,40 @@ 
  */
 function smart_getModuleConfig($moduleName = false)
 {
-    static $smartConfigs;
-    if (isset($smartConfigs[$moduleName])) {
-        $ret =& $smartConfigs[$moduleName];
-
-        return $ret;
-    }
-    global $xoopsModule, $xoopsModuleConfig;
-    if (!$moduleName) {
-        if (isset($xoopsModule) && is_object($xoopsModule)) {
-            $smartConfigs[$xoopsModule->getVar('dirname')] = $xoopsModuleConfig;
-
-            return $smartConfigs[$xoopsModule->getVar('dirname')];
-        }
-    }
-    // if we still did not found the xoopsModule, this is because there is none
-    if (!$moduleName) {
-        $ret = false;
-
-        return $ret;
-    }
-    if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $moduleName) {
-        $smartConfigs[$moduleName] = $xoopsModuleConfig;
-    } else {
-        $module = smart_getModuleInfo($moduleName);
-        if (!is_object($module)) {
-            $ret = false;
-
-            return $ret;
-        }
-        $hModConfig                = xoops_getHandler('config');
-        $smartConfigs[$moduleName] =& $hModConfig->getConfigsByCat(0, $module->getVar('mid'));
-    }
-
-    return $smartConfigs[$moduleName];
+	static $smartConfigs;
+	if (isset($smartConfigs[$moduleName])) {
+		$ret =& $smartConfigs[$moduleName];
+
+		return $ret;
+	}
+	global $xoopsModule, $xoopsModuleConfig;
+	if (!$moduleName) {
+		if (isset($xoopsModule) && is_object($xoopsModule)) {
+			$smartConfigs[$xoopsModule->getVar('dirname')] = $xoopsModuleConfig;
+
+			return $smartConfigs[$xoopsModule->getVar('dirname')];
+		}
+	}
+	// if we still did not found the xoopsModule, this is because there is none
+	if (!$moduleName) {
+		$ret = false;
+
+		return $ret;
+	}
+	if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $moduleName) {
+		$smartConfigs[$moduleName] = $xoopsModuleConfig;
+	} else {
+		$module = smart_getModuleInfo($moduleName);
+		if (!is_object($module)) {
+			$ret = false;
+
+			return $ret;
+		}
+		$hModConfig                = xoops_getHandler('config');
+		$smartConfigs[$moduleName] =& $hModConfig->getConfigsByCat(0, $module->getVar('mid'));
+	}
+
+	return $smartConfigs[$moduleName];
 }
 
 /**
@@ -544,10 +544,10 @@ 
  */
 function smart_deleteFile($dirname)
 {
-    // Simple delete for a file
-    if (is_file($dirname)) {
-        return unlink($dirname);
-    }
+	// Simple delete for a file
+	if (is_file($dirname)) {
+		return unlink($dirname);
+	}
 }
 
 /**
@@ -556,12 +556,12 @@ 
  */
 function smart_formatErrors($errors = array())
 {
-    $ret = '';
-    foreach ($errors as $key => $value) {
-        $ret .= '<br> - ' . $value;
-    }
+	$ret = '';
+	foreach ($errors as $key => $value) {
+		$ret .= '<br> - ' . $value;
+	}
 
-    return $ret;
+	return $ret;
 }
 
 /**
@@ -575,64 +575,64 @@ 
  */
 function smart_getLinkedUnameFromId($userid = 0, $name = 0, $users = array(), $withContact = false)
 {
-    if (!is_numeric($userid)) {
-        return $userid;
-    }
-    $userid = (int)$userid;
-    if ($userid > 0) {
-        if ($users == array()) {
-            //fetching users
-            $memberHandler = xoops_getHandler('member');
-            $user          =& $memberHandler->getUser($userid);
-        } else {
-            if (!isset($users[$userid])) {
-                return $GLOBALS['xoopsConfig']['anonymous'];
-            }
-            $user =& $users[$userid];
-        }
-        if (is_object($user)) {
-            $ts        = MyTextSanitizer:: getInstance();
-            $username  = $user->getVar('uname');
-            $fullname  = '';
-            $fullname2 = $user->getVar('name');
-            if ($name && !empty($fullname2)) {
-                $fullname = $user->getVar('name');
-            }
-            if (!empty($fullname)) {
-                $linkeduser = "$fullname [<a href='" . XOOPS_URL . '/userinfo.php?uid=' . $userid . "'>" . $ts->htmlSpecialChars($username) . '</a>]';
-            } else {
-                $linkeduser = "<a href='" . XOOPS_URL . '/userinfo.php?uid=' . $userid . "'>" . ucwords($ts->htmlSpecialChars($username)) . '</a>';
-            }
-            // add contact info: email + PM
-            if ($withContact) {
-                $linkeduser .= ' <a href="mailto:' .
-                               $user->getVar('email') .
-                               '"><img style="vertical-align: middle;" src="' .
-                               XOOPS_URL .
-                               '/images/icons/email.gif' .
-                               '" alt="' .
-                               _CO_SOBJECT_SEND_EMAIL .
-                               '" title="' .
-                               _CO_SOBJECT_SEND_EMAIL .
-                               '"/></a>';
-                $js = "javascript:openWithSelfMain('" . XOOPS_URL . '/pmlite.php?send2=1&to_userid=' . $userid . "', 'pmlite',450,370);";
-                $linkeduser .= ' <a href="' .
-                               $js .
-                               '"><img style="vertical-align: middle;" src="' .
-                               XOOPS_URL .
-                               '/images/icons/pm.gif' .
-                               '" alt="' .
-                               _CO_SOBJECT_SEND_PM .
-                               '" title="' .
-                               _CO_SOBJECT_SEND_PM .
-                               '"/></a>';
-            }
-
-            return $linkeduser;
-        }
-    }
-
-    return $GLOBALS['xoopsConfig']['anonymous'];
+	if (!is_numeric($userid)) {
+		return $userid;
+	}
+	$userid = (int)$userid;
+	if ($userid > 0) {
+		if ($users == array()) {
+			//fetching users
+			$memberHandler = xoops_getHandler('member');
+			$user          =& $memberHandler->getUser($userid);
+		} else {
+			if (!isset($users[$userid])) {
+				return $GLOBALS['xoopsConfig']['anonymous'];
+			}
+			$user =& $users[$userid];
+		}
+		if (is_object($user)) {
+			$ts        = MyTextSanitizer:: getInstance();
+			$username  = $user->getVar('uname');
+			$fullname  = '';
+			$fullname2 = $user->getVar('name');
+			if ($name && !empty($fullname2)) {
+				$fullname = $user->getVar('name');
+			}
+			if (!empty($fullname)) {
+				$linkeduser = "$fullname [<a href='" . XOOPS_URL . '/userinfo.php?uid=' . $userid . "'>" . $ts->htmlSpecialChars($username) . '</a>]';
+			} else {
+				$linkeduser = "<a href='" . XOOPS_URL . '/userinfo.php?uid=' . $userid . "'>" . ucwords($ts->htmlSpecialChars($username)) . '</a>';
+			}
+			// add contact info: email + PM
+			if ($withContact) {
+				$linkeduser .= ' <a href="mailto:' .
+							   $user->getVar('email') .
+							   '"><img style="vertical-align: middle;" src="' .
+							   XOOPS_URL .
+							   '/images/icons/email.gif' .
+							   '" alt="' .
+							   _CO_SOBJECT_SEND_EMAIL .
+							   '" title="' .
+							   _CO_SOBJECT_SEND_EMAIL .
+							   '"/></a>';
+				$js = "javascript:openWithSelfMain('" . XOOPS_URL . '/pmlite.php?send2=1&to_userid=' . $userid . "', 'pmlite',450,370);";
+				$linkeduser .= ' <a href="' .
+							   $js .
+							   '"><img style="vertical-align: middle;" src="' .
+							   XOOPS_URL .
+							   '/images/icons/pm.gif' .
+							   '" alt="' .
+							   _CO_SOBJECT_SEND_PM .
+							   '" title="' .
+							   _CO_SOBJECT_SEND_PM .
+							   '"/></a>';
+			}
+
+			return $linkeduser;
+		}
+	}
+
+	return $GLOBALS['xoopsConfig']['anonymous'];
 }
 
 /**
@@ -643,33 +643,33 @@ 
  */
 function smart_adminMenu($currentoption = 0, $breadcrumb = '', $submenus = false, $currentsub = -1)
 {
-    global $xoopsModule, $xoopsConfig;
-    include_once XOOPS_ROOT_PATH . '/class/template.php';
-    if (file_exists(XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php')) {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php';
-    } else {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/modinfo.php';
-    }
-    if (file_exists(XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php')) {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php';
-    } else {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/admin.php';
-    }
-    $headermenu = array();
-    $adminmenu  = array();
-    include XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/admin/menu.php';
-    $tpl = new XoopsTpl();
-    $tpl->assign(array(
-                     'headermenu'      => $headermenu,
-                     'adminmenu'       => $adminmenu,
-                     'current'         => $currentoption,
-                     'breadcrumb'      => $breadcrumb,
-                     'headermenucount' => count($headermenu),
-                     'submenus'        => $submenus,
-                     'currentsub'      => $currentsub,
-                     'submenuscount'   => count($submenus)
-                 ));
-    $tpl->display('db:smartobject_admin_menu.tpl');
+	global $xoopsModule, $xoopsConfig;
+	include_once XOOPS_ROOT_PATH . '/class/template.php';
+	if (file_exists(XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php')) {
+		include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php';
+	} else {
+		include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/modinfo.php';
+	}
+	if (file_exists(XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php')) {
+		include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php';
+	} else {
+		include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/admin.php';
+	}
+	$headermenu = array();
+	$adminmenu  = array();
+	include XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/admin/menu.php';
+	$tpl = new XoopsTpl();
+	$tpl->assign(array(
+					 'headermenu'      => $headermenu,
+					 'adminmenu'       => $adminmenu,
+					 'current'         => $currentoption,
+					 'breadcrumb'      => $breadcrumb,
+					 'headermenucount' => count($headermenu),
+					 'submenus'        => $submenus,
+					 'currentsub'      => $currentsub,
+					 'submenuscount'   => count($submenus)
+				 ));
+	$tpl->display('db:smartobject_admin_menu.tpl');
 }
 
 /**
@@ -679,13 +679,13 @@ 
  */
 function smart_collapsableBar($id = '', $title = '', $dsc = '')
 {
-    global $xoopsModule;
-    echo "<h3 style=\"color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; \"><a href='javascript:;' onclick=\"togglecollapse('" . $id . "'); toggleIcon('" . $id . "_icon')\";>";
-    echo "<img id='" . $id . "_icon' src=" . SMARTOBJECT_URL . "assets/images/close12.gif alt='' /></a>&nbsp;" . $title . '</h3>';
-    echo "<div id='" . $id . "'>";
-    if ($dsc !== '') {
-        echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">" . $dsc . '</span>';
-    }
+	global $xoopsModule;
+	echo "<h3 style=\"color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; \"><a href='javascript:;' onclick=\"togglecollapse('" . $id . "'); toggleIcon('" . $id . "_icon')\";>";
+	echo "<img id='" . $id . "_icon' src=" . SMARTOBJECT_URL . "assets/images/close12.gif alt='' /></a>&nbsp;" . $title . '</h3>';
+	echo "<div id='" . $id . "'>";
+	if ($dsc !== '') {
+		echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">" . $dsc . '</span>';
+	}
 }
 
 /**
@@ -695,15 +695,15 @@ 
  */
 function smart_ajaxCollapsableBar($id = '', $title = '', $dsc = '')
 {
-    global $xoopsModule;
-    $onClick = "ajaxtogglecollapse('$id')";
-    //$onClick = "togglecollapse('$id'); toggleIcon('" . $id . "_icon')";
-    echo '<h3 style="border: 1px solid; color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; " onclick="' . $onClick . '">';
-    echo "<img id='" . $id . "_icon' src=" . SMARTOBJECT_URL . "assets/images/close12.gif alt='' /></a>&nbsp;" . $title . '</h3>';
-    echo "<div id='" . $id . "'>";
-    if ($dsc !== '') {
-        echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">" . $dsc . '</span>';
-    }
+	global $xoopsModule;
+	$onClick = "ajaxtogglecollapse('$id')";
+	//$onClick = "togglecollapse('$id'); toggleIcon('" . $id . "_icon')";
+	echo '<h3 style="border: 1px solid; color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; " onclick="' . $onClick . '">';
+	echo "<img id='" . $id . "_icon' src=" . SMARTOBJECT_URL . "assets/images/close12.gif alt='' /></a>&nbsp;" . $title . '</h3>';
+	echo "<div id='" . $id . "'>";
+	if ($dsc !== '') {
+		echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">" . $dsc . '</span>';
+	}
 }
 
 /**
@@ -730,20 +730,20 @@ 
  */
 function smart_openclose_collapsable($name)
 {
-    $urls        = smart_getCurrentUrls();
-    $path        = $urls['phpself'];
-    $cookie_name = $path . '_smart_collaps_' . $name;
-    $cookie_name = str_replace('.', '_', $cookie_name);
-    $cookie      = smart_getCookieVar($cookie_name, '');
-    if ($cookie === 'none') {
-        echo '
+	$urls        = smart_getCurrentUrls();
+	$path        = $urls['phpself'];
+	$cookie_name = $path . '_smart_collaps_' . $name;
+	$cookie_name = str_replace('.', '_', $cookie_name);
+	$cookie      = smart_getCookieVar($cookie_name, '');
+	if ($cookie === 'none') {
+		echo '
                 <script type="text/javascript"><!--
                 togglecollapse("' . $name . '"); toggleIcon("' . $name . '_icon");
                     //-->
                 </script>
                 ';
-    }
-    /*  if ($cookie == 'none') {
+	}
+	/*  if ($cookie == 'none') {
      echo '
      <script type="text/javascript"><!--
      hideElement("' . $name . '");
@@ -759,9 +759,9 @@ 
  */
 function smart_close_collapsable($name)
 {
-    echo '</div>';
-    smart_openclose_collapsable($name);
-    echo '<br>';
+	echo '</div>';
+	smart_openclose_collapsable($name);
+	echo '<br>';
 }
 
 /**
@@ -771,11 +771,11 @@ 
  */
 function smart_setCookieVar($name, $value, $time = 0)
 {
-    if ($time == 0) {
-        $time = time() + 3600 * 24 * 365;
-        //$time = '';
-    }
-    setcookie($name, $value, $time, '/');
+	if ($time == 0) {
+		$time = time() + 3600 * 24 * 365;
+		//$time = '';
+	}
+	setcookie($name, $value, $time, '/');
 }
 
 /**
@@ -785,12 +785,12 @@ 
  */
 function smart_getCookieVar($name, $default = '')
 {
-    $name = str_replace('.', '_', $name);
-    if (isset($_COOKIE[$name]) && ($_COOKIE[$name] > '')) {
-        return $_COOKIE[$name];
-    } else {
-        return $default;
-    }
+	$name = str_replace('.', '_', $name);
+	if (isset($_COOKIE[$name]) && ($_COOKIE[$name] > '')) {
+		return $_COOKIE[$name];
+	} else {
+		return $default;
+	}
 }
 
 /**
@@ -798,25 +798,25 @@ 
  */
 function smart_getCurrentUrls()
 {
-    $urls        = array();
-    $http        = (strpos(XOOPS_URL, 'https://') === false) ? 'http://' : 'https://';
-    $phpself     = $_SERVER['PHP_SELF'];
-    $httphost    = $_SERVER['HTTP_HOST'];
-    $querystring = $_SERVER['QUERY_STRING'];
-    if ($querystring !== '') {
-        $querystring = '?' . $querystring;
-    }
-    $currenturl           = $http . $httphost . $phpself . $querystring;
-    $urls                 = array();
-    $urls['http']         = $http;
-    $urls['httphost']     = $httphost;
-    $urls['phpself']      = $phpself;
-    $urls['querystring']  = $querystring;
-    $urls['full_phpself'] = $http . $httphost . $phpself;
-    $urls['full']         = $currenturl;
-    $urls['isHomePage']   = (XOOPS_URL . '/index.php') == ($http . $httphost . $phpself);
-
-    return $urls;
+	$urls        = array();
+	$http        = (strpos(XOOPS_URL, 'https://') === false) ? 'http://' : 'https://';
+	$phpself     = $_SERVER['PHP_SELF'];
+	$httphost    = $_SERVER['HTTP_HOST'];
+	$querystring = $_SERVER['QUERY_STRING'];
+	if ($querystring !== '') {
+		$querystring = '?' . $querystring;
+	}
+	$currenturl           = $http . $httphost . $phpself . $querystring;
+	$urls                 = array();
+	$urls['http']         = $http;
+	$urls['httphost']     = $httphost;
+	$urls['phpself']      = $phpself;
+	$urls['querystring']  = $querystring;
+	$urls['full_phpself'] = $http . $httphost . $phpself;
+	$urls['full']         = $currenturl;
+	$urls['isHomePage']   = (XOOPS_URL . '/index.php') == ($http . $httphost . $phpself);
+
+	return $urls;
 }
 
 /**
@@ -824,9 +824,9 @@ 
  */
 function smart_getCurrentPage()
 {
-    $urls = smart_getCurrentUrls();
+	$urls = smart_getCurrentUrls();
 
-    return $urls['full'];
+	return $urls['full'];
 }
 
 /**
@@ -889,39 +889,39 @@ 
  */
 function smart_modFooter()
 {
-    global $xoopsConfig, $xoopsModule, $xoopsModuleConfig;
-
-    include_once XOOPS_ROOT_PATH . '/class/template.php';
-    $tpl = new XoopsTpl();
-
-    $hModule      = xoops_getHandler('module');
-    $versioninfo  =& $hModule->get($xoopsModule->getVar('mid'));
-    $modfootertxt = 'Module ' . $versioninfo->getInfo('name') . ' - Version ' . $versioninfo->getInfo('version') . '';
-    $modfooter    = "<a href='" .
-                    $versioninfo->getInfo('support_site_url') .
-                    "' target='_blank'><img src='" .
-                    XOOPS_URL .
-                    '/modules/' .
-                    $xoopsModule->getVar('dirname') .
-                    "/assets/images/cssbutton.gif' title='" .
-                    $modfootertxt .
-                    "' alt='" .
-                    $modfootertxt .
-                    "'/></a>";
-    $tpl->assign('modfooter', $modfooter);
-
-    if (!defined('_AM_SOBJECT_XOOPS_PRO')) {
-        define('_AM_SOBJECT_XOOPS_PRO', 'Do you need help with this module ?<br>Do you need new features not yet available?');
-    }
-    $smartobjectConfig = smart_getModuleConfig('smartobject');
-    $tpl->assign('smartobject_enable_admin_footer', $smartobjectConfig['enable_admin_footer']);
-    $tpl->display(SMARTOBJECT_ROOT_PATH . 'templates/smartobject_admin_footer.html');
+	global $xoopsConfig, $xoopsModule, $xoopsModuleConfig;
+
+	include_once XOOPS_ROOT_PATH . '/class/template.php';
+	$tpl = new XoopsTpl();
+
+	$hModule      = xoops_getHandler('module');
+	$versioninfo  =& $hModule->get($xoopsModule->getVar('mid'));
+	$modfootertxt = 'Module ' . $versioninfo->getInfo('name') . ' - Version ' . $versioninfo->getInfo('version') . '';
+	$modfooter    = "<a href='" .
+					$versioninfo->getInfo('support_site_url') .
+					"' target='_blank'><img src='" .
+					XOOPS_URL .
+					'/modules/' .
+					$xoopsModule->getVar('dirname') .
+					"/assets/images/cssbutton.gif' title='" .
+					$modfootertxt .
+					"' alt='" .
+					$modfootertxt .
+					"'/></a>";
+	$tpl->assign('modfooter', $modfooter);
+
+	if (!defined('_AM_SOBJECT_XOOPS_PRO')) {
+		define('_AM_SOBJECT_XOOPS_PRO', 'Do you need help with this module ?<br>Do you need new features not yet available?');
+	}
+	$smartobjectConfig = smart_getModuleConfig('smartobject');
+	$tpl->assign('smartobject_enable_admin_footer', $smartobjectConfig['enable_admin_footer']);
+	$tpl->display(SMARTOBJECT_ROOT_PATH . 'templates/smartobject_admin_footer.html');
 }
 
 function smart_xoops_cp_footer()
 {
-    smart_modFooter();
-    xoops_cp_footer();
+	smart_modFooter();
+	xoops_cp_footer();
 }
 
 /**
@@ -930,11 +930,11 @@ 
  */
 function smart_sanitizeForCommonTags($text)
 {
-    global $xoopsConfig;
-    $text = str_replace('{X_SITENAME}', $xoopsConfig['sitename'], $text);
-    $text = str_replace('{X_ADMINMAIL}', $xoopsConfig['adminmail'], $text);
+	global $xoopsConfig;
+	$text = str_replace('{X_SITENAME}', $xoopsConfig['sitename'], $text);
+	$text = str_replace('{X_ADMINMAIL}', $xoopsConfig['adminmail'], $text);
 
-    return $text;
+	return $text;
 }
 
 /**
@@ -942,7 +942,7 @@ 
  */
 function smart_addScript($src)
 {
-    echo '<script src="' . $src . '" type="text/javascript"></script>';
+	echo '<script src="' . $src . '" type="text/javascript"></script>';
 }
 
 /**
@@ -950,17 +950,17 @@ 
  */
 function smart_addStyle($src)
 {
-    if ($src === 'smartobject') {
-        $src = SMARTOBJECT_URL . 'assets/css/module.css';
-    }
-    echo smart_get_css_link($src);
+	if ($src === 'smartobject') {
+		$src = SMARTOBJECT_URL . 'assets/css/module.css';
+	}
+	echo smart_get_css_link($src);
 }
 
 function smart_addAdminAjaxSupport()
 {
-    smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/lib/prototype.js');
-    smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/src/scriptaculous.js');
-    smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/src/smart.js');
+	smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/lib/prototype.js');
+	smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/src/scriptaculous.js');
+	smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/src/smart.js');
 }
 
 /**
@@ -969,11 +969,11 @@ 
  */
 function smart_sanitizeForSmartpopupLink($text)
 {
-    $patterns[]     = "/\[smartpopup=(['\"]?)([^\"'<>]*)\\1](.*)\[\/smartpopup\]/sU";
-    $replacements[] = "<a href=\"javascript:openWithSelfMain('\\2', 'smartpopup', 700, 519);\">\\3</a>";
-    $ret            = preg_replace($patterns, $replacements, $text);
+	$patterns[]     = "/\[smartpopup=(['\"]?)([^\"'<>]*)\\1](.*)\[\/smartpopup\]/sU";
+	$replacements[] = "<a href=\"javascript:openWithSelfMain('\\2', 'smartpopup', 700, 519);\">\\3</a>";
+	$ret            = preg_replace($patterns, $replacements, $text);
 
-    return $ret;
+	return $ret;
 }
 
 /**
@@ -988,25 +988,25 @@ 
  */
 function smart_getImageSize($url, & $width, & $height)
 {
-    if (empty($width) || empty($height)) {
-        if (!$dimension = @ getimagesize($url)) {
-            return false;
-        }
-        if (!empty($width)) {
-            $height = $dimension[1] * $width / $dimension[0];
-        } elseif (!empty($height)) {
-            $width = $dimension[0] * $height / $dimension[1];
-        } else {
-            list($width, $height) = array(
-                $dimension[0],
-                $dimension[1]
-            );
-        }
-
-        return true;
-    } else {
-        return true;
-    }
+	if (empty($width) || empty($height)) {
+		if (!$dimension = @ getimagesize($url)) {
+			return false;
+		}
+		if (!empty($width)) {
+			$height = $dimension[1] * $width / $dimension[0];
+		} elseif (!empty($height)) {
+			$width = $dimension[0] * $height / $dimension[1];
+		} else {
+			list($width, $height) = array(
+				$dimension[0],
+				$dimension[1]
+			);
+		}
+
+		return true;
+	} else {
+		return true;
+	}
 }
 
 /**
@@ -1019,8 +1019,8 @@ 
  */
 function smart_htmlnumericentities($str)
 {
-    //    return preg_replace('/[^!-%\x27-;=?-~ ]/e', '"&#".ord("$0").chr(59)', $str);
-    return preg_replace_callback('/[^!-%\x27-;=?-~ ]/', function ($m) { return '&#' . ord($m[0]) . chr(59); }, $str);
+	//    return preg_replace('/[^!-%\x27-;=?-~ ]/e', '"&#".ord("$0").chr(59)', $str);
+	return preg_replace_callback('/[^!-%\x27-;=?-~ ]/', function ($m) { return '&#' . ord($m[0]) . chr(59); }, $str);
 }
 
 /**
@@ -1030,24 +1030,24 @@ 
  */
 function smart_getcorehandler($name, $optional = false)
 {
-    static $handlers;
-    $name = strtolower(trim($name));
-    if (!isset($handlers[$name])) {
-        if (file_exists($hnd_file = XOOPS_ROOT_PATH . '/kernel/' . $name . '.php')) {
-            require_once $hnd_file;
-        }
-        $class = 'Xoops' . ucfirst($name) . 'Handler';
-        if (class_exists($class)) {
-            $handlers[$name] = new $class ($GLOBALS['xoopsDB'], 'xoops');
-        }
-    }
-    if (!isset($handlers[$name]) && !$optional) {
-        trigger_error('Class <b>' . $class . '</b> does not exist<br>Handler Name: ' . $name, E_USER_ERROR);
-    }
-    if (isset($handlers[$name])) {
-        return $handlers[$name];
-    }
-    $inst = false;
+	static $handlers;
+	$name = strtolower(trim($name));
+	if (!isset($handlers[$name])) {
+		if (file_exists($hnd_file = XOOPS_ROOT_PATH . '/kernel/' . $name . '.php')) {
+			require_once $hnd_file;
+		}
+		$class = 'Xoops' . ucfirst($name) . 'Handler';
+		if (class_exists($class)) {
+			$handlers[$name] = new $class ($GLOBALS['xoopsDB'], 'xoops');
+		}
+	}
+	if (!isset($handlers[$name]) && !$optional) {
+		trigger_error('Class <b>' . $class . '</b> does not exist<br>Handler Name: ' . $name, E_USER_ERROR);
+	}
+	if (isset($handlers[$name])) {
+		return $handlers[$name];
+	}
+	$inst = false;
 }
 
 /**
@@ -1056,15 +1056,15 @@ 
  */
 function smart_sanitizeAdsenses_callback($matches)
 {
-    global $smartobjectAdsenseHandler;
-    if (isset($smartobjectAdsenseHandler->objects[$matches[1]])) {
-        $adsenseObj = $smartobjectAdsenseHandler->objects[$matches[1]];
-        $ret        = $adsenseObj->render();
-
-        return $ret;
-    } else {
-        return '';
-    }
+	global $smartobjectAdsenseHandler;
+	if (isset($smartobjectAdsenseHandler->objects[$matches[1]])) {
+		$adsenseObj = $smartobjectAdsenseHandler->objects[$matches[1]];
+		$ret        = $adsenseObj->render();
+
+		return $ret;
+	} else {
+		return '';
+	}
 }
 
 /**
@@ -1073,13 +1073,13 @@ 
  */
 function smart_sanitizeAdsenses($text)
 {
-    $patterns     = array();
-    $replacements = array();
+	$patterns     = array();
+	$replacements = array();
 
-    $patterns[] = "/\[adsense](.*)\[\/adsense\]/sU";
-    $text       = preg_replace_callback($patterns, 'smart_sanitizeAdsenses_callback', $text);
+	$patterns[] = "/\[adsense](.*)\[\/adsense\]/sU";
+	$text       = preg_replace_callback($patterns, 'smart_sanitizeAdsenses_callback', $text);
 
-    return $text;
+	return $text;
 }
 
 /**
@@ -1088,15 +1088,15 @@ 
  */
 function smart_sanitizeCustomtags_callback($matches)
 {
-    global $smartobjectCustomtagHandler;
-    if (isset($smartobjectCustomtagHandler->objects[$matches[1]])) {
-        $customObj = $smartobjectCustomtagHandler->objects[$matches[1]];
-        $ret       = $customObj->renderWithPhp();
-
-        return $ret;
-    } else {
-        return '';
-    }
+	global $smartobjectCustomtagHandler;
+	if (isset($smartobjectCustomtagHandler->objects[$matches[1]])) {
+		$customObj = $smartobjectCustomtagHandler->objects[$matches[1]];
+		$ret       = $customObj->renderWithPhp();
+
+		return $ret;
+	} else {
+		return '';
+	}
 }
 
 /**
@@ -1105,13 +1105,13 @@ 
  */
 function smart_sanitizeCustomtags($text)
 {
-    $patterns     = array();
-    $replacements = array();
+	$patterns     = array();
+	$replacements = array();
 
-    $patterns[] = "/\[customtag](.*)\[\/customtag\]/sU";
-    $text       = preg_replace_callback($patterns, 'smart_sanitizeCustomtags_callback', $text);
+	$patterns[] = "/\[customtag](.*)\[\/customtag\]/sU";
+	$text       = preg_replace_callback($patterns, 'smart_sanitizeCustomtags_callback', $text);
 
-    return $text;
+	return $text;
 }
 
 /**
@@ -1120,20 +1120,20 @@ 
  */
 function smart_loadLanguageFile($module, $file)
 {
-    global $xoopsConfig;
-
-    $filename = XOOPS_ROOT_PATH . '/modules/' . $module . '/language/' . $xoopsConfig['language'] . '/' . $file . '.php';
-    if (!file_exists($filename)) {
-        $filename = XOOPS_ROOT_PATH . '/modules/' . $module . '/language/english/' . $file . '.php';
-    }
-    if (file_exists($filename)) {
-        include_once($filename);
-    }
+	global $xoopsConfig;
+
+	$filename = XOOPS_ROOT_PATH . '/modules/' . $module . '/language/' . $xoopsConfig['language'] . '/' . $file . '.php';
+	if (!file_exists($filename)) {
+		$filename = XOOPS_ROOT_PATH . '/modules/' . $module . '/language/english/' . $file . '.php';
+	}
+	if (file_exists($filename)) {
+		include_once($filename);
+	}
 }
 
 function smart_loadCommonLanguageFile()
 {
-    smart_loadLanguageFile('smartobject', 'common');
+	smart_loadLanguageFile('smartobject', 'common');
 }
 
 /**
@@ -1143,35 +1143,35 @@ 
  */
 function smart_purifyText($text, $keyword = false)
 {
-    global $myts;
-    $text = str_replace('&nbsp;', ' ', $text);
-    $text = str_replace('<br>', ' ', $text);
-    $text = str_replace('<br>', ' ', $text);
-    $text = str_replace('<br', ' ', $text);
-    $text = strip_tags($text);
-    $text = html_entity_decode($text);
-    $text = $myts->undoHtmlSpecialChars($text);
-    $text = str_replace(')', ' ', $text);
-    $text = str_replace('(', ' ', $text);
-    $text = str_replace(':', ' ', $text);
-    $text = str_replace('&euro', ' euro ', $text);
-    $text = str_replace('&hellip', '...', $text);
-    $text = str_replace('&rsquo', ' ', $text);
-    $text = str_replace('!', ' ', $text);
-    $text = str_replace('?', ' ', $text);
-    $text = str_replace('"', ' ', $text);
-    $text = str_replace('-', ' ', $text);
-    $text = str_replace('\n', ' ', $text);
-    $text = str_replace('&#8213;', ' ', $text);
-
-    if ($keyword) {
-        $text = str_replace('.', ' ', $text);
-        $text = str_replace(',', ' ', $text);
-        $text = str_replace('\'', ' ', $text);
-    }
-    $text = str_replace(';', ' ', $text);
-
-    return $text;
+	global $myts;
+	$text = str_replace('&nbsp;', ' ', $text);
+	$text = str_replace('<br>', ' ', $text);
+	$text = str_replace('<br>', ' ', $text);
+	$text = str_replace('<br', ' ', $text);
+	$text = strip_tags($text);
+	$text = html_entity_decode($text);
+	$text = $myts->undoHtmlSpecialChars($text);
+	$text = str_replace(')', ' ', $text);
+	$text = str_replace('(', ' ', $text);
+	$text = str_replace(':', ' ', $text);
+	$text = str_replace('&euro', ' euro ', $text);
+	$text = str_replace('&hellip', '...', $text);
+	$text = str_replace('&rsquo', ' ', $text);
+	$text = str_replace('!', ' ', $text);
+	$text = str_replace('?', ' ', $text);
+	$text = str_replace('"', ' ', $text);
+	$text = str_replace('-', ' ', $text);
+	$text = str_replace('\n', ' ', $text);
+	$text = str_replace('&#8213;', ' ', $text);
+
+	if ($keyword) {
+		$text = str_replace('.', ' ', $text);
+		$text = str_replace(',', ' ', $text);
+		$text = str_replace('\'', ' ', $text);
+	}
+	$text = str_replace(';', ' ', $text);
+
+	return $text;
 }
 
 /**
@@ -1180,49 +1180,49 @@ 
  */
 function smart_html2text($document)
 {
-    // PHP Manual:: function preg_replace
-    // $document should contain an HTML document.
-    // This will remove HTML tags, javascript sections
-    // and white space. It will also convert some
-    // common HTML entities to their text equivalent.
-    // Credits: newbb2
-    $search = array(
-        "'<script[^>]*?>.*?</script>'si",  // Strip out javascript
-        "'<img.*?/>'si",       // Strip out img tags
-        "'<[\/\!]*?[^<>]*?>'si",          // Strip out HTML tags
-        "'([\r\n])[\s]+'",                // Strip out white space
-        "'&(quot|#34);'i",                // Replace HTML entities
-        "'&(amp|#38);'i",
-        "'&(lt|#60);'i",
-        "'&(gt|#62);'i",
-        "'&(nbsp|#160);'i",
-        "'&(iexcl|#161);'i",
-        "'&(cent|#162);'i",
-        "'&(pound|#163);'i",
-        "'&(copy|#169);'i",
-        "'&#(\d+);'e"
-    );                    // evaluate as php
-
-    $replace = array(
-        '',
-        '',
-        '',
-        "\\1",
-        "\"",
-        '&',
-        '<',
-        '>',
-        ' ',
-        chr(161),
-        chr(162),
-        chr(163),
-        chr(169),
-        "chr(\\1)"
-    );
-
-    $text = preg_replace($search, $replace, $document);
-
-    return $text;
+	// PHP Manual:: function preg_replace
+	// $document should contain an HTML document.
+	// This will remove HTML tags, javascript sections
+	// and white space. It will also convert some
+	// common HTML entities to their text equivalent.
+	// Credits: newbb2
+	$search = array(
+		"'<script[^>]*?>.*?</script>'si",  // Strip out javascript
+		"'<img.*?/>'si",       // Strip out img tags
+		"'<[\/\!]*?[^<>]*?>'si",          // Strip out HTML tags
+		"'([\r\n])[\s]+'",                // Strip out white space
+		"'&(quot|#34);'i",                // Replace HTML entities
+		"'&(amp|#38);'i",
+		"'&(lt|#60);'i",
+		"'&(gt|#62);'i",
+		"'&(nbsp|#160);'i",
+		"'&(iexcl|#161);'i",
+		"'&(cent|#162);'i",
+		"'&(pound|#163);'i",
+		"'&(copy|#169);'i",
+		"'&#(\d+);'e"
+	);                    // evaluate as php
+
+	$replace = array(
+		'',
+		'',
+		'',
+		"\\1",
+		"\"",
+		'&',
+		'<',
+		'>',
+		' ',
+		chr(161),
+		chr(162),
+		chr(163),
+		chr(169),
+		"chr(\\1)"
+	);
+
+	$text = preg_replace($search, $replace, $document);
+
+	return $text;
 }
 
 /**
@@ -1236,32 +1236,32 @@ 
  */
 function smart_getfloat($str, $set = false)
 {
-    if (preg_match("/([0-9\.,-]+)/", $str, $match)) {
-        // Found number in $str, so set $str that number
-        $str = $match[0];
-        if (false !== strpos($str, ',')) {
-            // A comma exists, that makes it easy, cos we assume it separates the decimal part.
-            $str = str_replace('.', '', $str);    // Erase thousand seps
-            $str = str_replace(',', '.', $str);    // Convert , to . for floatval command
-
-            return (float)$str;
-        } else {
-            // No comma exists, so we have to decide, how a single dot shall be treated
-            if (preg_match("/^[0-9\-]*[\.]{1}[0-9-]+$/", $str) == true && $set['single_dot_as_decimal'] == true) {
-                // Treat single dot as decimal separator
-                return (float)$str;
-            } else {
-                //echo "str: ".$str; echo "ret: ".str_replace('.', '', $str); echo "<br><br> ";
-                // Else, treat all dots as thousand seps
-                $str = str_replace('.', '', $str);    // Erase thousand seps
-
-                return (float)$str;
-            }
-        }
-    } else {
-        // No number found, return zero
-        return 0;
-    }
+	if (preg_match("/([0-9\.,-]+)/", $str, $match)) {
+		// Found number in $str, so set $str that number
+		$str = $match[0];
+		if (false !== strpos($str, ',')) {
+			// A comma exists, that makes it easy, cos we assume it separates the decimal part.
+			$str = str_replace('.', '', $str);    // Erase thousand seps
+			$str = str_replace(',', '.', $str);    // Convert , to . for floatval command
+
+			return (float)$str;
+		} else {
+			// No comma exists, so we have to decide, how a single dot shall be treated
+			if (preg_match("/^[0-9\-]*[\.]{1}[0-9-]+$/", $str) == true && $set['single_dot_as_decimal'] == true) {
+				// Treat single dot as decimal separator
+				return (float)$str;
+			} else {
+				//echo "str: ".$str; echo "ret: ".str_replace('.', '', $str); echo "<br><br> ";
+				// Else, treat all dots as thousand seps
+				$str = str_replace('.', '', $str);    // Erase thousand seps
+
+				return (float)$str;
+			}
+		}
+	} else {
+		// No number found, return zero
+		return 0;
+	}
 }
 
 /**
@@ -1271,26 +1271,26 @@ 
  */
 function smart_currency($var, $currencyObj = false)
 {
-    $ret = smart_getfloat($var, array('single_dot_as_decimal' => true));
-    $ret = round($ret, 2);
-    // make sur we have at least .00 in the $var
-    $decimal_section_original = strstr($ret, '.');
-    $decimal_section          = $decimal_section_original;
-    if ($decimal_section) {
-        if (strlen($decimal_section) == 1) {
-            $decimal_section = '.00';
-        } elseif (strlen($decimal_section) == 2) {
-            $decimal_section .= '0';
-        }
-        $ret = str_replace($decimal_section_original, $decimal_section, $ret);
-    } else {
-        $ret .= '.00';
-    }
-    if ($currencyObj) {
-        $ret = $ret . ' ' . $currencyObj->getCode();
-    }
-
-    return $ret;
+	$ret = smart_getfloat($var, array('single_dot_as_decimal' => true));
+	$ret = round($ret, 2);
+	// make sur we have at least .00 in the $var
+	$decimal_section_original = strstr($ret, '.');
+	$decimal_section          = $decimal_section_original;
+	if ($decimal_section) {
+		if (strlen($decimal_section) == 1) {
+			$decimal_section = '.00';
+		} elseif (strlen($decimal_section) == 2) {
+			$decimal_section .= '0';
+		}
+		$ret = str_replace($decimal_section_original, $decimal_section, $ret);
+	} else {
+		$ret .= '.00';
+	}
+	if ($currencyObj) {
+		$ret = $ret . ' ' . $currencyObj->getCode();
+	}
+
+	return $ret;
 }
 
 /**
@@ -1299,7 +1299,7 @@ 
  */
 function smart_float($var)
 {
-    return smart_currency($var);
+	return smart_currency($var);
 }
 
 /**
@@ -1308,16 +1308,16 @@ 
  */
 function smart_getModuleAdminLink($moduleName = false)
 {
-    global $xoopsModule;
-    if (!$moduleName && (isset($xoopsModule) && is_object($xoopsModule))) {
-        $moduleName = $xoopsModule->getVar('dirname');
-    }
-    $ret = '';
-    if ($moduleName) {
-        $ret = "<a href='" . XOOPS_URL . "/modules/$moduleName/admin/index.php'>" . _CO_SOBJECT_ADMIN_PAGE . '</a>';
-    }
-
-    return $ret;
+	global $xoopsModule;
+	if (!$moduleName && (isset($xoopsModule) && is_object($xoopsModule))) {
+		$moduleName = $xoopsModule->getVar('dirname');
+	}
+	$ret = '';
+	if ($moduleName) {
+		$ret = "<a href='" . XOOPS_URL . "/modules/$moduleName/admin/index.php'>" . _CO_SOBJECT_ADMIN_PAGE . '</a>';
+	}
+
+	return $ret;
 }
 
 /**
@@ -1325,19 +1325,19 @@ 
  */
 function smart_getEditors()
 {
-    $filename = XOOPS_ROOT_PATH . '/class/xoopseditor/xoopseditor.php';
-    if (!file_exists($filename)) {
-        return false;
-    }
-    include_once $filename;
-    $xoopseditorHandler = XoopsEditorHandler::getInstance();
-    $aList              = $xoopseditorHandler->getList();
-    $ret                = array();
-    foreach ($aList as $k => $v) {
-        $ret[$v] = $k;
-    }
-
-    return $ret;
+	$filename = XOOPS_ROOT_PATH . '/class/xoopseditor/xoopseditor.php';
+	if (!file_exists($filename)) {
+		return false;
+	}
+	include_once $filename;
+	$xoopseditorHandler = XoopsEditorHandler::getInstance();
+	$aList              = $xoopseditorHandler->getList();
+	$ret                = array();
+	foreach ($aList as $k => $v) {
+		$ret[$v] = $k;
+	}
+
+	return $ret;
 }
 
 /**
@@ -1347,11 +1347,11 @@ 
  */
 function smart_getTablesArray($moduleName, $items)
 {
-    $ret = array();
-    foreach ($items as $item) {
-        $ret[] = $moduleName . '_' . $item;
-    }
-    $ret[] = $moduleName . '_meta';
+	$ret = array();
+	foreach ($items as $item) {
+		$ret[] = $moduleName . '_' . $item;
+	}
+	$ret[] = $moduleName . '_meta';
 
-    return $ret;
+	return $ret;
 }

Spacing +106 added lines, -106 removed lines

@@ -11,7 +11,7 @@ 
 
 function smart_get_css_link($cssfile)
 {
-    $ret = '<link rel="stylesheet" type="text/css" href="' . $cssfile . '" />';
+    $ret = '<link rel="stylesheet" type="text/css" href="'.$cssfile.'" />';
 
     return $ret;
 }
@@ -100,14 +100,14 @@ 
         $seoMode = smart_getModuleModeSEO($moduleName);
         if ($seoMode === 'rewrite') {
             $seoModuleName = smart_getModuleNameForSEO($moduleName);
-            $ret           = XOOPS_URL . '/' . $seoModuleName . '/';
+            $ret           = XOOPS_URL.'/'.$seoModuleName.'/';
         } elseif ($seoMode === 'pathinfo') {
-            $ret = XOOPS_URL . '/modules/' . $moduleName . '/seo.php/' . $seoModuleName . '/';
+            $ret = XOOPS_URL.'/modules/'.$moduleName.'/seo.php/'.$seoModuleName.'/';
         } else {
-            $ret = XOOPS_URL . '/modules/' . $moduleName . '/';
+            $ret = XOOPS_URL.'/modules/'.$moduleName.'/';
         }
 
-        return '<a href="' . $ret . '">' . $smartModule->getVar('name') . '</a>';
+        return '<a href="'.$ret.'">'.$smartModule->getVar('name').'</a>';
     }
 }
 
@@ -170,11 +170,11 @@ 
     /**
      * include SmartObject admin language file
      */
-    $fileName = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php';
+    $fileName = XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/'.$xoopsConfig['language'].'/admin.php';
     if (file_exists($fileName)) {
         include_once $fileName;
     } else {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/admin.php';
+        include_once XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/english/admin.php';
     }
     ?>
     <script type='text/javascript'>
@@ -192,9 +192,9 @@ 
     /**
      * Include the admin language constants for the SmartObject Framework
      */
-    $admin_file = SMARTOBJECT_ROOT_PATH . 'language/' . $xoopsConfig['language'] . '/admin.php';
+    $admin_file = SMARTOBJECT_ROOT_PATH.'language/'.$xoopsConfig['language'].'/admin.php';
     if (!file_exists($admin_file)) {
-        $admin_file = SMARTOBJECT_ROOT_PATH . 'language/english/admin.php';
+        $admin_file = SMARTOBJECT_ROOT_PATH.'language/english/admin.php';
     }
     include_once($admin_file);
 }
@@ -214,7 +214,7 @@ 
     //Verifies that a MySQL table exists
     $xoopsDB  = XoopsDatabaseFactory::getDatabaseConnection();
     $realname = $xoopsDB->prefix($table);
-    $sql      = 'SHOW TABLES FROM ' . XOOPS_DB_NAME;
+    $sql      = 'SHOW TABLES FROM '.XOOPS_DB_NAME;
     $ret      = $xoopsDB->queryF($sql);
     while (list($m_table) = $xoopsDB->fetchRow($ret)) {
         if ($m_table == $realname) {
@@ -243,7 +243,7 @@ 
         $moduleName = smart_getCurrentModuleName();
     }
     $xoopsDB = XoopsDatabaseFactory::getDatabaseConnection();
-    $sql     = sprintf('SELECT metavalue FROM %s WHERE metakey=%s', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($key));
+    $sql     = sprintf('SELECT metavalue FROM %s WHERE metakey=%s', $xoopsDB->prefix($moduleName.'_meta'), $xoopsDB->quoteString($key));
     $ret     = $xoopsDB->query($sql);
     if (!$ret) {
         $value = false;
@@ -286,9 +286,9 @@ 
     $xoopsDB = XoopsDatabaseFactory::getDatabaseConnection();
     $ret     = smart_GetMeta($key, $moduleName);
     if ($ret === '0' || $ret > 0) {
-        $sql = sprintf('UPDATE %s SET metavalue = %s WHERE metakey = %s', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($value), $xoopsDB->quoteString($key));
+        $sql = sprintf('UPDATE %s SET metavalue = %s WHERE metakey = %s', $xoopsDB->prefix($moduleName.'_meta'), $xoopsDB->quoteString($value), $xoopsDB->quoteString($key));
     } else {
-        $sql = sprintf('INSERT INTO %s (metakey, metavalue) VALUES (%s, %s)', $xoopsDB->prefix($moduleName . '_meta'), $xoopsDB->quoteString($key), $xoopsDB->quoteString($value));
+        $sql = sprintf('INSERT INTO %s (metakey, metavalue) VALUES (%s, %s)', $xoopsDB->prefix($moduleName.'_meta'), $xoopsDB->quoteString($key), $xoopsDB->quoteString($value));
     }
     $ret = $xoopsDB->queryF($sql);
     if (!$ret) {
@@ -468,7 +468,7 @@ 
 {
     static $smartModules;
     if (isset($smartModules[$moduleName])) {
-        $ret =& $smartModules[$moduleName];
+        $ret = & $smartModules[$moduleName];
 
         return $ret;
     }
@@ -504,7 +504,7 @@ 
 {
     static $smartConfigs;
     if (isset($smartConfigs[$moduleName])) {
-        $ret =& $smartConfigs[$moduleName];
+        $ret = & $smartConfigs[$moduleName];
 
         return $ret;
     }
@@ -532,7 +532,7 @@ 
             return $ret;
         }
         $hModConfig                = xoops_getHandler('config');
-        $smartConfigs[$moduleName] =& $hModConfig->getConfigsByCat(0, $module->getVar('mid'));
+        $smartConfigs[$moduleName] = & $hModConfig->getConfigsByCat(0, $module->getVar('mid'));
     }
 
     return $smartConfigs[$moduleName];
@@ -558,7 +558,7 @@ 
 {
     $ret = '';
     foreach ($errors as $key => $value) {
-        $ret .= '<br> - ' . $value;
+        $ret .= '<br> - '.$value;
     }
 
     return $ret;
@@ -578,17 +578,17 @@ 
     if (!is_numeric($userid)) {
         return $userid;
     }
-    $userid = (int)$userid;
+    $userid = (int) $userid;
     if ($userid > 0) {
         if ($users == array()) {
             //fetching users
             $memberHandler = xoops_getHandler('member');
-            $user          =& $memberHandler->getUser($userid);
+            $user          = & $memberHandler->getUser($userid);
         } else {
             if (!isset($users[$userid])) {
                 return $GLOBALS['xoopsConfig']['anonymous'];
             }
-            $user =& $users[$userid];
+            $user = & $users[$userid];
         }
         if (is_object($user)) {
             $ts        = MyTextSanitizer:: getInstance();
@@ -599,32 +599,32 @@ 
                 $fullname = $user->getVar('name');
             }
             if (!empty($fullname)) {
-                $linkeduser = "$fullname [<a href='" . XOOPS_URL . '/userinfo.php?uid=' . $userid . "'>" . $ts->htmlSpecialChars($username) . '</a>]';
+                $linkeduser = "$fullname [<a href='".XOOPS_URL.'/userinfo.php?uid='.$userid."'>".$ts->htmlSpecialChars($username).'</a>]';
             } else {
-                $linkeduser = "<a href='" . XOOPS_URL . '/userinfo.php?uid=' . $userid . "'>" . ucwords($ts->htmlSpecialChars($username)) . '</a>';
+                $linkeduser = "<a href='".XOOPS_URL.'/userinfo.php?uid='.$userid."'>".ucwords($ts->htmlSpecialChars($username)).'</a>';
             }
             // add contact info: email + PM
             if ($withContact) {
-                $linkeduser .= ' <a href="mailto:' .
-                               $user->getVar('email') .
-                               '"><img style="vertical-align: middle;" src="' .
-                               XOOPS_URL .
-                               '/images/icons/email.gif' .
-                               '" alt="' .
-                               _CO_SOBJECT_SEND_EMAIL .
-                               '" title="' .
-                               _CO_SOBJECT_SEND_EMAIL .
+                $linkeduser .= ' <a href="mailto:'.
+                               $user->getVar('email').
+                               '"><img style="vertical-align: middle;" src="'.
+                               XOOPS_URL.
+                               '/images/icons/email.gif'.
+                               '" alt="'.
+                               _CO_SOBJECT_SEND_EMAIL.
+                               '" title="'.
+                               _CO_SOBJECT_SEND_EMAIL.
                                '"/></a>';
-                $js = "javascript:openWithSelfMain('" . XOOPS_URL . '/pmlite.php?send2=1&to_userid=' . $userid . "', 'pmlite',450,370);";
-                $linkeduser .= ' <a href="' .
-                               $js .
-                               '"><img style="vertical-align: middle;" src="' .
-                               XOOPS_URL .
-                               '/images/icons/pm.gif' .
-                               '" alt="' .
-                               _CO_SOBJECT_SEND_PM .
-                               '" title="' .
-                               _CO_SOBJECT_SEND_PM .
+                $js = "javascript:openWithSelfMain('".XOOPS_URL.'/pmlite.php?send2=1&to_userid='.$userid."', 'pmlite',450,370);";
+                $linkeduser .= ' <a href="'.
+                               $js.
+                               '"><img style="vertical-align: middle;" src="'.
+                               XOOPS_URL.
+                               '/images/icons/pm.gif'.
+                               '" alt="'.
+                               _CO_SOBJECT_SEND_PM.
+                               '" title="'.
+                               _CO_SOBJECT_SEND_PM.
                                '"/></a>';
             }
 
@@ -644,20 +644,20 @@ 
 function smart_adminMenu($currentoption = 0, $breadcrumb = '', $submenus = false, $currentsub = -1)
 {
     global $xoopsModule, $xoopsConfig;
-    include_once XOOPS_ROOT_PATH . '/class/template.php';
-    if (file_exists(XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php')) {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/modinfo.php';
+    include_once XOOPS_ROOT_PATH.'/class/template.php';
+    if (file_exists(XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/'.$xoopsConfig['language'].'/modinfo.php')) {
+        include_once XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/'.$xoopsConfig['language'].'/modinfo.php';
     } else {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/modinfo.php';
+        include_once XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/english/modinfo.php';
     }
-    if (file_exists(XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php')) {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/' . $xoopsConfig['language'] . '/admin.php';
+    if (file_exists(XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/'.$xoopsConfig['language'].'/admin.php')) {
+        include_once XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/'.$xoopsConfig['language'].'/admin.php';
     } else {
-        include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/language/english/admin.php';
+        include_once XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/language/english/admin.php';
     }
     $headermenu = array();
     $adminmenu  = array();
-    include XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->getVar('dirname') . '/admin/menu.php';
+    include XOOPS_ROOT_PATH.'/modules/'.$xoopsModule->getVar('dirname').'/admin/menu.php';
     $tpl = new XoopsTpl();
     $tpl->assign(array(
                      'headermenu'      => $headermenu,
@@ -680,11 +680,11 @@ 
 function smart_collapsableBar($id = '', $title = '', $dsc = '')
 {
     global $xoopsModule;
-    echo "<h3 style=\"color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; \"><a href='javascript:;' onclick=\"togglecollapse('" . $id . "'); toggleIcon('" . $id . "_icon')\";>";
-    echo "<img id='" . $id . "_icon' src=" . SMARTOBJECT_URL . "assets/images/close12.gif alt='' /></a>&nbsp;" . $title . '</h3>';
-    echo "<div id='" . $id . "'>";
+    echo "<h3 style=\"color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; \"><a href='javascript:;' onclick=\"togglecollapse('".$id."'); toggleIcon('".$id."_icon')\";>";
+    echo "<img id='".$id."_icon' src=".SMARTOBJECT_URL."assets/images/close12.gif alt='' /></a>&nbsp;".$title.'</h3>';
+    echo "<div id='".$id."'>";
     if ($dsc !== '') {
-        echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">" . $dsc . '</span>';
+        echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">".$dsc.'</span>';
     }
 }
 
@@ -698,11 +698,11 @@ 
     global $xoopsModule;
     $onClick = "ajaxtogglecollapse('$id')";
     //$onClick = "togglecollapse('$id'); toggleIcon('" . $id . "_icon')";
-    echo '<h3 style="border: 1px solid; color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; " onclick="' . $onClick . '">';
-    echo "<img id='" . $id . "_icon' src=" . SMARTOBJECT_URL . "assets/images/close12.gif alt='' /></a>&nbsp;" . $title . '</h3>';
-    echo "<div id='" . $id . "'>";
+    echo '<h3 style="border: 1px solid; color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; " onclick="'.$onClick.'">';
+    echo "<img id='".$id."_icon' src=".SMARTOBJECT_URL."assets/images/close12.gif alt='' /></a>&nbsp;".$title.'</h3>';
+    echo "<div id='".$id."'>";
     if ($dsc !== '') {
-        echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">" . $dsc . '</span>';
+        echo "<span style=\"color: #567; margin: 3px 0 12px 0; font-size: small; display: block; \">".$dsc.'</span>';
     }
 }
 
@@ -732,13 +732,13 @@ 
 {
     $urls        = smart_getCurrentUrls();
     $path        = $urls['phpself'];
-    $cookie_name = $path . '_smart_collaps_' . $name;
+    $cookie_name = $path.'_smart_collaps_'.$name;
     $cookie_name = str_replace('.', '_', $cookie_name);
     $cookie      = smart_getCookieVar($cookie_name, '');
     if ($cookie === 'none') {
         echo '
                 <script type="text/javascript"><!--
-                togglecollapse("' . $name . '"); toggleIcon("' . $name . '_icon");
+                togglecollapse("' . $name.'"); toggleIcon("'.$name.'_icon");
                     //-->
                 </script>
                 ';
@@ -804,17 +804,17 @@ 
     $httphost    = $_SERVER['HTTP_HOST'];
     $querystring = $_SERVER['QUERY_STRING'];
     if ($querystring !== '') {
-        $querystring = '?' . $querystring;
+        $querystring = '?'.$querystring;
     }
-    $currenturl           = $http . $httphost . $phpself . $querystring;
+    $currenturl           = $http.$httphost.$phpself.$querystring;
     $urls                 = array();
     $urls['http']         = $http;
     $urls['httphost']     = $httphost;
     $urls['phpself']      = $phpself;
     $urls['querystring']  = $querystring;
-    $urls['full_phpself'] = $http . $httphost . $phpself;
+    $urls['full_phpself'] = $http.$httphost.$phpself;
     $urls['full']         = $currenturl;
-    $urls['isHomePage']   = (XOOPS_URL . '/index.php') == ($http . $httphost . $phpself);
+    $urls['isHomePage']   = (XOOPS_URL.'/index.php') == ($http.$httphost.$phpself);
 
     return $urls;
 }
@@ -891,22 +891,22 @@ 
 {
     global $xoopsConfig, $xoopsModule, $xoopsModuleConfig;
 
-    include_once XOOPS_ROOT_PATH . '/class/template.php';
+    include_once XOOPS_ROOT_PATH.'/class/template.php';
     $tpl = new XoopsTpl();
 
     $hModule      = xoops_getHandler('module');
-    $versioninfo  =& $hModule->get($xoopsModule->getVar('mid'));
-    $modfootertxt = 'Module ' . $versioninfo->getInfo('name') . ' - Version ' . $versioninfo->getInfo('version') . '';
-    $modfooter    = "<a href='" .
-                    $versioninfo->getInfo('support_site_url') .
-                    "' target='_blank'><img src='" .
-                    XOOPS_URL .
-                    '/modules/' .
-                    $xoopsModule->getVar('dirname') .
-                    "/assets/images/cssbutton.gif' title='" .
-                    $modfootertxt .
-                    "' alt='" .
-                    $modfootertxt .
+    $versioninfo  = & $hModule->get($xoopsModule->getVar('mid'));
+    $modfootertxt = 'Module '.$versioninfo->getInfo('name').' - Version '.$versioninfo->getInfo('version').'';
+    $modfooter    = "<a href='".
+                    $versioninfo->getInfo('support_site_url').
+                    "' target='_blank'><img src='".
+                    XOOPS_URL.
+                    '/modules/'.
+                    $xoopsModule->getVar('dirname').
+                    "/assets/images/cssbutton.gif' title='".
+                    $modfootertxt.
+                    "' alt='".
+                    $modfootertxt.
                     "'/></a>";
     $tpl->assign('modfooter', $modfooter);
 
@@ -915,7 +915,7 @@ 
     }
     $smartobjectConfig = smart_getModuleConfig('smartobject');
     $tpl->assign('smartobject_enable_admin_footer', $smartobjectConfig['enable_admin_footer']);
-    $tpl->display(SMARTOBJECT_ROOT_PATH . 'templates/smartobject_admin_footer.html');
+    $tpl->display(SMARTOBJECT_ROOT_PATH.'templates/smartobject_admin_footer.html');
 }
 
 function smart_xoops_cp_footer()
@@ -942,7 +942,7 @@ 
  */
 function smart_addScript($src)
 {
-    echo '<script src="' . $src . '" type="text/javascript"></script>';
+    echo '<script src="'.$src.'" type="text/javascript"></script>';
 }
 
 /**
@@ -951,16 +951,16 @@ 
 function smart_addStyle($src)
 {
     if ($src === 'smartobject') {
-        $src = SMARTOBJECT_URL . 'assets/css/module.css';
+        $src = SMARTOBJECT_URL.'assets/css/module.css';
     }
     echo smart_get_css_link($src);
 }
 
 function smart_addAdminAjaxSupport()
 {
-    smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/lib/prototype.js');
-    smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/src/scriptaculous.js');
-    smart_addScript(SMARTOBJECT_URL . 'include/scriptaculous/src/smart.js');
+    smart_addScript(SMARTOBJECT_URL.'include/scriptaculous/lib/prototype.js');
+    smart_addScript(SMARTOBJECT_URL.'include/scriptaculous/src/scriptaculous.js');
+    smart_addScript(SMARTOBJECT_URL.'include/scriptaculous/src/smart.js');
 }
 
 /**
@@ -1020,7 +1020,7 @@ 
 function smart_htmlnumericentities($str)
 {
     //    return preg_replace('/[^!-%\x27-;=?-~ ]/e', '"&#".ord("$0").chr(59)', $str);
-    return preg_replace_callback('/[^!-%\x27-;=?-~ ]/', function ($m) { return '&#' . ord($m[0]) . chr(59); }, $str);
+    return preg_replace_callback('/[^!-%\x27-;=?-~ ]/', function($m) { return '&#'.ord($m[0]).chr(59); }, $str);
 }
 
 /**
@@ -1033,16 +1033,16 @@ 
     static $handlers;
     $name = strtolower(trim($name));
     if (!isset($handlers[$name])) {
-        if (file_exists($hnd_file = XOOPS_ROOT_PATH . '/kernel/' . $name . '.php')) {
+        if (file_exists($hnd_file = XOOPS_ROOT_PATH.'/kernel/'.$name.'.php')) {
             require_once $hnd_file;
         }
-        $class = 'Xoops' . ucfirst($name) . 'Handler';
+        $class = 'Xoops'.ucfirst($name).'Handler';
         if (class_exists($class)) {
-            $handlers[$name] = new $class ($GLOBALS['xoopsDB'], 'xoops');
+            $handlers[$name] = new $class($GLOBALS['xoopsDB'], 'xoops');
         }
     }
     if (!isset($handlers[$name]) && !$optional) {
-        trigger_error('Class <b>' . $class . '</b> does not exist<br>Handler Name: ' . $name, E_USER_ERROR);
+        trigger_error('Class <b>'.$class.'</b> does not exist<br>Handler Name: '.$name, E_USER_ERROR);
     }
     if (isset($handlers[$name])) {
         return $handlers[$name];
@@ -1122,9 +1122,9 @@ 
 {
     global $xoopsConfig;
 
-    $filename = XOOPS_ROOT_PATH . '/modules/' . $module . '/language/' . $xoopsConfig['language'] . '/' . $file . '.php';
+    $filename = XOOPS_ROOT_PATH.'/modules/'.$module.'/language/'.$xoopsConfig['language'].'/'.$file.'.php';
     if (!file_exists($filename)) {
-        $filename = XOOPS_ROOT_PATH . '/modules/' . $module . '/language/english/' . $file . '.php';
+        $filename = XOOPS_ROOT_PATH.'/modules/'.$module.'/language/english/'.$file.'.php';
     }
     if (file_exists($filename)) {
         include_once($filename);
@@ -1187,11 +1187,11 @@ 
     // common HTML entities to their text equivalent.
     // Credits: newbb2
     $search = array(
-        "'<script[^>]*?>.*?</script>'si",  // Strip out javascript
-        "'<img.*?/>'si",       // Strip out img tags
-        "'<[\/\!]*?[^<>]*?>'si",          // Strip out HTML tags
-        "'([\r\n])[\s]+'",                // Strip out white space
-        "'&(quot|#34);'i",                // Replace HTML entities
+        "'<script[^>]*?>.*?</script>'si", // Strip out javascript
+        "'<img.*?/>'si", // Strip out img tags
+        "'<[\/\!]*?[^<>]*?>'si", // Strip out HTML tags
+        "'([\r\n])[\s]+'", // Strip out white space
+        "'&(quot|#34);'i", // Replace HTML entities
         "'&(amp|#38);'i",
         "'&(lt|#60);'i",
         "'&(gt|#62);'i",
@@ -1201,7 +1201,7 @@ 
         "'&(pound|#163);'i",
         "'&(copy|#169);'i",
         "'&#(\d+);'e"
-    );                    // evaluate as php
+    ); // evaluate as php
 
     $replace = array(
         '',
@@ -1241,21 +1241,21 @@ 
         $str = $match[0];
         if (false !== strpos($str, ',')) {
             // A comma exists, that makes it easy, cos we assume it separates the decimal part.
-            $str = str_replace('.', '', $str);    // Erase thousand seps
-            $str = str_replace(',', '.', $str);    // Convert , to . for floatval command
+            $str = str_replace('.', '', $str); // Erase thousand seps
+            $str = str_replace(',', '.', $str); // Convert , to . for floatval command
 
-            return (float)$str;
+            return (float) $str;
         } else {
             // No comma exists, so we have to decide, how a single dot shall be treated
             if (preg_match("/^[0-9\-]*[\.]{1}[0-9-]+$/", $str) == true && $set['single_dot_as_decimal'] == true) {
                 // Treat single dot as decimal separator
-                return (float)$str;
+                return (float) $str;
             } else {
                 //echo "str: ".$str; echo "ret: ".str_replace('.', '', $str); echo "<br><br> ";
                 // Else, treat all dots as thousand seps
-                $str = str_replace('.', '', $str);    // Erase thousand seps
+                $str = str_replace('.', '', $str); // Erase thousand seps
 
-                return (float)$str;
+                return (float) $str;
             }
         }
     } else {
@@ -1287,7 +1287,7 @@ 
         $ret .= '.00';
     }
     if ($currencyObj) {
-        $ret = $ret . ' ' . $currencyObj->getCode();
+        $ret = $ret.' '.$currencyObj->getCode();
     }
 
     return $ret;
@@ -1314,7 +1314,7 @@ 
     }
     $ret = '';
     if ($moduleName) {
-        $ret = "<a href='" . XOOPS_URL . "/modules/$moduleName/admin/index.php'>" . _CO_SOBJECT_ADMIN_PAGE . '</a>';
+        $ret = "<a href='".XOOPS_URL."/modules/$moduleName/admin/index.php'>"._CO_SOBJECT_ADMIN_PAGE.'</a>';
     }
 
     return $ret;
@@ -1325,7 +1325,7 @@ 
  */
 function smart_getEditors()
 {
-    $filename = XOOPS_ROOT_PATH . '/class/xoopseditor/xoopseditor.php';
+    $filename = XOOPS_ROOT_PATH.'/class/xoopseditor/xoopseditor.php';
     if (!file_exists($filename)) {
         return false;
     }
@@ -1349,9 +1349,9 @@ 
 {
     $ret = array();
     foreach ($items as $item) {
-        $ret[] = $moduleName . '_' . $item;
+        $ret[] = $moduleName.'_'.$item;
     }
-    $ret[] = $moduleName . '_meta';
+    $ret[] = $moduleName.'_meta';
 
     return $ret;
 }

class/member.php

Indentation +200 added lines, -200 removed lines

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

Spacing +10 added lines, -10 removed lines

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

class/smartmlobject.php

Indentation +142 added lines, -142 removed lines

@@ -24,82 +24,82 @@ 
  */
 class SmartMlObject extends SmartObject
 {
-    /**
-     * SmartMlObject constructor.
-     */
-    public function __construct()
-    {
-        $this->initVar('language', XOBJ_DTYPE_TXTBOX, 'english', false, null, '', true, _CO_SOBJECT_LANGUAGE_CAPTION, _CO_SOBJECT_LANGUAGE_DSC, true, true);
-        $this->setControl('language', 'language');
-    }
-
-    /**
-     * If object is not new, change the control of the not-multilanguage fields
-     *
-     * We need to intercept this function from SmartObject because if the object is not new...
-     */
-    // function getForm() {
-
-    //}
-
-    /**
-     * Strip Multilanguage Fields
-     *
-     * Get rid of all the multilanguage fields to have an object with only global fields.
-     * This will be usefull when creating the ML object for the first time. Then we will be able
-     * to create translations.
-     */
-    public function stripMultilanguageFields()
-    {
-        $objectVars    =& $this->getVars();
-        $newObjectVars = array();
-        foreach ($objectVars as $key => $var) {
-            if (!$var['multilingual']) {
-                $newObjectVars[$key] = $var;
-            }
-        }
-        $this->vars = $newObjectVars;
-    }
-
-    public function stripNonMultilanguageFields()
-    {
-        $objectVars    =& $this->getVars();
-        $newObjectVars = array();
-        foreach ($objectVars as $key => $var) {
-            if ($var['multilingual'] || $key == $this->handler->keyName) {
-                $newObjectVars[$key] = $var;
-            }
-        }
-        $this->vars = $newObjectVars;
-    }
-
-    /**
-     * Make non multilanguage fields read only
-     *
-     * This is used when we are creating/editing a translation.
-     * We only want to edit the multilanguag fields, not the global one.
-     */
-    public function makeNonMLFieldReadOnly()
-    {
-        foreach ($this->getVars() as $key => $var) {
-            //if (($key == 'language') || (!$var['multilingual'] && $key <> $this->handler->keyName)) {
-            if (!$var['multilingual'] && $key != $this->handler->keyName) {
-                $this->setControl($key, 'label');
-            }
-        }
-    }
-
-    /**
-     * @param  bool   $onlyUrl
-     * @param  bool   $withimage
-     * @return string
-     */
-    public function getEditLanguageLink($onlyUrl = false, $withimage = true)
-    {
-        $controller = new SmartObjectController($this->handler);
-
-        return $controller->getEditLanguageLink($this, $onlyUrl, $withimage);
-    }
+	/**
+	 * SmartMlObject constructor.
+	 */
+	public function __construct()
+	{
+		$this->initVar('language', XOBJ_DTYPE_TXTBOX, 'english', false, null, '', true, _CO_SOBJECT_LANGUAGE_CAPTION, _CO_SOBJECT_LANGUAGE_DSC, true, true);
+		$this->setControl('language', 'language');
+	}
+
+	/**
+	 * If object is not new, change the control of the not-multilanguage fields
+	 *
+	 * We need to intercept this function from SmartObject because if the object is not new...
+	 */
+	// function getForm() {
+
+	//}
+
+	/**
+	 * Strip Multilanguage Fields
+	 *
+	 * Get rid of all the multilanguage fields to have an object with only global fields.
+	 * This will be usefull when creating the ML object for the first time. Then we will be able
+	 * to create translations.
+	 */
+	public function stripMultilanguageFields()
+	{
+		$objectVars    =& $this->getVars();
+		$newObjectVars = array();
+		foreach ($objectVars as $key => $var) {
+			if (!$var['multilingual']) {
+				$newObjectVars[$key] = $var;
+			}
+		}
+		$this->vars = $newObjectVars;
+	}
+
+	public function stripNonMultilanguageFields()
+	{
+		$objectVars    =& $this->getVars();
+		$newObjectVars = array();
+		foreach ($objectVars as $key => $var) {
+			if ($var['multilingual'] || $key == $this->handler->keyName) {
+				$newObjectVars[$key] = $var;
+			}
+		}
+		$this->vars = $newObjectVars;
+	}
+
+	/**
+	 * Make non multilanguage fields read only
+	 *
+	 * This is used when we are creating/editing a translation.
+	 * We only want to edit the multilanguag fields, not the global one.
+	 */
+	public function makeNonMLFieldReadOnly()
+	{
+		foreach ($this->getVars() as $key => $var) {
+			//if (($key == 'language') || (!$var['multilingual'] && $key <> $this->handler->keyName)) {
+			if (!$var['multilingual'] && $key != $this->handler->keyName) {
+				$this->setControl($key, 'label');
+			}
+		}
+	}
+
+	/**
+	 * @param  bool   $onlyUrl
+	 * @param  bool   $withimage
+	 * @return string
+	 */
+	public function getEditLanguageLink($onlyUrl = false, $withimage = true)
+	{
+		$controller = new SmartObjectController($this->handler);
+
+		return $controller->getEditLanguageLink($this, $onlyUrl, $withimage);
+	}
 }
 
 /**
@@ -107,70 +107,70 @@ 
  */
 class SmartPersistableMlObjectHandler extends SmartPersistableObjectHandler
 {
-    /**
-     * @param  null  $criteria
-     * @param  bool  $id_as_key
-     * @param  bool  $as_object
-     * @param  bool  $debug
-     * @param  bool  $language
-     * @return array
-     */
-    public function getObjects($criteria = null, $id_as_key = false, $as_object = true, $debug = false, $language = false)
-    {
-        // Create the first part of the SQL query to join the "_text" table
-        $sql = 'SELECT * FROM ' .
-               $this->table .
-               ' AS ' .
-               $this->_itemname .
-               ' INNER JOIN ' .
-               $this->table .
-               '_text AS ' .
-               $this->_itemname .
-               '_text ON ' .
-               $this->_itemname .
-               '.' .
-               $this->keyName .
-               '=' .
-               $this->_itemname .
-               '_text.' .
-               $this->keyName;
-
-        if ($language) {
-            // If a language was specified, then let's create a WHERE clause to only return the objects associated with this language
-
-            // if no criteria was previously created, let's create it
-            if (!$criteria) {
-                $criteria = new CriteriaCompo();
-            }
-            $criteria->add(new Criteria('language', $language));
-
-            return parent::getObjects($criteria, $id_as_key, $as_object, $debug, $sql);
-        }
-
-        return parent::getObjects($criteria, $id_as_key, $as_object, $debug, $sql);
-    }
-
-    /**
-     * @param  mixed $id
-     * @param  bool  $language
-     * @param  bool  $as_object
-     * @param  bool  $debug
-     * @return mixed
-     */
-    public function &get($id, $language = false, $as_object = true, $debug = false)
-    {
-        if (!$language) {
-            return parent::get($id, $as_object, $debug);
-        } else {
-            $criteria = new CriteriaCompo();
-            $criteria->add(new Criteria('language', $language));
-
-            return parent::get($id, $as_object, $debug, $criteria);
-        }
-    }
-
-    public function changeTableNameForML()
-    {
-        $this->table = $this->db->prefix($this->_moduleName . '_' . $this->_itemname . '_text');
-    }
+	/**
+	 * @param  null  $criteria
+	 * @param  bool  $id_as_key
+	 * @param  bool  $as_object
+	 * @param  bool  $debug
+	 * @param  bool  $language
+	 * @return array
+	 */
+	public function getObjects($criteria = null, $id_as_key = false, $as_object = true, $debug = false, $language = false)
+	{
+		// Create the first part of the SQL query to join the "_text" table
+		$sql = 'SELECT * FROM ' .
+			   $this->table .
+			   ' AS ' .
+			   $this->_itemname .
+			   ' INNER JOIN ' .
+			   $this->table .
+			   '_text AS ' .
+			   $this->_itemname .
+			   '_text ON ' .
+			   $this->_itemname .
+			   '.' .
+			   $this->keyName .
+			   '=' .
+			   $this->_itemname .
+			   '_text.' .
+			   $this->keyName;
+
+		if ($language) {
+			// If a language was specified, then let's create a WHERE clause to only return the objects associated with this language
+
+			// if no criteria was previously created, let's create it
+			if (!$criteria) {
+				$criteria = new CriteriaCompo();
+			}
+			$criteria->add(new Criteria('language', $language));
+
+			return parent::getObjects($criteria, $id_as_key, $as_object, $debug, $sql);
+		}
+
+		return parent::getObjects($criteria, $id_as_key, $as_object, $debug, $sql);
+	}
+
+	/**
+	 * @param  mixed $id
+	 * @param  bool  $language
+	 * @param  bool  $as_object
+	 * @param  bool  $debug
+	 * @return mixed
+	 */
+	public function &get($id, $language = false, $as_object = true, $debug = false)
+	{
+		if (!$language) {
+			return parent::get($id, $as_object, $debug);
+		} else {
+			$criteria = new CriteriaCompo();
+			$criteria->add(new Criteria('language', $language));
+
+			return parent::get($id, $as_object, $debug, $criteria);
+		}
+	}
+
+	public function changeTableNameForML()
+	{
+		$this->table = $this->db->prefix($this->_moduleName . '_' . $this->_itemname . '_text');
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -11,7 +11,7 @@ 
  */
 
 // defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/smartobject.php';
 
 /**
  * SmartObject base Multilanguage-enabled class
@@ -51,7 +51,7 @@ 
      */
     public function stripMultilanguageFields()
     {
-        $objectVars    =& $this->getVars();
+        $objectVars    = & $this->getVars();
         $newObjectVars = array();
         foreach ($objectVars as $key => $var) {
             if (!$var['multilingual']) {
@@ -63,7 +63,7 @@ 
 
     public function stripNonMultilanguageFields()
     {
-        $objectVars    =& $this->getVars();
+        $objectVars    = & $this->getVars();
         $newObjectVars = array();
         foreach ($objectVars as $key => $var) {
             if ($var['multilingual'] || $key == $this->handler->keyName) {
@@ -118,21 +118,21 @@ 
     public function getObjects($criteria = null, $id_as_key = false, $as_object = true, $debug = false, $language = false)
     {
         // Create the first part of the SQL query to join the "_text" table
-        $sql = 'SELECT * FROM ' .
-               $this->table .
-               ' AS ' .
-               $this->_itemname .
-               ' INNER JOIN ' .
-               $this->table .
-               '_text AS ' .
-               $this->_itemname .
-               '_text ON ' .
-               $this->_itemname .
-               '.' .
-               $this->keyName .
-               '=' .
-               $this->_itemname .
-               '_text.' .
+        $sql = 'SELECT * FROM '.
+               $this->table.
+               ' AS '.
+               $this->_itemname.
+               ' INNER JOIN '.
+               $this->table.
+               '_text AS '.
+               $this->_itemname.
+               '_text ON '.
+               $this->_itemname.
+               '.'.
+               $this->keyName.
+               '='.
+               $this->_itemname.
+               '_text.'.
                $this->keyName;
 
         if ($language) {
@@ -171,6 +171,6 @@ 
 
     public function changeTableNameForML()
     {
-        $this->table = $this->db->prefix($this->_moduleName . '_' . $this->_itemname . '_text');
+        $this->table = $this->db->prefix($this->_moduleName.'_'.$this->_itemname.'_text');
     }
 }

class/file.php

Indentation +16 added lines, -16 removed lines

@@ -8,14 +8,14 @@ 
  */
 class SmartobjectFile extends SmartobjectBasedUrl
 {
-    /**
-     * SmartobjectFile constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->quickInitVar('fileid', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_DIRNAME);
-    }
+	/**
+	 * SmartobjectFile constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->quickInitVar('fileid', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_DIRNAME);
+	}
 }
 
 /**
@@ -23,12 +23,12 @@ 
  */
 class SmartobjectFileHandler extends SmartPersistableObjectHandler
 {
-    /**
-     * SmartobjectFileHandler constructor.
-     * @param XoopsDatabase $db
-     */
-    public function __construct(XoopsDatabase $db)
-    {
-        parent::__construct($db, 'file', 'fileid', 'caption', 'desc', 'smartobject');
-    }
+	/**
+	 * SmartobjectFileHandler constructor.
+	 * @param XoopsDatabase $db
+	 */
+	public function __construct(XoopsDatabase $db)
+	{
+		parent::__construct($db, 'file', 'fileid', 'caption', 'desc', 'smartobject');
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -1,7 +1,7 @@
 <?php
 // defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 
-include_once XOOPS_ROOT_PATH . '/modules/smartobject/class/basedurl.php';
+include_once XOOPS_ROOT_PATH.'/modules/smartobject/class/basedurl.php';
 
 /**
  * Class SmartobjectFile