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

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 Symfony\Component\String\UnicodeString;
  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 = mb_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.     }
  146.     while ($count > 0);
  148.     return $strString;
  149. }
  151. /**
  152.  * Return an unserialized array or the argument
  153.  *
  154.  * @param mixed   $varValue
  155.  * @param boolean $blnForceArray
  156.  *
  157.  * @return mixed
  158.  *
  159.  * @deprecated Using deserialize() has been deprecated and will no longer work in Contao 5.0.
  160.  *             Use StringUtil::deserialize() instead.
  161.  */
  162. function deserialize($varValue, $blnForceArray=false)
  163. {
  164.     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.');
  166.     // Already an array
  167.     if (is_array($varValue))
  168.     {
  169.         return $varValue;
  170.     }
  172.     // Null
  173.     if ($varValue === null)
  174.     {
  175.         return $blnForceArray ? array() : null;
  176.     }
  178.     // Not a string
  179.     if (!is_string($varValue))
  180.     {
  181.         return $blnForceArray ? array($varValue) : $varValue;
  182.     }
  184.     // Empty string
  185.     if (trim($varValue) === '')
  186.     {
  187.         return $blnForceArray ? array() : '';
  188.     }
  190.     // Potentially including an object (see #6724)
  191.     if (preg_match('/[OoC]:\+?[0-9]+:"/', $varValue))
  192.     {
  193.         trigger_error('The deserialize() function does not allow serialized objects', E_USER_WARNING);
  195.         return $blnForceArray ? array($varValue) : $varValue;
  196.     }
  198.     $varUnserialized = @unserialize($varValue, array('allowed_classes' => false));
  200.     if (is_array($varUnserialized))
  201.     {
  202.         $varValue = $varUnserialized;
  203.     }
  204.     elseif ($blnForceArray)
  205.     {
  206.         $varValue = array($varValue);
  207.     }
  209.     return $varValue;
  210. }
  212. /**
  213.  * Split a string into fragments, remove whitespace and return fragments as array
  214.  *
  215.  * @param string $strPattern
  216.  * @param string $strString
  217.  *
  218.  * @return array
  219.  *
  220.  * @deprecated Using trimsplit() has been deprecated and will no longer work in Contao 5.0.
  221.  *             Use StringUtil::trimsplit() instead.
  222.  */
  223. function trimsplit($strPattern, $strString)
  224. {
  225.     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.');
  227.     // Split
  228.     if (strlen($strPattern) == 1)
  229.     {
  230.         $arrFragments = array_map('trim', explode($strPattern, $strString));
  231.     }
  232.     else
  233.     {
  234.         $arrFragments = array_map('trim', preg_split('/' . $strPattern . '/ui', $strString));
  235.     }
  237.     // Empty array
  238.     if (count($arrFragments) < 2 && !strlen($arrFragments[0]))
  239.     {
  240.         $arrFragments = array();
  241.     }
  243.     return $arrFragments;
  244. }
  246. /**
  247.  * Convert all ampersands into their HTML entity (default) or unencoded value
  248.  *
  249.  * @param string  $strString
  250.  * @param boolean $blnEncode
  251.  *
  252.  * @return string
  253.  *
  254.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  255.  */
  256. function ampersand($strString, $blnEncode=true)
  257. {
  258.     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.');
  260.     return StringUtil::ampersand($strString, $blnEncode);
  261. }
  263. /**
  264.  * Replace line breaks with HTML5-style <br> tags
  265.  *
  266.  * @param string  $str
  267.  * @param boolean $xhtml
  268.  *
  269.  * @return string
  270.  *
  271.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  272.  */
  273. function nl2br_html5($str, $xhtml=false)
  274. {
  275.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_html5()" has been deprecated and will no longer work in Contao 5.0.');
  277.     return nl2br($str, $xhtml);
  278. }
  280. /**
  281.  * Replace line breaks with XHTML-style <br /> tags
  282.  *
  283.  * @param string $str
  284.  *
  285.  * @return string
  286.  *
  287.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  288.  */
  289. function nl2br_xhtml($str)
  290. {
  291.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_xhtml()" has been deprecated and will no longer work in Contao 5.0.');
  293.     return nl2br($str);
  294. }
  296. /**
  297.  * Replace line breaks with <br> tags preserving preformatted text
  298.  *
  299.  * @param string  $str
  300.  * @param boolean $xhtml
  301.  *
  302.  * @return string
  303.  *
  304.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  305.  */
  306. function nl2br_pre($str, $xhtml=false)
  307. {
  308.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_pre()" has been deprecated and will no longer work in Contao 5.0.');
  310.     return preg_replace('/\r?\n/', $xhtml ? '<br />' : '<br>', $str);
  311. }
  313. /**
  314.  * Compare two file names using a case-insensitive "natural order" algorithm
  315.  *
  316.  * @param string $a
  317.  * @param string $b
  318.  *
  319.  * @return integer
  320.  *
  321.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  322.  */
  323. function basename_natcasecmp($a, $b)
  324. {
  325.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "basename_natcasecmp()" has been deprecated and will no longer work in Contao 5.0.');
  327.     return strnatcasecmp(basename($a), basename($b));
  328. }
  330. /**
  331.  * Compare two file names using a case-insensitive, reverse "natural order" algorithm
  332.  *
  333.  * @param string $a
  334.  * @param string $b
  335.  *
  336.  * @return integer
  337.  *
  338.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  339.  */
  340. function basename_natcasercmp($a, $b)
  341. {
  342.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "basename_natcasercmp()" has been deprecated and will no longer work in Contao 5.0.');
  344.     return -strnatcasecmp(basename($a), basename($b));
  345. }
  347. /**
  348.  * Sort an array by keys using a case-insensitive "natural order" algorithm
  349.  *
  350.  * @param array $arrArray
  351.  *
  352.  * @return array
  353.  *
  354.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  355.  */
  356. function natcaseksort($arrArray)
  357. {
  358.     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.');
  360.     uksort($arrArray, 'strnatcasecmp');
  362.     return $arrArray;
  363. }
  365. /**
  366.  * Compare two values based on their length (ascending)
  367.  *
  368.  * @param integer $a
  369.  * @param integer $b
  370.  *
  371.  * @return integer
  372.  *
  373.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  374.  */
  375. function length_sort_asc($a, $b)
  376. {
  377.     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.');
  379.     return strlen($a) - strlen($b);
  380. }
  382. /**
  383.  * Compare two values based on their length (descending)
  384.  *
  385.  * @param integer $a
  386.  * @param integer $b
  387.  *
  388.  * @return integer
  389.  *
  390.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  391.  */
  392. function length_sort_desc($a, $b)
  393. {
  394.     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.');
  396.     return strlen($b) - strlen($a);
  397. }
  399. /**
  400.  * Insert a parameter or array into an existing array at a particular index
  401.  *
  402.  * @param array   $arrCurrent
  403.  * @param integer $intIndex
  404.  * @param mixed   $arrNew
  405.  *
  406.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  407.  */
  408. function array_insert(&$arrCurrent, $intIndex, $arrNew)
  409. {
  410.     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.');
  412.     ArrayUtil::arrayInsert($arrCurrent, $intIndex, $arrNew);
  413. }
  415. /**
  416.  * Duplicate a particular element of an array
  417.  *
  418.  * @param array   $arrStack
  419.  * @param integer $intIndex
  420.  *
  421.  * @return array
  422.  *
  423.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  424.  */
  425. function array_duplicate($arrStack, $intIndex)
  426. {
  427.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_duplicate()" has been deprecated and will no longer work in Contao 5.0.');
  429.     $arrBuffer = $arrStack;
  430.     $arrStack = array();
  432.     for ($i=0; $i<=$intIndex; $i++)
  433.     {
  434.         $arrStack[] = $arrBuffer[$i];
  435.     }
  437.     for ($i=$intIndex, $c=count($arrBuffer); $i<$c; $i++)
  438.     {
  439.         $arrStack[] = $arrBuffer[$i];
  440.     }
  442.     return $arrStack;
  443. }
  445. /**
  446.  * Move an array element one position up
  447.  *
  448.  * @param array   $arrStack
  449.  * @param integer $intIndex
  450.  *
  451.  * @return array
  452.  *
  453.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  454.  */
  455. function array_move_up($arrStack, $intIndex)
  456. {
  457.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_move_up()" has been deprecated and will no longer work in Contao 5.0.');
  459.     if ($intIndex > 0)
  460.     {
  461.         $arrBuffer = $arrStack[$intIndex];
  462.         $arrStack[$intIndex] = $arrStack[($intIndex-1)];
  463.         $arrStack[($intIndex-1)] = $arrBuffer;
  464.     }
  465.     else
  466.     {
  467.         $arrStack[] = $arrStack[$intIndex];
  468.         array_shift($arrStack);
  469.     }
  471.     return $arrStack;
  472. }
  474. /**
  475.  * Move an array element one position down
  476.  *
  477.  * @param array   $arrStack
  478.  * @param integer $intIndex
  479.  *
  480.  * @return array
  481.  *
  482.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  483.  */
  484. function array_move_down($arrStack, $intIndex)
  485. {
  486.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_move_down()" has been deprecated and will no longer work in Contao 5.0.');
  488.     if (($intIndex+1) < count($arrStack))
  489.     {
  490.         $arrBuffer = $arrStack[$intIndex];
  491.         $arrStack[$intIndex] = $arrStack[($intIndex+1)];
  492.         $arrStack[($intIndex+1)] = $arrBuffer;
  493.     }
  494.     else
  495.     {
  496.         array_unshift($arrStack, $arrStack[$intIndex]);
  497.         array_pop($arrStack);
  498.     }
  500.     return $arrStack;
  501. }
  503. /**
  504.  * Delete a particular element of an array
  505.  *
  506.  * @param array   $arrStack
  507.  * @param integer $intIndex
  508.  *
  509.  * @return array
  510.  *
  511.  * @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
  512.  */
  513. function array_delete($arrStack, $intIndex)
  514. {
  515.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "array_delete()" has been deprecated and will no longer work in Contao 5.0.');
  517.     unset($arrStack[$intIndex]);
  519.     return array_values($arrStack);
  520. }
  522. /**
  523.  * Return true if an array is associative
  524.  *
  525.  * @param array $arrArray
  526.  *
  527.  * @return boolean
  528.  *
  529.  * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
  530.  */
  531. function array_is_assoc($arrArray)
  532. {
  533.     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.');
  535.     return ArrayUtil::isAssoc($arrArray);
  536. }
  538. /**
  539.  * Return a specific character
  540.  *
  541.  * Unicode version of chr() that handles UTF-8 characters.
  542.  *
  543.  * @param integer $dec
  544.  *
  545.  * @return string
  546.  *
  547.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  548.  *             Use mb_chr() instead.
  549.  */
  550. function utf8_chr($dec)
  551. {
  552.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_chr()" has been deprecated and will no longer work in Contao 5.0. Use "mb_chr()" instead.');
  554.     return mb_chr($dec);
  555. }
  557. /**
  558.  * Return the ASCII value of a character
  559.  *
  560.  * Unicode version of ord() that handles UTF-8 characters.
  561.  *
  562.  * @param string $str
  563.  *
  564.  * @return integer
  565.  *
  566.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  567.  *             Use mb_ord() instead.
  568.  */
  569. function utf8_ord($str)
  570. {
  571.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_ord()" has been deprecated and will no longer work in Contao 5.0. Use "mb_ord()" instead.');
  573.     return mb_ord($str);
  574. }
  576. /**
  577.  * Convert character encoding
  578.  *
  579.  * @param string $str
  580.  * @param string $to
  581.  * @param string $from
  582.  *
  583.  * @return string
  584.  *
  585.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  586.  *             Use StringUtil::convertEncoding() instead.
  587.  */
  588. function utf8_convert_encoding($str, $to, $from=null)
  589. {
  590.     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.');
  592.     if (!$str)
  593.     {
  594.         return '';
  595.     }
  597.     if (!$from)
  598.     {
  599.         $from = mb_detect_encoding($str);
  600.     }
  602.     if ($from == $to)
  603.     {
  604.         return $str;
  605.     }
  607.     if ($from == 'UTF-8' && $to == 'ISO-8859-1')
  608.     {
  609.         return utf8_decode($str);
  610.     }
  612.     if ($from == 'ISO-8859-1' && $to == 'UTF-8')
  613.     {
  614.         return utf8_encode($str);
  615.     }
  617.     return mb_convert_encoding($str, $to, $from);
  618. }
  620. /**
  621.  * Convert all unicode entities to their applicable characters
  622.  *
  623.  * Calls mb_chr() to convert unicode entities. HTML entities like '&nbsp;'
  624.  * or '&quot;' will not be decoded.
  625.  *
  626.  * @param string $str
  627.  *
  628.  * @return string
  629.  *
  630.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  631.  *             Use html_entity_decode() instead.
  632.  */
  633. function utf8_decode_entities($str)
  634. {
  635.     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.');
  637.     $str = preg_replace_callback('~&#x([0-9a-f]+);~i', static function ($matches) { return mb_chr(hexdec($matches[1])); }, $str);
  638.     $str = preg_replace_callback('~&#([0-9]+);~', static function ($matches) { return mb_chr($matches[1]); }, $str);
  640.     return $str;
  641. }
  643. /**
  644.  * Callback function for utf8_decode_entities
  645.  *
  646.  * @param array $matches
  647.  *
  648.  * @return string
  649.  *
  650.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  651.  */
  652. function utf8_chr_callback($matches)
  653. {
  654.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_chr_callback()" has been deprecated and will no longer work in Contao 5.0.');
  656.     return mb_chr($matches[1]);
  657. }
  659. /**
  660.  * Callback function for utf8_decode_entities
  661.  *
  662.  * @param array $matches
  663.  *
  664.  * @return string
  665.  *
  666.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  667.  */
  668. function utf8_hexchr_callback($matches)
  669. {
  670.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_hexchr_callback()" has been deprecated and will no longer work in Contao 5.0.');
  672.     return mb_chr(hexdec($matches[1]));
  673. }
  675. /**
  676.  * Detect the encoding of a string
  677.  *
  678.  * @param string $str
  679.  *
  680.  * @return string
  681.  *
  682.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  683.  *             Use mb_detect_encoding() instead.
  684.  */
  685. function utf8_detect_encoding($str)
  686. {
  687.     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.');
  689.     return mb_detect_encoding($str, array('ASCII', 'ISO-2022-JP', 'UTF-8', 'EUC-JP', 'ISO-8859-1'));
  690. }
  692. /**
  693.  * Romanize a string
  694.  *
  695.  * @param string $str
  696.  *
  697.  * @return string
  698.  *
  699.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  700.  *             Use the symfony/string component instead.
  701.  */
  702. function utf8_romanize($str)
  703. {
  704.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_romanize()" has been deprecated and will no longer work in Contao 5.0. Use the "symfony/string" component instead.');
  706.     return (new UnicodeString($str))->ascii()->toString();
  707. }
  709. /**
  710.  * Determine the number of characters of a string
  711.  *
  712.  * @param string $str
  713.  *
  714.  * @return integer
  715.  *
  716.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  717.  *             Use mb_strlen() instead.
  718.  */
  719. function utf8_strlen($str)
  720. {
  721.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strlen()" has been deprecated and will no longer work in Contao 5.0. Use "mb_strlen()" instead.');
  723.     return mb_strlen($str);
  724. }
  726. /**
  727.  * Find the position of the first occurrence of a string in another string
  728.  *
  729.  * @param string  $haystack
  730.  * @param string  $needle
  731.  * @param integer $offset
  732.  *
  733.  * @return integer
  734.  *
  735.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  736.  *             Use mb_strpos instead.
  737.  */
  738. function utf8_strpos($haystack, $needle, $offset=0)
  739. {
  740.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strpos()" has been deprecated and will no longer work in Contao 5.0. Use "mb_strpos()" instead.');
  742.     return mb_strpos($haystack, $needle, $offset);
  743. }
  745. /**
  746.  * Find the last occurrence of a character in a string
  747.  *
  748.  * @param string $haystack
  749.  * @param string $needle
  750.  *
  751.  * @return string
  752.  *
  753.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  754.  *             Use mb_strrchr() instead.
  755.  */
  756. function utf8_strrchr($haystack, $needle)
  757. {
  758.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strrchr()" has been deprecated and will no longer work in Contao 5.0. Use "mb_strrchr()" instead.');
  760.     return mb_strrchr($haystack, $needle);
  761. }
  763. /**
  764.  * Find the position of the last occurrence of a string in another string
  765.  *
  766.  * @param string $haystack
  767.  * @param string $needle
  768.  *
  769.  * @return mixed
  770.  *
  771.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  772.  *             Use mb_strrpos() instead.
  773.  */
  774. function utf8_strrpos($haystack, $needle)
  775. {
  776.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strrpos()" has been deprecated and will no longer work in Contao 5.0. Use "mb_strrpos()" instead.');
  778.     return mb_strrpos($haystack, $needle);
  779. }
  781. /**
  782.  * Find the first occurrence of a string in another string
  783.  *
  784.  * @param string $haystack
  785.  * @param string $needle
  786.  *
  787.  * @return string
  788.  *
  789.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  790.  *             Use mb_strstr() instead.
  791.  */
  792. function utf8_strstr($haystack, $needle)
  793. {
  794.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strstr()" has been deprecated and will no longer work in Contao 5.0. Use "mb_strstr()" instead.');
  796.     return mb_strstr($haystack, $needle);
  797. }
  799. /**
  800.  * Make a string lowercase
  801.  *
  802.  * @param string $str
  803.  *
  804.  * @return string
  805.  *
  806.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  807.  *             Use mb_strtolower() instead.
  808.  */
  809. function utf8_strtolower($str)
  810. {
  811.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strtolower()" has been deprecated and will no longer work in Contao 5.0. Use "mb_strtolower()" instead.');
  813.     return mb_strtolower($str);
  814. }
  816. /**
  817.  * Make a string uppercase
  818.  *
  819.  * @param string $str
  820.  *
  821.  * @return string
  822.  *
  823.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  824.  *             Use mb_strtoupper() instead.
  825.  */
  826. function utf8_strtoupper($str)
  827. {
  828.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_strtoupper()" has been deprecated and will no longer work in Contao 5.0. Use "mb_strtoupper()" instead.');
  830.     return mb_strtoupper($str);
  831. }
  833. /**
  834.  * Return substring of a string
  835.  *
  836.  * @param string  $str
  837.  * @param integer $start
  838.  * @param integer $length
  839.  *
  840.  * @return string
  841.  *
  842.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  843.  *             Use mb_substr() instead.
  844.  */
  845. function utf8_substr($str, $start, $length=null)
  846. {
  847.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_substr()" has been deprecated and will no longer work in Contao 5.0. Use "mb_substr()" instead.');
  849.     return mb_substr($str, $start, $length);
  850. }
  852. /**
  853.  * Make sure the first letter is uppercase
  854.  *
  855.  * @param string $str
  856.  *
  857.  * @return string
  858.  *
  859.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  860.  *             Use the symfony/string component instead.
  861.  */
  862. function utf8_ucfirst($str)
  863. {
  864.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_ucfirst()" has been deprecated and will no longer work in Contao 5.0. Use the "symfony/string" component instead.');
  866.     return (new UnicodeString($str))->title()->toString();
  867. }
  869. /**
  870.  * Convert a string to an array
  871.  *
  872.  * @param string $str
  873.  *
  874.  * @return array
  875.  *
  876.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  877.  *             Use mb_str_split() instead.
  878.  */
  879. function utf8_str_split($str)
  880. {
  881.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "utf8_str_split()" has been deprecated and will no longer work in Contao 5.0. Use "mb_str_split()" instead.');
  883.     return mb_str_split($str);
  884. }
  886. /**
  887.  * Replace line breaks with <br> tags (to be used with preg_replace_callback)
  888.  *
  889.  * @param array $matches
  890.  *
  891.  * @return string
  892.  *
  893.  * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  894.  */
  895. function nl2br_callback($matches)
  896. {
  897.     trigger_deprecation('contao/core-bundle', '4.0', 'Using "nl2br_callback()" has been deprecated and will no longer work in Contao 5.0.');
  899.     return str_replace("\n", '<br>', $matches[0]);
  900. }