Passed
Push — master ( da394c...44937f )
by Michael
05:20
created

SysUtility::truncateHtml()   F

Complexity

Conditions 19
Paths 194

Size

Total Lines 87
Code Lines 47

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 19
eloc 47
nc 194
nop 5
dl 0
loc 87
rs 3.7333
c 1
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace XoopsModules\Marquee\Common;
4
5
/*
6
 Utility Class Definition
7
8
 You may not change or alter any portion of this comment or credits of
9
 supporting developers from this source code or any supporting source code
10
 which is considered copyrighted (c) material of the original comment or credit
11
 authors.
12
13
 This program is distributed in the hope that it will be useful, but
14
 WITHOUT ANY WARRANTY; without even the implied warranty of
15
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16
 */
17
18
/**
19
 *
20
 * @license      https://www.fsf.org/copyleft/gpl.html GNU public license
21
 * @copyright    https://xoops.org 2000-2020 &copy; XOOPS Project
22
 * @author       ZySpec <[email protected]>
23
 * @author       Mamba <[email protected]>
24
 */
25
26
use MyTextSanitizer;
27
use XoopsFormDhtmlTextArea;
28
use XoopsFormTextArea;
29
use XoopsModules\Marquee;
30
31
/**
32
 * Class SysUtility
33
 */
34
class SysUtility
35
{
36
    use VersionChecks;
0 ignored issues
show
introduced by
The trait XoopsModules\Marquee\Common\VersionChecks requires some properties which are not provided by XoopsModules\Marquee\Common\SysUtility: $tag_name, $prerelease
Loading history...
37
38
    //checkVerXoops, checkVerPhp Traits
39
    use ServerStats;
40
41
    // getServerStats Trait
42
    use FilesManagement;
43
44
    // Files Management Trait
45
46
    /**
47
     * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags
48
     * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags
49
     * www.cakephp.org
50
     *
51
     * @param string $text         String to truncate.
52
     * @param int    $length       Length of returned string, including ellipsis.
53
     * @param string $ending       Ending to be appended to the trimmed string.
54
     * @param bool   $exact        If false, $text will not be cut mid-word
55
     * @param bool   $considerHtml If true, HTML tags would be handled correctly
56
     *
57
     * @return string Trimmed string.
58
     */
59
    public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true)
60
    {
61
        if ($considerHtml) {
62
            // if the plain text is shorter than the maximum length, return the whole text
63
            if (mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) {
64
                return $text;
65
            }
66
            // splits all html-tags to scanable lines
67
            \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER);
68
            $total_length = mb_strlen($ending);
69
            $open_tags    = [];
70
            $truncate     = '';
71
            foreach ($lines as $line_matchings) {
72
                // if there is any html-tag in this line, handle it and add it (uncounted) to the output
73
                if (!empty($line_matchings[1])) {
74
                    // if it's an "empty element" with or without xhtml-conform closing slash
75
                    if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) {
76
                        // do nothing
77
                        // if tag is a closing tag
78
                    } elseif (\preg_match('/^<\s*\/([^\s]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) {
79
                        // delete tag from $open_tags list
80
                        $pos = \array_search($tag_matchings[1], $open_tags, true);
81
                        if (false !== $pos) {
82
                            unset($open_tags[$pos]);
83
                        }
84
                        // if tag is an opening tag
85
                    } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
86
                        // add tag to the beginning of $open_tags list
87
                        \array_unshift($open_tags, mb_strtolower($tag_matchings[1]));
88
                    }
89
                    // add html-tag to $truncate'd text
90
                    $truncate .= $line_matchings[1];
91
                }
92
                // calculate the length of the plain text part of the line; handle entities as one character
93
                $content_length = mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2]));
94
                if ($total_length + $content_length > $length) {
95
                    // the number of characters which are left
96
                    $left            = $length - $total_length;
97
                    $entities_length = 0;
98
                    // search for html entities
99
                    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)) {
100
                        // calculate the real length of all entities in the legal range
101
                        foreach ($entities[0] as $entity) {
102
                            if ($left >= $entity[1] + 1 - $entities_length) {
103
                                $left--;
104
                                $entities_length += mb_strlen($entity[0]);
105
                            } else {
106
                                // no more characters left
107
                                break;
108
                            }
109
                        }
110
                    }
111
                    $truncate .= mb_substr($line_matchings[2], 0, $left + $entities_length);
112
                    // maximum lenght is reached, so get off the loop
113
                    break;
114
                }
115
                $truncate     .= $line_matchings[2];
116
                $total_length += $content_length;
117
                // if the maximum length is reached, get off the loop
118
                if ($total_length >= $length) {
119
                    break;
120
                }
121
            }
122
        } else {
123
            if (mb_strlen($text) <= $length) {
124
                return $text;
125
            }
126
            $truncate = mb_substr($text, 0, $length - mb_strlen($ending));
127
        }
128
        // if the words shouldn't be cut in the middle...
129
        if (!$exact) {
130
            // ...search the last occurance of a space...
131
            $spacepos = mb_strrpos($truncate, ' ');
132
            if (isset($spacepos)) {
133
                // ...and cut the text in this position
134
                $truncate = mb_substr($truncate, 0, $spacepos);
135
            }
136
        }
137
        // add the defined ending to the text
138
        $truncate .= $ending;
139
        if ($considerHtml) {
140
            // close all unclosed html-tags
141
            foreach ($open_tags as $tag) {
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $open_tags does not seem to be defined for all execution paths leading up to this point.
Loading history...
142
                $truncate .= '</' . $tag . '>';
143
            }
144
        }
145
        return $truncate;
146
    }
147
148
    /**
149
     * @param \Xmf\Module\Helper $helper
150
     * @param array|null         $options
151
     * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor
152
     */
153
    public static function getEditor($helper = null, $options = null)
154
    {
155
        /** @var Helper $helper */
156
        if (null === $options) {
157
            $options           = [];
158
            $options['name']   = 'Editor';
159
            $options['value']  = 'Editor';
160
            $options['rows']   = 10;
161
            $options['cols']   = '100%';
162
            $options['width']  = '100%';
163
            $options['height'] = '400px';
164
        }
165
        if (null === $helper) {
166
            $helper = Helper::getInstance();
0 ignored issues
show
Bug introduced by
The type XoopsModules\Marquee\Common\Helper was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
167
        }
168
        $isAdmin = $helper->isUserAdmin();
169
        if (\class_exists('XoopsFormEditor')) {
170
            if ($isAdmin) {
171
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea');
172
            } else {
173
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea');
174
            }
175
        } else {
176
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', '100%');
0 ignored issues
show
Bug introduced by
'100%' of type string is incompatible with the type integer expected by parameter $cols of XoopsFormDhtmlTextArea::__construct(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

176
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', /** @scrutinizer ignore-type */ '100%');
Loading history...
Bug introduced by
'100%' of type string is incompatible with the type integer expected by parameter $rows of XoopsFormDhtmlTextArea::__construct(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

176
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], /** @scrutinizer ignore-type */ '100%', '100%');
Loading history...
177
        }
178
        //        $form->addElement($descEditor);
179
        return $descEditor;
180
    }
181
182
    /**
183
     * @param $fieldname
184
     * @param $table
185
     *
186
     * @return bool
187
     */
188
    public function fieldExists($fieldname, $table)
189
    {
190
        global $xoopsDB;
191
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");
192
        return ($xoopsDB->getRowsNum($result) > 0);
193
    }
194
}
195