Inheritance diagram for ilChatroomAuthInputGUI:

Collaboration diagram for ilChatroomAuthInputGUI:

Public Member Functions
	setIsReadOnly (bool $isReadOnly)

	setCtrlPath ($ctrl_path)

	setValueByArray (array $a_values)

	checkInput ()
	{} More...

	insert (ilTemplate $a_tpl)
	{} More...

	render ()

	getSize ()

	setSize ($size)

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...

Data Fields
const	NAME_AUTH_PROP_1 = 'key'

const	NAME_AUTH_PROP_2 = 'secret'

Protected Member Functions
	getRandomValues ()

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$ctrl_path = array()

	$size = 10

	$values

	$isReadOnly = 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

Private Member Functions
	uuidV4 ()
	Generates a pseudo random string following the RFC 4122. More...

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

Detailed Description

Class ilChatroomAuthInputGUI.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de; Thomas Joußen tjous.nosp@m.sen@.nosp@m.datab.nosp@m.ay.d.nosp@m.e ilChatroomAuthInputGUI: ilFormPropertyDispatchGUI

Definition at line 10 of file class.ilChatroomAuthInputGUI.php.

Member Function Documentation

◆ checkInput()

ilChatroomAuthInputGUI::checkInput ( )

{}

Definition at line 110 of file class.ilChatroomAuthInputGUI.php.

References $_POST, $DIC, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

     {
         global $DIC;
 
         $_POST[$this->getPostVar()][self::NAME_AUTH_PROP_1] = ilUtil::stripSlashes($_POST[$this->getPostVar()][self::NAME_AUTH_PROP_1]);
         $_POST[$this->getPostVar()][self::NAME_AUTH_PROP_2] = ilUtil::stripSlashes($_POST[$this->getPostVar()][self::NAME_AUTH_PROP_2]);
 
         $post = $_POST[$this->getPostVar()];
 
         if ($this->getRequired() && 2 > count(array_filter(array_map('trim', $post)))) {
             $this->setAlert($DIC->language()->txt('msg_input_is_required'));
             return false;
         }
 
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getRandomValues()

ilChatroomAuthInputGUI::getRandomValues ( )

protected

Definition at line 46 of file class.ilChatroomAuthInputGUI.php.

References $response, exit, and uuidV4().

     {
         $response = new stdClass();
 
         $response->{self::NAME_AUTH_PROP_1} = $this->uuidV4();
         $response->{self::NAME_AUTH_PROP_2} = $this->uuidV4();
 
         echo json_encode($response);
         exit();
     }

Here is the call graph for this function:

◆ getSize()

ilChatroomAuthInputGUI::getSize ( )

Returns: int

Definition at line 186 of file class.ilChatroomAuthInputGUI.php.

References $size.

Referenced by render().

     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ insert()

ilChatroomAuthInputGUI::insert ( ilTemplate $a_tpl )

{}

Definition at line 130 of file class.ilChatroomAuthInputGUI.php.

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

     {
         $a_tpl->setCurrentBlock('prop_generic');
         $a_tpl->setVariable('PROP_GENERIC', $this->render());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ render()

ilChatroomAuthInputGUI::render ( )

Returns: string

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

References $DIC, $i, $tpl, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), and getSize().

Referenced by insert().

     {
         global $DIC;
 
         $tpl = new ilTemplate('tpl.chatroom_auth_input.html', true, true, 'Modules/Chatroom');
 
         for ($i = 1; $i <= count($this->values); $i++) {
             $const = 'NAME_AUTH_PROP_' . $i;
             $const_val = constant('self::' . $const);
 
             $tpl->setVariable('TXT_AUTH_PROP_' . $i, $DIC->language()->txt('chatroom_auth_' . $const_val));
             $tpl->setVariable('ID_AUTH_PROP_' . $i, $const_val);
             $tpl->setVariable('NAME_AUTH_PROP_' . $i, $const_val);
             $tpl->setVariable('VALUE_AUTH_PROP_' . $i, $this->values[$const_val]);
         }
 
         if (!$this->isReadOnly && !$this->getDisabled()) {
             for ($i = 1; $i <= count($this->values); $i++) {
                 $const = 'NAME_AUTH_PROP_' . $i;
                 $const_val = constant('self::' . $const);
 
                 $tpl->setVariable('ID_AUTH_PROP_' . $i . '_BTN', $const_val);
             }
 
             $DIC->ctrl()->setParameterByClass('ilformpropertydispatchgui', 'postvar', $this->getPostVar());
             $tpl->setVariable(
                 'URL',
                 $DIC->ctrl()->getLinkTargetByClass($this->ctrl_path, 'getRandomValues', '', true, false)
             );
             $tpl->setVariable('ID_BTN', $this->getFieldId() . '_btn');
             $tpl->setVariable('TXT_BTN', $DIC->language()->txt('chatroom_auth_btn_txt'));
         }
 
         $tpl->setVariable('POST_VAR', $this->getPostVar());
         $tpl->setVariable('SIZE', $this->getSize());
 
         if ($this->getDisabled()) {
             $tpl->setVariable('DISABLED', ' disabled="disabled"');
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCtrlPath()

ilChatroomAuthInputGUI::setCtrlPath ( $ctrl_path )

Parameters

array $ctrl_path

Definition at line 87 of file class.ilChatroomAuthInputGUI.php.

References $ctrl_path.

     {
         $this->ctrl_path = $ctrl_path;
     }

◆ setIsReadOnly()

ilChatroomAuthInputGUI::setIsReadOnly ( bool $isReadOnly )

Parameters

bool $isReadOnly

Definition at line 38 of file class.ilChatroomAuthInputGUI.php.

References $isReadOnly.

                                                     : void
     {
         $this->isReadOnly = $isReadOnly;
     }

◆ setSize()

ilChatroomAuthInputGUI::setSize ( $size )

Parameters

int $size

Definition at line 194 of file class.ilChatroomAuthInputGUI.php.

References $size.

     {
         $this->size = $size;
     }

◆ setValueByArray()

ilChatroomAuthInputGUI::setValueByArray ( array $a_values )

Parameters

array $a_values

Definition at line 95 of file class.ilChatroomAuthInputGUI.php.

References ilFormPropertyGUI\getPostVar(), and ilSubEnabledFormPropertyGUI\getSubItems().

     {
         $this->values = array(
             self::NAME_AUTH_PROP_1 => $a_values[$this->getPostVar()][self::NAME_AUTH_PROP_1],
             self::NAME_AUTH_PROP_2 => $a_values[$this->getPostVar()][self::NAME_AUTH_PROP_2]
         );
 
         foreach ($this->getSubItems() as $item) {
             $item->setValueByArray($a_values);
         }
     }

Here is the call graph for this function:

◆ uuidV4()

ilChatroomAuthInputGUI::uuidV4 ( )

private

Generates a pseudo random string following the RFC 4122.

Returns: string

Definition at line 61 of file class.ilChatroomAuthInputGUI.php.

Referenced by getRandomValues().

     {
         return sprintf(
             '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
             // 32 bits for "time_low"
             mt_rand(0, 0xffff),
             mt_rand(0, 0xffff),
             // 16 bits for "time_mid"
             mt_rand(0, 0xffff),
             // 16 bits for "time_high_and_version",
             // four most significant bits holds version number 4
             mt_rand(0, 0x0fff) | 0x4000,
             // 16 bits, 8 bits for "clk_seq_hi_res",
             // 8 bits for "clk_seq_low",
             // two most significant bits holds zero and one for variant DCE1.1
             mt_rand(0, 0x3fff) | 0x8000,
             // 48 bits for "node"
             mt_rand(0, 0xffff),
             mt_rand(0, 0xffff),
             mt_rand(0, 0xffff)
         );
     }

Here is the caller graph for this function:

Field Documentation

◆ $ctrl_path

ilChatroomAuthInputGUI::$ctrl_path = array()

protected

Definition at line 18 of file class.ilChatroomAuthInputGUI.php.

Referenced by setCtrlPath().

◆ $isReadOnly

ilChatroomAuthInputGUI::$isReadOnly = false

protected

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

Referenced by setIsReadOnly().

◆ $size

ilChatroomAuthInputGUI::$size = 10

protected

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

Referenced by getSize(), and setSize().

◆ $values

ilChatroomAuthInputGUI::$values

protected

Initial value:

= array(
        self::NAME_AUTH_PROP_1 => '',
        self::NAME_AUTH_PROP_2 => ''
    )

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

◆ NAME_AUTH_PROP_1

const ilChatroomAuthInputGUI::NAME_AUTH_PROP_1 = 'key'

Definition at line 12 of file class.ilChatroomAuthInputGUI.php.

◆ NAME_AUTH_PROP_2

const ilChatroomAuthInputGUI::NAME_AUTH_PROP_2 = 'secret'

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

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

Modules/Chatroom/classes/class.ilChatroomAuthInputGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkInput()

◆ getRandomValues()

◆ getSize()

◆ insert()

◆ render()

◆ setCtrlPath()

◆ setIsReadOnly()

◆ setSize()

◆ setValueByArray()

◆ uuidV4()

Field Documentation

◆ $ctrl_path

◆ $isReadOnly

◆ $size

◆ $values

◆ NAME_AUTH_PROP_1

◆ NAME_AUTH_PROP_2