https://github.com/dean-forest-tech/silverstripe-cataloguepage

A custom page type that allows mapping of multiple catalogue categories to a page in the CMS
https://github.com/dean-forest-tech/silverstripe-cataloguepage

Last synced: 22 days ago
JSON representation

A custom page type that allows mapping of multiple catalogue categories to a page in the CMS

• Host: GitHub
• URL: https://github.com/dean-forest-tech/silverstripe-cataloguepage
• Owner: Dean-Forest-Tech
• License: bsd-3-clause
• Created: 2015-02-13T20:52:54.000Z (almost 10 years ago)
• Default Branch: 2
• Last Pushed: 2024-12-10T16:15:14.000Z (about 1 month ago)
• Last Synced: 2024-12-10T17:46:11.727Z (about 1 month ago)
• Language: PHP
• Size: 53.7 KB
• Stars: 1
• Watchers: 5
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Silverstripe CataloguePage Module

A custom page type that either allows:

Mapping of product objects (defined via config) to a CMS page

Or

Mapping of multiple categories to a page in the CMS that then

renders them (and their products) into a template.

The page type also includes a $PaginatedChildren variable to allow

automatically breaking up larger product lists into smaller pages.

## Installation

The easiest way to install this module is via composer:

    # composer require "silverstripe/cataloguepage"

    

Otherwise install and download this module to the "cataloguepage" folder

in your project root.

## Requirements

* Silverstripe Framework 4.0 +

* Silverstripe CMS 4.0 +

### Recommended

* Silverstripe Catalogue

## Setup

Unless you are using the SilverCommerce catalogue admin or frontend you will need to identify your custom product and category classes.

### Custom Product or Categories

To customise the Product and Category objects that are used via this

page, you will need to change the **"product_class"** and **"category_class"**

config variables on CataloguePage.

It is important to be aware that CataloguePage will attempt to hand over

the current request to a controller identified by the

**"base_product_controller"** config variable. You will need to ensure

that you create a conntroller that can render your product.

The easiest way to do this is to set it in your config.yml as below:

```

ilateral\SilverStripe\CataloguePage\Model\CataloguePage:

  product_class: 'Product'

  category_class: 'Category'

  base_product_controller: 'ProductController'

```

## Usage

Setup the catalogue as normal (add categories and then add products to

them).

Then add a catalogue page.

Once the page is created, you should have "Products" and "Categories"

tabs in the CMS, use this to add categories that will be displayed on

this page.

**NOTE** If you are using the [catalogue module](https://github.com/i-lateral/silverstripe-catalogue)

then you will most likely want to disable the frontend catalogue routing

and tempaltes. This can be done via silverstripe config:

config.yml

    Catalogue:

      enable_frontend: false

_config.php

    

    Catalogue::config()->enable_frontend = false;