Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:123355
Precedence: bulk
MIME-Version: 1.0
References: <CAPzBOBMpOztgNQx35ZnP4c5ZHV-Ax1ETH0=YMzVT9Hq9cdyyDQ@mail.gmail.com>
 <407efbd0-2d9c-4bcb-b795-0ee326728415@heigl.org>
In-Reply-To: <407efbd0-2d9c-4bcb-b795-0ee326728415@heigl.org>
Date: Sat, 18 May 2024 19:46:36 +0200
Message-ID: <CAPzBOBPRaxhnjHNzqza57rH1+_j7pb-9FtgB_qf4ONcThHpdAA@mail.gmail.com>
Subject: Re: [PHP-DEV] [Discussion] "Internal" attribute and warning
To: Andreas Heigl <andreas@heigl.org>
Cc: internals@lists.php.net
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
From: landers.robert@gmail.com (Robert Landers)

On Sat, May 18, 2024 at 7:38=E2=80=AFPM Andreas Heigl <andreas@heigl.org> w=
rote:
>
> Hey all.
>
> Am 18.05.24 um 16:00 schrieb Robert Landers:
> > Hello internals,
> >
> > I've been thinking about having an "internal" attribute that will emit
> > a warning if called from outside it's left-most namespace.
> >
> > It might look something like this:
> >
> > namespace MyCompany\PackageA {
> >    #[\Internal] function doStuff() {}
> > }
> >
> > namespace OtherCompany\PackageB {
> >    \MyCompany\PackageA\doStuff(); // warning emitted
> > }
> >
> > namespace MyCompany\PackageB {
> >    \MyCompany\PackageB\doStuff(); // left-most part of namespace
> > matches, no warning
> > }
> >
> > This would allow for library maintainers to mark internal constructs
> > as such and provide users with feedback that they are using code that
> > may be changed without any notice.
> >
> > Any thoughts?
> I do like the idea in general of being able to mark certain things as
> internal to a certain namespace.
>
> My question is more in the direction of: If we are not enforcing
> breaking the code but merely emit a warning then that is IMO not
> something that we need to implement on the language level. People will
> still be able to use the internal method and just ignore the warning.

I guess that depends on what you mean by "break the code." Many people
turn warnings into exceptions, and for those people this will
effectively break their code. Some people may choose to ignore it one
way or another, but that would be up to them. The idea isn't to break
people's code though, it's to provide a way to mark very-malleable
APIs in libraries. Maybe, "Internal" is a bad name for this, but it's
the most logical.

>                                                                ,,,
>                                                               (o o)
> +---------------------------------------------------------ooO-(_)-Ooo-+
> | Andreas Heigl                                                       |
> | mailto:andreas@heigl.org                  N 50=C2=B022'59.5" E 08=C2=B0=
23'58" |
> | https://andreas.heigl.org                                           |
> +---------------------------------------------------------------------+
> | https://hei.gl/appointmentwithandreas                               |
> +---------------------------------------------------------------------+
> | GPG-Key: https://hei.gl/keyandreasheiglorg                          |
> +---------------------------------------------------------------------+

Robert Landers
Software Engineer
Utrecht NL