gdmedia/silverstripe-gdm-extensions

Handy extensions and models for SilverStripe

Guru Digital SilverStripe Extensions

A collection of handy extensions, page types, models and modules., _(*1)

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, _(*2)

Requirements _{(Installed automatically when using Composer)}

• SilverStripe ^3.1
• silverstripe-australia/gridfieldextensions ^1
• colymba/gridfield-bulk-editing-tools ^2.1
• sheadawson/silverstripe-linkable ^1.0
• unclecheese/betterbuttons ^1.2

Installation

composer require gdmedia/silverstripe-gdm-extensions

or download the The zip then extract and rename ss-gdm-extensions-master to silverstripe-gdm-extensions, _(*3)

License

3-clause BSD license See License, _(*4)

Documentation

ToDo, _(*5)

Extended classes

• ContentController via SSGuru_ContentController Added features Additional the methods.....
• Controller via SSGuru_Controller Added features Additional the methods.....
• ErrorPage via SSGuru_ErrorPage Added features Additional the methods.....
• PageUtilities via SSGuru_PageUtilities Added features Additional the methods.....
• SiteTree via SSGuru_SiteTree Added features Additional the methods.....
• ViewableData via SSGuru_ViewableData Added features Additional the methods.....

Configuration

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

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 ), _(*7)

Add optional extensions in your mysite/_config/config.yml, _(*8)

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., _(*9)

If the issue does look like a new bug:, _(*10)

• 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., _(*11)

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., _(*12)

Versioning

Prior to version 1.0.0 breaking changes may occur., _(*13)

This project follows Semantic Versioning paradigm. That is:, _(*14)

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., _(*15)