Feature: Query content view controller

[bdunogier]

Implements EZP-24624
Reopening of #1473 & #1460
BDD scenario

In this approach, a built-in QueryController is added. It can be used in any content_view config to add the results of a QueryType to the view. See the BDD specs linked above for code examples.

The view is configured to use ez_query:contentQueryAction. The controller action runs the QueryType specified as query, and sets the results to the variable specified as variable.

The elements from queryParameters are passed to the QueryType's getQuery() method.
The expression language can be used in any queryParameter by prefixing the value with @=. The expression is given the view, the location and the content. This makes it easy to pass any property from those value objects to generate the query.

A working configuration example, with a QueryType, can be found in the BDD scenario.

[crevillo]

hi @bdunogier , a question about
blogPathString: @=location.pathString. Will it work if we quote the @=... part? i mean
blogPathString: "@=location.pathString". Asking because looks symfony 3 will make us quote of this kind of things starting with @

Edit: now i see in the md you're quoting it, so looks it will work

[bdunogier]

It should have been quoted, I'll fix the example. So the answer is "yes" :-)

[crevillo]

nitipick: Location

[yannickroger]

Looks good to me.

Don't forget to add some phpdoc before merge.

[glye]

This doesn't actually say that the children of the given location id are being returned as results. Do you consider that irrelevant to the feature, since it's up to the custom QueryType?

[bdunogier]

It is a fair question. We could add a sentence that asserts that the results are those we expect. It is kind of what "the Query results" means here, but it needs to be made more explicit. "The results of the LocationChidren query" are assigned to the children twig variable ?

[glye]

Seems good. I second Yannick on doc.

[wizhippo]

How about pagination support to return pager instance?

[bdunogier]

Pushed an improved version of the configuration. Let's use the behat scenario to discuss: https://github.com/ezsystems/ezpublish-kernel/pull/1675/files#diff-6d2810af82a8d9056f00de53f69e3702 :-)

[bdunogier]

First behat implementation added, may pass. Will need refactoring :)

[bdunogier]

BDD implemented and passing !

[bdunogier]

@wizhippo as much as I'd like to do it, I'm not sure it can fit before the scope freeze (tomorrow).

How would you see that working when it comes to assigning pagination data to the template (naming, mainly) ?

[andrerom]

I guess we haven't fully (re)defined this, but I would have thought heading should be:

<?php

/**
 * File containing the BlaBla class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */

Ideally skipping the file description (File containing the BlaBla class) in favor of rather spending the effort by having more useful class description, including usage examples.

[bdunogier]

I'd go for @license and @copyright alone, I don't really see the point of the first line anyway, and it seems that we don't really care about it.

[andrerom]

How about pagination support to return pager instance?

@wizhippo as much as I'd like to do it, I'm not sure it can fit before the scope freeze (tomorrow).

How would you see that working when it comes to assigning pagination data to the template (naming, mainly) ?

Agreed this is a follow up topic.

Very Side comment on that, no need to discuss this here, more for when we tackle this perhaps: If we want to think a bit forward we should maybe rather think of using items as offsets, like github does, and as recommended for misc reasons, but will be difficult to handle sorting in a good way for the API so might not be applicable.

[andrerom]

private

[bdunogier]

fixed

[andrerom]

+1 🐴 besides license nitpick.

You have quite a bit to demo tomorrow ;)

[bdunogier]

Files headers taken care of.

[yannickroger]

+1

[bdunogier]

And here we go.