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
cc 19
eloc 47
c 1
b 0
f 0
nc 194
nop 5
dl 0
loc 89
rs 3.7333

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

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

200
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], /** @scrutinizer ignore-type */ '100%', '100%');
Loading history...
201
        }
202
203
        //        $form->addElement($descEditor);
204
205
        return $descEditor;
206
    }
207
208
    /**
209
     * @param $fieldname
210
     * @param $table
211
     *
212
     * @return bool
213
     */
214
    public function fieldExists($fieldname, $table)
215
    {
216
        global $xoopsDB;
217
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");
218
219
        return ($xoopsDB->getRowsNum($result) > 0);
220
    }
221
}
222