Color picker form for selecting color hexcodes using yui library. More...

Inheritance diagram for ilColorPickerInputGUI:

Collaboration diagram for ilColorPickerInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	checkInput ()
	Check input, strip slashes etc. More...

	getInput ()

	setValueByArray (array $a_values)

	setValue ($a_value)

	setDefaultColor (string $a_defaultcolor)

	getDefaultColor ()

	setAcceptNamedColors (bool $a_acceptnamedcolors)

	getAcceptNamedColors ()

	getHexcode ()

	insert (ilTemplate $a_tpl)

Public Member Functions inherited from ilTextInputGUI
	__construct (string $a_title="", string $a_postvar="")

	setValue ($a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

	setValidationRegexp (string $a_value)

	getValidationRegexp ()

	setMaxLength (?int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setInlineStyle (string $a_style)

	getInlineStyle ()

	setCssClass (string $a_class)

	getCssClass ()

	setValueByArray (array $a_values)

	getSize ()

	setSuffix (string $a_value)

	getSuffix ()

	setInputType (string $a_type)
	set input type More...

	getInputType ()

	setSubmitFormOnEnter (bool $a_val)

	getSubmitFormOnEnter ()

	checkInput ()
	Check input, strip slashes etc. More...

	getInput ()

	getDataSource ()

	setDataSource (string $href, ?string $a_delimiter=null)

	setDataSourceSubmitOnSelection (bool $a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl (string $a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	render (string $a_mode="")

	insert (ilTemplate $a_tpl)

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

	setDisableHtmlAutoComplete (bool $autocomplete)

	isHtmlAutoCompleteDisabled ()

	getPostValueForComparison ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Static Public Member Functions
static	determineHexcode (string $a_value)

Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Protected Attributes
string	$hex = ""

bool	$acceptnamedcolors = false

string	$defaultcolor = ""

Protected Attributes inherited from ilTextInputGUI
	$value = null

int	$maxlength = 200

int	$size = 40

string	$validationRegexp = ""

string	$validationFailureMessage = ''

string	$suffix = ""

string	$style_css = ""

string	$css_class = ""

string	$ajax_datasource = ""

string	$ajax_datasource_delimiter = null

bool	$ajax_datasource_commit = false

string	$ajax_datasource_commit_url = ""

bool	$submit_form_on_enter = false

bool	$autocomplete_disabled = false

string	$input_type = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

Color picker form for selecting color hexcodes using yui library.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Deprecated:: 12 This component will be removed with ILIAS 12

Definition at line 27 of file class.ilColorPickerInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilColorPickerInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

Reimplemented from ilTextInputGUI.

Definition at line 33 of file class.ilColorPickerInputGUI.php.

      {
        parent::__construct($a_title, $a_postvar);
        $this->setType("color");
        $this->setDefaultColor("04427e");
    }

References ILIAS\GlobalScreen\Provider\__construct(), setDefaultColor(), and ilFormPropertyGUI\setType().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilColorPickerInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilTextInputGUI.

Definition at line 42 of file class.ilColorPickerInputGUI.php.

                                : bool
    {
        if ($this->getRequired() && !strlen($this->getInput())
        ) {
            $this->setAlert($this->lng->txt("msg_input_is_required"));
            return false;
        }
 
        return true;
    }

References getInput(), ilFormPropertyGUI\getRequired(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setAlert().

Here is the call graph for this function:

◆ determineHexcode()

static ilColorPickerInputGUI::determineHexcode ( string $a_value )

static

Definition at line 107 of file class.ilColorPickerInputGUI.php.

                                                            : string
    {
        $a_value = trim(strtolower($a_value));
 
        // remove leading #
        if (strpos($a_value, '#') === 0) {
            $a_value = substr($a_value, 1);
        }
 
        // handle standard color names (no leading (!))
        switch ($a_value) {
            // html4 colors
            case "black": $a_value = "000000";
                break;
            case "maroon": $a_value = "800000";
                break;
            case "green": $a_value = "008000";
                break;
            case "olive": $a_value = "808000";
                break;
            case "navy": $a_value = "000080";
                break;
            case "purple": $a_value = "800080";
                break;
            case "teal": $a_value = "008080";
                break;
            case "silver": $a_value = "C0C0C0";
                break;
            case "gray": $a_value = "808080";
                break;
            case "red": $a_value = "ff0000";
                break;
            case "lime": $a_value = "00ff00";
                break;
            case "yellow": $a_value = "ffff00";
                break;
            case "blue": $a_value = "0000ff";
                break;
            case "fuchsia": $a_value = "ff00ff";
                break;
            case "aqua": $a_value = "00ffff";
                break;
            case "white": $a_value = "ffffff";
                break;
 
                // other colors used by ILIAS, supported by modern browsers
            case "brown": $a_value = "a52a2a";
                break;
        }
 
        // handle rgb values
        if (substr($a_value, 0, 3) == "rgb") {
            $pos1 = strpos($a_value, "(");
            $pos2 = strpos($a_value, ")");
            $rgb = explode(",", substr($a_value, $pos1 + 1, $pos2 - $pos1 - 1));
            $r = str_pad(dechex((int) $rgb[0]), 2, "0", STR_PAD_LEFT);
            $g = str_pad(dechex((int) $rgb[1]), 2, "0", STR_PAD_LEFT);
            $b = str_pad(dechex((int) $rgb[2]), 2, "0", STR_PAD_LEFT);
            $a_value = $r . $g . $b;
        }
 
        $a_value = trim(strtolower($a_value));
 
        // expand three digit hex numbers
        if (preg_match("/^[a-f0-9]{3}/", $a_value) && strlen($a_value) == 3) {
            $a_value = "" . $a_value;
            $a_value = $a_value[0] . $a_value[0] . $a_value[1] . $a_value[1] . $a_value[2] . $a_value[2];
        }
 
        if (!preg_match("/^[a-f0-9]{6}/", $a_value)) {
            $a_value = "";
        }
 
        return strtoupper($a_value);
    }

References Vendor\Package\$b.

Referenced by getInput(), insert(), ilTRBLColorPickerInputGUI\insert(), ilTRBLColorPickerInputGUI\setAllValue(), ilTRBLColorPickerInputGUI\setBottomValue(), ilTRBLColorPickerInputGUI\setLeftValue(), ilTRBLColorPickerInputGUI\setRightValue(), ilTRBLColorPickerInputGUI\setTopValue(), and setValue().

Here is the caller graph for this function:

◆ getAcceptNamedColors()

ilColorPickerInputGUI::getAcceptNamedColors ( )

Definition at line 94 of file class.ilColorPickerInputGUI.php.

                                          : bool
    {
        return $this->acceptnamedcolors;
    }

References $acceptnamedcolors.

Referenced by getInput(), insert(), and setValue().

Here is the caller graph for this function:

◆ getDefaultColor()

ilColorPickerInputGUI::getDefaultColor ( )

Definition at line 83 of file class.ilColorPickerInputGUI.php.

                                     : string
    {
        return $this->defaultcolor;
    }

References $defaultcolor.

Referenced by getHexcode().

Here is the caller graph for this function:

◆ getHexcode()

ilColorPickerInputGUI::getHexcode ( )

Definition at line 99 of file class.ilColorPickerInputGUI.php.

                                : string
    {
        if (strpos($this->hex, '#') === 0) {
            return substr($this->hex, 1);
        }
        return $this->hex ?: $this->getDefaultColor();
    }

References getDefaultColor().

Referenced by insert(), and setValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInput()

ilColorPickerInputGUI::getInput ( )

Returns: string|string[]

Reimplemented from ilTextInputGUI.

Definition at line 53 of file class.ilColorPickerInputGUI.php.

                              : string
    {
        $value = trim($this->str($this->getPostVar()));
        if ($this->getAcceptNamedColors() && substr($value, 0, 1) == "!") {
            return $value;
        }
        return $this->determineHexcode($value);
    }

References ilTextInputGUI\$value, determineHexcode(), getAcceptNamedColors(), ilFormPropertyGUI\getPostVar(), and ilFormPropertyGUI\str().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilColorPickerInputGUI::insert ( ilTemplate $a_tpl )

Reimplemented from ilTextInputGUI.

Definition at line 183 of file class.ilColorPickerInputGUI.php.

                                             : void
    {
        $tpl = new ilTemplate('tpl.prop_color.html', true, true, 'components/ILIAS/Form');
        $tpl->setVariable('COLOR_ID', $this->getFieldId());
        $ic = ilColorPickerInputGUI::determineHexcode($this->getHexcode());
        if ($ic == "") {
            $ic = "FFFFFF";
        }
        $tpl->setVariable('INIT_COLOR_SHORT', $ic);
        $tpl->setVariable('POST_VAR', $this->getPostVar());
 
        if ($this->getDisabled()) {
            $a_tpl->setVariable('COLOR_DISABLED', 'disabled="disabled"');
        }
 
        $tpl->setVariable("POST_VAR", $this->getPostVar());
        $tpl->setVariable("PROP_COLOR_ID", $this->getFieldId());
 
        if (substr(trim($this->getValue() ?? ""), 0, 1) == "!" && $this->getAcceptNamedColors()) {
            $tpl->setVariable(
                "PROPERTY_VALUE_COLOR",
                ilLegacyFormElementsUtil::prepareFormOutput(trim($this->getValue()))
            );
        } else {
            $tpl->setVariable("PROPERTY_VALUE_COLOR", ilLegacyFormElementsUtil::prepareFormOutput($this->getHexcode()));
            $tpl->setVariable('INIT_COLOR', '#' . $this->getHexcode());
        }
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
    }

References determineHexcode(), getAcceptNamedColors(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getHexcode(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getValue(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ setAcceptNamedColors()

ilColorPickerInputGUI::setAcceptNamedColors ( bool $a_acceptnamedcolors )

Definition at line 89 of file class.ilColorPickerInputGUI.php.

                                                                   : void
    {
        $this->acceptnamedcolors = $a_acceptnamedcolors;
    }

◆ setDefaultColor()

ilColorPickerInputGUI::setDefaultColor ( string $a_defaultcolor )

Definition at line 78 of file class.ilColorPickerInputGUI.php.

                                                           : void
    {
        $this->defaultcolor = $a_defaultcolor;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setValue()

ilColorPickerInputGUI::setValue ( $a_value )

Parameters

string | array $a_value

Reimplemented from ilTextInputGUI.

Definition at line 67 of file class.ilColorPickerInputGUI.php.

                                      : void
    {
        $a_value = trim($a_value);
        if ($this->getAcceptNamedColors() && substr($a_value, 0, 1) == "!") {
            parent::setValue($a_value);
        } else {
            $this->hex = ilColorPickerInputGUI::determineHexcode($a_value);
            parent::setValue($this->getHexcode());
        }
    }

References determineHexcode(), getAcceptNamedColors(), and getHexcode().

Referenced by setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilColorPickerInputGUI::setValueByArray ( array $a_values )

Reimplemented from ilTextInputGUI.

Definition at line 62 of file class.ilColorPickerInputGUI.php.

                                                    : void
    {
        $this->setValue($a_values[$this->getPostVar()]);
    }

References ilFormPropertyGUI\getPostVar(), and setValue().

Here is the call graph for this function:

Field Documentation

◆ $acceptnamedcolors

bool ilColorPickerInputGUI::$acceptnamedcolors = false

protected

Definition at line 30 of file class.ilColorPickerInputGUI.php.

Referenced by getAcceptNamedColors().

◆ $defaultcolor

string ilColorPickerInputGUI::$defaultcolor = ""

protected

Definition at line 31 of file class.ilColorPickerInputGUI.php.

Referenced by getDefaultColor().

◆ $hex

string ilColorPickerInputGUI::$hex = ""

protected

Definition at line 29 of file class.ilColorPickerInputGUI.php.

The documentation for this class was generated from the following file:

components/ILIAS/Form/classes/class.ilColorPickerInputGUI.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ determineHexcode()

◆ getAcceptNamedColors()

◆ getDefaultColor()

◆ getHexcode()

◆ getInput()

◆ insert()

◆ setAcceptNamedColors()

◆ setDefaultColor()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $acceptnamedcolors

◆ $defaultcolor

◆ $hex