Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:107600
MIME-Version: 1.0
Date: Sun, 20 Oct 2019 11:00:15 -0400
Message-ID: <CAJaRsPvTvZVWtszNH-uqaOc8487ncGjKdgFikzq60gUhvTNMtQ@mail.gmail.com>
To: PHP Internals <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="0000000000000ad745059558d43f"
Subject: substr with null length
From: colinodell@gmail.com ("Colin O'Dell")

--0000000000000ad745059558d43f
Content-Type: text/plain; charset="UTF-8"

Hello Internals,

Is there any particular reason why the substr() function doesn't accept a
null $length like mb_substr() does?  It seems the behavior to read through
the end of the string can only be controlled by the presence or absence of
the $length parameter:  https://3v4l.org/YpuO1

I discovered this discrepancy between the two methods while attempting to
create a specialized string wrapper class with a method like this:

    public function getSubstring(int $start, ?int $length = null): string
    {
        if ($this->isMultibyte) {
            return mb_substr($this->line, $start, $length, $this->encoding);
        } else {
            return substr($this->line, $start, $length);
        }
    }

This method would not work as expected without additional boilerplate like:

    public function getSubstring (int $start, ?int $length = null): string
    {
        if ($this->isMultibyte) {
            return mb_substr($this->line, $start, $length, $this->encoding);
        } elseif ($length === null) {
            return substr($this->line, $start);
        } else {
            return substr($this->line, $start, $length);
        }
    }

Or:

    public function getSubstring (int $start, ?int $length = null): string
    {
        if ($this->isMultibyte) {
            return mb_substr($this->line, $start, $length, $this->encoding);
        } else {
            return substr($this->line, $start, $length ??
(strlen($this->line) - $start));
        }
    }

Are there any historical reasons preventing substr() from accepting a null
$length like mb_substr() does?  I'd be happy to write the RFC and take a
stab at the implementation if there's interest in such a change.

Regards,

Colin O'Dell
colinodell@gmail.com

--0000000000000ad745059558d43f--