strip_suffix.php

<?php

declare(strict_types=1);

namespace Psl\Str\Byte;

/**
 * Returns the string with the given suffix removed, or the string itself if
 * it doesn't end with the suffix.
 *
 * @pure
 */
function strip_suffix(string $string, string $suffix): string
{
    if ($string === '' || $suffix === '') {
        return $string;
    }

    if ($string === $suffix) {
        return '';
    }

    $suffix_length = length($suffix);
    $string_length = length($string);
    // if $suffix_length is greater than $string_length, return $string as it can't contain $suffix.
    // if $suffix_length and $string_length are the same, return $string as $suffix is not $string.
    if ($suffix_length >= $string_length) {
        return $string;
    }

    if (!ends_with($string, $suffix)) {
        return $string;
    }

    /**
     * $string_length is greater than $suffix_length, so the result is always int<0, max>.
     *
     * @var int<0, max> $length
     */
    $length = $string_length - $suffix_length;

    return slice($string, 0, $length);
}