Skip to main content

Compound criterion for plone.app.collection managing complex query

Project description

.. image:: https://secure.travis-ci.org/collective/collective.compoundcriterion.png
:target: http://travis-ci.org/collective/collective.compoundcriterion

.. image:: https://coveralls.io/repos/collective/collective.compoundcriterion/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/collective/collective.compoundcriterion?branch=master

============================
collective.compoundcriterion
============================

This package add a new kind of criterion available for plone.app.collection.

Motivation
----------

Sometimes, some index are composed of different elements with a certain logic or you need to query particular elements of the site like groups of the current user or anything else.
This is not achievable using default indexes and Collection UI, you need to write python code.

How to use
----------

When adding/editing a Collection, a new criterion filed under the 'Other' category of available indexes called 'Filter' is available.

When selecting a 'Filter', a selection box will show you named adapter that provide the collective.compoundcriterion.interfaces.ICoumpondCriterionFilter interface.

You will be able to select among available ones. This can still be used together with other criteria.

To register this complex query builder named adapter, you will have to add this kind of code :

.. code:: xml

<adapter for="*"
factory="collective.compoundcriterion.tests.adapter.CompoundCrietrionFilterAdapter"
provides="collective.compoundcriterion.interfaces.ICompoundCriterionFilter"
name="testing-compound-adapter" />

How to test
-----------

Add the adapter registration zcml here above to a configure.zcml file (like the one in collective.compoundcriterion), it will make the 'testing-compound-adapter' available in the Collection 'Filter' index.

This testing adapter will query elements of the site having string 'special_text_to_find' in the title. So create a document with such title and it should work.

A second adapter can be used to test :

.. code:: xml

<adapter for="*"
factory="collective.compoundcriterion.tests.adapter.SampleCompoundCrietrionFilterAdapter"
provides="collective.compoundcriterion.interfaces.ICompoundCriterionFilter"
name="sample-compound-adapter" />

This one will query elements having 'title_with_sample_text' in the title.

Contributors
============

- IMIO, support@imio.be
Changelog
=========


0.4 (2018-08-31)
----------------

- When getting the adapter, if context is not the Collection, try to get real context
following various cases. This is the case when using Collection
from plone.app.contenttypes.
[gbastien]
- Do not use a SelectionWidget to render the querystring widget as it does not
exist anymore for plone.app.contenttypes Collection.
Use the MultipleSelectionWidget. This way finally we may select several
filters to build the query.
[gbastien]
- When using 'not' in queries for ZCatalog 3, 'query' level must be replaced by 'not' in query dictionary.
[sgeulette]

0.3 (2016-12-08)
----------------

- Return clear message when a query format is not plone.app.querystring compliant.
[gbastien]


0.2 (2015-09-04)
----------------

- Raise a KeyError if the format of the query returned by the named adapter
is not compliant with what is returned by
plone.app.querystring.queryparser.parseFormquery, this way it behaves
correctly with collective.eeafaceted.collectionwidget.
[gbastien]


0.1 (2015-06-02)
----------------

- Initial release.
[IMIO]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
collective.compoundcriterion-0.4.tar.gz (21.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page