mambax7 / smartobject

class/ExportRenderer.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +182 added lines, -182 removed lines

@@ -41,186 +41,186 @@
  */
 class ExportRenderer
 {
-    public $data;
-    public $format;
-    public $filename;
-    public $filepath;
-    public $options;
-
-    /**
-     * Constructor
-     *
-     * @param array       $data     contains the data to be exported
-     * @param bool|string $filename name of the file in which the exported data will be saved
-     * @param bool|string $filepath path where the file will be saved
-     * @param string      $format   format of the ouputed export. Currently only supports CSV
-     * @param array       $options  options of the format to be exported in
-     */
-    public function __construct(
-        $data,
-        $filename = false,
-        $filepath = false,
-        $format = 'csv',
-        $options = ['separator' => ';']
-    ) {
-        $this->data     = $data;
-        $this->format   = $format;
-        $this->filename = $filename;
-        $this->filepath = $filepath;
-        $this->options  = $options;
-    }
-
-    /**
-     * @param         $dataArray
-     * @param         $separator
-     * @param  string $trim
-     * @param  bool   $removeEmptyLines
-     * @return string
-     */
-    public function arrayToCsvString($dataArray, $separator, $trim = 'both', $removeEmptyLines = true)
-    {
-        if (!is_array($dataArray) || empty($dataArray)) {
-            return '';
-        }
-        switch ($trim) {
-            case 'none':
-                $trimFunction = false;
-                break;
-            case 'left':
-                $trimFunction = 'ltrim';
-                break;
-            case 'right':
-                $trimFunction = 'rtrim';
-                break;
-            default: //'both':
-                $trimFunction = 'trim';
-                break;
-        }
-        $ret = [];
-        foreach ($dataArray as $key => $field) {
-            $ret[$key] = $this->valToCsvHelper($field, $separator, $trimFunction);
-        }
-
-        return implode($separator, $ret);
-    }
-
-    /**
-     * @param $val
-     * @param $separator
-     * @param $trimFunction
-     * @return mixed|string
-     */
-    public function valToCsvHelper($val, $separator, $trimFunction)
-    {
-        if ($trimFunction) {
-            $val = $trimFunction($val);
-        }
-        //If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
-        $needQuote = false;
-        do {
-            if (false !== strpos($val, '"')) {
-                $val       = str_replace('"', '""', $val);
-                $needQuote = true;
-                break;
-            }
-            if (false !== strpos($val, $separator)) {
-                $needQuote = true;
-                break;
-            }
-            if ((false !== strpos($val, "\n")) || (false !== strpos($val, "\r"))) { // \r is for mac
-                $needQuote = true;
-                break;
-            }
-        } while (false);
-        if ($needQuote) {
-            $val = '"' . $val . '"';
-        }
-
-        return $val;
-    }
-
-    public function execute()
-    {
-        $exportFileData = '';
-
-        switch ($this->format) {
-            case 'csv':
-                $separator      = isset($this->options['separator']) ? $this->options['separator'] : ';';
-                $firstRow       = implode($separator, $this->data['columnsHeaders']);
-                $exportFileData .= $firstRow . "\r\n";
-
-                foreach ($this->data['rows'] as $cols) {
-                    $exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
-                }
-                break;
-        }
-        $this->saveExportFile($exportFileData);
-    }
-
-    /**
-     * @param $content
-     */
-    public function saveExportFile($content)
-    {
-        switch ($this->format) {
-            case 'csv':
-                $this->saveCsv($content);
-                break;
-        }
-    }
-
-    /**
-     * @param $content
-     */
-    public function saveCsv($content)
-    {
-        if (!$this->filepath) {
-            $this->filepath = XOOPS_UPLOAD_PATH . '/';
-        }
-        if (!$this->filename) {
-            $this->filename .= time();
-            $this->filename .= '.csv';
-        }
-
-        $fullFileName = $this->filepath . $this->filename;
-
-        if (!$handle = fopen($fullFileName, 'a+')) {
-            trigger_error('Unable to open ' . $fullFileName, E_USER_WARNING);
-        } elseif (false === fwrite($handle, $content)) {
-            trigger_error('Unable to write in ' . $fullFileName, E_USER_WARNING);
-        } else {
-            $mimeType  = 'text/csv';
-            $file      = strrev($this->filename);
-            $temp_name = strtolower(strrev(substr($file, 0, strpos($file, '--'))));
-            if ('' === $temp_name) {
-                $file_name = $this->filename;
-            } else {
-                $file_name = $temp_name;
-            }
-            $fullFileName = $this->filepath . stripslashes(trim($this->filename));
-
-            if (ini_get('zlib.output_compression')) {
-                ini_set('zlib.output_compression', 'Off');
-            }
-
-            header('Pragma: public');
-            header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
-            header('Cache-Control: private', false);
-            header('Content-Transfer-Encoding: binary');
-            if (isset($mimeType)) {
-                header('Content-Type: ' . $mimeType);
-            }
-
-            header('Content-Disposition: attachment; filename=' . $file_name);
-
-            if (isset($mimeType) && false !== strpos($mimeType, 'text/')) {
-                $fp = fopen($fullFileName, 'r');
-            } else {
-                $fp = fopen($fullFileName, 'rb');
-            }
-            fpassthru($fp);
-            exit();
-        }
-        fclose($handle);
-    }
+	public $data;
+	public $format;
+	public $filename;
+	public $filepath;
+	public $options;
+
+	/**
+	 * Constructor
+	 *
+	 * @param array       $data     contains the data to be exported
+	 * @param bool|string $filename name of the file in which the exported data will be saved
+	 * @param bool|string $filepath path where the file will be saved
+	 * @param string      $format   format of the ouputed export. Currently only supports CSV
+	 * @param array       $options  options of the format to be exported in
+	 */
+	public function __construct(
+		$data,
+		$filename = false,
+		$filepath = false,
+		$format = 'csv',
+		$options = ['separator' => ';']
+	) {
+		$this->data     = $data;
+		$this->format   = $format;
+		$this->filename = $filename;
+		$this->filepath = $filepath;
+		$this->options  = $options;
+	}
+
+	/**
+	 * @param         $dataArray
+	 * @param         $separator
+	 * @param  string $trim
+	 * @param  bool   $removeEmptyLines
+	 * @return string
+	 */
+	public function arrayToCsvString($dataArray, $separator, $trim = 'both', $removeEmptyLines = true)
+	{
+		if (!is_array($dataArray) || empty($dataArray)) {
+			return '';
+		}
+		switch ($trim) {
+			case 'none':
+				$trimFunction = false;
+				break;
+			case 'left':
+				$trimFunction = 'ltrim';
+				break;
+			case 'right':
+				$trimFunction = 'rtrim';
+				break;
+			default: //'both':
+				$trimFunction = 'trim';
+				break;
+		}
+		$ret = [];
+		foreach ($dataArray as $key => $field) {
+			$ret[$key] = $this->valToCsvHelper($field, $separator, $trimFunction);
+		}
+
+		return implode($separator, $ret);
+	}
+
+	/**
+	 * @param $val
+	 * @param $separator
+	 * @param $trimFunction
+	 * @return mixed|string
+	 */
+	public function valToCsvHelper($val, $separator, $trimFunction)
+	{
+		if ($trimFunction) {
+			$val = $trimFunction($val);
+		}
+		//If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
+		$needQuote = false;
+		do {
+			if (false !== strpos($val, '"')) {
+				$val       = str_replace('"', '""', $val);
+				$needQuote = true;
+				break;
+			}
+			if (false !== strpos($val, $separator)) {
+				$needQuote = true;
+				break;
+			}
+			if ((false !== strpos($val, "\n")) || (false !== strpos($val, "\r"))) { // \r is for mac
+				$needQuote = true;
+				break;
+			}
+		} while (false);
+		if ($needQuote) {
+			$val = '"' . $val . '"';
+		}
+
+		return $val;
+	}
+
+	public function execute()
+	{
+		$exportFileData = '';
+
+		switch ($this->format) {
+			case 'csv':
+				$separator      = isset($this->options['separator']) ? $this->options['separator'] : ';';
+				$firstRow       = implode($separator, $this->data['columnsHeaders']);
+				$exportFileData .= $firstRow . "\r\n";
+
+				foreach ($this->data['rows'] as $cols) {
+					$exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
+				}
+				break;
+		}
+		$this->saveExportFile($exportFileData);
+	}
+
+	/**
+	 * @param $content
+	 */
+	public function saveExportFile($content)
+	{
+		switch ($this->format) {
+			case 'csv':
+				$this->saveCsv($content);
+				break;
+		}
+	}
+
+	/**
+	 * @param $content
+	 */
+	public function saveCsv($content)
+	{
+		if (!$this->filepath) {
+			$this->filepath = XOOPS_UPLOAD_PATH . '/';
+		}
+		if (!$this->filename) {
+			$this->filename .= time();
+			$this->filename .= '.csv';
+		}
+
+		$fullFileName = $this->filepath . $this->filename;
+
+		if (!$handle = fopen($fullFileName, 'a+')) {
+			trigger_error('Unable to open ' . $fullFileName, E_USER_WARNING);
+		} elseif (false === fwrite($handle, $content)) {
+			trigger_error('Unable to write in ' . $fullFileName, E_USER_WARNING);
+		} else {
+			$mimeType  = 'text/csv';
+			$file      = strrev($this->filename);
+			$temp_name = strtolower(strrev(substr($file, 0, strpos($file, '--'))));
+			if ('' === $temp_name) {
+				$file_name = $this->filename;
+			} else {
+				$file_name = $temp_name;
+			}
+			$fullFileName = $this->filepath . stripslashes(trim($this->filename));
+
+			if (ini_get('zlib.output_compression')) {
+				ini_set('zlib.output_compression', 'Off');
+			}
+
+			header('Pragma: public');
+			header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
+			header('Cache-Control: private', false);
+			header('Content-Transfer-Encoding: binary');
+			if (isset($mimeType)) {
+				header('Content-Type: ' . $mimeType);
+			}
+
+			header('Content-Disposition: attachment; filename=' . $file_name);
+
+			if (isset($mimeType) && false !== strpos($mimeType, 'text/')) {
+				$fp = fopen($fullFileName, 'r');
+			} else {
+				$fp = fopen($fullFileName, 'rb');
+			}
+			fpassthru($fp);
+			exit();
+		}
+		fclose($handle);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -236,7 +236,7 @@ 
             }
         } while (false);
         if ($needQuote) {
-            $val = '"' . $val . '"';
+            $val = '"'.$val.'"';
         }
 
         return $val;
@@ -250,10 +250,10 @@ 
             case 'csv':
                 $separator      = isset($this->options['separator']) ? $this->options['separator'] : ';';
                 $firstRow       = implode($separator, $this->data['columnsHeaders']);
-                $exportFileData .= $firstRow . "\r\n";
+                $exportFileData .= $firstRow."\r\n";
 
                 foreach ($this->data['rows'] as $cols) {
-                    $exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
+                    $exportFileData .= $this->arrayToCsvString($cols, $separator)."\r\n";
                 }
                 break;
         }
@@ -278,19 +278,19 @@ 
     public function saveCsv($content)
     {
         if (!$this->filepath) {
-            $this->filepath = XOOPS_UPLOAD_PATH . '/';
+            $this->filepath = XOOPS_UPLOAD_PATH.'/';
         }
         if (!$this->filename) {
             $this->filename .= time();
             $this->filename .= '.csv';
         }
 
-        $fullFileName = $this->filepath . $this->filename;
+        $fullFileName = $this->filepath.$this->filename;
 
         if (!$handle = fopen($fullFileName, 'a+')) {
-            trigger_error('Unable to open ' . $fullFileName, E_USER_WARNING);
+            trigger_error('Unable to open '.$fullFileName, E_USER_WARNING);
         } elseif (false === fwrite($handle, $content)) {
-            trigger_error('Unable to write in ' . $fullFileName, E_USER_WARNING);
+            trigger_error('Unable to write in '.$fullFileName, E_USER_WARNING);
         } else {
             $mimeType  = 'text/csv';
             $file      = strrev($this->filename);
@@ -300,7 +300,7 @@ 
             } else {
                 $file_name = $temp_name;
             }
-            $fullFileName = $this->filepath . stripslashes(trim($this->filename));
+            $fullFileName = $this->filepath.stripslashes(trim($this->filename));
 
             if (ini_get('zlib.output_compression')) {
                 ini_set('zlib.output_compression', 'Off');
@@ -311,10 +311,10 @@ 
             header('Cache-Control: private', false);
             header('Content-Transfer-Encoding: binary');
             if (isset($mimeType)) {
-                header('Content-Type: ' . $mimeType);
+                header('Content-Type: '.$mimeType);
             }
 
-            header('Content-Disposition: attachment; filename=' . $file_name);
+            header('Content-Disposition: attachment; filename='.$file_name);
 
             if (isset($mimeType) && false !== strpos($mimeType, 'text/')) {
                 $fp = fopen($fullFileName, 'r');

class/Link.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * @access public
      * @param  string $key    key of the object's variable to be returned
      * @param  string $format format to use for the output
-     * @return mixed  formatted value of the variable
+     * @return integer  formatted value of the variable
      */
     public function getVar($key, $format = 's')
     {

Indentation +148 added lines, -148 removed lines

@@ -29,152 +29,152 @@
  */
 class Link extends Smartobject\BaseSmartObject
 {
-    /**
-     * Link constructor.
-     */
-    public function __construct()
-    {
-        $this->initVar('linkid', XOBJ_DTYPE_INT, '', true);
-        $this->initVar('date', XOBJ_DTYPE_INT, 0, false, null, '', false, _CO_SOBJECT_LINK_DATE, '', true, true, false);
-        $this->initVar('from_uid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_FROM_UID, _CO_SOBJECT_LINK_FROM_UID_DSC);
-        $this->initVar('from_email', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_FROM_EMAIL, _CO_SOBJECT_LINK_FROM_EMAIL_DSC, true);
-        $this->initVar('from_name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_FROM_NAME, _CO_SOBJECT_LINK_FROM_NAME_DSC, true);
-        $this->initVar('to_uid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_TO_UID, _CO_SOBJECT_LINK_TO_UID_DSC);
-        $this->initVar('to_email', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_TO_EMAIL, _CO_SOBJECT_LINK_TO_EMAIL_DSC, true);
-        $this->initVar('to_name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_TO_NAME, _CO_SOBJECT_LINK_TO_NAME_DSC, true);
-        $this->initVar('link', XOBJ_DTYPE_TXTBOX, '', false, 255, '', false, _CO_SOBJECT_LINK_LINK, _CO_SOBJECT_LINK_LINK_DSC, true);
-        $this->initVar('subject', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_SUBJECT, _CO_SOBJECT_LINK_SUBJECT_DSC, true);
-        $this->initVar('body', XOBJ_DTYPE_TXTAREA, '', true, null, '', false, _CO_SOBJECT_LINK_BODY, _CO_SOBJECT_LINK_BODY_DSC);
-        $this->initVar('mid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_MID, _CO_SOBJECT_LINK_MID_DSC);
-        $this->initVar('mid_name', XOBJ_DTYPE_TXTBOX, '', false, 255, '', false, _CO_SOBJECT_LINK_MID_NAME, _CO_SOBJECT_LINK_MID_NAME_DSC, true);
-    }
-
-    /**
-     * 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 ('s' === $format && in_array($key, ['from_uid', 'to_uid', 'date', 'link'])) {
-            //            return call_user_func(array($this, $key));
-            return $this->{$key}();
-        }
-
-        return parent::getVar($key, $format);
-    }
-
-    /**
-     * @return string
-     */
-    public function from_uid()
-    {
-        $ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('from_uid', 'e'), 1, null, true);
-
-        return $ret;
-    }
-
-    /**
-     * @param  bool $withContact
-     * @return string
-     */
-    public function to_uid($withContact = false)
-    {
-        $ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('to_uid', 'e'), 1, null, true);
-
-        return $ret;
-    }
-
-    /**
-     * @return string
-     */
-    public function date()
-    {
-        $ret = formatTimestamp($this->getVar('date', 'e'));
-
-        return $ret;
-    }
-
-    /**
-     * @param  bool $full
-     * @return mixed|string
-     */
-    public function link($full = false)
-    {
-        $ret = $this->getVar('link', 'e');
-        if ($full) {
-            $myts = \MyTextSanitizer::getInstance();
-            $ret  = $myts->displayTarea($ret);
-
-            return $ret;
-        } else {
-            $ret = '<a href="' . $ret . '" alt="' . $this->getVar('link', 'e') . '" title="' . $this->getVar('link', 'e') . '">' . _AM_SOBJECT_SENT_LINKS_GOTO . '</a>';
-
-            return $ret;
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function getViewItemLink()
-    {
-        $ret = '<a href="' . SMARTOBJECT_URL . 'admin/link.php?op=view&linkid=' . $this->getVar('linkid') . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'mail_find.png" alt="' . _AM_SOBJECT_SENT_LINK_VIEW . '" title="' . _AM_SOBJECT_SENT_LINK_VIEW . '"></a>';
-
-        return $ret;
-    }
-
-    /**
-     * @return string
-     */
-    public function getFromInfo()
-    {
-        // check if from_uid represent a user
-
-        if ($this->getVar('from_uid')) {
-            $user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('from_uid'));
-            if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
-                $user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
-            }
-        } else {
-            $user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
-        }
-
-        return $user;
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        $ret             = parent::toArray();
-        $ret['fromInfo'] = $this->getFromInfo();
-        $ret['toInfo']   = $this->getToInfo();
-        $ret['fullLink'] = $this->link(true);
-
-        return $ret;
-    }
-
-    /**
-     * @return string
-     */
-    public function getToInfo()
-    {
-        // check if from_uid represent a user
-
-        if ($this->getVar('to_uid')) {
-            $user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('to_uid'));
-            if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
-                $user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
-            }
-        } else {
-            $user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
-        }
-
-        return $user;
-    }
+	/**
+	 * Link constructor.
+	 */
+	public function __construct()
+	{
+		$this->initVar('linkid', XOBJ_DTYPE_INT, '', true);
+		$this->initVar('date', XOBJ_DTYPE_INT, 0, false, null, '', false, _CO_SOBJECT_LINK_DATE, '', true, true, false);
+		$this->initVar('from_uid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_FROM_UID, _CO_SOBJECT_LINK_FROM_UID_DSC);
+		$this->initVar('from_email', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_FROM_EMAIL, _CO_SOBJECT_LINK_FROM_EMAIL_DSC, true);
+		$this->initVar('from_name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_FROM_NAME, _CO_SOBJECT_LINK_FROM_NAME_DSC, true);
+		$this->initVar('to_uid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_TO_UID, _CO_SOBJECT_LINK_TO_UID_DSC);
+		$this->initVar('to_email', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_TO_EMAIL, _CO_SOBJECT_LINK_TO_EMAIL_DSC, true);
+		$this->initVar('to_name', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_TO_NAME, _CO_SOBJECT_LINK_TO_NAME_DSC, true);
+		$this->initVar('link', XOBJ_DTYPE_TXTBOX, '', false, 255, '', false, _CO_SOBJECT_LINK_LINK, _CO_SOBJECT_LINK_LINK_DSC, true);
+		$this->initVar('subject', XOBJ_DTYPE_TXTBOX, '', true, 255, '', false, _CO_SOBJECT_LINK_SUBJECT, _CO_SOBJECT_LINK_SUBJECT_DSC, true);
+		$this->initVar('body', XOBJ_DTYPE_TXTAREA, '', true, null, '', false, _CO_SOBJECT_LINK_BODY, _CO_SOBJECT_LINK_BODY_DSC);
+		$this->initVar('mid', XOBJ_DTYPE_INT, '', false, null, '', false, _CO_SOBJECT_LINK_MID, _CO_SOBJECT_LINK_MID_DSC);
+		$this->initVar('mid_name', XOBJ_DTYPE_TXTBOX, '', false, 255, '', false, _CO_SOBJECT_LINK_MID_NAME, _CO_SOBJECT_LINK_MID_NAME_DSC, true);
+	}
+
+	/**
+	 * 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 ('s' === $format && in_array($key, ['from_uid', 'to_uid', 'date', 'link'])) {
+			//            return call_user_func(array($this, $key));
+			return $this->{$key}();
+		}
+
+		return parent::getVar($key, $format);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function from_uid()
+	{
+		$ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('from_uid', 'e'), 1, null, true);
+
+		return $ret;
+	}
+
+	/**
+	 * @param  bool $withContact
+	 * @return string
+	 */
+	public function to_uid($withContact = false)
+	{
+		$ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('to_uid', 'e'), 1, null, true);
+
+		return $ret;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function date()
+	{
+		$ret = formatTimestamp($this->getVar('date', 'e'));
+
+		return $ret;
+	}
+
+	/**
+	 * @param  bool $full
+	 * @return mixed|string
+	 */
+	public function link($full = false)
+	{
+		$ret = $this->getVar('link', 'e');
+		if ($full) {
+			$myts = \MyTextSanitizer::getInstance();
+			$ret  = $myts->displayTarea($ret);
+
+			return $ret;
+		} else {
+			$ret = '<a href="' . $ret . '" alt="' . $this->getVar('link', 'e') . '" title="' . $this->getVar('link', 'e') . '">' . _AM_SOBJECT_SENT_LINKS_GOTO . '</a>';
+
+			return $ret;
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getViewItemLink()
+	{
+		$ret = '<a href="' . SMARTOBJECT_URL . 'admin/link.php?op=view&linkid=' . $this->getVar('linkid') . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'mail_find.png" alt="' . _AM_SOBJECT_SENT_LINK_VIEW . '" title="' . _AM_SOBJECT_SENT_LINK_VIEW . '"></a>';
+
+		return $ret;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getFromInfo()
+	{
+		// check if from_uid represent a user
+
+		if ($this->getVar('from_uid')) {
+			$user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('from_uid'));
+			if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
+				$user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
+			}
+		} else {
+			$user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
+		}
+
+		return $user;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$ret             = parent::toArray();
+		$ret['fromInfo'] = $this->getFromInfo();
+		$ret['toInfo']   = $this->getToInfo();
+		$ret['fullLink'] = $this->link(true);
+
+		return $ret;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getToInfo()
+	{
+		// check if from_uid represent a user
+
+		if ($this->getVar('to_uid')) {
+			$user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('to_uid'));
+			if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
+				$user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
+			}
+		} else {
+			$user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
+		}
+
+		return $user;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -111,7 +111,7 @@ 
 
             return $ret;
         } else {
-            $ret = '<a href="' . $ret . '" alt="' . $this->getVar('link', 'e') . '" title="' . $this->getVar('link', 'e') . '">' . _AM_SOBJECT_SENT_LINKS_GOTO . '</a>';
+            $ret = '<a href="'.$ret.'" alt="'.$this->getVar('link', 'e').'" title="'.$this->getVar('link', 'e').'">'._AM_SOBJECT_SENT_LINKS_GOTO.'</a>';
 
             return $ret;
         }
@@ -122,7 +122,7 @@ 
      */
     public function getViewItemLink()
     {
-        $ret = '<a href="' . SMARTOBJECT_URL . 'admin/link.php?op=view&linkid=' . $this->getVar('linkid') . '"><img src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'mail_find.png" alt="' . _AM_SOBJECT_SENT_LINK_VIEW . '" title="' . _AM_SOBJECT_SENT_LINK_VIEW . '"></a>';
+        $ret = '<a href="'.SMARTOBJECT_URL.'admin/link.php?op=view&linkid='.$this->getVar('linkid').'"><img src="'.SMARTOBJECT_IMAGES_ACTIONS_URL.'mail_find.png" alt="'._AM_SOBJECT_SENT_LINK_VIEW.'" title="'._AM_SOBJECT_SENT_LINK_VIEW.'"></a>';
 
         return $ret;
     }
@@ -137,10 +137,10 @@ 
         if ($this->getVar('from_uid')) {
             $user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('from_uid'));
             if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
-                $user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
+                $user = '<a href="mailto:'.$this->getVar('from_email').'">'.$this->getVar('from_email').'</a>';
             }
         } else {
-            $user = '<a href="mailto:' . $this->getVar('from_email') . '">' . $this->getVar('from_email') . '</a>';
+            $user = '<a href="mailto:'.$this->getVar('from_email').'">'.$this->getVar('from_email').'</a>';
         }
 
         return $user;
@@ -169,10 +169,10 @@ 
         if ($this->getVar('to_uid')) {
             $user = Smartobject\Utility::getLinkedUnameFromId($this->getVar('to_uid'));
             if ($user == $GLOBALS['xoopsConfig']['anonymous']) {
-                $user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
+                $user = '<a href="mailto:'.$this->getVar('to_email').'">'.$this->getVar('to_email').'</a>';
             }
         } else {
-            $user = '<a href="mailto:' . $this->getVar('to_email') . '">' . $this->getVar('to_email') . '</a>';
+            $user = '<a href="mailto:'.$this->getVar('to_email').'">'.$this->getVar('to_email').'</a>';
         }
 
         return $user;

class/MemberHandler.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +200 added lines, -200 removed lines

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

Spacing +9 added lines, -9 removed lines

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

class/MetaGen.php

Doc Comments +5 added lines, -5 removed lines

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

Indentation +387 added lines, -387 removed lines

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

Spacing +3 added lines, -3 removed lines

@@ -213,7 +213,7 @@ 
 
         $titleTag = [];
 
-        $show_mod_name_breadcrumb = null !==($helper->getConfig('show_mod_name_breadcrumb')) ? $helper->getConfig('show_mod_name_breadcrumb') : true;
+        $show_mod_name_breadcrumb = null !== ($helper->getConfig('show_mod_name_breadcrumb')) ? $helper->getConfig('show_mod_name_breadcrumb') : true;
 
         if ($moduleName && $show_mod_name_breadcrumb) {
             $titleTag['module'] = $moduleName;
@@ -270,7 +270,7 @@ 
             /** @var Smartobject\Helper $helper */
             $helper = Smartobject\Helper::getInstance();
 
-            if  (null !== ($helper->getConfig('module_meta_description'))) {
+            if (null !== ($helper->getConfig('module_meta_description'))) {
                 $description = $helper->getConfig('module_meta_description');
             }
         }
@@ -365,7 +365,7 @@ 
         /** @var Smartobject\Helper $helper */
         $helper = Smartobject\Helper::getInstance();
 
-        $keywords = $this->findMetaKeywords($this->_original_title . ' ' . $this->_description, $this->_minChar);
+        $keywords = $this->findMetaKeywords($this->_original_title.' '.$this->_description, $this->_minChar);
         if (null !== ($helper->getModule()) && null !== ($helper->getConfig('moduleMetaKeywords'))
             && '' !== $helper->getConfig('moduleMetaKeywords')) {
             $moduleKeywords = explode(',', $helper->getConfig('moduleMetaKeywords'));

class/ObjectColumn.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 
     /**
      * SmartObjectColumn constructor.
-     * @param        $keyname
+     * @param        string $keyname
      * @param string $align
      * @param bool   $width
      * @param bool   $customMethodForValue

Indentation +71 added lines, -71 removed lines

@@ -23,82 +23,82 @@
  */
 class ObjectColumn
 {
-    public $_keyname;
-    public $_align;
-    public $_width;
-    public $_customMethodForValue;
-    public $_extraParams;
-    public $_sortable;
-    public $_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;
-    }
+	/**
+	 * 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;
-    }
+	public function getKeyName()
+	{
+		return $this->_keyname;
+	}
 
-    /**
-     * @return string
-     */
-    public function getAlign()
-    {
-        return $this->_align;
-    }
+	/**
+	 * @return string
+	 */
+	public function getAlign()
+	{
+		return $this->_align;
+	}
 
-    /**
-     * @return bool
-     */
-    public function isSortable()
-    {
-        return $this->_sortable;
-    }
+	/**
+	 * @return bool
+	 */
+	public function isSortable()
+	{
+		return $this->_sortable;
+	}
 
-    /**
-     * @return bool|string
-     */
-    public function getWidth()
-    {
-        if ($this->_width) {
-            $ret = $this->_width;
-        } else {
-            $ret = '';
-        }
+	/**
+	 * @return bool|string
+	 */
+	public function getWidth()
+	{
+		if ($this->_width) {
+			$ret = $this->_width;
+		} else {
+			$ret = '';
+		}
 
-        return $ret;
-    }
+		return $ret;
+	}
 
-    /**
-     * @return bool
-     */
-    public function getCustomCaption()
-    {
-        return $this->_customCaption;
-    }
+	/**
+	 * @return bool
+	 */
+	public function getCustomCaption()
+	{
+		return $this->_customCaption;
+	}
 }

class/ObjectController.php

Doc Comments +5 added lines, -5 removed lines

@@ -126,9 +126,9 @@ 
 
     /**
      * @param        $smartObj
-     * @param        $objectid
-     * @param        $created_success_msg
-     * @param        $modified_success_msg
+     * @param        integer $objectid
+     * @param        string $created_success_msg
+     * @param        string $modified_success_msg
      * @param  bool  $redirect_page
      * @param  bool  $debug
      * @return mixed
@@ -440,7 +440,7 @@ 
     }
 
     /**
-     * @param         $smartObj
+     * @param         MlObject $smartObj
      * @param  bool   $onlyUrl
      * @param  bool   $withimage
      * @return string
@@ -498,7 +498,7 @@ 
     }
 
     /**
-     * @param $smartObj
+     * @param BaseSmartObject $smartObj
      * @return string
      */
     public function getPrintAndMailLink($smartObj)

Indentation +506 added lines, -506 removed lines

@@ -33,511 +33,511 @@
  */
 class ObjectController
 {
-    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]) && '1' == $_POST['delete_' . $key]) {
-                        $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'])) {
+	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]) && '1' == $_POST['delete_' . $key]) {
+						$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'])) {
 //            require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartuploader.php';
-            $uploaderObj = new Uploader($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 (XOBJ_DTYPE_FILE === $smartObj->vars[$related_field]['data_type']) {
-                                $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 PermissionHandler($this->handler);
-                $smartPermissionsHandler->storeAllPermissionsForId($smartObj->id());
-            }
-        }
-
-        if (null === $redirect_page) {
-            return $smartObj;
-        } else {
-            if (!$storeResult) {
-                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
-            }
-
-            $redirect_page = $redirect_page ?: Smartobject\Utility::getPageBeforeForm();
-
-            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 void
-     * @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 = \Xmf\Request::getInt('confirm', 0, POST);
-        if ($confirm) {
-            if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
-            }
-
-            redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
-        } else {
-            // no confirm: show deletion condition
-
-            xoops_cp_header();
-
-            if (!$confirm_msg) {
-                $confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
-            }
-
-            xoops_confirm([
-                              '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 = \Xmf\Request::getInt('confirm', 0, POST);
-        if ($confirm) {
-            if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
-            }
-
-            redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
-        } else {
-            // no confirm: show deletion condition
-            if (!$confirm_msg) {
-                $confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
-            }
-
-            ob_start();
-            xoops_confirm([
-                              '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       = Smartobject\Utility::getModuleModeSEO($this->handler->_moduleName);
-        $seoModuleName = Smartobject\Utility::getModuleNameForSEO($this->handler->_moduleName);
-
-        /**
-         * $seoIncludeId feature is not finished yet, so let's put it always to true
-         */
-        //$seoIncludeId = Smartobject\Utility::getModuleIncludeIdSEO($this->handler->_moduleName);
-        $seoIncludeId = true;
-
-        if ('rewrite' === $seoMode) {
-            $ret = XOOPS_URL . '/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
-        } elseif ('pathinfo' === $seoMode) {
-            $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 = Smartobject\Utility::getModuleInfo($smartObj->handler->_moduleName);
-        $link        = Smartobject\Utility::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;
-    }
+			$uploaderObj = new Uploader($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 (XOBJ_DTYPE_FILE === $smartObj->vars[$related_field]['data_type']) {
+								$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 PermissionHandler($this->handler);
+				$smartPermissionsHandler->storeAllPermissionsForId($smartObj->id());
+			}
+		}
+
+		if (null === $redirect_page) {
+			return $smartObj;
+		} else {
+			if (!$storeResult) {
+				redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
+			}
+
+			$redirect_page = $redirect_page ?: Smartobject\Utility::getPageBeforeForm();
+
+			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 void
+	 * @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 = \Xmf\Request::getInt('confirm', 0, POST);
+		if ($confirm) {
+			if (!$this->handler->delete($smartObj)) {
+				redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+			}
+
+			redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
+		} else {
+			// no confirm: show deletion condition
+
+			xoops_cp_header();
+
+			if (!$confirm_msg) {
+				$confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
+			}
+
+			xoops_confirm([
+							  '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 = \Xmf\Request::getInt('confirm', 0, POST);
+		if ($confirm) {
+			if (!$this->handler->delete($smartObj)) {
+				redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+			}
+
+			redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
+		} else {
+			// no confirm: show deletion condition
+			if (!$confirm_msg) {
+				$confirm_msg = _CO_SOBJECT_DELETE_CONFIRM;
+			}
+
+			ob_start();
+			xoops_confirm([
+							  '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       = Smartobject\Utility::getModuleModeSEO($this->handler->_moduleName);
+		$seoModuleName = Smartobject\Utility::getModuleNameForSEO($this->handler->_moduleName);
+
+		/**
+		 * $seoIncludeId feature is not finished yet, so let's put it always to true
+		 */
+		//$seoIncludeId = Smartobject\Utility::getModuleIncludeIdSEO($this->handler->_moduleName);
+		$seoIncludeId = true;
+
+		if ('rewrite' === $seoMode) {
+			$ret = XOOPS_URL . '/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
+		} elseif ('pathinfo' === $seoMode) {
+			$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 = Smartobject\Utility::getModuleInfo($smartObj->handler->_moduleName);
+		$link        = Smartobject\Utility::getCurrentPage();
+		$mid         = $smartModule->getVar('mid');
+		$friendlink  = "<a href=\"javascript:openWithSelfMain('"
+					   . SMARTOBJECT_URL
+					   . 'sendlink.php?link='
+					   . $link
+					   . '&amp;mid='
+					   . $mid
+					   . "', ',',',',',','sendmessage', 674, 500);\"><img src=\""
+					   . SMARTOBJECT_IMAGES_ACTIONS_URL
+					   . 'mail_send.png"  alt="'
+					   . _CO_SOBJECT_EMAIL
+					   . '" title="'
+					   . _CO_SOBJECT_EMAIL
+					   . '" style="vertical-align: middle;"></a>';
+
+		$ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';
+
+		return $ret;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getModuleItemString()
+	{
+		$ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;
+
+		return $ret;
+	}
 }

Spacing +46 added lines, -46 removed lines

@@ -52,15 +52,15 @@ 
         foreach (array_keys($smartObj->vars) as $key) {
             switch ($smartObj->vars[$key]['data_type']) {
                 case XOBJ_DTYPE_IMAGE:
-                    if (isset($_POST['url_' . $key]) && '' !== $_POST['url_' . $key]) {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
-                        $smartObj->setVar($key, $_POST['url_' . $key]);
+                    if (isset($_POST['url_'.$key]) && '' !== $_POST['url_'.$key]) {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
+                        $smartObj->setVar($key, $_POST['url_'.$key]);
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
                         }
                     }
-                    if (isset($_POST['delete_' . $key]) && '1' == $_POST['delete_' . $key]) {
-                        $oldFile = $smartObj->getUploadDir(true) . $smartObj->getVar($key, 'e');
+                    if (isset($_POST['delete_'.$key]) && '1' == $_POST['delete_'.$key]) {
+                        $oldFile = $smartObj->getUploadDir(true).$smartObj->getVar($key, 'e');
                         $smartObj->setVar($key, '');
                         if (file_exists($oldFile)) {
                             unlink($oldFile);
@@ -70,10 +70,10 @@ 
 
                 case XOBJ_DTYPE_URLLINK:
                     $linkObj = $smartObj->getUrlLinkObj($key);
-                    $linkObj->setVar('caption', $_POST['caption_' . $key]);
-                    $linkObj->setVar('description', $_POST['desc_' . $key]);
-                    $linkObj->setVar('target', $_POST['target_' . $key]);
-                    $linkObj->setVar('url', $_POST['url_' . $key]);
+                    $linkObj->setVar('caption', $_POST['caption_'.$key]);
+                    $linkObj->setVar('description', $_POST['desc_'.$key]);
+                    $linkObj->setVar('target', $_POST['target_'.$key]);
+                    $linkObj->setVar('url', $_POST['url_'.$key]);
                     if ('' !== $linkObj->getVar('url')) {
                         $smartObj->storeUrlLinkObj($linkObj);
                     }
@@ -82,11 +82,11 @@ 
                     break;
 
                 case XOBJ_DTYPE_FILE:
-                    if (!isset($_FILES['upload_' . $key]['name']) || '' === $_FILES['upload_' . $key]['name']) {
+                    if (!isset($_FILES['upload_'.$key]['name']) || '' === $_FILES['upload_'.$key]['name']) {
                         $fileObj = $smartObj->getFileObj($key);
-                        $fileObj->setVar('caption', $_POST['caption_' . $key]);
-                        $fileObj->setVar('description', $_POST['desc_' . $key]);
-                        $fileObj->setVar('url', $_POST['url_' . $key]);
+                        $fileObj->setVar('caption', $_POST['caption_'.$key]);
+                        $fileObj->setVar('description', $_POST['desc_'.$key]);
+                        $fileObj->setVar('url', $_POST['url_'.$key]);
                         if (!('' === $fileObj->getVar('url') && '' === $fileObj->getVar('url')
                               && '' === $fileObj->getVar('url'))) {
                             $res = $smartObj->storeFileObj($fileObj);
@@ -110,7 +110,7 @@ 
                         $value = strtotime($_POST[$key]);
                         //if strtotime returns false, the value is already a time stamp
                         if (!$value) {
-                            $value = (int)$_POST[$key];
+                            $value = (int) $_POST[$key];
                         }
                     }
                     $smartObj->setVar($key, $value);
@@ -159,7 +159,7 @@ 
                 if (isset($file_array['name']) && '' !== $file_array['name']
                     && in_array(str_replace('upload_', '', $name), array_keys($smartObj->vars))) {
                     if ($uploaderObj->fetchMedia($name)) {
-                        $uploaderObj->setTargetFileName(time() . '_' . $uploaderObj->getMediaName());
+                        $uploaderObj->setTargetFileName(time().'_'.$uploaderObj->getMediaName());
                         if ($uploaderObj->upload()) {
                             // Find the related field in the SmartObject
                             $related_field   = str_replace('upload_', '', $name);
@@ -168,14 +168,14 @@ 
                             if (XOBJ_DTYPE_FILE === $smartObj->vars[$related_field]['data_type']) {
                                 $object_fileurl = $smartObj->getUploadDir();
                                 $fileObj        = $smartObj->getFileObj($related_field);
-                                $fileObj->setVar('url', $object_fileurl . $uploaderObj->getSavedFileName());
-                                $fileObj->setVar('caption', $_POST['caption_' . $related_field]);
-                                $fileObj->setVar('description', $_POST['desc_' . $related_field]);
+                                $fileObj->setVar('url', $object_fileurl.$uploaderObj->getSavedFileName());
+                                $fileObj->setVar('caption', $_POST['caption_'.$related_field]);
+                                $fileObj->setVar('description', $_POST['desc_'.$related_field]);
                                 $smartObj->storeFileObj($fileObj);
                                 //todo: catch errors
                                 $smartObj->setVar($related_field, $fileObj->getVar('fileid'));
                             } else {
-                                $old_file = $smartObj->getUploadDir(true) . $smartObj->getVar($related_field);
+                                $old_file = $smartObj->getUploadDir(true).$smartObj->getVar($related_field);
                                 unlink($old_file);
                                 $smartObj->setVar($related_field, $uploaderObj->getSavedFileName());
                             }
@@ -206,7 +206,7 @@ 
             return $smartObj;
         } else {
             if (!$storeResult) {
-                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($smart_previous_page, 3, _CO_SOBJECT_SAVE_ERROR.$smartObj->getHtmlErrors());
             }
 
             $redirect_page = $redirect_page ?: Smartobject\Utility::getPageBeforeForm();
@@ -235,7 +235,7 @@ 
         $debug = false,
         $x_param = false
     ) {
-        $objectid = isset($_POST[$this->handler->keyName]) ? (int)$_POST[$this->handler->keyName] : 0;
+        $objectid = isset($_POST[$this->handler->keyName]) ? (int) $_POST[$this->handler->keyName] : 0;
         if ($debug) {
             if ($x_param) {
                 $smartObj = $this->handler->getD($objectid, true, $x_param);
@@ -311,7 +311,7 @@ 
     {
         global $smart_previous_page;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -321,7 +321,7 @@ 
         $confirm = \Xmf\Request::getInt('confirm', 0, POST);
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
             }
 
             redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
@@ -354,7 +354,7 @@ 
     {
         global $smart_previous_page, $xoopsTpl;
 
-        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int)$_REQUEST[$this->handler->keyName] : 0;
+        $objectid = isset($_REQUEST[$this->handler->keyName]) ? (int) $_REQUEST[$this->handler->keyName] : 0;
         $smartObj = $this->handler->get($objectid);
 
         if ($smartObj->isNew()) {
@@ -364,7 +364,7 @@ 
         $confirm = \Xmf\Request::getInt('confirm', 0, POST);
         if ($confirm) {
             if (!$this->handler->delete($smartObj)) {
-                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR . $smartObj->getHtmlErrors());
+                redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_ERROR.$smartObj->getHtmlErrors());
             }
 
             redirect_header($_POST['redirect_page'], 3, _CO_SOBJECT_DELETE_SUCCESS);
@@ -396,14 +396,14 @@ 
      */
     public function getAdminViewItemLink(SmartObject $smartObj, $onlyUrl = false, $withimage = false)
     {
-        $ret = $this->handler->_moduleUrl . 'admin/' . $this->handler->_page . '?op=view&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret = $this->handler->_moduleUrl.'admin/'.$this->handler->_page.'?op=view&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "viewmag.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_ADMIN_VIEW . "'  title='" . _CO_SOBJECT_ADMIN_VIEW . "'></a>";
+            return "<a href='".$ret."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."viewmag.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_ADMIN_VIEW."'  title='"._CO_SOBJECT_ADMIN_VIEW."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -425,15 +425,15 @@ 
         $seoIncludeId = true;
 
         if ('rewrite' === $seoMode) {
-            $ret = XOOPS_URL . '/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
+            $ret = XOOPS_URL.'/'.$seoModuleName.'.'.$this->handler->_itemname.($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').'/'.$smartObj->getVar('short_url').'.html';
         } elseif ('pathinfo' === $seoMode) {
-            $ret = SMARTOBJECT_URL . 'seo.php/' . $seoModuleName . '.' . $this->handler->_itemname . ($seoIncludeId ? '.' . $smartObj->getVar($this->handler->keyName) : '') . '/' . $smartObj->getVar('short_url') . '.html';
+            $ret = SMARTOBJECT_URL.'seo.php/'.$seoModuleName.'.'.$this->handler->_itemname.($seoIncludeId ? '.'.$smartObj->getVar($this->handler->keyName) : '').'/'.$smartObj->getVar('short_url').'.html';
         } else {
-            $ret = $this->handler->_moduleUrl . $this->handler->_page . '?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+            $ret = $this->handler->_moduleUrl.$this->handler->_page.'?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         }
 
         if (!$onlyUrl) {
-            $ret = "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+            $ret = "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
         }
 
         return $ret;
@@ -447,14 +447,14 @@ 
      */
     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');
+        $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."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."wizard.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_LANGUAGE_MODIFY."'  title='"._CO_SOBJECT_LANGUAGE_MODIFY."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -467,14 +467,14 @@ 
     public function getEditItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=mod&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=mod&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "edit.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_MODIFY . "'  title='" . _CO_SOBJECT_MODIFY . "'></a>";
+            return "<a href='".$ret."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."edit.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_MODIFY."'  title='"._CO_SOBJECT_MODIFY."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -487,14 +487,14 @@ 
     public function getDeleteItemLink($smartObj, $onlyUrl = false, $withimage = true, $userSide = false)
     {
         $admin_side = $userSide ? '' : 'admin/';
-        $ret        = $this->handler->_moduleUrl . $admin_side . $this->handler->_page . '?op=del&' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
+        $ret        = $this->handler->_moduleUrl.$admin_side.$this->handler->_page.'?op=del&'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
         if ($onlyUrl) {
             return $ret;
         } elseif ($withimage) {
-            return "<a href='" . $ret . "'><img src='" . SMARTOBJECT_IMAGES_ACTIONS_URL . "editdelete.png' style='vertical-align: middle;' alt='" . _CO_SOBJECT_DELETE . "'  title='" . _CO_SOBJECT_DELETE . "'></a>";
+            return "<a href='".$ret."'><img src='".SMARTOBJECT_IMAGES_ACTIONS_URL."editdelete.png' style='vertical-align: middle;' alt='"._CO_SOBJECT_DELETE."'  title='"._CO_SOBJECT_DELETE."'></a>";
         }
 
-        return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . '</a>';
+        return "<a href='".$ret."'>".$smartObj->getVar($this->handler->identifierName).'</a>';
     }
 
     /**
@@ -505,9 +505,9 @@ 
     {
         global $xoopsConfig;
 
-        $printlink = $this->handler->_moduleUrl . 'print.php?' . $this->handler->keyName . '=' . $smartObj->getVar($this->handler->keyName);
-        $js        = "javascript:openWithSelfMain('" . $printlink . "', 'smartpopup', 700, 519);";
-        $printlink = '<a href="' . $js . '"><img  src="' . SMARTOBJECT_IMAGES_ACTIONS_URL . 'fileprint.png" alt="" style="vertical-align: middle;"></a>';
+        $printlink = $this->handler->_moduleUrl.'print.php?'.$this->handler->keyName.'='.$smartObj->getVar($this->handler->keyName);
+        $js        = "javascript:openWithSelfMain('".$printlink."', 'smartpopup', 700, 519);";
+        $printlink = '<a href="'.$js.'"><img  src="'.SMARTOBJECT_IMAGES_ACTIONS_URL.'fileprint.png" alt="" style="vertical-align: middle;"></a>';
 
         $smartModule = Smartobject\Utility::getModuleInfo($smartObj->handler->_moduleName);
         $link        = Smartobject\Utility::getCurrentPage();
@@ -526,7 +526,7 @@ 
                        . _CO_SOBJECT_EMAIL
                        . '" style="vertical-align: middle;"></a>';
 
-        $ret = '<span id="smartobject_print_button">' . $printlink . '&nbsp;</span>' . '<span id="smartobject_mail_button">' . $friendlink . '</span>';
+        $ret = '<span id="smartobject_print_button">'.$printlink.'&nbsp;</span>'.'<span id="smartobject_mail_button">'.$friendlink.'</span>';
 
         return $ret;
     }
@@ -536,7 +536,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->handler->_moduleName . '_' . $this->handler->_itemname;
+        $ret = $this->handler->_moduleName.'_'.$this->handler->_itemname;
 
         return $ret;
     }

class/PermissionHandler.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +199 added lines, -199 removed lines

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

class/PersistableObjectHandler.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +976 added lines, -976 removed lines

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

Spacing +48 added lines, -48 removed lines

@@ -150,18 +150,18 @@ 
 
         $this->_itemname      = $itemname;
         $this->_moduleName    = $modulename;
-        $this->table          = $db->prefix($modulename . '_' . $itemname);
+        $this->table          = $db->prefix($modulename.'_'.$itemname);
         $this->keyName        = $keyname;
 //        $this->className      = ucfirst($modulename) . ucfirst($itemname);
         $this->className      = $itemname;
 
         $this->identifierName = $idenfierName;
         $this->summaryName    = $summaryName;
-        $this->_page          = $itemname . '.php';
-        $this->_modulePath    = XOOPS_ROOT_PATH . '/modules/' . $this->_moduleName . '/';
-        $this->_moduleUrl     = XOOPS_URL . '/modules/' . $this->_moduleName . '/';
-        $this->_uploadPath    = XOOPS_UPLOAD_PATH . '/' . $this->_moduleName . '/';
-        $this->_uploadUrl     = XOOPS_UPLOAD_URL . '/' . $this->_moduleName . '/';
+        $this->_page          = $itemname.'.php';
+        $this->_modulePath    = XOOPS_ROOT_PATH.'/modules/'.$this->_moduleName.'/';
+        $this->_moduleUrl     = XOOPS_URL.'/modules/'.$this->_moduleName.'/';
+        $this->_uploadPath    = XOOPS_UPLOAD_PATH.'/'.$this->_moduleName.'/';
+        $this->_uploadUrl     = XOOPS_UPLOAD_URL.'/'.$this->_moduleName.'/';
     }
 
     /**
@@ -203,7 +203,7 @@ 
         $smartPermissionsHandler = new PermissionHandler($this);
         $grantedItems            = $smartPermissionsHandler->getGrantedItems($perm_name);
         if (count($grantedItems) > 0) {
-            $criteria->add(new \Criteria($this->keyName, '(' . implode(', ', $grantedItems) . ')', 'IN'));
+            $criteria->add(new \Criteria($this->keyName, '('.implode(', ', $grantedItems).')', 'IN'));
 
             return true;
         } else {
@@ -243,7 +243,7 @@ 
     {
 //        $obj0 = new $this->className($this);
 
-        $obj =  new $this->className;
+        $obj = new $this->className;
 
         $obj->setImageDir($this->getImageUrl(), $this->getImagePath());
         if (!$obj->handler) {
@@ -262,7 +262,7 @@ 
      */
     public function getImageUrl()
     {
-        return $this->_uploadUrl . $this->_itemname . '/';
+        return $this->_uploadUrl.$this->_itemname.'/';
     }
 
     /**
@@ -270,12 +270,12 @@ 
      */
     public function getImagePath()
     {
-        $dir = $this->_uploadPath . $this->_itemname;
+        $dir = $this->_uploadPath.$this->_itemname;
         if (!file_exists($dir)) {
             Smartobject\Utility::mkdirAsAdmin($dir);
         }
 
-        return $dir . '/';
+        return $dir.'/';
     }
 
     /**
@@ -314,7 +314,7 @@ 
         if ($debug) {
             $obj_array = $this->getObjectsD($criteria, false, $as_object);
         } else {
-            $obj_array =& $this->getObjects($criteria, false, $as_object);
+            $obj_array = & $this->getObjects($criteria, false, $as_object);
             //patch: weird bug of indexing by id even if id_as_key = false;
             if (!isset($obj_array[0]) && is_object($obj_array[$id])) {
                 $obj_array[0] = $obj_array[$id];
@@ -368,13 +368,13 @@ 
         if ($this->generalSQL) {
             $sql = $this->generalSQL;
         } elseif (!$sql) {
-            $sql = 'SELECT * FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT * FROM '.$this->table.' AS '.$this->_itemname;
         }
 
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ('' !== $criteria->getSort()) {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -403,12 +403,12 @@ 
         $ret = [];
 
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby) {
                 $sql .= $criteria->getGroupby();
             }
             if ('' !== $criteria->getSort()) {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
         }
         if ($debug) {
@@ -481,18 +481,18 @@ 
             $obj->assignVars($myrow);
             if (!$id_as_key) {
                 if ($as_object) {
-                    $ret[] =& $obj;
+                    $ret[] = & $obj;
                 } else {
                     $ret[] = $obj->toArray();
                 }
             } else {
                 if ($as_object) {
-                    $value =& $obj;
+                    $value = & $obj;
                 } else {
                     $value = $obj->toArray();
                 }
                 if ('parentid' === $id_as_key) {
-                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] =& $value;
+                    $ret[$obj->getVar('parentid', 'e')][$obj->getVar($this->keyName)] = & $value;
                 } else {
                     $ret[$obj->getVar($this->keyName)] = $value;
                 }
@@ -535,15 +535,15 @@ 
             $criteria->setSort($this->getIdentifierName());
         }
 
-        $sql = 'SELECT ' . (is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
+        $sql = 'SELECT '.(is_array($this->keyName) ? implode(', ', $this->keyName) : $this->keyName);
         if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->getIdentifierName();
+            $sql .= ', '.$this->getIdentifierName();
         }
-        $sql .= ' FROM ' . $this->table . ' AS ' . $this->_itemname;
+        $sql .= ' FROM '.$this->table.' AS '.$this->_itemname;
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ('' !== $criteria->getSort()) {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -580,7 +580,7 @@ 
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
             if ('' !== $criteria->groupby) {
                 $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+                $field   = $criteria->groupby.', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
             }
         }
         /**
@@ -591,10 +591,10 @@ 
             $sql = $this->generalSQL;
             $sql = str_replace('SELECT *', 'SELECT COUNT(*)', $sql);
         } else {
-            $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table . ' AS ' . $this->_itemname;
+            $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table.' AS '.$this->_itemname;
         }
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ('' !== $criteria->groupby) {
                 $sql .= $criteria->getGroupby();
             }
@@ -637,13 +637,13 @@ 
         if (is_array($this->keyName)) {
             $clause = [];
             for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                $clause[] = $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
             }
             $whereclause = implode(' AND ', $clause);
         } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+            $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
         }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+        $sql = 'DELETE FROM '.$this->table.' WHERE '.$whereclause;
         if (false !== $force) {
             $result = $this->db->queryF($sql);
         } else {
@@ -704,7 +704,7 @@ 
              * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
              */
             if (!is_a($obj, $this->className)) {
-                $obj->setError(get_class($obj) . ' Differs from ' . $this->className);
+                $obj->setError(get_class($obj).' Differs from '.$this->className);
 
                 return false;
             }
@@ -765,7 +765,7 @@ 
         $fieldsToStoreInDB = [];
         foreach ($obj->cleanVars as $k => $v) {
             if (XOBJ_DTYPE_INT == $obj->vars[$k]['data_type']) {
-                $cleanvars[$k] = (int)$v;
+                $cleanvars[$k] = (int) $v;
             } elseif (is_array($v)) {
                 $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
             } else {
@@ -778,13 +778,13 @@ 
         if ($obj->isNew()) {
             if (!is_array($this->keyName)) {
                 if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+                    $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq');
                 }
             }
 
-            $sql = 'INSERT INTO ' . $this->table . ' (' . implode(',', array_keys($fieldsToStoreInDB)) . ') VALUES (' . implode(',', array_values($fieldsToStoreInDB)) . ')';
+            $sql = 'INSERT INTO '.$this->table.' ('.implode(',', array_keys($fieldsToStoreInDB)).') VALUES ('.implode(',', array_values($fieldsToStoreInDB)).')';
         } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
+            $sql = 'UPDATE '.$this->table.' SET';
             foreach ($fieldsToStoreInDB as $key => $value) {
                 if ((!is_array($this->keyName) && $key == $this->keyName)
                     || (is_array($this->keyName)
@@ -794,7 +794,7 @@ 
                 if (isset($notfirst)) {
                     $sql .= ',';
                 }
-                $sql      .= ' ' . $key . ' = ' . $value;
+                $sql .= ' '.$key.' = '.$value;
                 $notfirst = true;
             }
             if (is_array($this->keyName)) {
@@ -803,12 +803,12 @@ 
                     if ($i > 0) {
                         $whereclause .= ' AND ';
                     }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                    $whereclause .= $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
                 }
             } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+                $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
             }
-            $sql .= ' WHERE ' . $whereclause;
+            $sql .= ' WHERE '.$whereclause;
         }
 
         if ($debug) {
@@ -881,7 +881,7 @@ 
      */
     public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = null, $force = false)
     {
-        $set_clause = $fieldname . ' = ';
+        $set_clause = $fieldname.' = ';
         if (is_numeric($fieldvalue)) {
             $set_clause .= $fieldvalue;
         } elseif (is_array($fieldvalue)) {
@@ -889,9 +889,9 @@ 
         } else {
             $set_clause .= $this->db->quoteString($fieldvalue);
         }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+        $sql = 'UPDATE '.$this->table.' SET '.$set_clause;
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
         }
         if (false !== $force) {
             $result = $this->db->queryF($sql);
@@ -915,8 +915,8 @@ 
     public function deleteAll(CriteriaElement $criteria = null)
     {
         if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql = 'DELETE FROM '.$this->table;
+            $sql .= ' '.$criteria->renderWhere();
             if (!$this->db->query($sql)) {
                 return false;
             }
@@ -949,7 +949,7 @@ 
      */
     public function getModuleItemString()
     {
-        $ret = $this->_moduleName . '_' . $this->_itemname;
+        $ret = $this->_moduleName.'_'.$this->_itemname;
 
         return $ret;
     }
@@ -961,7 +961,7 @@ 
     {
         if (isset($object->vars['counter'])) {
             $new_counter = $object->getVar('counter') + 1;
-            $sql         = 'UPDATE ' . $this->table . ' SET counter=' . $new_counter . ' WHERE ' . $this->keyName . '=' . $object->id();
+            $sql         = 'UPDATE '.$this->table.' SET counter='.$new_counter.' WHERE '.$this->keyName.'='.$object->id();
             $this->query($sql, null, true);
         }
     }
@@ -1005,7 +1005,7 @@ 
     public function getIdentifierName($withprefix = true)
     {
         if ($withprefix) {
-            return $this->_itemname . '.' . $this->identifierName;
+            return $this->_itemname.'.'.$this->identifierName;
         } else {
             return $this->identifierName;
         }

class/SingleView.php

Doc Comments +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
 
     /**
      * Constructor
-     * @param       $object
+     * @param       BaseSmartObject $object
      * @param bool  $userSide
      * @param array $actions
      * @param bool  $headerAsRow
@@ -46,7 +46,7 @@ 
     }
 
     /**
-     * @param $rowObj
+     * @param ObjectRow $rowObj
      */
     public function addRow($rowObj)
     {

Indentation +82 added lines, -82 removed lines

@@ -23,94 +23,94 @@
  */
 class SingleView
 {
-    public $_object;
-    public $_userSide;
-    public $_tpl;
-    public $_rows;
-    public $_actions;
-    public $_headerAsRow = true;
+	public $_object;
+	public $_userSide;
+	public $_tpl;
+	public $_rows;
+	public $_actions;
+	public $_headerAsRow = true;
 
-    /**
-     * Constructor
-     * @param       $object
-     * @param bool  $userSide
-     * @param array $actions
-     * @param bool  $headerAsRow
-     */
-    public function __construct($object, $userSide = false, $actions = [], $headerAsRow = true)
-    {
-        $this->_object      = $object;
-        $this->_userSide    = $userSide;
-        $this->_actions     = $actions;
-        $this->_headerAsRow = $headerAsRow;
-    }
+	/**
+	 * Constructor
+	 * @param       $object
+	 * @param bool  $userSide
+	 * @param array $actions
+	 * @param bool  $headerAsRow
+	 */
+	public function __construct($object, $userSide = false, $actions = [], $headerAsRow = true)
+	{
+		$this->_object      = $object;
+		$this->_userSide    = $userSide;
+		$this->_actions     = $actions;
+		$this->_headerAsRow = $headerAsRow;
+	}
 
-    /**
-     * @param $rowObj
-     */
-    public function addRow($rowObj)
-    {
-        $this->_rows[] = $rowObj;
-    }
+	/**
+	 * @param $rowObj
+	 */
+	public function addRow($rowObj)
+	{
+		$this->_rows[] = $rowObj;
+	}
 
-    /**
-     * @param  bool $fetchOnly
-     * @param  bool $debug
-     * @return mixed|string|void
-     */
-    public function render($fetchOnly = false, $debug = false)
-    {
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
+	/**
+	 * @param  bool $fetchOnly
+	 * @param  bool $debug
+	 * @return mixed|string|void
+	 */
+	public function render($fetchOnly = false, $debug = false)
+	{
+		require_once XOOPS_ROOT_PATH . '/class/template.php';
 
-        $this->_tpl             = new \XoopsTpl();
-        $vars                   = $this->_object->vars;
-        $smartobjectObjectArray = [];
+		$this->_tpl             = new \XoopsTpl();
+		$vars                   = $this->_object->vars;
+		$smartobjectObjectArray = [];
 
-        foreach ($this->_rows as $row) {
-            $key = $row->getKeyName();
-            if ($row->_customMethodForValue && method_exists($this->_object, $row->_customMethodForValue)) {
-                $method = $row->_customMethodForValue;
-                $value  = $this->_object->$method();
-            } else {
-                $value = $this->_object->getVar($row->getKeyName());
-            }
-            if ($row->isHeader()) {
-                $this->_tpl->assign('smartobject_single_view_header_caption', $this->_object->vars[$key]['form_caption']);
-                $this->_tpl->assign('smartobject_single_view_header_value', $value);
-            } else {
-                $smartobjectObjectArray[$key]['value']   = $value;
-                $smartobjectObjectArray[$key]['header']  = $row->isHeader();
-                $smartobjectObjectArray[$key]['caption'] = $this->_object->vars[$key]['form_caption'];
-            }
-        }
-        $action_row = '';
-        if (in_array('edit', $this->_actions)) {
-            $action_row .= $this->_object->getEditItemLink(false, true, true);
-        }
-        if (in_array('delete', $this->_actions)) {
-            $action_row .= $this->_object->getDeleteItemLink(false, true, true);
-        }
-        if ($action_row) {
-            $smartobjectObjectArray['zaction']['value']   = $action_row;
-            $smartobjectObjectArray['zaction']['caption'] = _CO_SOBJECT_ACTIONS;
-        }
+		foreach ($this->_rows as $row) {
+			$key = $row->getKeyName();
+			if ($row->_customMethodForValue && method_exists($this->_object, $row->_customMethodForValue)) {
+				$method = $row->_customMethodForValue;
+				$value  = $this->_object->$method();
+			} else {
+				$value = $this->_object->getVar($row->getKeyName());
+			}
+			if ($row->isHeader()) {
+				$this->_tpl->assign('smartobject_single_view_header_caption', $this->_object->vars[$key]['form_caption']);
+				$this->_tpl->assign('smartobject_single_view_header_value', $value);
+			} else {
+				$smartobjectObjectArray[$key]['value']   = $value;
+				$smartobjectObjectArray[$key]['header']  = $row->isHeader();
+				$smartobjectObjectArray[$key]['caption'] = $this->_object->vars[$key]['form_caption'];
+			}
+		}
+		$action_row = '';
+		if (in_array('edit', $this->_actions)) {
+			$action_row .= $this->_object->getEditItemLink(false, true, true);
+		}
+		if (in_array('delete', $this->_actions)) {
+			$action_row .= $this->_object->getDeleteItemLink(false, true, true);
+		}
+		if ($action_row) {
+			$smartobjectObjectArray['zaction']['value']   = $action_row;
+			$smartobjectObjectArray['zaction']['caption'] = _CO_SOBJECT_ACTIONS;
+		}
 
-        $this->_tpl->assign('smartobject_header_as_row', $this->_headerAsRow);
-        $this->_tpl->assign('smartobject_object_array', $smartobjectObjectArray);
+		$this->_tpl->assign('smartobject_header_as_row', $this->_headerAsRow);
+		$this->_tpl->assign('smartobject_object_array', $smartobjectObjectArray);
 
-        if ($fetchOnly) {
-            return $this->_tpl->fetch('db:smartobject_singleview_display.tpl');
-        } else {
-            $this->_tpl->display('db:smartobject_singleview_display.tpl');
-        }
-    }
+		if ($fetchOnly) {
+			return $this->_tpl->fetch('db:smartobject_singleview_display.tpl');
+		} else {
+			$this->_tpl->display('db:smartobject_singleview_display.tpl');
+		}
+	}
 
-    /**
-     * @param  bool $debug
-     * @return mixed|string|void
-     */
-    public function fetch($debug = false)
-    {
-        return $this->render(true, $debug);
-    }
+	/**
+	 * @param  bool $debug
+	 * @return mixed|string|void
+	 */
+	public function fetch($debug = false)
+	{
+		return $this->render(true, $debug);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      */
     public function render($fetchOnly = false, $debug = false)
     {
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
+        require_once XOOPS_ROOT_PATH.'/class/template.php';
 
         $this->_tpl             = new \XoopsTpl();
         $vars                   = $this->_object->vars;