class/Utility.php
<?php namespace XoopsModules\Cardealer;
/*
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.
*/
/**
* Module: cardealer
*
* @category Module
* @package cardealer
* @author XOOPS Development Team <mambax7@gmail.com> - <https://xoops.org>
* @copyright {@link https://xoops.org/ XOOPS Project}
* @license GPL 2.0 or later
* @link https://xoops.org/
* @since 1.0.0
*/
use Xmf\Request;
use XoopsModules\Cardealer;
use XoopsModules\Cardealer\Common;
/**
* Class Utility
*/
class Utility
{
use Common\VersionChecks; //checkVerXoops, checkVerPhp Traits
use Common\ServerStats; // getServerStats Trait
use Common\FilesManagement; // Files Management Trait
//--------------- Custom module methods -----------------------------
/**
* @param $text
* @param $form_sort
* @return string
*/
public static function selectSorting($text, $form_sort)
{
global $start, $order, $file_cat, $sort, $xoopsModule;
$select_view = '';
$moduleDirName = basename(dirname(__DIR__));
$helper = Cardealer\Helper::getInstance();
$pathModIcon16 = XOOPS_URL . '/modules/' . $moduleDirName . '/' . $helper->getModule()->getInfo('modicons16');
$select_view = '<form name="form_switch" id="form_switch" action="' . Request::getString('REQUEST_URI', '', 'SERVER') . '" method="post"><span style="font-weight: bold;">' . $text . '</span>';
if ($form_sort == $sort) {
$sel1 = 'asc' === $order ? 'selasc.png' : 'asc.png';
$sel2 = 'desc' === $order ? 'seldesc.png' : 'desc.png';
} else {
$sel1 = 'asc.png';
$sel2 = 'desc.png';
}
$select_view .= ' <a href="' . Request::getString('PHP_SELF', '', 'SERVER') . '?start=' . $start . '&sort=' . $form_sort . '&order=asc" /><img src="' . $pathModIcon16 . '/' . $sel1 . '" title="ASC" alt="ASC"></a>';
$select_view .= '<a href="' . Request::getString('PHP_SELF', '', 'SERVER') . '?start=' . $start . '&sort=' . $form_sort . '&order=desc" /><img src="' . $pathModIcon16 . '/' . $sel2 . '" title="DESC" alt="DESC"></a>';
$select_view .= '</form>';
return $select_view;
}
/***************Blocks***************/
/**
* @param array $cats
* @return string
*/
public static function blockAddCatSelect($cats)
{
$cat_sql = '';
if (is_array($cats)) {
$cat_sql = '(' . current($cats);
array_shift($cats);
foreach ($cats as $cat) {
$cat_sql .= ',' . $cat;
}
$cat_sql .= ')';
}
return $cat_sql;
}
/**
* @param $content
*/
public static function metaKeywords($content)
{
global $xoopsTpl, $xoTheme;
$myts = \MyTextSanitizer::getInstance();
$content = $myts->undoHtmlSpecialChars($myts->displayTarea($content));
if (null !== $xoTheme && is_object($xoTheme)) {
$xoTheme->addMeta('meta', 'keywords', strip_tags($content));
} else { // Compatibility for old Xoops versions
$xoopsTpl->assign('xoops_metaKeywords', strip_tags($content));
}
}
/**
* @param $content
*/
public static function metaDescription($content)
{
global $xoopsTpl, $xoTheme;
$myts = \MyTextSanitizer::getInstance();
$content = $myts->undoHtmlSpecialChars($myts->displayTarea($content));
if (null !== $xoTheme && is_object($xoTheme)) {
$xoTheme->addMeta('meta', 'description', strip_tags($content));
} else { // Compatibility for old Xoops versions
$xoopsTpl->assign('xoops_metaDescription', strip_tags($content));
}
}
/**
* @param $tableName
* @param $columnName
*
* @return array
*/
public static function enumerate($tableName, $columnName)
{
$table = $GLOBALS['xoopsDB']->prefix($tableName);
$sql = 'SELECT COLUMN_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = "' . $table . '" AND COLUMN_NAME = "' . $columnName . '"';
$result = $GLOBALS['xoopsDB']->query($sql);
if (!$result) {
exit ($GLOBALS['xoopsDB']->error());
}
$row = $GLOBALS['xoopsDB']->fetchBoth($result);
$enumList = explode(',', str_replace("'", '', substr($row['COLUMN_TYPE'], 5, -6)));
return $enumList;
}
/**
* @param array|string $tableName
* @param int $id_field
* @param int $id
*
* @return mixed
*/
public static function cloneRecord($tableName, $id_field, $id)
{
$new_id = false;
$table = $GLOBALS['xoopsDB']->prefix($tableName);
// copy content of the record you wish to clone
$tempTable = $GLOBALS['xoopsDB']->fetchArray($GLOBALS['xoopsDB']->query("SELECT * FROM $table WHERE $id_field='$id' "), MYSQLI_ASSOC) or exit('Could not select record');
// set the auto-incremented id's value to blank.
unset($tempTable[$id_field]);
// insert cloned copy of the original record
$result = $GLOBALS['xoopsDB']->queryF("INSERT INTO $table (" . implode(', ', array_keys($tempTable)) . ") VALUES ('" . implode("', '", array_values($tempTable)) . "')") or exit ($GLOBALS['xoopsDB']->error());
if ($result) {
// Return the new id
$new_id = $GLOBALS['xoopsDB']->getInsertId();
}
return $new_id;
}
/**
* truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags
* www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags
* www.cakephp.org
*
* @param string $text String to truncate.
* @param integer $length Length of returned string, including ellipsis.
* @param string $ending Ending to be appended to the trimmed string.
* @param boolean $exact If false, $text will not be cut mid-word
* @param boolean $considerHtml If true, HTML tags would be handled correctly
*
* @return string Trimmed string.
*/
public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true)
{
if ($considerHtml) {
// if the plain text is shorter than the maximum length, return the whole text
if (strlen(preg_replace('/<.*?' . '>/', '', $text)) <= $length) {
return $text;
}
// splits all html-tags to scanable lines
preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, PREG_SET_ORDER);
$total_length = strlen($ending);
$openTags = [];
$truncate = '';
foreach ($lines as $line_matchings) {
// if there is any html-tag in this line, handle it and add it (uncounted) to the output
if (!empty($line_matchings[1])) {
// if it's an "empty element" with or without xhtml-conform closing slash
if (preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) {
// do nothing
// if tag is a closing tag
} elseif (preg_match('/^<\s*\/([^\s]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) {
// delete tag from $openTags list
$pos = array_search($tag_matchings[1], $openTags);
if (false !== $pos) {
unset($openTags[$pos]);
}
// if tag is an opening tag
} elseif (preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
// add tag to the beginning of $openTags list
array_unshift($openTags, strtolower($tag_matchings[1]));
}
// add html-tag to $truncate'd text
$truncate .= $line_matchings[1];
}
// calculate the length of the plain text part of the line; handle entities as one character
$content_length = strlen(preg_replace('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2]));
if ($total_length + $content_length > $length) {
// the number of characters which are left
$left = $length - $total_length;
$entities_length = 0;
// search for html entities
if (preg_match_all('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', $line_matchings[2], $entities, PREG_OFFSET_CAPTURE)) {
// calculate the real length of all entities in the legal range
foreach ($entities[0] as $entity) {
if ($entity[1] + 1 - $entities_length <= $left) {
$left--;
$entities_length += strlen($entity[0]);
} else {
// no more characters left
break;
}
}
}
$truncate .= substr($line_matchings[2], 0, $left + $entities_length);
// maximum lenght is reached, so get off the loop
break;
} else {
$truncate .= $line_matchings[2];
$total_length += $content_length;
}
// if the maximum length is reached, get off the loop
if ($total_length >= $length) {
break;
}
}
} else {
if (strlen($text) <= $length) {
return $text;
} else {
$truncate = substr($text, 0, $length - strlen($ending));
}
}
// if the words shouldn't be cut in the middle...
if (!$exact) {
// ...search the last occurance of a space...
$spacepos = strrpos($truncate, ' ');
if (isset($spacepos)) {
// ...and cut the text in this position
$truncate = substr($truncate, 0, $spacepos);
}
}
// add the defined ending to the text
$truncate .= $ending;
if ($considerHtml) {
// close all unclosed html-tags
foreach ($openTags as $tag) {
$truncate .= '</' . $tag . '>';
}
}
return $truncate;
}
}