silverstripe/segment-field

A reusable approach to segment-generating fields

2.1.0 2017-09-05 23:06 UTC

README

Build Status Code Quality Codecov Version License

A reusable approach to segment-generating fields.

Usage

use SilverStripe\Forms\SegmentField;
use SilverStripe\Forms\SegmentFieldModifier\SlugSegmentFieldModifier;
use SilverStripe\Forms\SegmentFieldModifier\IDSegmentFieldModifier;

SegmentField::create('PageName')->setModifiers(array(
    SlugSegmentFieldModifier::create()->setDefault('page'),
    array('-', ''),
    IDSegmentFieldModifier::create(),
))->setPreview($this->PageDisplayName)
  1. Starting with a value of "My New Page!".
  2. The value is passed through SlugSegmentFieldModifier.
  3. Preview value becomes "My-New-Page", Input value becomes "My-New-Page".
  4. The value is passed through array('-', '').
  5. Preview value becomes "My-New-Page-", Input value becomes "My-New-Page".
  6. The value is passed through IDSegmentFieldModifier.
  7. Preview value becomes "My-New-Page-1" (with the DataObject ID), Input value becomes "My-New-Page".

You can pass any similarly structured array or implementation of SilverStripe\Forms\SegmentFieldModifier in the modifiers list.

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Thanks

I'd like to thank SilverStripe for letting me work on fun projects like this. Feel free to talk to me about using the framework and CMS or working at SilverStripe.