mambax7 / smartobject

class/smartobjectcontroller.php

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

class/rating.php

Indentation +208 added lines, -208 removed lines

@@ -37,125 +37,125 @@ 
  */
 class SmartobjectRating extends SmartObject
 {
-    public $_modulePlugin = false;
-
-    /**
-     * SmartobjectRating constructor.
-     */
-    public function __construct()
-    {
-        $this->quickInitVar('ratingid', XOBJ_DTYPE_INT, true);
-        $this->quickInitVar('dirname', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_DIRNAME);
-        $this->quickInitVar('item', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_ITEM);
-        $this->quickInitVar('itemid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_ITEMID);
-        $this->quickInitVar('uid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_UID);
-        $this->quickInitVar('date', XOBJ_DTYPE_LTIME, true, _CO_SOBJECT_RATING_DATE);
-        $this->quickInitVar('rate', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_RATE);
-
-        $this->initNonPersistableVar('name', XOBJ_DTYPE_TXTBOX, 'user', _CO_SOBJECT_RATING_NAME);
-
-        $this->setControl('dirname', array(
-            'handler'  => 'rating',
-            'method'   => 'getModuleList',
-            'onSelect' => 'submit'
-        ));
-
-        $this->setControl('item', array(
-            'object' => &$this,
-            'method' => 'getItemList'
-        ));
-
-        $this->setControl('uid', 'user');
-
-        $this->setControl('rate', array(
-            'handler' => 'rating',
-            'method'  => 'getRateList'
-        ));
-    }
-
-    /**
-     * @param  string $key
-     * @param  string $format
-     * @return mixed
-     */
-    public function getVar($key, $format = 's')
-    {
-        if ($format === 's' && in_array($key, array('name', 'dirname'))) {
-            //            return call_user_func(array($this, $key));
-            return $this->{$key}();
-        }
-
-        return parent::getVar($key, $format);
-    }
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        $ret = smart_getLinkedUnameFromId($this->getVar('uid', 'e'), true, array());
-
-        return $ret;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function dirname()
-    {
-        global $smartobjectRatingHandler;
-        $moduleArray = $smartobjectRatingHandler->getModuleList();
-
-        return $moduleArray[$this->getVar('dirname', 'n')];
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getItemList()
-    {
-        $plugin = $this->getModulePlugin();
-
-        return $plugin->getItemList();
-    }
-
-    /**
-     * @return string
-     */
-    public function getItemValue()
-    {
-        $moduleUrl      = XOOPS_URL . '/modules/' . $this->getVar('dirname', 'n') . '/';
-        $plugin         = $this->getModulePlugin();
-        $pluginItemInfo = $plugin->getItemInfo($this->getVar('item'));
-        if (!$pluginItemInfo) {
-            return '';
-        }
-        $itemPath = sprintf($pluginItemInfo['url'], $this->getVar('itemid'));
-        $ret      = '<a href="' . $moduleUrl . $itemPath . '">' . $pluginItemInfo['caption'] . '</a>';
-
-        return $ret;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getRateValue()
-    {
-        return $this->getVar('rate');
-    }
-
-    /**
-     * @return bool
-     */
-    public function getModulePlugin()
-    {
-        if (!$this->_modulePlugin) {
-            global $smartobjectRatingHandler;
-            $this->_modulePlugin = $smartobjectRatingHandler->pluginsObject->getPlugin($this->getVar('dirname', 'n'));
-        }
-
-        return $this->_modulePlugin;
-    }
+	public $_modulePlugin = false;
+
+	/**
+	 * SmartobjectRating constructor.
+	 */
+	public function __construct()
+	{
+		$this->quickInitVar('ratingid', XOBJ_DTYPE_INT, true);
+		$this->quickInitVar('dirname', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_DIRNAME);
+		$this->quickInitVar('item', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_ITEM);
+		$this->quickInitVar('itemid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_ITEMID);
+		$this->quickInitVar('uid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_UID);
+		$this->quickInitVar('date', XOBJ_DTYPE_LTIME, true, _CO_SOBJECT_RATING_DATE);
+		$this->quickInitVar('rate', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_RATE);
+
+		$this->initNonPersistableVar('name', XOBJ_DTYPE_TXTBOX, 'user', _CO_SOBJECT_RATING_NAME);
+
+		$this->setControl('dirname', array(
+			'handler'  => 'rating',
+			'method'   => 'getModuleList',
+			'onSelect' => 'submit'
+		));
+
+		$this->setControl('item', array(
+			'object' => &$this,
+			'method' => 'getItemList'
+		));
+
+		$this->setControl('uid', 'user');
+
+		$this->setControl('rate', array(
+			'handler' => 'rating',
+			'method'  => 'getRateList'
+		));
+	}
+
+	/**
+	 * @param  string $key
+	 * @param  string $format
+	 * @return mixed
+	 */
+	public function getVar($key, $format = 's')
+	{
+		if ($format === 's' && in_array($key, array('name', 'dirname'))) {
+			//            return call_user_func(array($this, $key));
+			return $this->{$key}();
+		}
+
+		return parent::getVar($key, $format);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		$ret = smart_getLinkedUnameFromId($this->getVar('uid', 'e'), true, array());
+
+		return $ret;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function dirname()
+	{
+		global $smartobjectRatingHandler;
+		$moduleArray = $smartobjectRatingHandler->getModuleList();
+
+		return $moduleArray[$this->getVar('dirname', 'n')];
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getItemList()
+	{
+		$plugin = $this->getModulePlugin();
+
+		return $plugin->getItemList();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getItemValue()
+	{
+		$moduleUrl      = XOOPS_URL . '/modules/' . $this->getVar('dirname', 'n') . '/';
+		$plugin         = $this->getModulePlugin();
+		$pluginItemInfo = $plugin->getItemInfo($this->getVar('item'));
+		if (!$pluginItemInfo) {
+			return '';
+		}
+		$itemPath = sprintf($pluginItemInfo['url'], $this->getVar('itemid'));
+		$ret      = '<a href="' . $moduleUrl . $itemPath . '">' . $pluginItemInfo['caption'] . '</a>';
+
+		return $ret;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getRateValue()
+	{
+		return $this->getVar('rate');
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getModulePlugin()
+	{
+		if (!$this->_modulePlugin) {
+			global $smartobjectRatingHandler;
+			$this->_modulePlugin = $smartobjectRatingHandler->pluginsObject->getPlugin($this->getVar('dirname', 'n'));
+		}
+
+		return $this->_modulePlugin;
+	}
 }
 
 /**
@@ -163,93 +163,93 @@ 
  */
 class SmartobjectRatingHandler extends SmartPersistableObjectHandler
 {
-    public $_rateOptions = array();
-    public $_moduleList  = false;
-    public $pluginsObject;
-
-    /**
-     * SmartobjectRatingHandler constructor.
-     * @param XoopsDatabase $db
-     */
-    public function __construct(XoopsDatabase $db)
-    {
-        parent::__construct($db, 'rating', 'ratingid', 'rate', '', 'smartobject');
-        $this->generalSQL = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname . ' INNER JOIN ' . $this->db->prefix('users') . ' AS user ON ' . $this->_itemname . '.uid=user.uid';
-
-        $this->_rateOptions[1] = 1;
-        $this->_rateOptions[2] = 2;
-        $this->_rateOptions[3] = 3;
-        $this->_rateOptions[4] = 4;
-        $this->_rateOptions[5] = 5;
-
-        $this->pluginsObject = new SmartPluginHandler();
-    }
-
-    /**
-     * @return bool
-     */
-    public function getModuleList()
-    {
-        if (!$this->_moduleList) {
-            $moduleArray          = $this->pluginsObject->getPluginsArray();
-            $this->_moduleList[0] = _CO_SOBJECT_MAKE_SELECTION;
-            foreach ($moduleArray as $k => $v) {
-                $this->_moduleList[$k] = $v;
-            }
-        }
-
-        return $this->_moduleList;
-    }
-
-    /**
-     * @return array
-     */
-    public function getRateList()
-    {
-        return $this->_rateOptions;
-    }
-
-    /**
-     * @param $itemid
-     * @param $dirname
-     * @param $item
-     * @return int
-     */
-    public function getRatingAverageByItemId($itemid, $dirname, $item)
-    {
-        $sql    = 'SELECT AVG(rate), COUNT(ratingid) FROM ' . $this->table . " WHERE itemid=$itemid AND dirname='$dirname' AND item='$item' GROUP BY itemid";
-        $result = $this->db->query($sql);
-        if (!$result) {
-            return 0;
-        }
-        list($average, $sum) = $this->db->fetchRow($result);
-        $ret['average'] = isset($average) ? $average : 0;
-        $ret['sum']     = isset($sum) ? $sum : 0;
-
-        return $ret;
-    }
-
-    /**
-     * @param $item
-     * @param $itemid
-     * @param $dirname
-     * @param $uid
-     * @return bool
-     */
-    public function already_rated($item, $itemid, $dirname, $uid)
-    {
-        $criteria = new CriteriaCompo();
-        $criteria->add(new Criteria('item', $item));
-        $criteria->add(new Criteria('itemid', $itemid));
-        $criteria->add(new Criteria('dirname', $dirname));
-        $criteria->add(new Criteria('user.uid', $uid));
-
-        $ret = $this->getObjects($criteria);
-
-        if (!$ret) {
-            return false;
-        } else {
-            return $ret[0];
-        }
-    }
+	public $_rateOptions = array();
+	public $_moduleList  = false;
+	public $pluginsObject;
+
+	/**
+	 * SmartobjectRatingHandler constructor.
+	 * @param XoopsDatabase $db
+	 */
+	public function __construct(XoopsDatabase $db)
+	{
+		parent::__construct($db, 'rating', 'ratingid', 'rate', '', 'smartobject');
+		$this->generalSQL = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname . ' INNER JOIN ' . $this->db->prefix('users') . ' AS user ON ' . $this->_itemname . '.uid=user.uid';
+
+		$this->_rateOptions[1] = 1;
+		$this->_rateOptions[2] = 2;
+		$this->_rateOptions[3] = 3;
+		$this->_rateOptions[4] = 4;
+		$this->_rateOptions[5] = 5;
+
+		$this->pluginsObject = new SmartPluginHandler();
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getModuleList()
+	{
+		if (!$this->_moduleList) {
+			$moduleArray          = $this->pluginsObject->getPluginsArray();
+			$this->_moduleList[0] = _CO_SOBJECT_MAKE_SELECTION;
+			foreach ($moduleArray as $k => $v) {
+				$this->_moduleList[$k] = $v;
+			}
+		}
+
+		return $this->_moduleList;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getRateList()
+	{
+		return $this->_rateOptions;
+	}
+
+	/**
+	 * @param $itemid
+	 * @param $dirname
+	 * @param $item
+	 * @return int
+	 */
+	public function getRatingAverageByItemId($itemid, $dirname, $item)
+	{
+		$sql    = 'SELECT AVG(rate), COUNT(ratingid) FROM ' . $this->table . " WHERE itemid=$itemid AND dirname='$dirname' AND item='$item' GROUP BY itemid";
+		$result = $this->db->query($sql);
+		if (!$result) {
+			return 0;
+		}
+		list($average, $sum) = $this->db->fetchRow($result);
+		$ret['average'] = isset($average) ? $average : 0;
+		$ret['sum']     = isset($sum) ? $sum : 0;
+
+		return $ret;
+	}
+
+	/**
+	 * @param $item
+	 * @param $itemid
+	 * @param $dirname
+	 * @param $uid
+	 * @return bool
+	 */
+	public function already_rated($item, $itemid, $dirname, $uid)
+	{
+		$criteria = new CriteriaCompo();
+		$criteria->add(new Criteria('item', $item));
+		$criteria->add(new Criteria('itemid', $itemid));
+		$criteria->add(new Criteria('dirname', $dirname));
+		$criteria->add(new Criteria('user.uid', $uid));
+
+		$ret = $this->getObjects($criteria);
+
+		if (!$ret) {
+			return false;
+		} else {
+			return $ret[0];
+		}
+	}
 }

class/urllink.php

Indentation +23 added lines, -23 removed lines

@@ -8,22 +8,22 @@ 
  */
 class SmartobjectUrlLink extends SmartobjectBasedUrl
 {
-    /**
-     * SmartobjectUrlLink constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->quickInitVar('urllinkid', XOBJ_DTYPE_TXTBOX, true);
-        $this->quickInitVar('target', XOBJ_DTYPE_TXTBOX, true);
+	/**
+	 * SmartobjectUrlLink constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->quickInitVar('urllinkid', XOBJ_DTYPE_TXTBOX, true);
+		$this->quickInitVar('target', XOBJ_DTYPE_TXTBOX, true);
 
-        $this->setControl('target', array(
-            'options' => array(
-                '_self'  => _CO_SOBJECT_URLLINK_SELF,
-                '_blank' => _CO_SOBJECT_URLLINK_BLANK
-            )
-        ));
-    }
+		$this->setControl('target', array(
+			'options' => array(
+				'_self'  => _CO_SOBJECT_URLLINK_SELF,
+				'_blank' => _CO_SOBJECT_URLLINK_BLANK
+			)
+		));
+	}
 }
 
 /**
@@ -31,12 +31,12 @@ 
  */
 class SmartobjectUrlLinkHandler extends SmartPersistableObjectHandler
 {
-    /**
-     * SmartobjectUrlLinkHandler constructor.
-     * @param XoopsDatabase $db
-     */
-    public function __construct(XoopsDatabase $db)
-    {
-        parent::__construct($db, 'urllink', 'urllinkid', 'caption', 'desc', 'smartobject');
-    }
+	/**
+	 * SmartobjectUrlLinkHandler constructor.
+	 * @param XoopsDatabase $db
+	 */
+	public function __construct(XoopsDatabase $db)
+	{
+		parent::__construct($db, 'urllink', 'urllinkid', 'caption', 'desc', 'smartobject');
+	}
 }

class/smarthighlighter.php

Indentation +84 added lines, -84 removed lines

@@ -19,96 +19,96 @@
  */
 class SmartHighlighter
 {
-    /**
-     * @access private
-     */
-    public $preg_keywords = '';
-    /**
-     * @access private
-     */
-    public $keywords = '';
-    /**
-     * @access private
-     */
-    public $singlewords = false;
-    /**
-     * @access private
-     */
-    public $replace_callback = null;
+	/**
+	 * @access private
+	 */
+	public $preg_keywords = '';
+	/**
+	 * @access private
+	 */
+	public $keywords = '';
+	/**
+	 * @access private
+	 */
+	public $singlewords = false;
+	/**
+	 * @access private
+	 */
+	public $replace_callback = null;
 
-    public $content;
+	public $content;
 
-    /**
-     * Main constructor
-     *
-     * This is the main constructor of keyhighlighter class. <br>
-     * It's the only public method of the class.
-     * @param string   $keywords         the keywords you want to highlight
-     * @param boolean  $singlewords      specify if it has to highlight also the single words.
-     * @param callback $replace_callback a custom callback for keyword highlight.
-     *                                   <code>
-     *                                   <?php
-     *                                   require ('keyhighlighter.class.php');
-     *
-     * function my_highlighter ($matches) {
-     *  return '<span style="font-weight: bolder; color: #FF0000;">' . $matches[0] . '</span>';
-     * }
-     *
-     * new keyhighlighter ('W3C', false, 'my_highlighter');
-     * readfile ('http://www.w3c.org/');
-     * ?>
-     * </code>
-     */
-    // public function __construct ()
-    public function __construct($keywords, $singlewords = false, $replace_callback = null)
-    {
-        $this->keywords         = $keywords;
-        $this->singlewords      = $singlewords;
-        $this->replace_callback = $replace_callback;
-    }
+	/**
+	 * Main constructor
+	 *
+	 * This is the main constructor of keyhighlighter class. <br>
+	 * It's the only public method of the class.
+	 * @param string   $keywords         the keywords you want to highlight
+	 * @param boolean  $singlewords      specify if it has to highlight also the single words.
+	 * @param callback $replace_callback a custom callback for keyword highlight.
+	 *                                   <code>
+	 *                                   <?php
+	 *                                   require ('keyhighlighter.class.php');
+	 *
+	 * function my_highlighter ($matches) {
+	 *  return '<span style="font-weight: bolder; color: #FF0000;">' . $matches[0] . '</span>';
+	 * }
+	 *
+	 * new keyhighlighter ('W3C', false, 'my_highlighter');
+	 * readfile ('http://www.w3c.org/');
+	 * ?>
+	 * </code>
+	 */
+	// public function __construct ()
+	public function __construct($keywords, $singlewords = false, $replace_callback = null)
+	{
+		$this->keywords         = $keywords;
+		$this->singlewords      = $singlewords;
+		$this->replace_callback = $replace_callback;
+	}
 
-    /**
-     * @access private
-     * @param $replace_matches
-     * @return mixed
-     */
-    public function replace($replace_matches)
-    {
-        $patterns = array();
-        if ($this->singlewords) {
-            $keywords = explode(' ', $this->preg_keywords);
-            foreach ($keywords as $keyword) {
-                $patterns[] = '/(?' . '>' . $keyword . '+)/si';
-            }
-        } else {
-            $patterns[] = '/(?' . '>' . $this->preg_keywords . '+)/si';
-        }
+	/**
+	 * @access private
+	 * @param $replace_matches
+	 * @return mixed
+	 */
+	public function replace($replace_matches)
+	{
+		$patterns = array();
+		if ($this->singlewords) {
+			$keywords = explode(' ', $this->preg_keywords);
+			foreach ($keywords as $keyword) {
+				$patterns[] = '/(?' . '>' . $keyword . '+)/si';
+			}
+		} else {
+			$patterns[] = '/(?' . '>' . $this->preg_keywords . '+)/si';
+		}
 
-        $result = $replace_matches[0];
+		$result = $replace_matches[0];
 
-        foreach ($patterns as $pattern) {
-            if (null !== $this->replace_callback) {
-                $result = preg_replace_callback($pattern, $this->replace_callback, $result);
-            } else {
-                $result = preg_replace($pattern, '<span class="highlightedkey">\\0</span>', $result);
-            }
-        }
+		foreach ($patterns as $pattern) {
+			if (null !== $this->replace_callback) {
+				$result = preg_replace_callback($pattern, $this->replace_callback, $result);
+			} else {
+				$result = preg_replace($pattern, '<span class="highlightedkey">\\0</span>', $result);
+			}
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * @access private
-     * @param $buffer
-     * @return mixed|string
-     */
-    public function highlight($buffer)
-    {
-        $buffer              = '>' . $buffer . '<';
-        $this->preg_keywords = preg_replace('/[^\w ]/si', '', $this->keywords);
-        $buffer              = preg_replace_callback("/(\>(((?" . ">[^><]+)|(?R))*)\<)/is", array(&$this, 'replace'), $buffer);
-        $buffer              = substr($buffer, 1, -1);
+	/**
+	 * @access private
+	 * @param $buffer
+	 * @return mixed|string
+	 */
+	public function highlight($buffer)
+	{
+		$buffer              = '>' . $buffer . '<';
+		$this->preg_keywords = preg_replace('/[^\w ]/si', '', $this->keywords);
+		$buffer              = preg_replace_callback("/(\>(((?" . ">[^><]+)|(?R))*)\<)/is", array(&$this, 'replace'), $buffer);
+		$buffer              = substr($buffer, 1, -1);
 
-        return $buffer;
-    }
+		return $buffer;
+	}
 }

class/smartobjectcategory.php

Indentation +204 added lines, -204 removed lines

@@ -18,123 +18,123 @@ 
  */
 class SmartobjectCategory extends SmartSeoObject
 {
-    public $_categoryPath;
-
-    /**
-     * SmartobjectCategory constructor.
-     */
-    public function __construct()
-    {
-        $this->initVar('categoryid', XOBJ_DTYPE_INT, '', true);
-        $this->initVar('parentid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_CATEGORY_PARENTID, _CO_SOBJECT_CATEGORY_PARENTID_DSC);
-        $this->initVar('name', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_NAME, _CO_SOBJECT_CATEGORY_NAME_DSC);
-        $this->initVar('description', XOBJ_DTYPE_TXTAREA, '', false, null, '', false, _CO_SOBJECT_CATEGORY_DESCRIPTION, _CO_SOBJECT_CATEGORY_DESCRIPTION_DSC);
-        $this->initVar('image', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_IMAGE, _CO_SOBJECT_CATEGORY_IMAGE_DSC);
-
-        $this->initCommonVar('doxcode');
-
-        $this->setControl('image', array('name' => 'image'));
-        $this->setControl('parentid', array('name' => 'parentcategory'));
-        $this->setControl('description', array(
-            'name'        => 'textarea',
-            'itemHandler' => false,
-            'method'      => false,
-            'module'      => false,
-            'form_editor' => 'default'
-        ));
-
-        // call parent constructor to get SEO fields initiated
-        parent::__construct();
-    }
-
-    /**
-     * returns a specific variable for the object in a proper format
-     *
-     * @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')
-    {
-        if ($format === 's' && in_array($key, array('description', 'image'))) {
-            //            return call_user_func(array($this, $key));
-            return $this->{$key}();
-        }
-
-        return parent::getVar($key, $format);
-    }
-
-    /**
-     * @return string
-     */
-    public function description()
-    {
-        return $this->getValueFor('description', false);
-    }
-
-    /**
-     * @return bool|mixed
-     */
-    public function image()
-    {
-        $ret = $this->getVar('image', 'e');
-        if ($ret == '-1') {
-            return false;
-        } else {
-            return $ret;
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        $this->setVar('doxcode', true);
-        global $myts;
-        $objectArray = parent::toArray();
-        if ($objectArray['image']) {
-            $objectArray['image'] = $this->getImageDir() . $objectArray['image'];
-        }
-
-        return $objectArray;
-    }
-
-    /**
-     * Create the complete path of a category
-     *
-     * @todo this could be improved as it uses multiple queries
-     * @param  bool   $withAllLink     make all name clickable
-     * @param  bool   $currentCategory
-     * @return string complete path (breadcrumb)
-     */
-    public function getCategoryPath($withAllLink = true, $currentCategory = false)
-    {
-        include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
-        $controller = new SmartObjectController($this->handler);
-
-        if (!$this->_categoryPath) {
-            if ($withAllLink && !$currentCategory) {
-                $ret = $controller->getItemLink($this);
-            } else {
-                $currentCategory = false;
-                $ret             = $this->getVar('name');
-            }
-            $parentid = $this->getVar('parentid');
-            if ($parentid != 0) {
-                $parentObj = $this->handler->get($parentid);
-                if ($parentObj->isNew()) {
-                    exit;
-                }
-                $parentid = $parentObj->getVar('parentid');
-                $ret      = $parentObj->getCategoryPath($withAllLink, $currentCategory) . ' > ' . $ret;
-            }
-            $this->_categoryPath = $ret;
-        }
-
-        return $this->_categoryPath;
-    }
+	public $_categoryPath;
+
+	/**
+	 * SmartobjectCategory constructor.
+	 */
+	public function __construct()
+	{
+		$this->initVar('categoryid', XOBJ_DTYPE_INT, '', true);
+		$this->initVar('parentid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_CATEGORY_PARENTID, _CO_SOBJECT_CATEGORY_PARENTID_DSC);
+		$this->initVar('name', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_NAME, _CO_SOBJECT_CATEGORY_NAME_DSC);
+		$this->initVar('description', XOBJ_DTYPE_TXTAREA, '', false, null, '', false, _CO_SOBJECT_CATEGORY_DESCRIPTION, _CO_SOBJECT_CATEGORY_DESCRIPTION_DSC);
+		$this->initVar('image', XOBJ_DTYPE_TXTBOX, '', false, null, '', false, _CO_SOBJECT_CATEGORY_IMAGE, _CO_SOBJECT_CATEGORY_IMAGE_DSC);
+
+		$this->initCommonVar('doxcode');
+
+		$this->setControl('image', array('name' => 'image'));
+		$this->setControl('parentid', array('name' => 'parentcategory'));
+		$this->setControl('description', array(
+			'name'        => 'textarea',
+			'itemHandler' => false,
+			'method'      => false,
+			'module'      => false,
+			'form_editor' => 'default'
+		));
+
+		// call parent constructor to get SEO fields initiated
+		parent::__construct();
+	}
+
+	/**
+	 * returns a specific variable for the object in a proper format
+	 *
+	 * @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')
+	{
+		if ($format === 's' && in_array($key, array('description', 'image'))) {
+			//            return call_user_func(array($this, $key));
+			return $this->{$key}();
+		}
+
+		return parent::getVar($key, $format);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->getValueFor('description', false);
+	}
+
+	/**
+	 * @return bool|mixed
+	 */
+	public function image()
+	{
+		$ret = $this->getVar('image', 'e');
+		if ($ret == '-1') {
+			return false;
+		} else {
+			return $ret;
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$this->setVar('doxcode', true);
+		global $myts;
+		$objectArray = parent::toArray();
+		if ($objectArray['image']) {
+			$objectArray['image'] = $this->getImageDir() . $objectArray['image'];
+		}
+
+		return $objectArray;
+	}
+
+	/**
+	 * Create the complete path of a category
+	 *
+	 * @todo this could be improved as it uses multiple queries
+	 * @param  bool   $withAllLink     make all name clickable
+	 * @param  bool   $currentCategory
+	 * @return string complete path (breadcrumb)
+	 */
+	public function getCategoryPath($withAllLink = true, $currentCategory = false)
+	{
+		include_once SMARTOBJECT_ROOT_PATH . 'class/smartobjectcontroller.php';
+		$controller = new SmartObjectController($this->handler);
+
+		if (!$this->_categoryPath) {
+			if ($withAllLink && !$currentCategory) {
+				$ret = $controller->getItemLink($this);
+			} else {
+				$currentCategory = false;
+				$ret             = $this->getVar('name');
+			}
+			$parentid = $this->getVar('parentid');
+			if ($parentid != 0) {
+				$parentObj = $this->handler->get($parentid);
+				if ($parentObj->isNew()) {
+					exit;
+				}
+				$parentid = $parentObj->getVar('parentid');
+				$ret      = $parentObj->getCategoryPath($withAllLink, $currentCategory) . ' > ' . $ret;
+			}
+			$this->_categoryPath = $ret;
+		}
+
+		return $this->_categoryPath;
+	}
 }
 
 /**
@@ -142,91 +142,91 @@ 
  */
 class SmartobjectCategoryHandler extends SmartPersistableObjectHandler
 {
-    public $allCategoriesObj = false;
-    public $_allCategoriesId = false;
-
-    /**
-     * SmartobjectCategoryHandler constructor.
-     * @param XoopsDatabase $db
-     * @param                      $modulename
-     */
-    public function __construct(XoopsDatabase $db, $modulename)
-    {
-        parent::__construct($db, 'category', 'categoryid', 'name', 'description', $modulename);
-    }
-
-    /**
-     * @param  int        $parentid
-     * @param  bool       $perm_name
-     * @param  string     $sort
-     * @param  string     $order
-     * @return array|bool
-     */
-    public function getAllCategoriesArray($parentid = 0, $perm_name = false, $sort = 'parentid', $order = 'ASC')
-    {
-        if (!$this->allCategoriesObj) {
-            $criteria = new CriteriaCompo();
-            $criteria->setSort($sort);
-            $criteria->setOrder($order);
-            global $xoopsUser;
-            $userIsAdmin = is_object($xoopsUser) && $xoopsUser->isAdmin();
-
-            if ($perm_name && !$userIsAdmin) {
-                if (!$this->setGrantedObjectsCriteria($criteria, $perm_name)) {
-                    return false;
-                }
-            }
-
-            $this->allCategoriesObj = $this->getObjects($criteria, 'parentid');
-        }
-
-        $ret = array();
-        if (isset($this->allCategoriesObj[$parentid])) {
-            foreach ($this->allCategoriesObj[$parentid] as $categoryid => $categoryObj) {
-                $ret[$categoryid]['self'] = $categoryObj->toArray();
-                if (isset($this->allCategoriesObj[$categoryid])) {
-                    $ret[$categoryid]['sub']          = $this->getAllCategoriesArray($categoryid);
-                    $ret[$categoryid]['subcatscount'] = count($ret[$categoryid]['sub']);
-                }
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * @param               $parentid
-     * @param  bool         $asString
-     * @return array|string
-     */
-    public function getParentIds($parentid, $asString = true)
-    {
-        if (!$this->allCategoriesId) {
-            $ret = array();
-            $sql = 'SELECT categoryid, parentid FROM ' . $this->table . ' AS ' . $this->_itemname . ' ORDER BY parentid';
-
-            $result = $this->db->query($sql);
-
-            if (!$result) {
-                return $ret;
-            }
-
-            while ($myrow = $this->db->fetchArray($result)) {
-                $this->allCategoriesId[$myrow['categoryid']] = $myrow['parentid'];
-            }
-        }
-
-        $retArray = array($parentid);
-        while ($parentid != 0) {
-            $parentid = $this->allCategoriesId[$parentid];
-            if ($parentid != 0) {
-                $retArray[] = $parentid;
-            }
-        }
-        if ($asString) {
-            return implode(', ', $retArray);
-        } else {
-            return $retArray;
-        }
-    }
+	public $allCategoriesObj = false;
+	public $_allCategoriesId = false;
+
+	/**
+	 * SmartobjectCategoryHandler constructor.
+	 * @param XoopsDatabase $db
+	 * @param                      $modulename
+	 */
+	public function __construct(XoopsDatabase $db, $modulename)
+	{
+		parent::__construct($db, 'category', 'categoryid', 'name', 'description', $modulename);
+	}
+
+	/**
+	 * @param  int        $parentid
+	 * @param  bool       $perm_name
+	 * @param  string     $sort
+	 * @param  string     $order
+	 * @return array|bool
+	 */
+	public function getAllCategoriesArray($parentid = 0, $perm_name = false, $sort = 'parentid', $order = 'ASC')
+	{
+		if (!$this->allCategoriesObj) {
+			$criteria = new CriteriaCompo();
+			$criteria->setSort($sort);
+			$criteria->setOrder($order);
+			global $xoopsUser;
+			$userIsAdmin = is_object($xoopsUser) && $xoopsUser->isAdmin();
+
+			if ($perm_name && !$userIsAdmin) {
+				if (!$this->setGrantedObjectsCriteria($criteria, $perm_name)) {
+					return false;
+				}
+			}
+
+			$this->allCategoriesObj = $this->getObjects($criteria, 'parentid');
+		}
+
+		$ret = array();
+		if (isset($this->allCategoriesObj[$parentid])) {
+			foreach ($this->allCategoriesObj[$parentid] as $categoryid => $categoryObj) {
+				$ret[$categoryid]['self'] = $categoryObj->toArray();
+				if (isset($this->allCategoriesObj[$categoryid])) {
+					$ret[$categoryid]['sub']          = $this->getAllCategoriesArray($categoryid);
+					$ret[$categoryid]['subcatscount'] = count($ret[$categoryid]['sub']);
+				}
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * @param               $parentid
+	 * @param  bool         $asString
+	 * @return array|string
+	 */
+	public function getParentIds($parentid, $asString = true)
+	{
+		if (!$this->allCategoriesId) {
+			$ret = array();
+			$sql = 'SELECT categoryid, parentid FROM ' . $this->table . ' AS ' . $this->_itemname . ' ORDER BY parentid';
+
+			$result = $this->db->query($sql);
+
+			if (!$result) {
+				return $ret;
+			}
+
+			while ($myrow = $this->db->fetchArray($result)) {
+				$this->allCategoriesId[$myrow['categoryid']] = $myrow['parentid'];
+			}
+		}
+
+		$retArray = array($parentid);
+		while ($parentid != 0) {
+			$parentid = $this->allCategoriesId[$parentid];
+			if ($parentid != 0) {
+				$retArray[] = $parentid;
+			}
+		}
+		if ($asString) {
+			return implode(', ', $retArray);
+		} else {
+			return $retArray;
+		}
+	}
 }

class/smartuploader.php

Indentation +42 added lines, -42 removed lines

@@ -89,51 +89,51 @@
  */
 class SmartUploader extends XoopsMediaUploader
 {
-    public $ext;
-    public $dimension;
+	public $ext;
+	public $dimension;
 
-    /**
-     * No admin check for uploads
-     */
-    public $noAdminSizeCheck;
+	/**
+	 * No admin check for uploads
+	 */
+	public $noAdminSizeCheck;
 
-    /**
-     * Constructor
-     *
-     * @param string    $uploadDir
-     * @param array|int $allowedMimeTypes
-     * @param int       $maxFileSize
-     * @param int       $maxWidth
-     * @param int       $maxHeight
-     * @internal param int $cmodvalue
-     */
-    public function __construct($uploadDir, $allowedMimeTypes = 0, $maxFileSize, $maxWidth = 0, $maxHeight = 0)
-    {
-        parent::__construct($uploadDir, $allowedMimeTypes, $maxFileSize, $maxWidth, $maxHeight);
-    }
+	/**
+	 * Constructor
+	 *
+	 * @param string    $uploadDir
+	 * @param array|int $allowedMimeTypes
+	 * @param int       $maxFileSize
+	 * @param int       $maxWidth
+	 * @param int       $maxHeight
+	 * @internal param int $cmodvalue
+	 */
+	public function __construct($uploadDir, $allowedMimeTypes = 0, $maxFileSize, $maxWidth = 0, $maxHeight = 0)
+	{
+		parent::__construct($uploadDir, $allowedMimeTypes, $maxFileSize, $maxWidth, $maxHeight);
+	}
 
-    /**
-     * @param $value
-     */
-    public function noAdminSizeCheck($value)
-    {
-        $this->noAdminSizeCheck = $value;
-    }
+	/**
+	 * @param $value
+	 */
+	public function noAdminSizeCheck($value)
+	{
+		$this->noAdminSizeCheck = $value;
+	}
 
-    /**
-     * Is the file the right size?
-     *
-     * @return bool
-     */
-    public function checkMaxFileSize()
-    {
-        if ($this->noAdminSizeCheck) {
-            return true;
-        }
-        if ($this->mediaSize > $this->maxFileSize) {
-            return false;
-        }
+	/**
+	 * Is the file the right size?
+	 *
+	 * @return bool
+	 */
+	public function checkMaxFileSize()
+	{
+		if ($this->noAdminSizeCheck) {
+			return true;
+		}
+		if ($this->mediaSize > $this->maxFileSize) {
+			return false;
+		}
 
-        return true;
-    }
+		return true;
+	}
 }

class/smartobject.php

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

class/smartobjecttable.php

Indentation +886 added lines, -886 removed lines

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

class/smarthookhandler.php

Indentation +37 added lines, -37 removed lines

@@ -6,44 +6,44 @@
  */
 class SmartHookHandler
 {
-    /**
-     * SmartHookHandler constructor.
-     */
-    public function __construct()
-    {
-    }
+	/**
+	 * SmartHookHandler constructor.
+	 */
+	public function __construct()
+	{
+	}
 
-    /**
-     * 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;
+	}
 
-    /**
-     * @param $hook_name
-     */
-    public function executeHook($hook_name)
-    {
-        $lower_hook_name = strtolower($hook_name);
-        $filename        = SMARTOBJECT_ROOT_PATH . 'include/custom_code/' . $lower_hook_name . '.php';
-        if (file_exists($filename)) {
-            include_once($filename);
-            $function = 'smarthook_' . $lower_hook_name;
-            if (function_exists($function)) {
-                $function();
-            }
-        }
-    }
+	/**
+	 * @param $hook_name
+	 */
+	public function executeHook($hook_name)
+	{
+		$lower_hook_name = strtolower($hook_name);
+		$filename        = SMARTOBJECT_ROOT_PATH . 'include/custom_code/' . $lower_hook_name . '.php';
+		if (file_exists($filename)) {
+			include_once($filename);
+			$function = 'smarthook_' . $lower_hook_name;
+			if (function_exists($function)) {
+				$function();
+			}
+		}
+	}
 }