Skip to main content

Add forms for user enterable search criteria to collections/topic/smart folders.

Project description

This package provides new criteria types based on the ATContentTypes.criteria types that are used to create a form at the top of the topic view. Users can use the form to submit criteria to supplement any search criteria in the topic. Values entered on the criteria tab for the topic become the default values on the form.

Also provided is an alternative display layout that uses the folder contents table and can still display the search form viewlet.

Form Criteria

Start with a collection and some content for search results.

>>> from Products.PloneTestCase import ptc
>>> self.login()
>>> foo_topic = self.folder['foo-topic-title']
>>> foo_topic
<ATTopic at /plone/Members/test_user_1_/foo-topic-title>
>>> self.folder['bar-document-title']
<ATDocument at /plone/Members/test_user_1_/bar-document-title>
>>> self.folder['baz-event-title']
<ATEvent at /plone/Members/test_user_1_/baz-event-title>

Create the browser object we’ll be using.

>>> from Products.Five.testbrowser import Browser
>>> browser = Browser()
>>> browser.handleErrors = False

Log in as a normal user.

>>> browser.open(portal.absolute_url())
>>> browser.getLink('Log in').click()
>>> browser.getControl('Login Name').value = ptc.default_user
>>> browser.getControl(
...     'Password').value = ptc.default_password
>>> browser.getControl('Log in').click()

Before the topic has any form criteria, the serach form is not present.

>>> browser.open(foo_topic.absolute_url())
>>> browser.getForm(name="formcriteria_search")
Traceback (most recent call last):
LookupError

Add a simple string form criterion for searchable text on the criteria tab.

>>> browser.getLink('Criteria').click()
>>> browser.getControl('Search Text').selected = True
>>> browser.getControl(name="criterion_type", index=0).getControl(
...     'Form: Text').selected = True
>>> browser.getControl('Add criteria').click()
>>> print browser.contents
<...
...Search Text...
...A simple string form criterion...

Set a default search term.

>>> browser.getControl(
...     name=
...     "crit__SearchableText_SimpleStringFormCriterion_value"
...     ).value = 'bar'
>>> browser.getControl(name="form.button.Save").click()
>>> print browser.contents
<...
...Changes saved...

Open another browser as an anymous user.

>>> anon_browser = Browser()
>>> anon_browser.handleErrors = False
>>> anon_browser.open(foo_topic.absolute_url())

If no form value have been submitted, such as on a fresh load of the topic view, the default term will be used in the query returning only one of the content objects.

>>> len(foo_topic.queryCatalog())
1
>>> anon_browser.getLink('Bar Document Title')
<Link text='Bar Document Title'
url='http://nohost/plone/Members/test_user_1_/bar-document-title'>
>>> anon_browser.getLink('Baz Event Title')
Traceback (most recent call last):
LinkNotFoundError

Now that a form criterion has been added, the topic view displays the search form.

>>> form = anon_browser.getForm(name="formcriteria_search")

Enter a search term and submit the query. The topic will now list the other content object.

>>> form.getControl(
...     name='crit__SearchableText_SimpleStringFormCriterion'
...     '.value').value = 'baz'
>>> form.getControl(name='submit').click()
>>> anon_browser.getLink('Bar Document Title')
Traceback (most recent call last):
LinkNotFoundError
>>> anon_browser.getLink('Baz Event Title')
<Link text='Baz Event Title'
url='http://nohost/plone/Members/test_user_1_/baz-event-title'>

The search form also reflects the search term submitted rather than the default value submitted on the criteria tab.

>>> anon_browser.getForm(name="formcriteria_search").getControl(
...     name='crit__SearchableText_SimpleStringFormCriterion'
...     '.value').value
'baz'

Contents View

Change the topic’s display layout to the contents view.

>>> browser.open(foo_topic.absolute_url())
>>> browser.getLink('folder_contents_view').click()
>>> print browser.contents
<...
...View changed...

The view renders the contents form.

>>> browser.getForm(name="folderContentsForm")
<zope.testbrowser.browser.Form object at ...>

The topic contents are listed in the contents table form.

>>> browser.getControl('Bar Document Title')
<ItemControl name='paths:list' type='checkbox'
optionValue='/plone/Members/test_user_1_/bar-document-title'
selected=False>
>>> browser.getControl('Baz Event Title')
Traceback (most recent call last):
LookupError: label 'Baz Event Title'

The search form is also rendered if form criteria are present.

>>> form = browser.getForm(name="formcriteria_search")

The contents view also reflects user submitted criteria.

>>> form.getControl(
...     name='crit__SearchableText_SimpleStringFormCriterion'
...     '.value').value = 'baz'
>>> form.getControl(name='submit').click()
>>> browser.getControl('Bar Document Title')
Traceback (most recent call last):
LookupError: label 'Bar Document Title'
>>> browser.getControl('Baz Event Title')
<ItemControl name='paths:list' type='checkbox'
optionValue='/plone/Members/test_user_1_/baz-event-title'
selected=False>

Changelog

0.4 - 2009-01-15

  • Add list criterion
  • Add selection criterion
  • Fix the form for access by anonymous users

0.3 - 2009-01-15

  • Fully re-use the AT edit widgets
  • Support criteria with multiple fields
  • Use the widgets to process the form values
  • Add checkbox criterion based on ATSelectionCriterion, ATPortalTypeCriterion, and ATReferenceCriterion
  • Add a date range form criterion (JS calendar not working yet)

0.2 - 2008-05-27

  • Fix i18n_domain in ZCML
  • Make the authenticator view conditional for Plone 3.0 compatibility

0.1 - 2008-05-24

  • Initial release

TODO

  • Additional Criteria

    Currently only some criteria have form criteria equivalents. The intention is to add form criteria for the rest of the ATCT criteria as well. I’m only likely to get to the ones that I need without any further input, so if you want one in particular let me know.

  • Form sort criteria

  • Use subcollections to support AdvancedQuery operations

    Collections will act as grouping/parenthesis and operators. IOW, a collection will have a boolean field to set whether it uses AND or OR to find the intersection or union of its result sets. Sub-collections will not acquire criteria but instead parent collections will treat sub-collections as criteria groupings. Not yet sure how to handle sorting.

Project details


Download files

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

Files for collective.formcriteria, version 0.4
Filename, size File type Python version Upload date Hashes
Filename, size collective.formcriteria-0.4.tar.gz (15.8 kB) File type Source Python version None Upload date Hashes View hashes

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