SysUtility::getEditor() - Code Metrics - Inspection of "Merge pull request #12 from mambax7/master" - XoopsModules25x/xlanguage - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( cb7af7...fe5258 )

by Michael

created 2020-09-11 10:24 UTC

SysUtility::getEditor() A

↳ Parent: SysUtility

Complexity

Conditions	5
Paths	12

Size

Total Lines	31
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	19
nc	12
nop	2
dl	0
loc	31
rs	9.3222
c	1
b	0
f	0

<?php

namespace XoopsModules\Xlanguage\Common;

/*
 Utility Class Definition

 You may not change or alter any portion of this comment or credits of
 supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit
 authors.

 This program is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 *
 * @license      https://www.fsf.org/copyleft/gpl.html GNU public license
 * @copyright    https://xoops.org 2000-2020 &copy; XOOPS Project
 * @author       ZySpec <[email protected]>
 * @author       Mamba <[email protected]>
 */

use MyTextSanitizer;
use XoopsFormDhtmlTextArea;
use XoopsFormTextArea;
use XoopsModules\Xlanguage\{
    Helper
};
/** @var Helper $helper */

/**
 * Class SysUtility
 */
class SysUtility
{
    use VersionChecks;


    //checkVerXoops, checkVerPhp Traits

    use ServerStats;

    // getServerStats Trait

    use FilesManagement;

    // Files Management Trait

    /**
     * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags
     * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags
     * www.cakephp.org
     *
     * @param string $text         String to truncate.
     * @param int    $length       Length of returned string, including ellipsis.
     * @param string $ending       Ending to be appended to the trimmed string.
     * @param bool   $exact        If false, $text will not be cut mid-word
     * @param bool   $considerHtml If true, HTML tags would be handled correctly
     *
     * @return string Trimmed string.
     */
    public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true)
    {
        $open_tags    = [];
        if ($considerHtml) {
            // if the plain text is shorter than the maximum length, return the whole text
            if (mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) {
                return $text;
            }
            // splits all html-tags to scanable lines
            \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER);
            $total_length = mb_strlen($ending);
            $truncate     = '';
            foreach ($lines as $line_matchings) {
                // if there is any html-tag in this line, handle it and add it (uncounted) to the output
                if (!empty($line_matchings[1])) {
                    // if it's an "empty element" with or without xhtml-conform closing slash
                    if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) {
                        // do nothing
                        // if tag is a closing tag
                    } elseif (\preg_match('/^<\s*\/([^\S]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) {
                        // delete tag from $open_tags list
                        $pos = \array_search($tag_matchings[1], $open_tags, true);
                        if (false !== $pos) {
                            unset($open_tags[$pos]);
                        }
                        // if tag is an opening tag
                    } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
                        // add tag to the beginning of $open_tags list
                        \array_unshift($open_tags, mb_strtolower($tag_matchings[1]));
                    }
                    // add html-tag to $truncate'd text
                    $truncate .= $line_matchings[1];
                }
                // calculate the length of the plain text part of the line; handle entities as one character
                $content_length = mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2]));
                if ($total_length + $content_length > $length) {
                    // the number of characters which are left
                    $left            = $length - $total_length;
                    $entities_length = 0;
                    // search for html entities
                    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)) {
                        // calculate the real length of all entities in the legal range
                        foreach ($entities[0] as $entity) {
                            if ($left >= $entity[1] + 1 - $entities_length) {
                                $left--;
                                $entities_length += mb_strlen($entity[0]);
                            } else {
                                // no more characters left
                                break;
                            }
                        }
                    }
                    $truncate .= mb_substr($line_matchings[2], 0, $left + $entities_length);
                    // maximum lenght is reached, so get off the loop
                    break;
                }
                $truncate     .= $line_matchings[2];
                $total_length += $content_length;

                // if the maximum length is reached, get off the loop
                if ($total_length >= $length) {
                    break;
                }
            }
        } else {
            if (mb_strlen($text) <= $length) {
                return $text;
            }
            $truncate = mb_substr($text, 0, $length - mb_strlen($ending));
        }
        // if the words shouldn't be cut in the middle...
        if (!$exact) {
            // ...search the last occurance of a space...
            $spacepos = mb_strrpos($truncate, ' ');
            if (isset($spacepos)) {
                // ...and cut the text in this position
                $truncate = mb_substr($truncate, 0, $spacepos);
            }
        }
        // add the defined ending to the text
        $truncate .= $ending;
        if ($considerHtml) {
            // close all unclosed html-tags
            foreach ($open_tags as $tag) {
                $truncate .= '</' . $tag . '>';
            }
        }

        return $truncate;
    }

    /**
     * @param null|Helper       $helper
     * @param array|null $options
     * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor
     */
    public static function getEditor($helper = null, $options = null)
    {
        if (null === $options) {
            $options           = [];
            $options['name']   = 'Editor';
            $options['value']  = 'Editor';
            $options['rows']   = 10;
            $options['cols']   = '100%';
            $options['width']  = '100%';
            $options['height'] = '400px';
        }

        if (null === $helper) {
            $helper = Helper::getInstance();
        }

        $isAdmin = $helper->isUserAdmin();

        if (\class_exists('XoopsFormEditor')) {
            if ($isAdmin) {
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea');
            } else {
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea');
            }
        } else {
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], 5, 50);
        }

        //        $form->addElement($descEditor);

        return $descEditor;
    }

    /**
     * @param $fieldname
     * @param $table
     *
     * @return bool
     */
    public function fieldExists($fieldname, $table)
    {
        global $xoopsDB;
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");

        return ($xoopsDB->getRowsNum($result) > 0);
    }
}


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

XoopsModules25x / xlanguage

Push — master ( cb7af7...fe5258 )

SysUtility::getEditor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like