Utility::getListWaitText() - Code Metrics - ggoffy/wgevents - Measure and Improve Code Quality continuously with Scrutinizer

Utility::getListWaitText() A
last analyzed 2025-11-09 08:21 UTC

↳ Parent: Utility

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	9
c	1
b	0
f	0
nc	3
nop	1
dl	0
loc	13
rs	9.9666

<?php

namespace XoopsModules\Wgevents;

/*
 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.
 */

/**
 * Module:  wgevents
 *
 * @package      \module\wgevents\class
 * @license      http://www.fsf.org/copyleft/gpl.html GNU public license
 * @copyright    https://xoops.org 2001-2017 &copy; XOOPS Project
 * @author       ZySpec <[email protected]>
 * @author       Mamba <[email protected]>
 * @since
 */

use XoopsModules\Wgevents;

/**
 * Class Utility
 */
class Utility
{
    use Common\VersionChecks;


    //checkVerXoops, checkVerPhp Traits

    use Common\ServerStats;

    // getServerStats Trait

    use Common\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)
    {
        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);
            $open_tags    = [];
            $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};|&#[0-9]{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};|&#[0-9]{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
        if ('' != $truncate) {
            $truncate .= $ending;
        }
        if ($considerHtml) {
            // close all unclosed html-tags
            foreach ($open_tags as $tag) {

                $truncate .= '</' . $tag . '>';
            }
        }

        return $truncate;
    }

    /**
     * @public function to convert float into string
     * @param  float $float
     * @return string
     */
    public static function FloatToString($float) {

        $helper = \XoopsModules\Wgevents\Helper::getInstance();
        $dec = $helper->getConfig('sep_comma');
        $thnd = $helper->getConfig('sep_thousand');

        return \number_format($float, 2, $dec, $thnd);

    }

    /**
     * @public function to convert string into float
     * @param  string $str
     * @return float
     */
    public static function StringToFloat($str) {

        $helper = \XoopsModules\Wgevents\Helper::getInstance();
        $dec = $helper->getConfig('sep_comma');
        $thnd = $helper->getConfig('sep_thousand');

        $str = \preg_replace('[^0-9\,\.\-\+]', '', (string)$str);
        $str = \str_replace([$thnd, ' '], '', $str);
        $str = \str_replace($dec, '.', $str);

        return (float)$str;

    }

    /**
     * @public function to get text of status
     * @param $status
     * @return string
     */
    public static function getStatusText($status)
    {
        switch ($status) {
            case '':
            default:
                $status_text = 'invalid status';
                break;
            case Constants::STATUS_NONE:
                $status_text = \_MA_WGEVENTS_STATUS_NONE;
                break;
            case Constants::STATUS_OFFLINE:
                $status_text = \_MA_WGEVENTS_STATUS_OFFLINE;
                break;
            case Constants::STATUS_ONLINE:
                $status_text = \_MA_WGEVENTS_STATUS_ONLINE;
                break;
            case Constants::STATUS_SUBMITTED:
                $status_text = \_MA_WGEVENTS_STATUS_SUBMITTED;
                break;
            case Constants::STATUS_VERIFIED:
                $status_text = \_MA_WGEVENTS_STATUS_VERIFIED;
                break;
            case Constants::STATUS_APPROVED:
                $status_text = \_MA_WGEVENTS_STATUS_APPROVED;
                break;
            case Constants::STATUS_LOCKED:
                $status_text = \_MA_WGEVENTS_STATUS_LOCKED;
                break;
            case Constants::STATUS_CANCELED:
                $status_text = \_MA_WGEVENTS_STATUS_CANCELED;
                break;
            case Constants::STATUS_PENDING:
                $status_text = \_MA_WGEVENTS_STATUS_PENDING;
                break;
            case Constants::STATUS_PROCESSING:
                $status_text = \_MA_WGEVENTS_STATUS_PROCESSING;
                break;
            case Constants::STATUS_DONE:
                $status_text = \_MA_WGEVENTS_STATUS_DONE;
                break;
        }

        return $status_text;

    }

    /**
     * @public function to get text of salutation
     * @param $salutation
     * @return string
     */
    public static function getSalutationText($salutation)
    {
        switch ($salutation) {
            case Constants::SALUTATION_NONE:
            default:
                $salutation_text = '';
                break;
            case Constants::SALUTATION_MEN:
                $salutation_text = \_MA_WGEVENTS_REGISTRATION_SALUTATION_MEN;
                break;
            case Constants::SALUTATION_WOMEN:
                $salutation_text = \_MA_WGEVENTS_REGISTRATION_SALUTATION_WOMEN;
                break;
        }

        return $salutation_text;

    }

    /**
     * @public function to get text of salutation
     * @param $financial
     * @return string
     */
    public static function getFinancialText($financial)
    {
        switch ($financial) {
            case Constants::FINANCIAL_UNPAID:
                $financial_text = \_MA_WGEVENTS_REGISTRATION_FINANCIAL_UNPAID;
                break;
            case Constants::FINANCIAL_PAID:
                $financial_text = \_MA_WGEVENTS_REGISTRATION_FINANCIAL_PAID;
                break;
            case -1:
            default:
                $financial_text = 'Invalid financial';
                break;
        }

        return $financial_text;

    }

    /**
     * @public function to get text of waiting list
     * @param $listwait
     * @return string
     */
    public static function getListWaitText($listwait)
    {
        switch ($listwait) {
            case 1:
                $listwait_text = \_MA_WGEVENTS_REGISTRATION_LISTWAIT_Y;
                break;
            case 0:
            default:
            $listwait_text = \_MA_WGEVENTS_REGISTRATION_LISTWAIT_N;
                break;
        }

        return $listwait_text;

    }
}


1			<?php
2
3			namespace XoopsModules\Wgevents;
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			* Module: wgevents
20			*
21			* @package \module\wgevents\class
22			* @license http://www.fsf.org/copyleft/gpl.html GNU public license
23			* @copyright https://xoops.org 2001-2017 © XOOPS Project
24			* @author ZySpec <[email protected]>
25			* @author Mamba <[email protected]>
26			* @since
27			*/
28
29			use XoopsModules\Wgevents;
30
31			/**
32			* Class Utility
33			*/
34			class Utility
35			{
36			use Common\VersionChecks;
			0 ignored issues – show introduced 2022-02-07 07:49 UTC by Report Bug Copy Issue Report The trait `XoopsModules\Wgevents\Common\VersionChecks` requires some properties which are not provided by `XoopsModules\Wgevents\Utility`: `$tag_name`, `$prerelease` Loading history...
37
38			//checkVerXoops, checkVerPhp Traits
39
40			use Common\ServerStats;
41
42			// getServerStats Trait
43
44			use Common\FilesManagement;
45
46			// Files Management 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($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true)
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};\|&#[0-9]{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};\|&#[0-9]{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 (isset($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			if ('' != $truncate) {
142			$truncate .= $ending;
143			}
144			if ($considerHtml) {
145			// close all unclosed html-tags
146			foreach ($open_tags as $tag) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2022-02-07 07:49 UTC by Report Bug Copy Issue Report The variable `$open_tags` does not seem to be defined for all execution paths leading up to this point. Loading history...
147			$truncate .= '</' . $tag . '>';
148			}
149			}
150
151			return $truncate;
152			}
153
154			/**
155			* @public function to convert float into string
156			* @param float $float
157			* @return string
158			*/
159			public static function FloatToString($float) {
160
161			$helper = \XoopsModules\Wgevents\Helper::getInstance();
162			$dec = $helper->getConfig('sep_comma');
163			$thnd = $helper->getConfig('sep_thousand');
164
165			return \number_format($float, 2, $dec, $thnd);
166
167			}
168
169			/**
170			* @public function to convert string into float
171			* @param string $str
172			* @return float
173			*/
174			public static function StringToFloat($str) {
175
176			$helper = \XoopsModules\Wgevents\Helper::getInstance();
177			$dec = $helper->getConfig('sep_comma');
178			$thnd = $helper->getConfig('sep_thousand');
179
180			$str = \preg_replace('[^0-9\,\.\-\+]', '', (string)$str);
181			$str = \str_replace([$thnd, ' '], '', $str);
182			$str = \str_replace($dec, '.', $str);
183
184			return (float)$str;
185
186			}
187
188			/**
189			* @public function to get text of status
190			* @param $status
191			* @return string
192			*/
193			public static function getStatusText($status)
194			{
195			switch ($status) {
196			case '':
197			default:
198			$status_text = 'invalid status';
199			break;
200			case Constants::STATUS_NONE:
201			$status_text = \_MA_WGEVENTS_STATUS_NONE;
202			break;
203			case Constants::STATUS_OFFLINE:
204			$status_text = \_MA_WGEVENTS_STATUS_OFFLINE;
205			break;
206			case Constants::STATUS_ONLINE:
207			$status_text = \_MA_WGEVENTS_STATUS_ONLINE;
208			break;
209			case Constants::STATUS_SUBMITTED:
210			$status_text = \_MA_WGEVENTS_STATUS_SUBMITTED;
211			break;
212			case Constants::STATUS_VERIFIED:
213			$status_text = \_MA_WGEVENTS_STATUS_VERIFIED;
214			break;
215			case Constants::STATUS_APPROVED:
216			$status_text = \_MA_WGEVENTS_STATUS_APPROVED;
217			break;
218			case Constants::STATUS_LOCKED:
219			$status_text = \_MA_WGEVENTS_STATUS_LOCKED;
220			break;
221			case Constants::STATUS_CANCELED:
222			$status_text = \_MA_WGEVENTS_STATUS_CANCELED;
223			break;
224			case Constants::STATUS_PENDING:
225			$status_text = \_MA_WGEVENTS_STATUS_PENDING;
226			break;
227			case Constants::STATUS_PROCESSING:
228			$status_text = \_MA_WGEVENTS_STATUS_PROCESSING;
229			break;
230			case Constants::STATUS_DONE:
231			$status_text = \_MA_WGEVENTS_STATUS_DONE;
232			break;
233			}
234
235			return $status_text;
236
237			}
238
239			/**
240			* @public function to get text of salutation
241			* @param $salutation
242			* @return string
243			*/
244			public static function getSalutationText($salutation)
245			{
246			switch ($salutation) {
247			case Constants::SALUTATION_NONE:
248			default:
249			$salutation_text = '';
250			break;
251			case Constants::SALUTATION_MEN:
252			$salutation_text = \_MA_WGEVENTS_REGISTRATION_SALUTATION_MEN;
253			break;
254			case Constants::SALUTATION_WOMEN:
255			$salutation_text = \_MA_WGEVENTS_REGISTRATION_SALUTATION_WOMEN;
256			break;
257			}
258
259			return $salutation_text;
260
261			}
262
263			/**
264			* @public function to get text of salutation
265			* @param $financial
266			* @return string
267			*/
268			public static function getFinancialText($financial)
269			{
270			switch ($financial) {
271			case Constants::FINANCIAL_UNPAID:
272			$financial_text = \_MA_WGEVENTS_REGISTRATION_FINANCIAL_UNPAID;
273			break;
274			case Constants::FINANCIAL_PAID:
275			$financial_text = \_MA_WGEVENTS_REGISTRATION_FINANCIAL_PAID;
276			break;
277			case -1:
278			default:
279			$financial_text = 'Invalid financial';
280			break;
281			}
282
283			return $financial_text;
284
285			}
286
287			/**
288			* @public function to get text of waiting list
289			* @param $listwait
290			* @return string
291			*/
292			public static function getListWaitText($listwait)
293			{
294			switch ($listwait) {
295			case 1:
296			$listwait_text = \_MA_WGEVENTS_REGISTRATION_LISTWAIT_Y;
297			break;
298			case 0:
299			default:
300			$listwait_text = \_MA_WGEVENTS_REGISTRATION_LISTWAIT_N;
301			break;
302			}
303
304			return $listwait_text;
305
306			}
307			}
308

ggoffy / wgevents

Utility::getListWaitText() A last analyzed 2025-11-09 08:21 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Utility::getListWaitText() A
last analyzed 2025-11-09 08:21 UTC