SysUtility::truncateHtml()   F
last analyzed

Complexity

Conditions 19
Paths 194

Size

Total Lines 89
Code Lines 47

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 19
eloc 47
nc 194
nop 5
dl 0
loc 89
rs 3.7333
c 2
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 declare(strict_types=1);
2
3
namespace XoopsModules\Contact\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      https://www.fsf.org/copyleft/gpl.html GNU public license
20
 * @copyright    https://xoops.org 2000-2020 &copy; XOOPS Project
21
 * @author       ZySpec <[email protected]>
22
 * @author       Mamba <[email protected]>
23
 */
24
25
use XoopsModules\Contact\Helper;
26
27
/**
28
 * Class SysUtility
29
 */
30
class SysUtility
31
{
32
    use VersionChecks;
0 ignored issues
show
introduced by
The trait XoopsModules\Contact\Common\VersionChecks requires some properties which are not provided by XoopsModules\Contact\Common\SysUtility: $tag_name, $prerelease
Loading history...
33
34
    //checkVerXoops, checkVerPhp Traits
35
36
    use ServerStats;
37
38
    // getServerStats Trait
39
40
    use FilesManagement;
41
42
    // Files Management Trait
43
44
    /**
45
     * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags
46
     * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags
47
     * www.cakephp.org
48
     *
49
     * @param string $text         String to truncate.
50
     * @param int    $length       Length of returned string, including ellipsis.
51
     * @param string $ending       Ending to be appended to the trimmed string.
52
     * @param bool   $exact        If false, $text will not be cut mid-word
53
     * @param bool   $considerHtml If true, HTML tags would be handled correctly
54
     *
55
     * @return string Trimmed string.
56
     */
57
    public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true): string
58
    {
59
        if ($considerHtml) {
60
            // if the plain text is shorter than the maximum length, return the whole text
61
            if (mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) {
62
                return $text;
63
            }
64
            // splits all html-tags to scanable lines
65
            \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER);
66
            $total_length = mb_strlen($ending);
67
            $open_tags    = [];
68
            $truncate     = '';
69
            foreach ($lines as $line_matchings) {
70
                // if there is any html-tag in this line, handle it and add it (uncounted) to the output
71
                if (!empty($line_matchings[1])) {
72
                    // if it's an "empty element" with or without xhtml-conform closing slash
73
                    if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) {
74
                        // do nothing
75
                        // if tag is a closing tag
76
                    } elseif (\preg_match('/^<\s*\/(\S+?)\s*>$/s', $line_matchings[1], $tag_matchings)) {
77
                        // delete tag from $open_tags list
78
                        $pos = \array_search($tag_matchings[1], $open_tags, true);
79
                        if (false !== $pos) {
80
                            unset($open_tags[$pos]);
81
                        }
82
                        // if tag is an opening tag
83
                    } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
84
                        // add tag to the beginning of $open_tags list
85
                        \array_unshift($open_tags, \mb_strtolower($tag_matchings[1]));
86
                    }
87
                    // add html-tag to $truncate'd text
88
                    $truncate .= $line_matchings[1];
89
                }
90
                // calculate the length of the plain text part of the line; handle entities as one character
91
                $content_length = mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2]));
92
                if ($total_length + $content_length > $length) {
93
                    // the number of characters which are left
94
                    $left            = $length - $total_length;
95
                    $entities_length = 0;
96
                    // search for html entities
97
                    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)) {
98
                        // calculate the real length of all entities in the legal range
99
                        foreach ($entities[0] as $entity) {
100
                            if ($left >= $entity[1] + 1 - $entities_length) {
101
                                $left--;
102
                                $entities_length += mb_strlen($entity[0]);
103
                            } else {
104
                                // no more characters left
105
                                break;
106
                            }
107
                        }
108
                    }
109
                    $truncate .= mb_substr($line_matchings[2], 0, $left + $entities_length);
110
                    // maximum lenght is reached, so get off the loop
111
                    break;
112
                }
113
                $truncate     .= $line_matchings[2];
114
                $total_length += $content_length;
115
116
                // if the maximum length is reached, get off the loop
117
                if ($total_length >= $length) {
118
                    break;
119
                }
120
            }
121
        } else {
122
            if (mb_strlen($text) <= $length) {
123
                return $text;
124
            }
125
            $truncate = mb_substr($text, 0, $length - mb_strlen($ending));
126
        }
127
        // if the words shouldn't be cut in the middle...
128
        if (!$exact) {
129
            // ...search the last occurance of a space...
130
            $spacepos = mb_strrpos($truncate, ' ');
131
            if (isset($spacepos)) {
132
                // ...and cut the text in this position
133
                $truncate = mb_substr($truncate, 0, $spacepos);
134
            }
135
        }
136
        // add the defined ending to the text
137
        $truncate .= $ending;
138
        if ($considerHtml) {
139
            // close all unclosed html-tags
140
            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...
141
                $truncate .= '</' . $tag . '>';
142
            }
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
166
        if (null === $helper) {
167
            $helper = Helper::getInstance();
168
        }
169
170
        $isAdmin = $helper->isUserAdmin();
171
172
        if (\class_exists('XoopsFormEditor')) {
173
            if ($isAdmin) {
174
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea');
175
            } else {
176
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea');
177
            }
178
        } else {
179
            $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

179
            $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

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