Track whether filtering was applied

[fritzmg]

Fix for #258

This PR introduces a CategoryFilteringNotAppliedException in the NewsCriteriaBuilder::setRegularListCriteria method which will allow you to return false if desired in a newsListFetchItems or newsListCountItems hook. For backwards compatibility NewsCriteriaBuilder::getCriteriaForListModule will not throw this exception by default.

[fritzmg]

CI failures are unrelated to the PR.

[aschempp]

Can't we just return true/false if filtering was applied in the respective methods?

[fritzmg]

You mean NewsCriteriaBuilder::getCriteriaForListModule should return NewsCriteria|null|false? That would be a BC break.

[aschempp]

I don't really understand the problem to be honest. What would be the difference between false and null?

[fritzmg]

• null means: no news articles are found (i.e. show the "empty" message in the new list module)
• false means: this hook should be skipped

[fritzmg]

/reminder @qzminski @aschempp

[fritzmg]

/reminder @qzminski @aschempp

[qzminski]

Looks good to me. @aschempp if you don't have any objections we can merge it.

[qzminski]

Sorry for the delay. Released as 4.0.8 :)

[qzminski]

I have reverted this pull request changes due to #272.

@fritzmg did you test this pull request?

For example, this line https://github.com/codefog/contao-news_categories/pull/263/files#diff-d540d7da12a707b7694cc9f3135ee02a80f7a211c40b9a1fd90767dfb2a8a06aR56
returns false but the method return type does not allow that.

Similar to this line https://github.com/codefog/contao-news_categories/pull/263/files#diff-d540d7da12a707b7694cc9f3135ee02a80f7a211c40b9a1fd90767dfb2a8a06aR39 where false is returned, but the method type defines the int as the return type.

[fritzmg]

True, the return type of the hooks are wrong. These hooks expect Collection|null|false and int|false as the return value.

[fritzmg]

See #273