ilColorPickerInputGUI Class Reference

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

Inheritance diagram for ilColorPickerInputGUI:

Collaboration diagram for ilColorPickerInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	checkInput ()
	check input More...
	setValueByArray ($a_values)
	Set values by array. More...
	setValue ($a_value)
	set value More...
	setDefaultColor ($a_defaultcolor)
	Set Default Color. More...
	getDefaultColor ()
	Get Default Color. More...
	setAcceptNamedColors ($a_acceptnamedcolors)
	Set Accept Named Colors (Leading '!'). More...
	getAcceptNamedColors ()
	Get Accept Named Colors (Leading '!'). More...
	getHexcode ()
	get hexcode More...
	insert ($a_tpl)
	Insert property html. More...
Public Member Functions inherited from ilTextInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValue ($a_value)
	Set Value. More...
	getValue ()
	Get Value. More...
	setValidationFailureMessage ($a_msg)
	Set message string for validation failure. More...
	getValidationFailureMessage ()
	setValidationRegexp ($a_value)
	Set validation regexp. More...
	getValidationRegexp ()
	Get validation regexp. More...
	setMaxLength ($a_maxlength)
	Set Max Length. More...
	getMaxLength ()
	Get Max Length. More...
	setSize ($a_size)
	Set Size. More...
	setInlineStyle ($a_style)
	Set inline style. More...
	getInlineStyle ()
	Get inline style. More...
	setCssClass ($a_class)
	getCssClass ()
	setValueByArray ($a_values)
	Set value by array. More...
	getSize ()
	Get Size. More...
	setSuffix ($a_value)
	Set suffix. More...
	getSuffix ()
	Get suffix. More...
	setInputType ($a_type)
	set input type More...
	getInputType ()
	get input type More...
	setSubmitFormOnEnter ($a_val)
	Set submit form on enter. More...
	getSubmitFormOnEnter ()
	Get submit form on enter. More...
	checkInput ()
	Check input, strip slashes etc. More...
	getDataSource ()
	get datasource link for js autocomplete More...
	setDataSource ($href, $a_delimiter=null)
	set datasource link for js autocomplete More...
	setDataSourceSubmitOnSelection ($a_stat)
	getDataSourceSubmitOnSelection ()
	setDataSourceSubmitUrl ($a_url)
	getDataSourceSubmitUrl ()
	setMultiValues (array $a_values)
	insert ($a_tpl)
	Insert property html. More...
	getTableFilterHTML ()
	Get HTML for table filter. More...
	getToolbarHTML ()
	Get HTML for toolbar. More...
	setDisableHtmlAutoComplete ($autocomplete)
	isHtmlAutoCompleteDisabled ()
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...
	getSubItems ()
	Get Subitems. More...
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...
	checkSubItemsInput ()
	Check SubItems. More...
	getSubForm ()
	Get sub form html. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getType ()
	Get Type. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setPostVar ($a_postvar)
	Set Post Variable. More...
	getPostVar ()
	Get Post Variable. More...
	getFieldId ()
	Get Post Variable. More...
	setInfo ($a_info)
	Set Information Text. More...
	getInfo ()
	Get Information Text. More...
	setAlert ($a_alert)
	Set Alert Text. More...
	getAlert ()
	Get Alert Text. More...
	setRequired ($a_required)
	Set Required. More...
	getRequired ()
	Get Required. More...
	setDisabled ($a_disabled)
	Set Disabled. More...
	getDisabled ()
	Get Disabled. More...
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm ($a_parentform)
	Set Parent Form. More...
	getParentForm ()
	Get Parent Form. More...
	setParent ($a_val)
	Set Parent GUI object. More...
	getParent ()
	Get Parent GUI object. More...
	getSubForm ()
	Get sub form html. More...
	hideSubForm ()
	Sub form hidden on init? More...
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...
	getHiddenTitle ()
	Get hidden title. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
	serializeData ()
	serialize data More...
	unserializeData ($a_data)
	unserialize data More...
	writeToSession ()
	Write to session. More...
	clearFromSession ()
	Clear session value. More...
	readFromSession ()
	Read from session. More...
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...
	getMulti ()
	Get Multi. More...
	setMultiValues (array $a_values)
	Set multi values. More...
	getMultiValues ()
	Get multi values. More...
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback ($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...
Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Static Public Member Functions
static	determineHexcode ($a_value)
	Determine hex code for a given value. More...
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Protected Attributes
	$hex
Protected Attributes inherited from ilTextInputGUI
	$value
	$maxlength = 200
	$size = 40
	$validationRegexp
	$validationFailureMessage = ''
	$suffix
	$style_css
	$css_class
	$ajax_datasource
	$ajax_datasource_delimiter
	$ajax_datasource_commit = false
	$ajax_datasource_commit_url
	$submit_form_on_enter = false
	$autocomplete_disabled = false
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$ctrl
	$lng
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References setDefaultColor(), and ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilColorPickerInputGUI::checkInput

(

)

check input

public

Returns

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

References $_POST, determineHexcode(), getAcceptNamedColors(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), and ilFormPropertyGUI\setAlert().

    {
        if (
            $this->getRequired() &&
            !strlen($_POST[$this->getPostVar()])
        ) {
            $this->setAlert($this->lng->txt("msg_input_is_required"));
            return false;
        }
        
        if ($this->getAcceptNamedColors() && substr($_POST[$this->getPostVar()], 0, 1) == "!") {
            $_POST[$this->getPostVar()] =
                ilUtil::stripslashes(trim($_POST[$this->getPostVar()]));
        } else {
            $_POST[$this->getPostVar()] =
                $this->determineHexcode(ilUtil::stripslashes(trim($_POST[$this->getPostVar()])));
        }
        return true;
    }

Here is the call graph for this function:

determineHexcode()

static ilColorPickerInputGUI::determineHexcode (   $a_value )

static

Determine hex code for a given value.

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

References $r.

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

    {
        $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($rgb[0]), 2, "0", STR_PAD_LEFT);
            $g = str_pad(dechex($rgb[1]), 2, "0", STR_PAD_LEFT);
            $b = str_pad(dechex($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("/^[0-9a-f]3/", $a_value) && strlen($a_value == 3)) {
            $a_value = "" . $a_value;
            $a_value = "0" . $a_value[0] . "0" . $a_value[1] . "0" . $a_value[2];
        }
        
        if (!preg_match("/^[a-f0-9]{6}/", $a_value)) {
            $a_value = "";
        }

        return strtoupper($a_value);
    }

Here is the caller graph for this function:

getAcceptNamedColors()

ilColorPickerInputGUI::getAcceptNamedColors

(

)

Get Accept Named Colors (Leading '!').

Returns

boolean Accept Named Colors (Leading '!')

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

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

    {
        return $this->acceptnamedcolors;
    }

Here is the caller graph for this function:

getDefaultColor()

ilColorPickerInputGUI::getDefaultColor

(

)

Get Default Color.

Returns

mixed Default Color

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

Referenced by getHexcode().

    {
        return $this->defaultcolor;
    }

Here is the caller graph for this function:

getHexcode()

ilColorPickerInputGUI::getHexcode

(

)

get hexcode

public

Returns

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

References getDefaultColor().

Referenced by insert(), and setValue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilColorPickerInputGUI::insert

(

$a_tpl

)

Insert property html.

Returns

int Size

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

References determineHexcode(), getAcceptNamedColors(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getHexcode(), ilUtil\getImagePath(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getValue(), ilYuiUtil\initColorPicker(), and ilUtil\prepareFormOutput().

    {
        include_once('./Services/YUI/classes/class.ilYuiUtil.php');
        
        ilYuiUtil::initColorPicker();
        
        
        $a_tpl->setCurrentBlock("prop_color");

        $js_tpl = new ilTemplate('tpl.color_picker.js', true, true, 'Services/Form');
        $js_tpl->setVariable('THUMB_PATH', ilUtil::getImagePath('color_picker_thumb.png', 'Services/Form'));
        $js_tpl->setVariable('HUE_THUMB_PATH', ilUtil::getImagePath('color_picker_hue_thumb.png', 'Services/Form'));
        $js_tpl->setVariable('COLOR_ID', $this->getFieldId());
        $ic = ilColorPickerInputGUI::determineHexcode($this->getHexcode());
        if ($ic == "") {
            $ic = "FFFFFF";
        }
        $js_tpl->setVariable('INIT_COLOR_SHORT', $ic);
        $js_tpl->setVariable('INIT_COLOR', '#' . $this->getHexcode());
        $js_tpl->setVariable('POST_VAR', $this->getPostVar());
        
        
        if ($this->getDisabled()) {
            $a_tpl->setVariable('COLOR_DISABLED', 'disabled="disabled"');
        } else {
            $a_tpl->setVariable('PROP_COLOR_JS', $js_tpl->get());
        }
        $a_tpl->setVariable("POST_VAR", $this->getPostVar());
        $a_tpl->setVariable("PROP_COLOR_ID", $this->getFieldId());

        if (substr(trim($this->getValue()), 0, 1) == "!" && $this->getAcceptNamedColors()) {
            $a_tpl->setVariable("PROPERTY_VALUE_COLOR", ilUtil::prepareFormOutput(trim($this->getValue())));
        } else {
            $a_tpl->setVariable("PROPERTY_VALUE_COLOR", ilUtil::prepareFormOutput($this->getHexcode()));
        }
        $a_tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

setAcceptNamedColors()

ilColorPickerInputGUI::setAcceptNamedColors

(

$a_acceptnamedcolors

)

Set Accept Named Colors (Leading '!').

Parameters

boolean

$a_acceptnamedcolors

Accept Named Colors (Leading '!')

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

    {
        $this->acceptnamedcolors = $a_acceptnamedcolors;
    }

setDefaultColor()

ilColorPickerInputGUI::setDefaultColor

(

$a_defaultcolor

)

Set Default Color.

Parameters

mixed

$a_defaultcolor

Default Color

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

Referenced by __construct(), and ilObjStyleSheetGUI\initTagStyleForm().

    {
        $this->defaultcolor = $a_defaultcolor;
    }

Here is the caller graph for this function:

setValue()

ilColorPickerInputGUI::setValue

(

$a_value

)

set value

public

Parameters

string

$a_value

color hexcode

Returns

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

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

Referenced by ilCalendarCategoryGUI\initFormCategory(), ilObjAssessmentFolderGUI\settingsObject(), and setValueByArray().

    {
        $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());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setValueByArray()

ilColorPickerInputGUI::setValueByArray

(

$a_values

)

Set values by array.

Parameters

type

$a_values

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

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

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

Here is the call graph for this function:

Field Documentation

$hex

ilColorPickerInputGUI::$hex

protected

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

---

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

• Services/Form/classes/class.ilColorPickerInputGUI.php