Str::substringUntil PHP Method

substringUntil() public static method

public static substringUntil ( $haystack, $needle )
    public static function substringUntil($haystack, $needle)
    {
        $pos = strpos($haystack, $needle);
        if (false === $pos) {
            return $haystack;
        }
        return trim(substr($haystack, 0, $pos));
    }

Usage Example

Example #1
0
function extract_doc_description($docComment)
{
    $rawDescription = Str::substringUntil(Str::substringUntil($docComment, '@return'), '@param');
    $lines = explode("\n", $rawDescription);
    array_shift($lines);
    // drop /*
    $cleaned = array_map(function ($line) {
        return trim(str_replace('*', '', $line));
    }, $lines);
    return trim(implode(' ', $cleaned));
}