gdmedia/silverstripe-gdm-extensions

There is no license information available for the latest version (0.1.25) of this package.

Handy extensions and models for SilverStripe

0.1.25 2017-07-02 02:50 UTC

README

A collection of handy extensions, page types, models and modules.

Work in progress

This module is work in progress and is still being regularly refactored. Until version 1.0 the API is likely to change

Requirements (Installed automatically when using Composer)

Installation

composer require gdmedia/silverstripe-gdm-extensions

or download the The zip then extract and rename ss-gdm-extensions-master to silverstripe-gdm-extensions

License

3-clause BSD license See License

Documentation

ToDo

####Extended classes

Configuration

ContentController, Controller, ErrorPage, PageUtilities, SiteTree and ViewableData are extended by default via ss-gdm-extensions/_config/config.yml

ContentController:
  extensions:
    - SSGuru_ContentController
Controller:
  extensions:
    - SSGuru_Controller
ErrorPage:
  extensions:
    - SSGuru_ErrorPage
Page:
  extensions:
    - SSGuru_PageUtilities
SiteTree:
  extensions:
    - SSGuru_ViewableData
    - SSGuru_SiteTree
ViewableData:
  extensions:
    - SSGuru_ViewableData

Other optional extensions are

  • SSGuru_CarouselPage - Adds a Carousel to a page type ( Compatible template required )

Add optional extensions in your mysite/_config/config.yml

YourPageClass:
  extensions:
    - SSGuru_PageExtension

Bug tracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

  • Create a new issue
  • Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
  • Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bug tracker.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Versioning

Prior to version 1.0.0 breaking changes may occur.

This project follows Semantic Versioning paradigm. That is:

Given a version number MAJOR.MINOR.PATCH, increment the:

  1. MAJOR version when you make incompatible API changes,
  2. MINOR version when you add functionality in a backwards-compatible manner, and
  3. PATCH version when you make backwards-compatible bug fixes.
  4. Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.