nextras / orm / 32193606707

92%

master: 92%

push

github

add #[\NoDiscard] to read-only API (#827)

* add #[\NoDiscard] to read-only API

Marks the methods that only compute and return a value with PHP 8.5's
#[\NoDiscard] attribute, so that PHP reports ignoring their return value.
Most notably the whole ICollection API, where discarding the result of
findBy()/orderBy()/limitBy() silently does nothing, as the collection is
immutable; those methods carry an explanatory message. Also covers
IRepository, IModel, IRepositoryLoader, IMapper, IEntity and the
relationship getters.

The attribute is not inherited by overriding methods, so it is declared
both on the interfaces (as documentation) and on their implementations
(where it is actually evaluated). Methods called for their side effect
are left out, incl. ICollection::setRelationshipMapper() which mutates
the collection in place.

On PHP 8.1-8.4 the attribute has no effect.

Closes #805

* tests: use the return values of #[\NoDiscard] methods

PHPStan reports method.resultDiscarded (non-ignorable) for calls whose
return value is thrown away on a separate line. The (void) cast is not
an option here, as the codebase supports PHP 8.1+, so the values are
assigned instead - incl. Repository::doRefreshAll(), where the fetch is
done for its identity-map side effect.

---------

Co-authored-by: Claude <noreply@anthropic.com>

4 of 4 new or added lines in 2 files covered. (100.0%)

4349 of 4730 relevant lines covered (91.95%)

5.39 hits per line