restruct/silverstripe-filterablearchive

This module decorates pages with configurable fields to filter them by. Handy for newsitems & blogs, etc.

2.0.10 2024-01-10 11:02 UTC

Requires

• silverstripe/framework: ^4.0
• silverstripe/tagfield: ^2.0|^3.0
• silverstripe/vendor-plugin: ^1.0

BSD-3-Clause

• Restruct

• filter
• news
• silverstripe
• archive

README

This module decorates pages with configurable fields to filter them by. Handy for newsitems & blogs, etc.

Filter items via dropdowns by date (paginated).

Features

• Apply decorators to filter pages by date (year, month/year, or day/month/year)
• Filtering by Tags & Categories & corresponding extensions

Installation

composer require restruct/silverstripe-filterablearchive dev-master

Then add the decorators & criteria (todo) which you want to filter by to config.yml:

---
name: 'filterablearchiveextensions'
---
NewsHolder:
  extensions:
    - 'FilterableArchiveHolderExtension'
  pagination_control_tab: "Root.Subpages" # name of tab for pagination settings, defaults to "Root.Main"
  pagination_insert_before: "Subpages" # optional, set position of tab
  managed_object_class: "NewsItem"
  managed_object_date_field: "Date"
NewsHolder_Controller:
  extensions:
    - 'FilterableArchiveHolder_ControllerExtension'
NewsItem_Controller:
  extensions:
    - 'FilterableArchiveItemExtension'

TODO:

• Move part of the shared functionality between Tags & Categories into a Trait (php >= v5.4)

Recommended

Newsgrid module (manage newsitems from a gridfield), applies this module

• silverstripe-newsgrid

Requirements

• SilverStripe 3.0 or newer