gorriecoe/silverstripe-linkfield

Adds a Linkfield for gorriecoe/silverstripe-link

Installs: 12 017

Dependents: 2

Suggesters: 0

Stars: 3

Watchers: 2

Forks: 8

Open Issues: 5

Type:silverstripe-vendormodule

1.0.0 2019-05-30 06:14 UTC

README

ko-fi

Adds a Linkfield for gorriecoe/silverstripe-link

Installation

Composer is the recommended way of installing SilverStripe modules.

composer require gorriecoe/silverstripe-linkfield

Requirements

  • gorriecoe/silverstripe-link ^1.0
  • silvershop/silverstripe-hasonefield 3.0.1. See Issue #11
  • symbiote/silverstripe-gridfieldextensions 3.1

Maintainers

Screenshots

Link list Detail edit form

Usage

<?php

use gorriecoe\Link\Models\Link;
use gorriecoe\LinkField\LinkField;

class MyClass extends DataObject
{
    private static $has_one = [
        'Button' => Link::class
    ];

    private static $many_many = [
        'Buttons' => Link::class
    ];

    private static $many_many_extraFields = [
        'Buttons' => [
            'Sort' => 'Int' // Required for all many_many relationships
        ]
    ];

    /**
     * CMS Fields
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->addFieldsToTab(
            'Root.Main',
            [
                LinkField::create(
                    'Button',
                    'Button',
                    $this
                ),
                LinkField::create(
                    'Buttons',
                    'Buttons',
                    $this
                )
            ]
        );
        return $fields;
    }
}

Sort column

By default the LinkField assumes that the sort column is named Sort. If you want to use another field name such as SortOrder, you can specify it using the setSortColumn method like so:

LinkField::create(
    'Buttons',
    'Buttons',
    $this
)->setSortColumn('SortOrder')

You can also globally define the sort column. In your config.yml add the following:

gorriecoe\LinkField\LinkField:
  sort_column: 'SortOrder'

Belongs many many

We can also add a belongs_many_many relation to the Link class. In your config.yml add the following:

gorriecoe\Link\Models\Link:
  belongs_many_many:
    MyCustomObject : MyCustomObject.Buttons