SysUtility::fieldExists() - Code Metrics - Inspection of "2.01_Beta-1" - XoopsModules25x/tdmdownloads - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#88)

by Michael
created 2021-08-09 03:00 UTC
SysUtility::fieldExists() A

↳ Parent: SysUtility
Complexity

Conditions	1
Paths	1
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	3
nc	1
nop	2
dl	0
loc	7
rs	10
c	1
b	0
f	0
<?php declare(strict_types=1);

namespace XoopsModules\Tdmdownloads\Common;

/*
 Utility Class Definition

 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.
 */

/**
 * @license      https://www.fsf.org/copyleft/gpl.html GNU public license
 * @copyright    https://xoops.org 2000-2020 &copy; XOOPS Project
 * @author       ZySpec <[email protected]>
 * @author       Mamba <[email protected]>
 */

use XoopsModules\Tdmdownloads\Helper;

/**
 * Class SysUtility
 */
class SysUtility
{
    use VersionChecks;


    //checkVerXoops, checkVerPhp Traits

    use ServerStats;

    // getServerStats Trait

    use FilesManagement;

    // Files Management Trait

    use ImageResizer;

    /**
     * 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 int    $length       Length of returned string, including ellipsis.
     * @param string $ending       Ending to be appended to the trimmed string.
     * @param bool   $exact        If false, $text will not be cut mid-word
     * @param bool   $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 (\mb_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 = \mb_strlen($ending);

            $open_tags = [];

            $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 $open_tags list

                        $pos = \array_search($tag_matchings[1], $open_tags, true);

                        if (false !== $pos) {
                            unset($open_tags[$pos]);
                        }
                        // if tag is an opening tag
                    } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
                        // add tag to the beginning of $open_tags list

                        \array_unshift($open_tags, \mb_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 = \mb_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 ($left >= $entity[1] + 1 - $entities_length) {
                                $left--;

                                $entities_length += \mb_strlen($entity[0]);
                            } else {
                                // no more characters left

                                break;
                            }
                        }
                    }

                    $truncate .= \mb_substr($line_matchings[2], 0, $left + $entities_length);

                    // maximum lenght is reached, so get off the loop

                    break;
                }

                $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 (\mb_strlen($text) <= $length) {
                return $text;
            }

            $truncate = \mb_substr($text, 0, $length - \mb_strlen($ending));
        }

        // if the words shouldn't be cut in the middle...

        if (!$exact) {
            // ...search the last occurance of a space...

            $spacepos = \mb_strrpos($truncate, ' ');

            if (isset($spacepos)) {
                // ...and cut the text in this position

                $truncate = \mb_substr($truncate, 0, $spacepos);
            }
        }

        // add the defined ending to the text

        $truncate .= $ending;

        if ($considerHtml) {
            // close all unclosed html-tags

            foreach ($open_tags as $tag) {

                $truncate .= '</' . $tag . '>';
            }
        }

        return $truncate;
    }

    /**
     * @param \Xmf\Module\Helper $helper
     * @param array|null         $options
     * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor
     */
    public static function getEditor($helper = null, $options = null)
    {
        /** @var Helper $helper */

        if (null === $options) {
            $options = [];

            $options['name'] = 'Editor';

            $options['value'] = 'Editor';

            $options['rows'] = 10;

            $options['cols'] = '100%';

            $options['width'] = '100%';

            $options['height'] = '400px';
        }

        if (null === $helper) {
            $helper = Helper::getInstance();
        }

        $isAdmin = $helper->isUserAdmin();

        if (\class_exists('XoopsFormEditor')) {
            if ($isAdmin) {
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea');
            } else {
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea');
            }
        } else {
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', '100%');
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], /** @scrutinizer ignore-type */ '100%', '100%');
        }

        //        $form->addElement($descEditor);

        return $descEditor;
    }

    /**
     * @param $fieldname
     * @param $table
     *
     * @return bool
     */
    public function fieldExists($fieldname, $table)
    {
        global $xoopsDB;

        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");

        return $xoopsDB->getRowsNum($result) > 0;
    }
}

XoopsModules25x / tdmdownloads

Pull Request — master (#88)

SysUtility::fieldExists() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
