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

Passed

Push — master ( 090f34...a19fbb )

by Nicolaas

created 2023-07-17 02:11 UTC

DBColour::ReadableColor() A

↳ Parent: DBColour

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?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 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 DBVarchar
{

    private static $colour_picker_field_class_name = SelectedColourPickerFormFieldDropdown::class;

    /**
     * please set
     * must be defined as #AABB99 (hex codes).
     *
     * @var array
     */
    protected const COLOURS = [];

    /**
     * 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',
        'ReadableColor' => 'Varchar'
    ];

    public function __construct($name = null, $size = 9)
    {
        parent::__construct($name, $size);
    }

    public function CssClass(?bool $isTransparent = false): string
    public function CssClass(/** @scrutinizer ignore-unused */ ?bool $isTransparent = false): string
    {
        return $this->getCssClass();
    }

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

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

    public function CssClassAlternative(?bool $isTransparent = false): string
    public function CssClassAlternative(/** @scrutinizer ignore-unused */ ?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 scaffoldFormField($title = null, $params = null)
    {
        return static::get_dropdown_field($this->name, $title);
    }

    /**
     *
     * @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(static::COLOURS)
            ->setLimitedToOptions(static::IS_LIMITED_TO_OPTIONS)
            ->setIsBgColour(static::IS_BG_COLOUR);
        ;
        return $field;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }

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

    public function ReadableColor(): string
    {
        return $this->getReadableColor();
    }
    public function getReadableColor(): string
    {
        // Remove '#' if it's present
        $hexColor = ltrim((string) $this->value, '#');

        // Check if the color is valid
        if(strlen($hexColor) == 6) {
            // Convert the color from hexadecimal to RGB
            $r = hexdec(substr($hexColor, 0, 2)) / 255;
            $g = hexdec(substr($hexColor, 2, 2)) / 255;
            $b = hexdec(substr($hexColor, 4, 2)) / 255;

            // Calculate the relative luminance
            $luminance = 0.2126 * $r + 0.7152 * $g + 0.0722 * $b;

            // Return either black or white, depending on the luminance
            if($luminance > 0.5) {
                return '#000000'; // Black color
            } else {
                return '#ffffff'; // White color
            }
        } else {
            return false; // Invalid color

        }
    }
    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 static function get_dropdown_field_old(?string $name = 'TextColour', ?string $title = 'Text Colour'): SelectedColourPickerFormField
// {
//     $field = SelectedColourPickerFormField::create(
//         $name,
//         $title,
//         static::COLOURS
//     );
//     $js = '
//         jQuery("#TextAndBackgroudColourExample").css("color", jQuery(this).val());
//     ';
//     $field->setAttribute('onchange', $js);
//     $field->setAttribute('onhover', $js);
//     $field->setAttribute('onclick', $js);
//     $field->setAttribute('onfocus', $js);
//
//     return $field;
// }
//


sunnysideup / silverstripe-selected-colour-picker

Push — master ( 090f34...a19fbb )

DBColour::ReadableColor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like