1: <?php
  2: /**
  3:  * Xoops Functions
  4:  *
  5:  * You may not change or alter any portion of this comment or credits
  6:  * of supporting developers from this source code or any supporting source code
  7:  * which is considered copyrighted (c) material of the original comment or credit authors.
  8:  * This program is distributed in the hope that it will be useful,
  9:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 11:  *
 12:  * @copyright       XOOPS Project (http://xoops.org)
 13:  * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 14:  * @package         kernel
 15:  * @since           2.0.0
 16:  * @version         $Id$
 17:  */
 18: 
 19: use Xoops\Core\Handler\Factory;
 20: 
 21: /**
 22:  * @deprecated
 23:  * @param string $name
 24:  * @param mixed $optional
 25:  * @return XoopsObjectHandler|XoopsPersistableObjectHandler|null
 26:  */
 27: function xoops_getHandler($name, $optional = false)
 28: {
 29:     $xoops = Xoops::getInstance();
 30:     $xoops->deprecated('xoops_getHandler(\'' . $name . '\') is deprecated. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
 31:     $handler = Factory::newSpec()->scheme('kernel')->name($name)->optional((bool) $optional)->build();
 32:     return $handler;
 33: }
 34: 
 35: /**
 36:  * @deprecated
 37:  * @param string|null $name
 38:  * @param string|null $module_dir
 39:  * @param bool $optional
 40:  * @return bool
 41:  */
 42: function xoops_getModuleHandler($name = null, $module_dir = null, $optional = false)
 43: {
 44:     $xoops = Xoops::getInstance();
 45:     $xoops->deprecated(__FUNCTION__ . ' is deprecated. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
 46:     return $xoops->getModuleHandler($name, $module_dir, $optional);
 47: }
 48: 
 49: /**
 50:  * @deprecated
 51:  * @param string $name Name of class to be loaded
 52:  * @param string $type domain of the class, potential values:
 53:  *                       core - located in /class/;
 54:  *                       framework - located in /Frameworks/;
 55:  *                       other - module class, located in /modules/[$type]/class/
 56:  * @return boolean
 57:  */
 58: function xoops_load($name, $type = 'core')
 59: {
 60:     $xoops = Xoops::getInstance();
 61:     $xoops->deprecated(__FUNCTION__ . ' is deprecated. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
 62:     return XoopsLoad::load($name, $type);
 63: }
 64: 
 65: /**
 66:  * @deprecated
 67:  * @param   string  $name       Name of language file to be loaded, without extension
 68:  * @param   string  $domain     Module dirname; global language file will be loaded if $domain is set to 'global' or not specified
 69:  * @param   string  $language   Language to be loaded, current language content will be loaded if not specified
 70:  * @return  boolean
 71:  * @todo    expand domain to multiple categories, e.g. module:system, framework:filter, etc.
 72:  *
 73:  */
 74: function xoops_loadLanguage($name, $domain = '', $language = null)
 75: {
 76:     $xoops = Xoops::getInstance();
 77:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
 78:     return $xoops->loadLanguage($name, $domain, $language);
 79: }
 80: 
 81: /**
 82:  * @deprecated
 83:  * @return array
 84:  */
 85: function xoops_getActiveModules()
 86: {
 87:     $xoops = Xoops::getInstance();
 88:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
 89:     return $xoops->getActiveModules();
 90: }
 91: 
 92: /**
 93:  * @deprecated
 94:  * @return array
 95:  */
 96: function xoops_setActiveModules()
 97: {
 98:     $xoops = Xoops::getInstance();
 99:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
100:     return $xoops->setActiveModules();
101: }
102: 
103: /**
104:  * @deprecated
105:  * @param string $dirname
106:  * @return bool
107:  */
108: function xoops_isActiveModule($dirname)
109: {
110:     $xoops = Xoops::getInstance();
111:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
112:     return $xoops->isActiveModule($dirname);
113: }
114: 
115: /**
116:  * @deprecated
117:  * @param bool $closehead
118:  * @return void
119:  */
120: function xoops_header($closehead = true)
121: {
122:     $xoops = Xoops::getInstance();
123:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
124:     $xoops->simpleHeader($closehead);
125: }
126: 
127: /**
128:  * @deprecated
129:  * @return void
130:  */
131: function xoops_footer()
132: {
133:     $xoops = Xoops::getInstance();
134:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
135:     $xoops->simpleFooter();
136: }
137: 
138: /**
139:  * @deprecated
140:  * @param mixed $msg
141:  * @param string $title
142:  * @return void
143:  */
144: function xoops_error($msg, $title = '')
145: {
146:     $xoops = Xoops::getInstance();
147:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
148:     echo $xoops->alert('error', $msg, $title);
149: }
150: 
151: /**
152:  * @deprecated
153:  * @param mixed $msg
154:  * @param string $title
155:  * @return void
156:  */
157: function xoops_result($msg, $title = '')
158: {
159:     $xoops = Xoops::getInstance();
160:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
161:     echo $xoops->alert('info', $msg, $title);
162: }
163: 
164: /**
165:  * @deprecated
166:  * @param mixed $hiddens
167:  * @param mixed $action
168:  * @param mixed $msg
169:  * @param string $submit
170:  * @param bool $addtoken
171:  * @return void
172:  */
173: function xoops_confirm($hiddens, $action, $msg, $submit = '', $addtoken = true)
174: {
175:     $xoops = Xoops::getInstance();
176:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
177:     echo $xoops->confirm($hiddens, $action, $msg, $submit, $addtoken);
178: }
179: 
180: /**
181:  * @deprecated
182:  * @param mixed$time
183:  * @param string $timeoffset
184:  * @return int
185:  */
186: function xoops_getUserTimestamp($time, $timeoffset = '')
187: {
188:     $xoops = Xoops::getInstance();
189:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
190:     return $xoops->getUserTimestamp($time, $timeoffset);
191: }
192: 
193: /**
194:  * @deprecated
195:  * @param int $time
196:  * @param string $format
197:  * @param string $timeoffset
198:  * @return string
199:  */
200: function formatTimestamp($time, $format = 'l', $timeoffset = '')
201: {
202:     $xoops = Xoops::getInstance();
203:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
204:     return XoopsLocale::formatTimestamp($time, $format, $timeoffset);
205: }
206: 
207: /**
208:  * @deprecated
209:  * @param int $timestamp
210:  * @param null $userTZ
211:  * @return int
212:  */
213: function userTimeToServerTime($timestamp, $userTZ = null)
214: {
215:     $xoops = Xoops::getInstance();
216:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
217:     return $xoops->userTimeToServerTime($timestamp, $userTZ);
218: }
219: 
220: /**
221:  * @deprecated
222:  * @return string
223:  */
224: function xoops_makepass()
225: {
226:     $xoops = Xoops::getInstance();
227:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
228:     return $xoops->makePass();
229: }
230: 
231: /**
232:  * @deprecated
233:  * @param string $email
234:  * @param bool $antispam
235:  * @return false|string
236:  */
237: function checkEmail($email, $antispam = false)
238: {
239:     $xoops = Xoops::getInstance();
240:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
241:     return $xoops->checkEmail($email, $antispam);
242: }
243: 
244: /**
245:  * @deprecated
246:  * @param string $url
247:  * @return string
248:  */
249: function formatURL($url)
250: {
251:     $xoops = Xoops::getInstance();
252:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
253:     return $xoops->formatURL($url);
254: }
255: 
256: /**
257:  * @deprecated
258:  * @return string
259:  */
260: function xoops_getbanner()
261: {
262:     $xoops = Xoops::getInstance();
263:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
264:     return $xoops->getBanner();
265: }
266: 
267: /**
268:  * @deprecated
269:  * @param string $url
270:  * @param int $time
271:  * @param string $message
272:  * @param bool $addredirect
273:  * @param bool $allowExternalLink
274:  * @return void
275:  */
276: function redirect_header($url, $time = 3, $message = '', $addredirect = true, $allowExternalLink = false)
277: {
278:     $xoops = Xoops::getInstance();
279:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
280:     $xoops->redirect($url, $time, $message, $addredirect, $allowExternalLink);
281: }
282: 
283: /**
284:  * @deprecated
285:  * @param string $key
286:  * @return string
287:  */
288: function xoops_getenv($key)
289: {
290:     $xoops = Xoops::getInstance();
291:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
292:     return $xoops->getEnv($key);
293: }
294: 
295: /**
296:  * @deprecated
297:  * @param string $theme
298:  * @return string
299:  */
300: function xoops_getcss($theme = '')
301: {
302:     $xoops = Xoops::getInstance();
303:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
304:     return $xoops->getCss($theme);
305: }
306: 
307: /**
308:  * @deprecated
309:  * @return XoopsMailer|XoopsMailerLocal
310:  */
311: function xoops_getMailer()
312: {
313:     $xoops = Xoops::getInstance();
314:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
315:     return $xoops->getMailer();
316: }
317: 
318: /**
319:  * @deprecated
320:  * @param int $rank_id
321:  * @param int $posts
322:  * @return array
323:  */
324: function xoops_getrank($rank_id = 0, $posts = 0)
325: {
326:     $xoops = Xoops::getInstance();
327:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
328:     return $xoops->service('userrank')->getUserRank(['rank' => $rank_id, 'posts' => $posts, 'uid' => 0])->getValue();
329: }
330: 
331: /**
332:  * @deprecated
333:  * @param string $str
334:  * @param int $start
335:  * @param int $length
336:  * @param string $trimmarker
337:  * @return string
338:  */
339: function xoops_substr($str, $start, $length, $trimmarker = '...')
340: {
341:     $xoops = Xoops::getInstance();
342:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
343:     return XoopsLocale::substr($str, $start, $length, $trimmarker);
344: }
345: 
346: /**
347:  * @deprecated
348:  * @param int $module_id
349:  * @return boolean|null
350:  */
351: function xoops_notification_deletebymodule($module_id)
352: {
353:     $xoops = Xoops::getInstance();
354:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. Use Notifications module instead.');
355: }
356: 
357: /**
358:  * @deprecated
359:  * @param int $user_id
360:  * @return boolean|null
361:  */
362: function xoops_notification_deletebyuser($user_id)
363: {
364:     $xoops = Xoops::getInstance();
365:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. Use Notifications module instead.');
366: }
367: 
368: /**
369:  * @deprecated
370:  * @param $module_id
371:  * @param $category
372:  * @param $item_id
373:  * @return boolean|null
374:  */
375: function xoops_notification_deletebyitem($module_id, $category, $item_id)
376: {
377:     $xoops = Xoops::getInstance();
378:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. Use Notifications module instead.');
379: }
380: 
381: /**
382:  * @deprecated
383:  * @param int $module_id
384:  * @param int|null $item_id
385:  * @return int
386:  */
387: function xoops_comment_count($module_id, $item_id = null)
388: {
389:     $xoops = Xoops::getInstance();
390:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. Use comments module instead.');
391: }
392: 
393: /**
394:  * @deprecated
395:  * @param int $module_id
396:  * @param int $item_id
397:  * @return boolean|null
398:  */
399: function xoops_comment_delete($module_id, $item_id)
400: {
401:     $xoops = Xoops::getInstance();
402:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. Use comments module instead.');
403: }
404: 
405: /**
406:  * @deprecated
407:  * @param int $module_id
408:  * @param string $perm_name
409:  * @param int|null $item_id
410:  * @return bool
411:  */
412: function xoops_groupperm_deletebymoditem($module_id, $perm_name, $item_id = null)
413: {
414:     $xoops = Xoops::getInstance();
415:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
416:     return $xoops->getHandlerGroupPermission()->deleteByModule($module_id, $perm_name, $item_id);
417: }
418: 
419: /**
420:  * @deprecated
421:  * @param $text
422:  * @return void
423:  */
424: function xoops_utf8_encode(&$text)
425: {
426:     $xoops = Xoops::getInstance();
427:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
428:     XoopsLocale::utf8_encode($text);
429: }
430: 
431: /**
432:  * @deprecated
433:  * @param $text
434:  * @return void
435:  */
436: function xoops_convert_encoding(&$text)
437: {
438:     $xoops = Xoops::getInstance();
439:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
440:     XoopsLocale::utf8_encode($text);
441: }
442: 
443: /**
444:  * @deprecated
445:  * @param $text
446:  * @return string
447:  */
448: function xoops_trim($text)
449: {
450:     $xoops = Xoops::getInstance();
451:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
452:     return XoopsLocale::trim($text);
453: }
454: 
455: /**
456:  * @deprecated
457:  * @param $option
458:  * @return string
459:  */
460: function xoops_getOption($option)
461: {
462:     $xoops = Xoops::getInstance();
463:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
464:     return $xoops->getOption($option);
465: }
466: 
467: /**
468:  * @deprecated
469:  * @param string $option
470:  * @param string|int|array $type
471:  * @return mixed
472:  */
473: function xoops_getConfigOption($option, $type = 'XOOPS_CONF')
474: {
475:     $xoops = Xoops::getInstance();
476:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
477:     return $xoops->getConfig($option);
478: }
479: 
480: /**
481:  * @deprecated
482:  * @param $option
483:  * @param null $new
484:  * @return void
485:  */
486: function xoops_setConfigOption($option, $new = null)
487: {
488:     $xoops = Xoops::getInstance();
489:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
490:     $xoops->setConfig($option, $new);
491: }
492: 
493: /**
494:  * @deprecated
495:  * @param string $option
496:  * @param string $dirname
497:  * @return mixed
498:  */
499: function xoops_getModuleOption($option, $dirname = '')
500: {
501:     $xoops = Xoops::getInstance();
502:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
503:     return $xoops->getModuleConfig($option, $dirname);
504: }
505: 
506: /**
507:  * @deprecated
508:  * @param $url
509:  * @param int $debug
510:  * @return string
511:  */
512: function xoops_getBaseDomain($url, $debug = 0)
513: {
514:     $xoops = Xoops::getInstance();
515:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
516:     return $xoops->getBaseDomain($url);
517: }
518: 
519: /**
520:  * @deprecated
521:  * @param string $url
522:  * @return string
523:  */
524: function xoops_getUrlDomain($url)
525: {
526:     $xoops = Xoops::getInstance();
527:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
528:     return $xoops->getBaseDomain($url, true);
529: }
530: 
531: /**
532:  * function to update compiled template file in templates_c folder
533:  *
534:  * @param string $tpl_id
535:  * @param boolean $clear_old
536:  * @return boolean
537:  */
538: function xoops_template_touch($tpl_id, $clear_old = true)
539: {
540:     $xoops = Xoops::getInstance();
541:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
542:     return $xoops->templateTouch($tpl_id);
543: }
544: 
545: /**
546:  * Clear the module cache
547:  *
548:  * @param int $mid Module ID
549:  * @return void
550:  */
551: function xoops_template_clear_module_cache($mid)
552: {
553:     $xoops = Xoops::getInstance();
554:     $xoops->deprecated(__FUNCTION__ . ' is deprecated since XOOPS 2.6.0. See how to replace it in file ' . __FILE__ . ' line ' . __LINE__);
555:     $xoops->templateClearModuleCache($mid);
556: }
557: 
558: 
559: // general php version compatibility functions
560: 
561: if (!function_exists('http_response_code')) {
562:     /**
563:      * http_response_code - conditionally defined for PHP <5.4
564:      *
565:      * Taken from stackoverflow answer by "dualed,"  see:
566:      * http://stackoverflow.com/questions/3258634/php-how-to-send-http-response-code
567:      *
568:      * @param int $newcode HTTP response code
569:      *
570:      * @return int old status code
571:      */
572:     function http_response_code($newcode = null)
573:     {
574:         static $code = 200;
575:         if ($newcode !== null) {
576:             header('X-PHP-Response-Code: '.$newcode, true, $newcode);
577:             if (!headers_sent()) {
578:                 $code = $newcode;
579:             }
580:         }
581:         return $code;
582:     }
583: }
584: 
585: // ENT_SUBSTITUTE flag for htmlspecialchars() added in PHP 5.4
586: if (!defined('ENT_SUBSTITUTE')) {
587:     define('ENT_SUBSTITUTE', 0);
588: }
589: 
590: /**
591:  * xhtmlspecialchars - a customized version of PHP htmlspecialchars to set the
592:  * flags and encoding parameters to the most approriate values for general use
593:  * in a UTF-8 environment.
594:  *
595:  * This function forces UTF-8 encoding, the ENT_QUOTES flag, and will also use
596:  * the ENT_SUBSTITUTE flag if it is available. This gives the optimal features
597:  * for 5.3 and in >5.4
598:  *
599:  * @param string  $string              string to be encoded
600:  * @param integer $dummy_flags         ignored - for call compatibility only
601:  * @param mixed   $dummy_encoding      ignored - for call compatibility only
602:  * @param mixed   $dummy_double_encode ignored - for call compatibility only
603:  *
604:  * @return string with any characters with special significance in HTML converted to entities
605:  */
606: function xhtmlspecialchars($string, $dummy_flags = 0, $dummy_encoding = '', $dummy_double_encode = true)
607: {
608:     return htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
609: }
610: