String_Utility.php
83 lines
| 1 | <?php |
| 2 | /** |
| 3 | * WooCommerce Square |
| 4 | * |
| 5 | * This source file is subject to the GNU General Public License v3.0 |
| 6 | * that is bundled with this package in the file license.txt. |
| 7 | * It is also available through the world-wide-web at this URL: |
| 8 | * http://www.gnu.org/licenses/gpl-3.0.html |
| 9 | * If you did not receive a copy of the license and are unable to |
| 10 | * obtain it through the world-wide-web, please send an email |
| 11 | * to license@woocommerce.com so we can send you a copy immediately. |
| 12 | * |
| 13 | * DISCLAIMER |
| 14 | * |
| 15 | * Do not edit or add to this file if you wish to upgrade WooCommerce Square to newer |
| 16 | * versions in the future. If you wish to customize WooCommerce Square for your |
| 17 | * needs please refer to https://docs.woocommerce.com/document/woocommerce-square/ |
| 18 | * |
| 19 | * @author WooCommerce |
| 20 | * @copyright Copyright: (c) 2019, Automattic, Inc. |
| 21 | * @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 |
| 22 | */ |
| 23 | |
| 24 | namespace WooCommerce\Square\Utilities; |
| 25 | |
| 26 | defined( 'ABSPATH' ) || exit; |
| 27 | |
| 28 | /** |
| 29 | * Helper for dealing with String values. |
| 30 | * |
| 31 | * @since 2.2.0 |
| 32 | */ |
| 33 | class String_Utility { |
| 34 | |
| 35 | /** |
| 36 | * Truncates $string after a given $length if string is longer than |
| 37 | * $length. |
| 38 | * |
| 39 | * The last characters will be replaced with the $omission string |
| 40 | * for a total length not exceeding $length |
| 41 | * |
| 42 | * See SV_WC_Helper::str_truncate() |
| 43 | * |
| 44 | * @since 2.2.0 |
| 45 | * @param string $string text to truncate |
| 46 | * @param int $length total desired length of string, including omission |
| 47 | * @param string $omission omission text, defaults to '...' |
| 48 | * @return string |
| 49 | */ |
| 50 | public static function truncate( $string, $length, $omission = '...' ) { |
| 51 | $string = self::to_ascii( $string ); |
| 52 | |
| 53 | // bail if string doesn't need to be truncated |
| 54 | if ( strlen( $string ) <= $length ) { |
| 55 | return $string; |
| 56 | } |
| 57 | |
| 58 | $length -= strlen( $omission ); |
| 59 | |
| 60 | return substr( $string, 0, $length ) . $omission; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Returns a string with all non-ASCII characters removed. This is useful |
| 65 | * for any string functions that expect only ASCII chars and can't |
| 66 | * safely handle UTF-8. Note this only allows ASCII chars in the range |
| 67 | * 33-126 (newlines/carriage returns are stripped) |
| 68 | * |
| 69 | * See SV_WC_Helper::str_to_ascii() |
| 70 | * |
| 71 | * @since 2.2.0 |
| 72 | * @param string $string string to make ASCII |
| 73 | * @return string |
| 74 | */ |
| 75 | public static function to_ascii( $string ) { |
| 76 | // strip ASCII chars 32 and under |
| 77 | $string = filter_var( $string, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW ); |
| 78 | |
| 79 | // strip ASCII chars 127 and higher |
| 80 | return filter_var( $string, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_HIGH ); |
| 81 | } |
| 82 | } |
| 83 |