DBColour::get_colours_for_dropdown() - Code Metrics - Inspection of "Update INDEX.md" - sunnysideup/silverstripe-selected-colour-picker - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 211f6c...7a1513 )

by Nicolaas
created 2023-07-18 01:07 UTC
DBColour::get_colours_for_dropdown() A

↳ Parent: DBColour
Complexity

Conditions	4
Paths	4
Size

Total Lines	20
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	4
eloc	12
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	20
rs	9.8666
<?php

namespace Sunnysideup\SelectedColourPicker\Model\Fields;

use SilverStripe\Forms\FormField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\FieldType\DBVarchar;

use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\FieldType\DBField;
use Sunnysideup\SelectedColourPicker\Forms\SelectedColourPickerFormField;
use Sunnysideup\SelectedColourPicker\Forms\SelectedColourPickerFormFieldDropdown;
use Sunnysideup\SelectedColourPicker\ViewableData\SelectedColourPickerFormFieldSwatches;
use TractorCow\Colorpicker\Color;
filter:
    dependency_paths: ["lib/*"]

class DBColour extends Color
{
    private static $colour_picker_field_class_name = SelectedColourPickerFormFieldDropdown::class;

    /**
     * please set
     * must be defined as #AABB99 (hex codes).
     * Needs to be set like this:
     * ```php
     *     [
     *         'schema1' => [
     *             '#fff000' => 'My Colour 1',
     *             '#fff000' => 'My Colour 2',
     *         ],
     *
     *     ]
     *
     * ```
     *
     * @var array
     */
    private static $colours = [
        'default' => self::DEFAULT_COLOURS,
    ];


    protected const DEFAULT_COLOURS = [
        '#FF0000' => 'Red',
        '#0000FF' => 'Blue',
        '#00FF00' => 'Green',
    ];



    /**
     * please set.
     *
     * @var string`
     */
    protected const CSS_CLASS_PREFIX = 'db-colour';

    /**
     * please set.
     *
     * @var bool
     */
    protected const IS_LIMITED_TO_OPTIONS = true;

    /**
     * please set.
     *
     * @var bool
     */
    protected const IS_BG_COLOUR = true;

    private static $casting = [
        'CssClass' => 'Varchar',
        'CssClassAlternative' => 'Boolean',
        'ReadableColor' => 'Varchar'
    ];

    private static $schema = 'default';

    public function __construct($name = null, $schema = '', $options = [])
    {
        $this->schema = $schema ?: $name;
        parent::__construct($name, $options);
    }



    public static function my_colours(string $name): array
    {
        return DBField::create_field(DBColour::class, $name)->getColours();
    }

    public static function get_swatches_field(string $name, string $value): LiteralField
    {
        return SelectedColourPickerFormFieldSwatches::get_swatches_field(
            (string) $name,
            (string) $value,
            self::my_colours(($name)),
            static::IS_BG_COLOUR
        );
    }

    /**
     *
     * @param  string $name
     * @param  string $title
     * @return FormField
     */
    public static function get_dropdown_field(string $name, ?string $title = '')
    {
        $className = Config::inst()->get(DBColour::class, 'colour_picker_field_class_name');
        return $className::create(
            $name,
            $title
        )
            ->setSource(self::my_colours($name))
            ->setLimitedToOptions(static::IS_LIMITED_TO_OPTIONS)
            ->setIsBgColour(static::IS_BG_COLOUR);
        ;
    }


    public function get_colours_for_dropdown(?string $name = 'default'): ?array
    {
        $colours = self::my_colours($name);
        $colours = self::my_colours(/** @scrutinizer ignore-type */ $name);
        if (!empty($colours)) {
            $array = [];

            foreach ($colours as $code => $label) {
                $textColor = $this->getIsColorLight($code) ? '#000000' : '#FFFFFF';

                $array[$code] = [
                    'label' => $label,
                    'background_css' => $code,
                    'color_css' => $textColor,
                    'sample_text' => 'Aa',
                ];
            }

            return $array;
        }
        return null;
    }


    /**
     * Detects if the given color is light
     * @param string $colour HEX color code
     */
    public static function get_font_colour(?string $colour = ''): string
    {
        return self::is_light_colour((string) $colour) ? '#000000' : '#ffffff';
    }

    /**
     * @param string $colour HEX color code
     */
    public static function is_dark_colour(?string $colour = ''): bool
    {
        return self::is_light_colour((string) $colour) ? false : true;
    }

    /**
     * Detects if the given color is light
     * @param string $colour HEX color code
     */
    public static function is_light_colour(?string $colour = ''): bool
    {
        if ($colour === 'transparent') {
            return true;
        }
        $colourWithoutHash = str_replace('#', '', (string) $colour);
        // Convert the color to its RGB values
        $rgb = sscanf($colourWithoutHash, "%02x%02x%02x");
        if (isset($rgb[0], $rgb[1], $rgb[2])) {
            // Calculate the relative luminance of the color using the formula from the W3C
            $luminance = 0.2126 * $rgb[0] + 0.7152 * $rgb[1] + 0.0722 * $rgb[2];

            // If the luminance is greater than 50%, the color is considered light
            return $luminance > 128;
        }
        return true;
    }


    public static function check_colour(?string $colour, ?bool $isBackgroundColour = false): string
    {
        $colour = strtolower($colour);
        $colour = strtolower(/** @scrutinizer ignore-type */ $colour);
        if($colour === 'transparent') {
            return 'transparent';
        }
        if(! strpos($colour, '#')) {
            $colour = '#' . $colour;
        }
        if(! $colour) {
            if($isBackgroundColour) {
                $colour = '#ffffff';
            } else {
                $colour = '#000000';
            }
        }
        return $colour;
    }


    public function CssClass(?bool $isTransparent = false): string
    {
        return $this->getCssClass();
    }

    public function getCssClass(?bool $isTransparent = false): string
    {
        $colours = $this->getColours();
        if($isTransparent) {
            $name = 'transparent';
        } else {
            $name = $colours[$this->value] ?? 'colour-error';
        }

        return $this->classCleanup($name);
    }

    public function CssClassAlternative(?bool $isTransparent = false): string
    {
        return $this->getCssClassAlternative();
    }

    public function getCssClassAlternative(?bool $isTransparent = false): string
    {
        if($isTransparent) {
            $name = 'ffffff00';
        } else {
            $name = $this->value ?: 'no-colour';
        }
        return $this->classCleanup($name);
    }


    public function ReadableColor(): string
    {
        return $this->getReadableColor();
    }
    public function getReadableColor(): string
    {
        // Remove '#' if it's present
        return $this->getFontColour();
    }
    private function classCleanup(string $name): string
    {
        $name = str_replace('#', '', $name);
        $name = preg_replace('#[^A-Za-z0-9]#', '-', $name);

        return static::CSS_CLASS_PREFIX . '-' . trim(trim(strtolower($name), '-'));
    }

    public function scaffoldFormField($title = null, $params = null)
    {
        return static::get_dropdown_field($this->name, $title);
    }

    protected function getColours(): array
    {
        return $this->Config()->get('colours');
    }

    protected function getMyColours(): array
    {
        $colours = $this->getColours();

        return $colours[$this->schema] ?? $colours['default'] ?? self::DEFAULT_COLOURS;
    }





}

sunnysideup / silverstripe-selected-colour-picker

Push — master ( 211f6c...7a1513 )

DBColour::get_colours_for_dropdown() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
