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