src/Eccube/Util/StringUtil.php line 263

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of EC-CUBE
  5.  *
  6.  * Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
  7.  *
  8.  * http://www.ec-cube.co.jp/
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Eccube\Util;
  16. use Doctrine\Common\Collections\ArrayCollection;
  18. class StringUtil
  19. {
  20.     /**
  21.      * The MIT License (MIT)
  22.      *
  23.      * Copyright (c) <Taylor Otwell>
  24.      *
  25.      * Permission is hereby granted, free of charge, to any person obtaining a copy
  26.      * of this software and associated documentation files (the "Software"), to deal
  27.      * in the Software without restriction, including without limitation the rights
  28.      * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  29.      * copies of the Software, and to permit persons to whom the Software is
  30.      * furnished to do so, subject to the following conditions:
  31.      *
  32.      * The above copyright notice and this permission notice shall be included in
  33.      * all copies or substantial portions of the Software.
  34.      *
  35.      * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  36.      * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  37.      * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  38.      * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  39.      * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  40.      * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  41.      * THE SOFTWARE
  42.      *
  43.      * Generate a more truly "random" alpha-numeric string.
  44.      *
  45.      * @param  int $length
  46.      *
  47.      * @return string
  48.      *
  49.      * @throws \RuntimeException
  50.      */
  51.     public static function random($length = 16)
  52.     {
  53.         if (function_exists('openssl_random_pseudo_bytes')) {
  54.             $bytes = openssl_random_pseudo_bytes($length * 2);
  56.             if ($bytes === false) {
  57.                 throw new \RuntimeException('Unable to generate random string.');
  58.             }
  60.             return substr(str_replace(['/', '+', '='], '', base64_encode($bytes)), 0, $length);
  61.         }
  63.         return static::quickRandom($length);
  64.     }
  66.     /**
  67.      * The MIT License (MIT)
  68.      *
  69.      * Copyright (c) <Taylor Otwell>
  70.      *
  71.      * Permission is hereby granted, free of charge, to any person obtaining a copy
  72.      * of this software and associated documentation files (the "Software"), to deal
  73.      * in the Software without restriction, including without limitation the rights
  74.      * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  75.      * copies of the Software, and to permit persons to whom the Software is
  76.      * furnished to do so, subject to the following conditions:
  77.      *
  78.      * The above copyright notice and this permission notice shall be included in
  79.      * all copies or substantial portions of the Software.
  80.      *
  81.      * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  82.      * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  83.      * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  84.      * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  85.      * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  86.      * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  87.      * THE SOFTWARE
  88.      *
  89.      * Generate a "random" alpha-numeric string.
  90.      *
  91.      * Should not be considered sufficient for cryptography, etc.
  92.      *
  93.      * @param  int $length
  94.      *
  95.      * @return string
  96.      */
  97.     public static function quickRandom($length = 16)
  98.     {
  99.         $pool = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
  101.         return substr(str_shuffle(str_repeat($pool, $length)), 0, $length);
  102.     }
  104.     /**
  105.      * 改行コードの変換
  106.      *
  107.      * @param $value
  108.      * @param string $lf
  109.      *
  110.      * @return string
  111.      */
  112.     public static function convertLineFeed($value, $lf = "\n")
  113.     {
  114.         if (empty($value)) {
  115.             return '';
  116.         }
  118.         return strtr($value, array_fill_keys(["\r\n", "\r", "\n"], $lf));
  119.     }
  121.     /**
  122.      * 文字コードの判定
  123.      *
  124.      * @param string $value
  125.      *
  126.      * @return string
  127.      */
  128.     public static function characterEncoding($value, $encoding = ['UTF-8', 'SJIS', 'EUC-JP', 'ASCII', 'JIS', 'sjis-win'])
  129.     {
  130.         foreach ($encoding as $encode) {
  131.             if (mb_check_encoding($value, $encode)) {
  132.                 return $encode;
  133.             }
  134.         }
  136.         return null;
  137.     }
  139.     /**
  140.      * 指定した文字列以上ある場合、「...」を付加する
  141.      * lengthに7を指定すると、「1234567890」は「1234567...」と「...」を付与して出力される
  142.      *
  143.      * @param string $value
  144.      * @param int $length
  145.      * @param string $end
  146.      *
  147.      * @return string
  148.      */
  149.     public static function ellipsis($value, $length = 100, $end = '...')
  150.     {
  151.         if (mb_strlen($value) <= $length) {
  152.             return $value;
  153.         }
  155.         return rtrim(mb_substr($value, 0, $length, 'UTF-8')).$end;
  156.     }
  158.     /**
  159.      * 現在からの経過時間を書式化する.
  160.      *
  161.      * @param $date
  162.      *
  163.      * @return string
  164.      */
  165.     public static function timeAgo($date)
  166.     {
  167.         if (empty($date)) {
  168.             return '';
  169.         }
  171.         $now = new \DateTime();
  172.         if (!($date instanceof \DateTime)) {
  173.             $date = new \DateTime($date);
  174.         }
  175.         $diff = $date->diff($now, true);
  176.         if ($diff->y > 0) {
  177.             // return $date->format("Y/m/d H:i");
  178.             return $date->format('Y/m/d');
  179.         }
  180.         if ($diff->m == 1 || $diff->days > 0) {
  181.             if ($diff->days <= 31) {
  182.                 return $diff->days.'日前';
  183.             }
  184.             // return $date->format("Y/m/d H:i");
  185.             return $date->format('Y/m/d');
  186.         }
  187.         if ($diff->h > 0) {
  188.             return $diff->h.'時間前';
  189.         }
  190.         if ($diff->i > 0) {
  191.             return $diff->i.'分前';
  192.         }
  194.         return $diff->s.'秒前';
  195.     }
  197.     /**
  198.      * 変数が空白かどうかをチェックする.
  199.      *
  200.      * 引数 $value が空白かどうかをチェックする. 空白の場合は true.
  201.      * 以下の文字は空白と判断する.
  202.      * - ' ' (ASCII 32 (0x20)), 通常の空白
  203.      * - "\t" (ASCII 9 (0x09)), タブ
  204.      * - "\n" (ASCII 10 (0x0A)), リターン
  205.      * - "\r" (ASCII 13 (0x0D)), 改行
  206.      * - "\0" (ASCII 0 (0x00)), NULバイト
  207.      * - "\x0B" (ASCII 11 (0x0B)), 垂直タブ
  208.      *
  209.      * 引数 $value がオブジェクト型、配列の場合は非推奨とし、 E_USER_DEPRECATED をスローする.
  210.      * EC-CUBE2系からの互換性、ビギナー層を配慮し、以下のような実装とする.
  211.      * 引数 $value が配列の場合は, 空の配列の場合 true を返す.
  212.      * 引数 $value が ArrayCollection::isEmpty() == true の場合 true を返す.
  213.      * 引数 $value が上記以外のオブジェクト型の場合は false を返す.
  214.      *
  215.      * 引数 $greedy が true の場合は, 全角スペース, ネストした空の配列も
  216.      * 空白と判断する.
  217.      *
  218.      * @param string $value チェック対象の変数. 文字型以外も使用できるが、非推奨.
  219.      * @param boolean $greedy '貧欲'にチェックを行う場合 true, デフォルト false
  220.      *
  221.      * @return boolean $value が空白と判断された場合 true
  222.      */
  223.     public static function isBlank($value, $greedy = false)
  224.     {
  225.         $deprecated = '\Eccube\Util\StringUtil::isBlank() の第一引数は文字型、数値を使用してください';
  226.         // テストカバレッジを上げるために return の前で trigger_error をスローしている
  227.         if (is_object($value)) {
  228.             if ($value instanceof ArrayCollection) {
  229.                 if ($value->isEmpty()) {
  230.                     @trigger_error($deprecated, E_USER_DEPRECATED);
  232.                     return true;
  233.                 } else {
  234.                     @trigger_error($deprecated, E_USER_DEPRECATED);
  236.                     return false;
  237.                 }
  238.             }
  239.             @trigger_error($deprecated, E_USER_DEPRECATED);
  241.             return false;
  242.         }
  243.         if (is_array($value)) {
  244.             if ($greedy) {
  245.                 if (empty($value)) {
  246.                     @trigger_error($deprecated, E_USER_DEPRECATED);
  248.                     return true;
  249.                 }
  250.                 $array_result = true;
  251.                 foreach ($value as $in) {
  252.                     $array_result = self::isBlank($in, $greedy);
  253.                     if (!$array_result) {
  254.                         @trigger_error($deprecated, E_USER_DEPRECATED);
  256.                         return false;
  257.                     }
  258.                 }
  259.                 @trigger_error($deprecated, E_USER_DEPRECATED);
  261.                 return $array_result;
  262.             } else {
  263.                 @trigger_error($deprecated, E_USER_DEPRECATED);
  265.                 return empty($value);
  266.             }
  267.         }
  269.         if ($greedy) {
  270.             $value = preg_replace('/　/', '', $value);
  271.         }
  273.         $value = trim($value);
  274.         if (strlen($value) > 0) {
  275.             return false;
  276.         }
  278.         return true;
  279.     }
  281.     /**
  282.      * @param $value
  283.      *
  284.      * @return bool
  285.      */
  286.     public static function isNotBlank($value, $greedy = false)
  287.     {
  288.         return !self::isBlank($value, $greedy);
  289.     }
  291.     /**
  292.      * 両端にある全角スペース、半角スペースを取り除く
  293.      *
  294.      * @param $value
  295.      *
  296.      * @return string
  297.      */
  298.     public static function trimAll($value)
  299.     {
  300.         if ($value === '') {
  301.             return '';
  302.         }
  303.         if ($value === 0) {
  304.             return 0;
  305.         }
  306.         if ($value == null) {
  307.             return null;
  308.         }
  310.         return preg_replace('/(^\s+)|(\s+$)/u', '', $value);
  311.     }
  313.     /**
  314.      * envファイルのコンテンツを更新または追加する.
  315.      *
  316.      * @param string $env
  317.      * @param array $replacement
  318.      *
  319.      * @return string
  320.      */
  321.     public static function replaceOrAddEnv($env, array $replacement)
  322.     {
  323.         foreach ($replacement as $key => $value) {
  324.             $pattern = '/^('.$key.')=(.*)/m';
  325.             if (preg_match($pattern, $env)) {
  326.                 $env = preg_replace($pattern, '$1='.$value, $env);
  327.                 if ('\\' === DIRECTORY_SEPARATOR) {
  328.                     // The m modifier of the preg functions converts the end-of-line to '\n'
  329.                     $env = self::convertLineFeed($env, "\r\n");
  330.                 }
  331.             } else {
  332.                 $env .= PHP_EOL."${key}=${value}";
  333.             }
  334.         }
  336.         return $env;
  337.     }
  338. }