BringYourOwnIdeas\Maintenance\Forms\GridFieldLinkButton

Complexity

Total Complexity

2

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getHTMLFragments()	0	8	1

<?php

namespace BringYourOwnIdeas\Maintenance\Forms;

use SilverStripe\Forms\GridField\GridField;
use SilverStripe\View\ArrayData;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;

/**
 * A button that contains a link to an URL.
 *
 * @package forms
 * @subpackage fields-gridfield
 */

class GridFieldLinkButton implements GridField_HTMLProvider
{
    /**
     * Fragment to write the button to.
     * @var string
     */
    protected $targetFragment;

    /**
     * URL link the button links out to.
     * @var string
     */
    protected $link;

    /**
     * Caption text for the button to show
     * @var string
     */
    protected $caption;

    /**
     * @param string $link The URL link the button links out to.
     * @param string $targetFragment The HTML fragment to write the button into
     */
    public function __construct($link, $caption, $targetFragment)
    {
        $this->link = $link;
        $this->caption = $caption;
        $this->targetFragment = $targetFragment;
    }

    /**
     * Place the link button in a <p> tag above the field
     *
     * @param GridField $gridField
     *
     * @return array
     */
    public function getHTMLFragments($gridField)
    {
        $fragment = ArrayData::create([
            'Link' => $this->link,
            'Caption' => $this->caption,
        ])->renderWith(__CLASS__);

        return [$this->targetFragment => $fragment];
    }
}