Passed
Pull Request — master (#2)
by Michael
02:17
created

SysUtility::truncateHtml()   F

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

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

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