Sunnysideup\DashboardWelcomeQuicklinks\Admin\DashboardWelcomeQuicklinks

Complexity

Total Complexity

37

Size/Duplication

Total Lines	319
Duplicated Lines	0 %

Importance

Changes	20
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	add_group()	0	7	2
A	getFontColor()	0	12	2
A	get_links()	0	3	1
A	get_base_phrase()	0	4	1
A	Breadcrumbs()	0	10	2
A	add_link()	0	6	1
B	makeShortCut()	0	36	6
A	Title()	0	8	3
C	updateFormWithQuicklinks()	0	78	14
A	getLinksFromImplementor()	0	12	4
A	getEditForm()	0	12	1

<?php

namespace Sunnysideup\DashboardWelcomeQuicklinks\Admin;

use SilverStripe\Admin\LeftAndMain;

The type SilverStripe\Admin\LeftAndMain was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\SiteConfig\SiteConfig;

The type SilverStripe\SiteConfig\SiteConfig was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\View\ArrayData;
use Sunnysideup\DashboardWelcomeQuicklinks\Api\DefaultDashboardProvider;
use Sunnysideup\DashboardWelcomeQuicklinks\Interfaces\DashboardWelcomeQuickLinksProvider;

/**
 * Class \Sunnysideup\DashboardWelcomeQuicklinks\Admin\DashboardWelcomeQuicklinks
 *
 */
class DashboardWelcomeQuicklinks extends LeftAndMain
{
    protected static int $item_counter = 0;
    protected static int $group_counter = 0;
    protected static array $links = [];


    public static function add_group(string $groupCode, string $title, ?int $sort = 0)
    {
        self::$group_counter++;

        self::$links[$groupCode] = [
            'Title' => $title,
            'SortOrder' => $sort ?: self::$group_counter,
        ];
    }

    public static function add_link(string $groupCode, string $title, string $link)
    {
        self::$item_counter++;
        self::$links[$groupCode]['Items'][] = [
            'Title' => $title,
            'Link' => $link,
        ];
    }

    public static function get_links()
    {
        return self::$links;
    }

    public static function get_base_phrase(string $phrase): string
    {
        $phrase = Config::inst()->get(static::class, $phrase .'_phrase');
        return _t('DashboardWelcomeQuicklinks.'.$phrase, $phrase);
    }

    private static string $add_phrase = '+';

The private property $add_phrase is not used, and could be removed.

    private static string $review_phrase = '☑';

The private property $review_phrase is not used, and could be removed.

    private static string $edit_phrase = '✎';

The private property $edit_phrase is not used, and could be removed.

    private static string $url_segment = 'go';

The private property $url_segment is not used, and could be removed.

    private static bool $use_default_dashboard_provider = true;

The private property $use_default_dashboard_provider is not used, and could be removed.

    private static $menu_title = 'Quick-links';

The private property $menu_title is not used, and could be removed.

    private static $menu_icon_class = 'font-icon-dashboard';

The private property $menu_icon_class is not used, and could be removed.

    private static $menu_priority = 99999;

The private property $menu_priority is not used, and could be removed.

    private static $colour_options = [];

The private property $colour_options is not used, and could be removed.

    private static $max_shortcuts_per_group = 7;

The private property $max_shortcuts_per_group is not used, and could be removed.

    private static $more_phrase = '... More';

The private property $more_phrase is not used, and could be removed.

    private static $default_colour_options = [

The private property $default_colour_options is not used, and could be removed.

        '#0D47A1',
        '#01579B',
        '#006064',
        '#004D40',
        '#1B5E20',
        '#33691E',
        '#827717',
        '#F57F17',
        '#FF6F00',
        '#E65100',
        '#BF360C',
        '#3E2723',
        '#212121',
        '#B71C1C',
        '#880E4F',
        '#4A148C',
        '#311B92',
        '#1A237E',
    ];

    /**
     * easy to distinguish colours
     *
     * @var array
     */
    private static $default_colour_options1 = [

The private property $default_colour_options1 is not used, and could be removed.

        '#F2F3F4',
        '#222222',
        '#F3C300',
        '#875692',
        '#F38400',
        '#A1CAF1',
        '#BE0032',
        '#C2B280',
        '#848482',
        '#008856',
        '#E68FAC',
        '#0067A5',
        '#F99379',
        '#604E97',
        '#F6A600',
        '#B3446C',
        '#DCD300',
        '#882D17',
        '#8DB600',
        '#654522',
        '#E25822',
        '#2B3D26',
    ];


    /**
     * light colours
     *
     * @var array
     */
    private static $default_colour_options3 = [

The private property $default_colour_options3 is not used, and could be removed.

        '#FFEBEE',
        '#FCE4EC',
        '#F3E5F5',
        '#EDE7F6',
        '#E8EAF6',
        '#E3F2FD',
        '#E1F5FE',
        '#E0F7FA',
        '#E0F2F1',
        '#E8F5E9',
        '#F1F8E9',
        '#F9FBE7',
        '#FFFDE7',
        '#FFF8E1',
        '#FFF3E0',
        '#FBE9E7',
        '#EFEBE9',
        '#FAFAFA'
    ];

    public function getEditForm($id = null, $fields = null)
    {
        $form = parent::getEditForm($id, $fields);

        // if ($form instanceof HTTPResponse) {
        //     return $form;
        // }
        // $form->Fields()->removeByName('LastVisited');

        $this->updateFormWithQuicklinks($form);

        return $form;
    }

    public function updateFormWithQuicklinks($form)
    {
        $shortcuts = $this->getLinksFromImplementor();
        // print_r($shortcuts);
        $html = '';
        $max = $this->Config()->get('max_shortcuts_per_group');
        if (count($shortcuts)) {
            $html = '<div class="grid-wrapper">';

            usort(
                $shortcuts,
                function ($a, $b) {
                    ($a['SortOrder'] ?? 0) <=> ($b['SortOrder'] ?? 0);
                }
            );

            foreach ($shortcuts as $groupCode => $groupDetails) {
                $colour = '';
                if (!empty($groupDetails['Colour'])) {
                    $colour = 'style="background-color: ' . $groupDetails['Colour'] . '"';
                }
                $icon = '';
                if (!empty($groupDetails['IconClass'])) {
                    $icon = '<i class="' . $groupDetails['IconClass'] . '"></i> ';
                }
                $html .= '
                <div class="grid-cell" ' . $colour . '>
                    <div class="header">
                    <h1>' . $icon . '' . ($groupDetails['Title'] ?? $groupCode) . '</h1>
                    </div>
                    <div class="entries">';
                $items = $groupDetails['Items'] ?? [];
                if (!empty($entry['Link']) && class_exists($entry['Link'])) {
                    $obj = Injector::inst()->get($entry['Link']);
                    if ($obj instanceof DataObject) {
                        $entry['Link'] = DataObject::get_one($entry['Link'])->CMSEditLink();
                    } else {
                        $entry['Link'] = $obj->Link();
                    }
                }
                foreach ($items as $count => $entry) {
                    $entry['Class'] = $entry['Class'] ?? '';
                    $entry['Class'] .= ($count > $max) ? ' more-item' : '';
                    $html .= $this->makeShortCut(
                        (string) $entry['Title'],
                        (string) $entry['Link'],
                        $entry['OnClick'] ?? '',
                        $entry['Script'] ?? '',
                        $entry['Class'] ?? '',
                        $entry['IconClass'] ?? '',
                        $entry['Target'] ?? '',
                    )->Field();
                    if($count > $max && count($items) == $count + 1) {
                        $html .= $this->makeShortCut(
                            $this->Config()->get('more_phrase'),
                            '#', // link
                            'dashboardWelcomeQuickLinksSetupInputAndFilterToggleMore(event); return false;', // onclick
                            '', // script
                            'more-item-more', //class
                        )->Field();
                    }
                }
                $html .= '</div></div>';
            }
        }
        $kc = (array) $this->Config()->get('colour_options');
        if(empty($kc)) {
            $kc = $this->Config()->get('default_colour_options');
        }
        $kcCount = count($kc);
        $colours = '';
        foreach ($kc as $key => $colour) {
            $colours .= ' .grid-wrapper .grid-cell:nth-child(' . $kcCount . 'n+' . ($key + 1) . ') div.header {background-color: ' . $colour . '; color: '.$this->getFontColor($colour).'!important;}';
        }
        $html .= '</div>';
        $html .= '<script>window.setTimeout(dashboardWelcomeQuickLinksSetupInputAndFilter, 500)</script>';
        $html .= '<style>' . $colours . '</style>';
        $form->Fields()->push(LiteralField::create('ShortCuts', $html));
    }

    protected function getLinksFromImplementor()
    {
        $array = [];
        $useDefaultDashboard = (bool) $this->config()->get('use_default_dashboard_provider');
        $classNames = ClassInfo::implementorsOf(DashboardWelcomeQuickLinksProvider::class);
        foreach ($classNames as $className) {
            if($useDefaultDashboard === false && (string) $className === DefaultDashboardProvider::class) {
                continue;
            }
            $array += Injector::inst()->get($className)->provideDashboardWelcomeQuickLinks();
        }
        return $array;
    }

    protected function makeShortCut(string $title, string $link, ?string $onclick = '', ?string $script = '', ?string $class = '', ?string $iconClass = '', ?string $target = '')
    {
        $name = preg_replace('#[\W_]+#u', '', (string) $title);
        $html = '';
        if ($onclick) {
            $onclick = ' onclick="' . $onclick . '"';
        }
        if ($script) {
            $script = '<script>' . $script . '</script>';
        }
        $icon = '';
        if (!empty($iconClass)) {
            $icon = '<i class="' . $iconClass . '"></i> ';
        }
        if(!$target) {
            $target = '_self';
        }
        $target = ' target="'.$target.'"';
        if ($link) {
            $html = '
            ' . $script . '
            <h2 class="' . $class . '">
                ' . $icon . '<a href="' . $link . '" ' . $target . ' ' . $onclick . '>' . $title . '</a>
            </h2>';
        } else {
            $html = '
            ' . $script . '
            <h2>
                ' . $title . '
            </h2>
            ';
        }

        return LiteralField::create(
            $name,
            $html
        );
    }
    /**
     * @return string
     */
    public function Title()
    {
        $app = $this->getApplicationName();
        $siteConfigTitle = SiteConfig::current_site_config()->Title;
        if($siteConfigTitle) {
            $app = $siteConfigTitle . ' ('.$app.')';
        }
        return ($section = $this->SectionTitle()) ? sprintf('%s for %s', $section, $app) : $app;
    }
    /**
     * @param bool $unlinked
     * @return ArrayList<ArrayData>
     */
    public function Breadcrumbs($unlinked = false)
    {
        $items = new ArrayList([
            new ArrayData([
                'Title' => $this->Title(),
                'Link' => ($unlinked) ? false : $this->Link()
            ])
        ]);

        return $items;
    }
    protected function getFontColor(string $backgroundColor): string
    {
        // Convert hex color to RGB
        $r = hexdec(substr($backgroundColor, 1, 2));
        $g = hexdec(substr($backgroundColor, 3, 2));
        $b = hexdec(substr($backgroundColor, 5, 2));

        // Calculate luminance
        $luminance = (0.299 * $r + 0.587 * $g + 0.114 * $b) / 255;

        // If luminance is greater than 0.5, use black font; otherwise, use white
        return $luminance > 0.5 ? '#222' : '#fff';
    }

}