vendor/contao/core-bundle/src/Resources/contao/helper/functions.php line 104

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. use Contao\ArrayUtil;
  12. use Contao\Folder;
  13. use Contao\StringUtil;
  14. use Contao\System;
  15. use Patchwork\Utf8;
  17. /**
  18.  * Add a log entry
  19.  *
  20.  * @param string $strMessage
  21.  * @param string $strLog
  22.  *
  23.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  24.  *             Use the logger service instead.
  25.  */
  26. function log_message($strMessage, $strLog=null)
  27. {
  28.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "log_message()" has been deprecated and will no longer work in Contao 5.0. Use the logger service instead.');
  30.     if ($strLog === null)
  31.     {
  32.         $strLog = 'prod-' . date('Y-m-d') . '.log';
  33.     }
  35.     $strLogsDir = null;
  37.     if (($container = System::getContainer()) !== null)
  38.     {
  39.         $strLogsDir = $container->getParameter('kernel.logs_dir');
  40.     }
  42.     if (!$strLogsDir)
  43.     {
  44.         $strLogsDir = $container->getParameter('kernel.project_dir') . '/var/logs';
  45.     }
  47.     error_log(sprintf("[%s] %s\n", date('d-M-Y H:i:s'), $strMessage), 3, $strLogsDir . '/' . $strLog);
  48. }
  50. /**
  51.  * Scan a directory and return its files and folders as array
  52.  *
  53.  * @param string  $strFolder
  54.  * @param boolean $blnUncached
  55.  *
  56.  * @return array
  57.  *
  58.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  59.  */
  60. function scan($strFolder, $blnUncached=false)
  61. {
  62.     trigger_deprecation('contao/core-bundle', '4.10', 'Using "scan()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Folder::scan()" instead.');
  64.     return Folder::scan($strFolder, $blnUncached);
  65. }
  67. /**
  68.  * Convert special characters to HTML entities and make sure that
  69.  * entities are never double converted.
  70.  *
  71.  * @param string  $strString
  72.  * @param boolean $blnStripInsertTags
  73.  *
  74.  * @return string
  75.  *
  76.  * @deprecated Using specialchars() has been deprecated and will no longer work in Contao 5.0.
  77.  *             Use StringUtil::specialchars() instead.
  78.  */
  79. function specialchars($strString, $blnStripInsertTags=false)
  80. {
  81.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "specialchars()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::specialchars()" instead.');
  83.     if ($blnStripInsertTags)
  84.     {
  85.         $strString = strip_insert_tags($strString);
  86.     }
  88.     return htmlspecialchars($strString, ENT_QUOTES, System::getContainer()->getParameter('kernel.charset'), false);
  89. }
  91. /**
  92.  * Standardize a parameter (strip special characters and convert spaces)
  93.  *
  94.  * @param string  $strString
  95.  * @param boolean $blnPreserveUppercase
  96.  *
  97.  * @return string
  98.  *
  99.  * @deprecated Using standardize() has been deprecated and will no longer work in Contao 5.0.
  100.  *             Use StringUtil::standardize() instead.
  101.  */
  102. function standardize($strString, $blnPreserveUppercase=false)
  103. {
  104.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "standardize()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::standardize()" instead.');
  106.     $arrSearch = array('/[^\pN\pL \.\&\/_-]+/u', '/[ \.\&\/-]+/');
  107.     $arrReplace = array('', '-');
  109.     $strString = html_entity_decode($strString, ENT_QUOTES, System::getContainer()->getParameter('kernel.charset'));
  110.     $strString = strip_insert_tags($strString);
  111.     $strString = preg_replace($arrSearch, $arrReplace, $strString);
  113.     if (is_numeric(substr($strString, 0, 1)))
  114.     {
  115.         $strString = 'id-' . $strString;
  116.     }
  118.     if (!$blnPreserveUppercase)
  119.     {
  120.         $strString = Utf8::strtolower($strString);
  121.     }
  123.     return trim($strString, '-');
  124. }
  126. /**
  127.  * Remove Contao insert tags from a string
  128.  *
  129.  * @param string $strString
  130.  *
  131.  * @return string
  132.  *
  133.  * @deprecated Using strip_insert_tags() has been deprecated and will no longer work in Contao 5.0.
  134.  *             Use StringUtil::stripInsertTags() instead.
  135.  */
  136. function strip_insert_tags($strString)
  137. {
  138.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "strip_insert_tags()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::stripInsertTags()" instead.');
  140.     $count = 0;
  142.     do
  143.     {
  144.         $strString = preg_replace('/{{[^{}]*}}/', '', $strString, -1, $count);
  145.     } while ($count > 0);
  147.     return $strString;
  148. }
  150. /**
  151.  * Return an unserialized array or the argument
  152.  *
  153.  * @param mixed   $varValue
  154.  * @param boolean $blnForceArray
  155.  *
  156.  * @return mixed
  157.  *
  158.  * @deprecated Using deserialize() has been deprecated and will no longer work in Contao 5.0.
  159.  *             Use StringUtil::deserialize() instead.
  160.  */
  161. function deserialize($varValue, $blnForceArray=false)
  162. {
  163.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "deserialize()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::deserialize()" instead.');
  165.     // Already an array
  166.     if (is_array($varValue))
  167.     {
  168.         return $varValue;
  169.     }
  171.     // Null
  172.     if ($varValue === null)
  173.     {
  174.         return $blnForceArray ? array() : null;
  175.     }
  177.     // Not a string
  178.     if (!is_string($varValue))
  179.     {
  180.         return $blnForceArray ? array($varValue) : $varValue;
  181.     }
  183.     // Empty string
  184.     if (trim($varValue) === '')
  185.     {
  186.         return $blnForceArray ? array() : '';
  187.     }
  189.     // Potentially including an object (see #6724)
  190.     if (preg_match('/[OoC]:\+?[0-9]+:"/', $varValue))
  191.     {
  192.         trigger_error('The deserialize() function does not allow serialized objects', E_USER_WARNING);
  194.         return $blnForceArray ? array($varValue) : $varValue;
  195.     }
  197.     $varUnserialized = @unserialize($varValue, array('allowed_classes' => false));
  199.     if (is_array($varUnserialized))
  200.     {
  201.         $varValue = $varUnserialized;
  202.     }
  203.     elseif ($blnForceArray)
  204.     {
  205.         $varValue = array($varValue);
  206.     }
  208.     return $varValue;
  209. }
  211. /**
  212.  * Split a string into fragments, remove whitespace and return fragments as array
  213.  *
  214.  * @param string $strPattern
  215.  * @param string $strString
  216.  *
  217.  * @return array
  218.  *
  219.  * @deprecated Using trimsplit() has been deprecated and will no longer work in Contao 5.0.
  220.  *             Use StringUtil::trimsplit() instead.
  221.  */
  222. function trimsplit($strPattern, $strString)
  223. {
  224.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "trimsplit()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::trimsplit()" instead.');
  226.     // Split
  227.     if (strlen($strPattern) == 1)
  228.     {
  229.         $arrFragments = array_map('trim', explode($strPattern, $strString));
  230.     }
  231.     else
  232.     {
  233.         $arrFragments = array_map('trim', preg_split('/' . $strPattern . '/ui', $strString));
  234.     }
  236.     // Empty array
  237.     if (count($arrFragments) < 2 && !strlen($arrFragments[0]))
  238.     {
  239.         $arrFragments = array();
  240.     }
  242.     return $arrFragments;
  243. }
  245. /**
  246.  * Convert all ampersands into their HTML entity (default) or unencoded value
  247.  *
  248.  * @param string  $strString
  249.  * @param boolean $blnEncode
  250.  *
  251.  * @return string
  252.  *
  253.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  254.  */
  255. function ampersand($strString, $blnEncode=true)
  256. {
  257.     trigger_deprecation('contao/core-bundle', '4.10', 'Using "ampersand()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::ampersand()" instead.');
  259.     return StringUtil::ampersand($strString, $blnEncode);
  260. }
  262. /**
  263.  * Replace line breaks with HTML5-style <br> tags
  264.  *
  265.  * @param string  $str
  266.  * @param boolean $xhtml
  267.  *
  268.  * @return string
  269.  *
  270.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  271.  */
  272. function nl2br_html5($str, $xhtml=false)
  273. {
  274.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_html5()" has been deprecated and will no longer work in Contao 5.0.');
  276.     return nl2br($str, $xhtml);
  277. }
  279. /**
  280.  * Replace line breaks with XHTML-style <br /> tags
  281.  *
  282.  * @param string $str
  283.  *
  284.  * @return string
  285.  *
  286.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  287.  */
  288. function nl2br_xhtml($str)
  289. {
  290.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_xhtml()" has been deprecated and will no longer work in Contao 5.0.');
  292.     return nl2br($str);
  293. }
  295. /**
  296.  * Replace line breaks with <br> tags preserving preformatted text
  297.  *
  298.  * @param string  $str
  299.  * @param boolean $xhtml
  300.  *
  301.  * @return string
  302.  *
  303.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  304.  */
  305. function nl2br_pre($str, $xhtml=false)
  306. {
  307.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_pre()" has been deprecated and will no longer work in Contao 5.0.');
  309.     return preg_replace('/\r?\n/', $xhtml ? '<br />' : '<br>', $str);
  310. }
  312. /**
  313.  * Compare two file names using a case insensitive "natural order" algorithm
  314.  *
  315.  * @param string $a
  316.  * @param string $b
  317.  *
  318.  * @return integer
  319.  *
  320.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  321.  */
  322. function basename_natcasecmp($a, $b)
  323. {
  324.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "basename_natcasecmp()" has been deprecated and will no longer work in Contao 5.0.');
  326.     return strnatcasecmp(basename($a), basename($b));
  327. }
  329. /**
  330.  * Compare two file names using a case insensitive, reverse "natural order" algorithm
  331.  *
  332.  * @param string $a
  333.  * @param string $b
  334.  *
  335.  * @return integer
  336.  *
  337.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  338.  */
  339. function basename_natcasercmp($a, $b)
  340. {
  341.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "basename_natcasercmp()" has been deprecated and will no longer work in Contao 5.0.');
  343.     return -strnatcasecmp(basename($a), basename($b));
  344. }
  346. /**
  347.  * Sort an array by keys using a case insensitive "natural order" algorithm
  348.  *
  349.  * @param array $arrArray
  350.  *
  351.  * @return array
  352.  *
  353.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  354.  */
  355. function natcaseksort($arrArray)
  356. {
  357.     trigger_deprecation('contao/core-bundle', '4.10', 'Using "natcaseksort()" has been deprecated and will no longer work in Contao 5.0. Use "uksort()" with "strnatcasecmp" instead.');
  359.     uksort($arrArray, 'strnatcasecmp');
  361.     return $arrArray;
  362. }
  364. /**
  365.  * Compare two values based on their length (ascending)
  366.  *
  367.  * @param integer $a
  368.  * @param integer $b
  369.  *
  370.  * @return integer
  371.  *
  372.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  373.  */
  374. function length_sort_asc($a, $b)
  375. {
  376.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "length_sort_asc()" has been deprecated and will no longer work in Contao 5.0. Use a closure instead.');
  378.     return strlen($a) - strlen($b);
  379. }
  381. /**
  382.  * Compare two values based on their length (descending)
  383.  *
  384.  * @param integer $a
  385.  * @param integer $b
  386.  *
  387.  * @return integer
  388.  *
  389.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  390.  */
  391. function length_sort_desc($a, $b)
  392. {
  393.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "length_sort_desc()" has been deprecated and will no longer work in Contao 5.0. Use a closure instead.');
  395.     return strlen($b) - strlen($a);
  396. }
  398. /**
  399.  * Insert a parameter or array into an existing array at a particular index
  400.  *
  401.  * @param array   $arrCurrent
  402.  * @param integer $intIndex
  403.  * @param mixed   $arrNew
  404.  *
  405.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  406.  */
  407. function array_insert(&$arrCurrent, $intIndex, $arrNew)
  408. {
  409.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_insert()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\ArrayUtil::arrayInsert()" instead.');
  411.     ArrayUtil::arrayInsert($arrCurrent, $intIndex, $arrNew);
  412. }
  414. /**
  415.  * Duplicate a particular element of an array
  416.  *
  417.  * @param array   $arrStack
  418.  * @param integer $intIndex
  419.  *
  420.  * @return array
  421.  *
  422.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  423.  */
  424. function array_duplicate($arrStack, $intIndex)
  425. {
  426.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_duplicate()" has been deprecated and will no longer work in Contao 5.0.');
  428.     $arrBuffer = $arrStack;
  429.     $arrStack = array();
  431.     for ($i=0; $i<=$intIndex; $i++)
  432.     {
  433.         $arrStack[] = $arrBuffer[$i];
  434.     }
  436.     for ($i=$intIndex, $c=count($arrBuffer); $i<$c; $i++)
  437.     {
  438.         $arrStack[] = $arrBuffer[$i];
  439.     }
  441.     return $arrStack;
  442. }
  444. /**
  445.  * Move an array element one position up
  446.  *
  447.  * @param array   $arrStack
  448.  * @param integer $intIndex
  449.  *
  450.  * @return array
  451.  *
  452.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  453.  */
  454. function array_move_up($arrStack, $intIndex)
  455. {
  456.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_move_up()" has been deprecated and will no longer work in Contao 5.0.');
  458.     if ($intIndex > 0)
  459.     {
  460.         $arrBuffer = $arrStack[$intIndex];
  461.         $arrStack[$intIndex] = $arrStack[($intIndex-1)];
  462.         $arrStack[($intIndex-1)] = $arrBuffer;
  463.     }
  464.     else
  465.     {
  466.         $arrStack[] = $arrStack[$intIndex];
  467.         array_shift($arrStack);
  468.     }
  470.     return $arrStack;
  471. }
  473. /**
  474.  * Move an array element one position down
  475.  *
  476.  * @param array   $arrStack
  477.  * @param integer $intIndex
  478.  *
  479.  * @return array
  480.  *
  481.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  482.  */
  483. function array_move_down($arrStack, $intIndex)
  484. {
  485.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_move_down()" has been deprecated and will no longer work in Contao 5.0.');
  487.     if (($intIndex+1) < count($arrStack))
  488.     {
  489.         $arrBuffer = $arrStack[$intIndex];
  490.         $arrStack[$intIndex] = $arrStack[($intIndex+1)];
  491.         $arrStack[($intIndex+1)] = $arrBuffer;
  492.     }
  493.     else
  494.     {
  495.         array_unshift($arrStack, $arrStack[$intIndex]);
  496.         array_pop($arrStack);
  497.     }
  499.     return $arrStack;
  500. }
  502. /**
  503.  * Delete a particular element of an array
  504.  *
  505.  * @param array   $arrStack
  506.  * @param integer $intIndex
  507.  *
  508.  * @return array
  509.  *
  510.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  511.  */
  512. function array_delete($arrStack, $intIndex)
  513. {
  514.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_delete()" has been deprecated and will no longer work in Contao 5.0.');
  516.     unset($arrStack[$intIndex]);
  518.     return array_values($arrStack);
  519. }
  521. /**
  522.  * Return true if an array is associative
  523.  *
  524.  * @param array $arrArray
  525.  *
  526.  * @return boolean
  527.  *
  528.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  529.  */
  530. function array_is_assoc($arrArray)
  531. {
  532.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_is_assoc()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\ArrayUtil::isAssoc()" instead.');
  534.     return ArrayUtil::isAssoc($arrArray);
  535. }
  537. /**
  538.  * Return a specific character
  539.  *
  540.  * Unicode version of chr() that handles UTF-8 characters.
  541.  *
  542.  * @param integer $dec
  543.  *
  544.  * @return string
  545.  *
  546.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  547.  *             Use Patchwork\Utf8::chr() instead.
  548.  */
  549. function utf8_chr($dec)
  550. {
  551.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_chr()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::chr()" instead.');
  553.     return Utf8::chr($dec);
  554. }
  556. /**
  557.  * Return the ASCII value of a character
  558.  *
  559.  * Unicode version of ord() that handles UTF-8 characters.
  560.  *
  561.  * @param string $str
  562.  *
  563.  * @return integer
  564.  *
  565.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  566.  *             Use Patchwork\Utf8::ord() instead.
  567.  */
  568. function utf8_ord($str)
  569. {
  570.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_ord()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::ord()" instead.');
  572.     return Utf8::ord($str);
  573. }
  575. /**
  576.  * Convert character encoding
  577.  *
  578.  * @param string $str
  579.  * @param string $to
  580.  * @param string $from
  581.  *
  582.  * @return string
  583.  *
  584.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  585.  *             Use StringUtil::convertEncoding() instead.
  586.  */
  587. function utf8_convert_encoding($str, $to, $from=null)
  588. {
  589.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_convert_encoding()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::convertEncoding()" instead.');
  591.     if (!$str)
  592.     {
  593.         return '';
  594.     }
  596.     if (!$from)
  597.     {
  598.         $from = mb_detect_encoding($str);
  599.     }
  601.     if ($from == $to)
  602.     {
  603.         return $str;
  604.     }
  606.     if ($from == 'UTF-8' && $to == 'ISO-8859-1')
  607.     {
  608.         return utf8_decode($str);
  609.     }
  611.     if ($from == 'ISO-8859-1' && $to == 'UTF-8')
  612.     {
  613.         return utf8_encode($str);
  614.     }
  616.     return mb_convert_encoding($str, $to, $from);
  617. }
  619. /**
  620.  * Convert all unicode entities to their applicable characters
  621.  *
  622.  * Calls Utf8::chr() to convert unicode entities. HTML entities like '&nbsp;'
  623.  * or '&quot;' will not be decoded.
  624.  *
  625.  * @param string $str
  626.  *
  627.  * @return string
  628.  *
  629.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  630.  *             Use html_entity_decode() instead.
  631.  */
  632. function utf8_decode_entities($str)
  633. {
  634.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_decode_entities()" has been deprecated and will no longer work in Contao 5.0. Use "html_entity_decode()" instead.');
  636.     $str = preg_replace_callback('~&#x([0-9a-f]+);~i', static function ($matches) { return Utf8::chr(hexdec($matches[1])); }, $str);
  637.     $str = preg_replace_callback('~&#([0-9]+);~', static function ($matches) { return Utf8::chr($matches[1]); }, $str);
  639.     return $str;
  640. }
  642. /**
  643.  * Callback function for utf8_decode_entities
  644.  *
  645.  * @param array $matches
  646.  *
  647.  * @return string
  648.  *
  649.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  650.  */
  651. function utf8_chr_callback($matches)
  652. {
  653.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_chr_callback()" has been deprecated and will no longer work in Contao 5.0.');
  655.     return Utf8::chr($matches[1]);
  656. }
  658. /**
  659.  * Callback function for utf8_decode_entities
  660.  *
  661.  * @param array $matches
  662.  *
  663.  * @return string
  664.  *
  665.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  666.  */
  667. function utf8_hexchr_callback($matches)
  668. {
  669.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_hexchr_callback()" has been deprecated and will no longer work in Contao 5.0.');
  671.     return Utf8::chr(hexdec($matches[1]));
  672. }
  674. /**
  675.  * Detect the encoding of a string
  676.  *
  677.  * @param string $str
  678.  *
  679.  * @return string
  680.  *
  681.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  682.  *             Use mb_detect_encoding() instead.
  683.  */
  684. function utf8_detect_encoding($str)
  685. {
  686.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_detect_encoding()" has been deprecated and will no longer work in Contao 5.0. Use "mb_detect_encoding()" instead.');
  688.     return mb_detect_encoding($str, array('ASCII', 'ISO-2022-JP', 'UTF-8', 'EUC-JP', 'ISO-8859-1'));
  689. }
  691. /**
  692.  * Romanize a string
  693.  *
  694.  * @param string $str
  695.  *
  696.  * @return string
  697.  *
  698.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  699.  *             Use Patchwork\Utf8::toAscii() instead.
  700.  */
  701. function utf8_romanize($str)
  702. {
  703.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_romanize()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::toAscii()" instead.');
  705.     return Utf8::toAscii($str);
  706. }
  708. /**
  709.  * Determine the number of characters of a string
  710.  *
  711.  * @param string $str
  712.  *
  713.  * @return integer
  714.  *
  715.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  716.  *             Use Patchwork\Utf8::strlen() instead.
  717.  */
  718. function utf8_strlen($str)
  719. {
  720.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strlen()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::strlen()" instead.');
  722.     return Utf8::strlen($str);
  723. }
  725. /**
  726.  * Find the position of the first occurence of a string in another string
  727.  *
  728.  * @param string  $haystack
  729.  * @param string  $needle
  730.  * @param integer $offset
  731.  *
  732.  * @return integer
  733.  *
  734.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  735.  *             Use Patchwork\Utf8::strpos instead.
  736.  */
  737. function utf8_strpos($haystack, $needle, $offset=0)
  738. {
  739.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strpos()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::strpos()" instead.');
  741.     return Utf8::strpos($haystack, $needle, $offset);
  742. }
  744. /**
  745.  * Find the last occurrence of a character in a string
  746.  *
  747.  * @param string $haystack
  748.  * @param string $needle
  749.  *
  750.  * @return string
  751.  *
  752.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  753.  *             Use Patchwork\Utf8::strrchr() instead.
  754.  */
  755. function utf8_strrchr($haystack, $needle)
  756. {
  757.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strrchr()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::strrchr()" instead.');
  759.     return Utf8::strrchr($haystack, $needle);
  760. }
  762. /**
  763.  * Find the position of the last occurrence of a string in another string
  764.  *
  765.  * @param string $haystack
  766.  * @param string $needle
  767.  *
  768.  * @return mixed
  769.  *
  770.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  771.  *             Use Patchwork\Utf8::strrpos() instead.
  772.  */
  773. function utf8_strrpos($haystack, $needle)
  774. {
  775.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strrpos()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::strrpos()" instead.');
  777.     return Utf8::strrpos($haystack, $needle);
  778. }
  780. /**
  781.  * Find the first occurrence of a string in another string
  782.  *
  783.  * @param string $haystack
  784.  * @param string $needle
  785.  *
  786.  * @return string
  787.  *
  788.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  789.  *             Use Patchwork\Utf8::strstr() instead.
  790.  */
  791. function utf8_strstr($haystack, $needle)
  792. {
  793.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strstr()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::strstr()" instead.');
  795.     return Utf8::strstr($haystack, $needle);
  796. }
  798. /**
  799.  * Make a string lowercase
  800.  *
  801.  * @param string $str
  802.  *
  803.  * @return string
  804.  *
  805.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  806.  *             Use Patchwork\Utf8::strtolower() instead.
  807.  */
  808. function utf8_strtolower($str)
  809. {
  810.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strtolower()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::strtolower()" instead.');
  812.     return Utf8::strtolower($str);
  813. }
  815. /**
  816.  * Make a string uppercase
  817.  *
  818.  * @param string $str
  819.  *
  820.  * @return string
  821.  *
  822.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  823.  *             Use Patchwork\Utf8::strtoupper() instead.
  824.  */
  825. function utf8_strtoupper($str)
  826. {
  827.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strtoupper()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::strtoupper()" instead.');
  829.     return Utf8::strtoupper($str);
  830. }
  832. /**
  833.  * Return substring of a string
  834.  *
  835.  * @param string  $str
  836.  * @param integer $start
  837.  * @param integer $length
  838.  *
  839.  * @return string
  840.  *
  841.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  842.  *             Use Patchwork\Utf8::substr() instead.
  843.  */
  844. function utf8_substr($str, $start, $length=null)
  845. {
  846.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_substr()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::substr()" instead.');
  848.     return Utf8::substr($str, $start, $length);
  849. }
  851. /**
  852.  * Make sure the first letter is uppercase
  853.  *
  854.  * @param string $str
  855.  *
  856.  * @return string
  857.  *
  858.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  859.  *             Use Patchwork\Utf8::ucfirst() instead.
  860.  */
  861. function utf8_ucfirst($str)
  862. {
  863.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_ucfirst()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::ucfirst()" instead.');
  865.     return Utf8::ucfirst($str);
  866. }
  868. /**
  869.  * Convert a string to an array
  870.  *
  871.  * @param string $str
  872.  *
  873.  * @return array
  874.  *
  875.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  876.  *             Use Patchwork\Utf8::str_split() instead.
  877.  */
  878. function utf8_str_split($str)
  879. {
  880.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_str_split()" has been deprecated and will no longer work in Contao 5.0. Use "Patchwork\Utf8::str_split()" instead.');
  882.     return Utf8::str_split($str);
  883. }
  885. /**
  886.  * Replace line breaks with <br> tags (to be used with preg_replace_callback)
  887.  *
  888.  * @param array $matches
  889.  *
  890.  * @return string
  891.  *
  892.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  893.  */
  894. function nl2br_callback($matches)
  895. {
  896.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_callback()" has been deprecated and will no longer work in Contao 5.0.');
  898.     return str_replace("\n", '<br>', $matches[0]);
  899. }