class/Marqueex.php
<?php declare(strict_types=1);
namespace XoopsModules\Marquee;
/**
* ****************************************************************************
* marquee - MODULE FOR XOOPS
* Copyright (c) Hervé Thouzard (https://www.herve-thouzard.com)
*
* You may not change or alter any portion of this comment or credits
* of supporting developers from this source code or any supporting source code
* which is considered copyrighted (c) material of the original comment or credit authors.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* @copyright Hervé Thouzard (https://www.herve-thouzard.com)
* @license GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
* @author Hervé Thouzard (https://www.herve-thouzard.com)
* ****************************************************************************
*/
//require_once XOOPS_ROOT_PATH . '/kernel/object.php';
//require_once XOOPS_ROOT_PATH . '/modules/marquee/class/Utility.php';
//if (!class_exists('MarqueePersistableObjectHandler')) {
// require_once XOOPS_ROOT_PATH . '/modules/marquee/class/PersistableObjectHandler.php';
//}
/**
* Class Marqueex
*/
class Marqueex extends \XoopsObject
{
private $marquee_marqueeid;
private $marquee_uid;
private $marquee_direction;
private $marquee_scrollamount;
private $marquee_behaviour;
private $marquee_bgcolor;
private $marquee_align;
private $marquee_height;
private $marquee_width;
private $marquee_hspace;
private $marquee_scrolldelay;
private $marquee_stoponmouseover;
private $marquee_loop;
private $marquee_vspace;
private $marquee_content;
private $marquee_source;
// To be able to use html
private $dohtml;
/**
* marquee constructor.
*/
public function __construct()
{
parent::__construct();
$this->initVar('marquee_marqueeid', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_uid', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_direction', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_scrollamount', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_behaviour', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_bgcolor', \XOBJ_DTYPE_TXTBOX, null, false, 7);
$this->initVar('marquee_align', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_height', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_width', \XOBJ_DTYPE_TXTBOX, null, false, 4);
$this->initVar('marquee_hspace', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_scrolldelay', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_stoponmouseover', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_loop', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_vspace', \XOBJ_DTYPE_INT, null, false);
$this->initVar('marquee_content', \XOBJ_DTYPE_OTHER, null, false);
$this->initVar('marquee_source', \XOBJ_DTYPE_TXTBOX, null, false, 255);
// To be able to use html
$this->initVar('dohtml', \XOBJ_DTYPE_INT, 1);
}
/**
* @param string $uniqid
*
* @return mixed|string
*/
public function constructMarquee($uniqid = '')
{
// require_once XOOPS_ROOT_PATH . '/modules/marquee/class/Utility.php';
$tblalign = ['top', 'bottom', 'middle'];
$tblbehaviour = ['scroll', 'slide', 'alternate'];
$tbldirection = ['right', 'left', 'up', 'down'];
$stop = 1 == $this->getVar('marquee_stoponmouseover') ? ' onmouseover="this.stop()" onmouseout="this.start()"' : '';
$bgcolor = '' !== \trim($this->getVar('marquee_bgcolor')) ? " bgcolor='" . $this->getVar('marquee_bgcolor') . "'" : '';
$height = 0 != $this->getVar('marquee_height') ? ' height=' . $this->getVar('marquee_height') : '';
$hspace = 0 != $this->getVar('marquee_hspace') ? ' hspace=' . $this->getVar('marquee_hspace') : '';
$width = '' !== \trim($this->getVar('marquee_width')) ? " width='" . $this->getVar('marquee_width') . "'" : '';
$scrolldelay = 0 != $this->getVar('marquee_scrolldelay') ? ' scrolldelay=' . $this->getVar('marquee_scrolldelay') : '';
$loop = 0 != $this->getVar('marquee_loop') ? ' loop=' . $this->getVar('marquee_loop') : " loop='infinite'";
$vspace = 0 != $this->getVar('marquee_vspace') ? ' vspace=' . $this->getVar('marquee_vspace') : '';
$scrollamount = 0 != $this->getVar('marquee_scrollamount') ? ' scrollamount=' . $this->getVar('marquee_scrollamount') : '';
$br = ' - ';
if ($this->getVar('marquee_direction') > 1) {
$br = '<br>';
}
$content = '';
if ('fixed' !== $this->getVar('marquee_source')) {
require_once XOOPS_ROOT_PATH . '/modules/marquee/plugins/' . $this->getVar('marquee_source') . '.php';
$function_name = 'b_marquee_' . $this->getVar('marquee_source'); // For example b_marquee_comments
if (\function_exists($function_name)) {
$limit = Utility::getModuleOption('itemscount');
$dateFormat = Utility::getModuleOption('dateformat');
$itemsSize = Utility::getModuleOption('itemssize');
$retval = $function_name($limit, $dateFormat, $itemsSize);
if ($retval && \is_array($retval)) {
foreach ($retval as $onevalue) {
if (isset($onevalue['category']) && '' !== \xoops_trim($onevalue['category'])) {
$onevalue['category'] = ' - ' . $onevalue['category'];
}
if (isset($onevalue['link']) && '' !== \xoops_trim($onevalue['link'])) {
$onevalue['link'] = ' - ' . $onevalue['link'];
}
$content .= $onevalue['date'] . $onevalue['category'] . $onevalue['link'] . $br;
}
}
}
} else {
$content = $this->getVar('marquee_content');
}
if (!Utility::isBot()) { // We are using the microsoft html tag
if ('dhtml' !== \mb_strtolower(Utility::getModuleOption('methodtouse'))) {
return "<marquee align='"
. $tblalign[$this->getVar('marquee_align')]
. "' behavior='"
. $tblbehaviour[$this->getVar('marquee_behaviour')]
. "' direction='"
. $tbldirection[$this->getVar('marquee_direction')]
. "' "
. $stop
. $scrollamount
. $bgcolor
. $height
. $hspace
. $width
. $scrolldelay
. $loop
. $vspace
. '>'
. $content
. '</marquee>';
} // We are using the javascript method
$jscontent = "<script type=\"text/javascript\">\n";
$jscontent .= "html$uniqid = '';\n";
$jscontent .= "html$uniqid += '" . Utility::javascriptEscape($content) . "' ;\n";
$jscontent .= "marquee$uniqid = new XbMarquee('marquee$uniqid', " . $this->getVar('marquee_height') . ', ' . $this->getVar('marquee_width') . ', ' . $this->getVar('marquee_scrollamount') . ', ' . $this->getVar('marquee_scrolldelay') . ", '" . $tbldirection[$this->getVar(
'marquee_direction'
)] . "', '" . $tblbehaviour[$this->getVar('marquee_behaviour')] . "', html$uniqid);\n";
$jscontent .= "init_$uniqid();\n";
$jscontent .= "</script>\n";
return $jscontent;
}
return $content;
}
}