Location siblings Query Type¶

This Query Type is used to build queries that fetch Location siblings.

Identifier	`SiteAPI:Location/Siblings`
Own conditions	location
Inherited Location conditions	main priority visible
Common Content conditions	content_type field is_field_empty creation_date section state
Common query parameters	limit offset sort

Examples¶

On the full view for article type Content fetch all siblings of type news that are in ObjectState review/approved, sort them by name and paginate them by 10 per page using URL query parameter page:

ezpublish:
    system:
        frontend_group:
            ngcontent_view:
                full:
                    article:
                        template: '@ezdesign/content/full/article.html.twig'
                        match:
                            Identifier\ContentType: article
                        queries:
                            news_siblings:
                                query_type: SiteAPI:Location/Siblings
                                max_per_page: 10
                                page: '@=queryParam("page", 1)'
                                parameters:
                                    content_type: news
                                    state:
                                        review: approved
                                    sort: name

{% set news_list = ng_query( 'news_siblings' ) %}

<h3>Article's news siblings</h3>

<ul>
{% for news in news_list %}
    <li>{{ news.content.name }}</li>
{% endfor %}
</ul>

{{ pagerfanta( news_list, 'twitter_bootstrap' ) }}

Own conditions¶

`location`¶

Defines sibling Location reference for fetching other siblings Locations.

Note

This condition is required. It’s also automatically set to the Location instance resolved by the view builder if the query is defined in the view builder configuration.

value type: Location
value format: single
operators: none
target: none
required: true
default: not defined

Examples:

# this is also automatically set when using from view builder configuration
location: '@=location'

# fetch siblings of the parent Location
location: '@=location.parent'

# fetch siblings of the parent Location's parent Location
location: '@=location.parent.parent'

Inherited Location conditions¶

`main`¶

Defines whether returned Locations are main Locations or not. Use true to get main Locations, false to get non-main Locations and null to get both (which is also the default behaviour).

value type: boolean, null
value format: single
operators: eq
target: none
required: false
default: not defined

Examples:

# identical to the example below
main: true

main:
    eq: true

# get both main and non-main Locations, which is also the default behaviour
main: ~

`priority`¶

Defines the priority of the Location.

value type: integer
value format: single
operators: gt, gte, lt, lte, between
target: none
required: false
default: not defined

Examples:

# multiple operators are combined with logical AND
depth:
    gt: 4
    lte: 8

depth:
    between: [4, 7]

`visible`¶

Defines whether returned Locations are visible or not. Use true to get visible Locations, false to get hidden Locations and null to get both (which is also the default behaviour).

value type: boolean, null
value format: single
operators: eq
target: none
required: false
default: not defined

Examples:

# identical to the example below
visible: false

visible:
    eq: false

# get both visible and hidden Locations, which also the default behaviour
visible: ~

Common Content conditions¶

`content_type`¶

Defines ContentType of the Content by the identifier.

value type: string
value format: single, array
operators: eq, in
target: string ContentType identifier
required: false
default: not defined

Examples:

# identical to the example below
content_type: article

content_type:
    eq: article

# identical to the example below
content_type: [image, video]

content_type:
    in: [image, video]

`field`¶

Defines conditions on Content fields.

value type: integer, string, boolean
value format: single, array
operators: eq, in, gt, gte, lt, lte, between, like, contains
target: string Field identifier
required: false
default: not defined

Examples:

field:
    date_field:
        not:
            gt: 'today +5 days'
    price:
        between: [100, 200]
        not: 155

`is_field_empty`¶

Defines conditions on whether the Content fields are empty or not.

Note

IsEmptyField criterion is supported only by Solr search engine, so this condition can be used only with the FindService. In order to use it configure the query with parameter use_filter set to false.

value type: boolean, null
value format: single
operators: eq
target: string Field identifier
required: false
default: not defined

Examples:

is_field_empty:
    image: false
    video: true

# allow both empty and non-empty fields, which is also the default behaviour
is_field_empty:
    audio: ~

`creation_date`¶

Defines the creation (first publication) date of the Content as a timestamp or time string as accepted by PHP function strtotime.

value type: integer, string
value format: single, array
operators: eq, in, gt, gte, lt, lte, between
target: none
required: false
default: not defined

Examples:

# identical to the example below
creation_date: 1535117737

creation_date:
    eq: 1535117737

# identical to the example below
creation_date: [1435117737, 1535117737]

creation_date:
    in: [1435117737, 1535117737]

# multiple operators are combined with logical AND
creation_date:
    gt: '29 June 1991'
    lte: '5 August 1995'

creation_date:
    gt: 'today'

creation_date:
    between: ['-1 week 2 days 4 hours 2 seconds', 'today']

`section`¶

Defines Section of the Content by the identifier.

value type: string
value format: single, array
operators: eq, in
target: none
required: false
default: not defined

Examples:

# identical to the example below
section: standard

section:
    eq: standard

# identical to the example below
section: [standard, restricted]

section:
    in: [standard, restricted]

`state`¶

Defines ObjectState of the Content by the ObjectStateGroup and ObjectState identifiers.

Note

Content can only exist in single ObjectState from the same ObjectStateGroup.

value type: string ObjectState identifier
value format: single
operators: eq
target: string ObjectStateGroup identifier
required: false
default: not defined

Examples:

# identical to the example below
state:
    ez_lock: not_locked

state:
    ez_lock:
        eq: not_locked

# multiple states are combined with logical AND
# identical to the example below
state:
    ez_lock: locked
    approval: rejected

state:
    ez_lock:
        eq: locked
    approval:
        eq: rejected

Common query parameters¶

`limit`¶

Defines the maximum number of items to return.

Note

This parameter will not be used if you execute the query from Twig using ng_query function. In that case Pargerfanta pager is used with semantic parameters page and max_per_page. To execute the query directly use ng_raw_query Twig function instead.

value type: integer
value format: single
required: false
default: 25

Examples:

limit: 10

`offset`¶

Defines the offset for search hits, used for paging the results.

Note

This parameter will not be used if you execute the query from Twig using ng_query function. In that case Pargerfanta pager is used with semantic parameters page and max_per_page. To execute the query directly use ng_raw_query Twig function instead.

value type: integer
value format: single
required: false
default: 0

Examples:

offset: 20

`sort`¶

value type: string, SortClause
value format: single, array
required: false
default: not defined

Here you can use any SortClause implementation. However, if you define the query in the view configuration, you won’t be able to instantiate the SortClause there. For that reason we provide a way to define the sort clause as a string instead. We this format a subset of commonly used SortClauses is supported. Sort direction is defined as asc for ascending and desc for descending. In can be omitted, in which case it will default to asc.

Strings can be used to define multiple sort clauses through an array of definitions:

sort:
    - depth asc
    - modified desc

Following sort clauses are available through string definition:

Location depth
Content Field
Content modification date
Content name
Location priority
Content publication date

Location depth ¶

String depth enables sorting by Location’s depth:

sort: depth

sort: depth asc

sort: depth desc

Content Field ¶

String in form of of field/[content_type]/[field] enables sorting by any Content Field. For example by Field with identifier title in ContentType with identifier article:

sort: field/article/title

sort: field/article/title asc

sort: field/article/title desc

Content modification date ¶

String modified enables sorting by the Content modification date:

sort: modified

sort: modified asc

sort: modified desc

Content name ¶

String name enables sorting by the Content name:

sort: name

sort: name asc

sort: name desc

Location priority ¶

String priority enables sorting by the Location priority:

sort: priority

sort: priority asc

sort: priority desc

Content publication date ¶

String published enables sorting by the Content publication/creation date:

sort: published

sort: published asc

sort: published desc

Location siblings Query Type¶

Examples¶

Own conditions¶

location¶

Inherited Location conditions¶

main¶

priority¶

visible¶

Common Content conditions¶

content_type¶

field¶

is_field_empty¶

creation_date¶

section¶

state¶

Common query parameters¶

limit¶

offset¶

sort¶

Location depth¶

Content Field¶

Content modification date¶

Content name¶

Location priority¶

Content publication date¶

`location`¶

`main`¶

`priority`¶

`visible`¶

`content_type`¶

`field`¶

`is_field_empty`¶

`creation_date`¶

`section`¶

`state`¶

`limit`¶

`offset`¶

`sort`¶

Location depth ¶

Content Field ¶

Content modification date ¶

Content name ¶

Location priority ¶

Content publication date ¶