SysUtility::truncateHtml()   F
last analyzed

Complexity

Conditions 19
Paths 194

Size

Total Lines 89
Code Lines 47

Duplication

Lines 0
Ratio 0 %

Importance

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

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 declare(strict_types=1);
2
3
namespace XoopsModules\Smartfaq\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
 * @license      GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
20
 * @copyright    XOOPS Project (https://xoops.org)
21
 * @author       ZySpec <[email protected]>
22
 * @author       Mamba <[email protected]>
23
 */
24
25
use XoopsFormEditor;
26
use XoopsModules\Smartfaq\Helper;
27
28
/**
29
 * Class SysUtility
30
 */
31
class SysUtility
32
{
33
    use VersionChecks;
0 ignored issues
show
introduced by
The trait XoopsModules\Smartfaq\Common\VersionChecks requires some properties which are not provided by XoopsModules\Smartfaq\Common\SysUtility: $tag_name, $prerelease
Loading history...
34
35
    //checkVerXoops, checkVerPhp Traits
36
37
    use ServerStats;
38
39
    // getServerStats Trait
40
41
    use FilesManagement;
42
43
    // Files Management Trait
44
45
    /**
46
     * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags
47
     * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags
48
     * www.cakephp.org
49
     *
50
     * @param string $text         String to truncate.
51
     * @param int    $length       Length of returned string, including ellipsis.
52
     * @param string $ending       Ending to be appended to the trimmed string.
53
     * @param bool   $exact        If false, $text will not be cut mid-word
54
     * @param bool   $considerHtml If true, HTML tags would be handled correctly
55
     *
56
     * @return string Trimmed string.
57
     */
58
    public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true)
59
    {
60
        if ($considerHtml) {
61
            // if the plain text is shorter than the maximum length, return the whole text
62
            if (mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) {
63
                return $text;
64
            }
65
            // splits all html-tags to scanable lines
66
            \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER);
67
            $total_length = mb_strlen($ending);
68
            $open_tags    = [];
69
            $truncate     = '';
70
            foreach ($lines as $line_matchings) {
71
                // if there is any html-tag in this line, handle it and add it (uncounted) to the output
72
                if (!empty($line_matchings[1])) {
73
                    // if it's an "empty element" with or without xhtml-conform closing slash
74
                    if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) {
75
                        // do nothing
76
                        // if tag is a closing tag
77
                    } elseif (\preg_match('/^<\s*\/(\S+?)\s*>$/', $line_matchings[1], $tag_matchings)) {
78
                        // delete tag from $open_tags list
79
                        $pos = \array_search($tag_matchings[1], $open_tags, true);
80
                        if (false !== $pos) {
81
                            unset($open_tags[$pos]);
82
                        }
83
                        // if tag is an opening tag
84
                    } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
85
                        // add tag to the beginning of $open_tags list
86
                        \array_unshift($open_tags, \mb_strtolower($tag_matchings[1]));
87
                    }
88
                    // add html-tag to $truncate'd text
89
                    $truncate .= $line_matchings[1];
90
                }
91
                // calculate the length of the plain text part of the line; handle entities as one character
92
                $content_length = mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2]));
93
                if ($total_length + $content_length > $length) {
94
                    // the number of characters which are left
95
                    $left            = $length - $total_length;
96
                    $entities_length = 0;
97
                    // search for html entities
98
                    if (\preg_match_all('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', $line_matchings[2], $entities, \PREG_OFFSET_CAPTURE)) {
99
                        // calculate the real length of all entities in the legal range
100
                        foreach ($entities[0] as $entity) {
101
                            if ($left >= $entity[1] + 1 - $entities_length) {
102
                                $left--;
103
                                $entities_length += mb_strlen($entity[0]);
104
                            } else {
105
                                // no more characters left
106
                                break;
107
                            }
108
                        }
109
                    }
110
                    $truncate .= mb_substr($line_matchings[2], 0, $left + $entities_length);
111
                    // maximum lenght is reached, so get off the loop
112
                    break;
113
                }
114
                $truncate     .= $line_matchings[2];
115
                $total_length += $content_length;
116
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
146
        return $truncate;
147
    }
148
149
    /**
150
     * @param \Xmf\Module\Helper $helper
151
     * @param array|null         $options
152
     * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor
153
     */
154
    public static function getEditor($helper = null, $options = null)
155
    {
156
        /** @var Helper $helper */
157
        if (null === $options) {
158
            $options           = [];
159
            $options['name']   = 'Editor';
160
            $options['value']  = 'Editor';
161
            $options['rows']   = 10;
162
            $options['cols']   = '100%';
163
            $options['width']  = '100%';
164
            $options['height'] = '400px';
165
        }
166
167
        if (null === $helper) {
168
            $helper = Helper::getInstance();
169
        }
170
171
        $isAdmin = $helper->isUserAdmin();
172
173
        if (\class_exists('XoopsFormEditor')) {
174
            if ($isAdmin) {
175
                $descEditor = new XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea');
176
            } else {
177
                $descEditor = new XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea');
178
            }
179
        } else {
180
            $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 $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

180
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], /** @scrutinizer ignore-type */ '100%', '100%');
Loading history...
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

180
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', /** @scrutinizer ignore-type */ '100%');
Loading history...
181
        }
182
183
        //        $form->addElement($descEditor);
184
185
        return $descEditor;
186
    }
187
188
    /**
189
     * @param string $fieldname
190
     * @param string $table
191
     * @return bool
192
     */
193
    public static function fieldExists(string $fieldname, string $table): bool
194
    {
195
        global $xoopsDB;
196
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");
197
198
        return ($xoopsDB->getRowsNum($result) > 0);
199
    }
200
201
    /**
202
     * @param array|string $tableName
203
     * @param array|string $tableName
204
     * @param string       $idField
205
     * @param int          $id
206
     *
207
     * @return mixed
208
     */
209
    public static function cloneRecord($tableName, $idField, $id)
210
    {
211
        $new_id = false;
0 ignored issues
show
Unused Code introduced by
The assignment to $new_id is dead and can be removed.
Loading history...
212
        $table  = $GLOBALS['xoopsDB']->prefix($tableName);
213
        // copy content of the record you wish to clone
214
        $sql    = "SELECT * FROM $table WHERE $idField='" . $id . "' ";
215
        $result = $GLOBALS['xoopsDB']->query($sql);
216
        if ($GLOBALS['xoopsDB']->isResultSet($result)) {
217
            $tempTable = $GLOBALS['xoopsDB']->fetchArray($result, \MYSQLI_ASSOC);
218
        }
219
        if (!$tempTable) {
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $tempTable does not seem to be defined for all execution paths leading up to this point.
Loading history...
220
            \trigger_error($GLOBALS['xoopsDB']->error());
221
        }
222
        // set the auto-incremented id's value to blank.
223
        unset($tempTable[$idField]);
224
        // insert cloned copy of the original  record
225
        $sql    = "INSERT INTO $table (" . \implode(', ', \array_keys($tempTable)) . ") VALUES ('" . \implode("', '", \array_values($tempTable)) . "')";
226
        $result = $GLOBALS['xoopsDB']->queryF($sql);
227
        if (!$result) {
228
            \trigger_error($GLOBALS['xoopsDB']->error());
229
        }
230
        // Return the new id
231
        $new_id = $GLOBALS['xoopsDB']->getInsertId();
232
233
        return $new_id;
234
    }
235
236
    /**
237
     * @param string $tablename
238
     *
239
     * @return bool
240
     */
241
    public static function tableExists($tablename)
242
    {
243
        $result = $GLOBALS['xoopsDB']->queryF("SHOW TABLES LIKE '$tablename'");
244
245
        return $GLOBALS['xoopsDB']->getRowsNum($result) > 0;
246
    }
247
}
248