Inheritance diagram for ilChatroomAuthInputGUI:

Collaboration diagram for ilChatroomAuthInputGUI:

Public Member Functions
	__construct (string $title, string $httpPostVariableName, protected \ILIAS\HTTP\Services $http)

	setIsReadOnly (bool $isReadOnly)

	setCtrlPath (array $ctrl_path)

	setValueByArray (array $a_values)

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

	render ()

	getSize ()

	setSize (int $size)

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)

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

Protected Member Functions
	getRandomValues ()

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)

Protected Attributes
array	$ctrl_path = []

int	$size = 10

array	$values = self::DEFAULT_SHAPE

bool	$isReadOnly = false

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

Private Member Functions
	uuidV4 ()

Private Attributes
const	NAME_AUTH_PROP_1 = 'key'

const	NAME_AUTH_PROP_2 = 'secret'

const	DEFAULT_SHAPE

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $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 29 of file class.ilChatroomAuthInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomAuthInputGUI::__construct	(	string	$title,
		string	$httpPostVariableName,
		protected \ILIAS\HTTP\Services	$http
	)

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

References ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct($title, $httpPostVariableName);
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilChatroomAuthInputGUI::checkInput ( )

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

References $post, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setAlert().

                                 : bool
     {
         $post = $this->http->request()->getParsedBody()[$this->getPostVar()] ?? [];
 
         if ($this->getRequired() && 2 > count(array_filter(array_map('trim', $post)))) {
             $this->setAlert($this->lng->txt('msg_input_is_required'));
             return false;
         }
 
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getInput()

ilChatroomAuthInputGUI::getInput ( )

Returns: array{key: string, secret: string}

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

References ilFormPropertyGUI\getPostVar(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ilFormPropertyGUI\stripSlashesAddSpaceFallback().

                               : array
     {
         $input = self::DEFAULT_SHAPE;
 
         $as_sanizited_string = $this->refinery->custom()->transformation(function (string $value): string {
             return $this->stripSlashesAddSpaceFallback($value);
         });
 
         $null_to_empty_string = $this->refinery->custom()->transformation(static function ($value): string {
             if ($value === null) {
                 return '';
             }
 
             throw new ilException('Expected null in transformation');
         });
 
         $sanizite_as_string = $this->refinery->in()->series([
             $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->string(),
                 $null_to_empty_string
             ]),
             $as_sanizited_string
         ]);
 
         if ($this->http->wrapper()->post()->has($this->getPostVar())) {
             $input = $this->http->wrapper()->post()->retrieve(
                 $this->getPostVar(),
                 $this->refinery->kindlyTo()->recordOf([
                     self::NAME_AUTH_PROP_1 => $sanizite_as_string,
                     self::NAME_AUTH_PROP_2 => $sanizite_as_string
                 ])
             );
         }
 
         return $input;
     }

Here is the call graph for this function:

◆ getRandomValues()

ilChatroomAuthInputGUI::getRandomValues ( )

protected

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

References $response, ILIAS\FileDelivery\http(), ILIAS\Filesystem\Stream\Streams\ofString(), and uuidV4().

                                         : void
     {
         $response = new stdClass();
 
         $response->{self::NAME_AUTH_PROP_1} = $this->uuidV4();
         $response->{self::NAME_AUTH_PROP_2} = $this->uuidV4();
 
         $responseStream = \ILIAS\Filesystem\Stream\Streams::ofString(json_encode($response, JSON_THROW_ON_ERROR));
         $this->http->saveResponse(
             $this->http->response()
                 ->withBody($responseStream)
                 ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
         );
         $this->http->sendResponse();
         $this->http->close();
     }

Here is the call graph for this function:

◆ getSize()

ilChatroomAuthInputGUI::getSize ( )

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

References $size.

Referenced by render().

                              : int
     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ insert()

ilChatroomAuthInputGUI::insert ( ilTemplate $a_tpl )

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

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

                                              : void
     {
         $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 ( )

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

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

Referenced by insert().

                             : string
     {
         global $DIC;
 
         $tpl = new ilTemplate('tpl.chatroom_auth_input.html', true, true, 'components/ILIAS/Chatroom');
 
         for ($i = 1, $iMax = count($this->values); $i <= $iMax; $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, $iMax = count($this->values); $i <= $iMax; $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)
             );
             $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 ( array $ctrl_path )

Parameters

string[] $ctrl_path

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

References $ctrl_path.

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

◆ setIsReadOnly()

ilChatroomAuthInputGUI::setIsReadOnly ( bool $isReadOnly )

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

References $isReadOnly.

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

◆ setSize()

ilChatroomAuthInputGUI::setSize ( int $size )

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

References $size.

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

◆ setValueByArray()

ilChatroomAuthInputGUI::setValueByArray ( array $a_values )

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

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

                                                     : void
     {
         $this->values = [
             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

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

Referenced by getRandomValues().

                              : string
     {
         return sprintf(
             '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
             // 32 bits for "time_low"
             random_int(0, 0xffff),
             random_int(0, 0xffff),
             // 16 bits for "time_mid"
             random_int(0, 0xffff),
             // 16 bits for "time_high_and_version",
             // four most significant bits holds version number 4
             random_int(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
             random_int(0, 0x3fff) | 0x8000,
             // 48 bits for "node"
             random_int(0, 0xffff),
             random_int(0, 0xffff),
             random_int(0, 0xffff)
         );
     }

Here is the caller graph for this function:

Field Documentation

◆ $ctrl_path

array ilChatroomAuthInputGUI::$ctrl_path = []

protected

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

Referenced by setCtrlPath().

◆ $isReadOnly

bool ilChatroomAuthInputGUI::$isReadOnly = false

protected

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

Referenced by setIsReadOnly().

◆ $size

int ilChatroomAuthInputGUI::$size = 10

protected

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

Referenced by getSize(), and setSize().

◆ $values

array ilChatroomAuthInputGUI::$values = self::DEFAULT_SHAPE

protected

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

◆ DEFAULT_SHAPE

const ilChatroomAuthInputGUI::DEFAULT_SHAPE

private

Initial value:

= [

self::NAME_AUTH_PROP_1 => ''

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

◆ NAME_AUTH_PROP_1

const ilChatroomAuthInputGUI::NAME_AUTH_PROP_1 = 'key'

private

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

◆ NAME_AUTH_PROP_2

const ilChatroomAuthInputGUI::NAME_AUTH_PROP_2 = 'secret'

private

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

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

components/ILIAS/Chatroom/classes/class.ilChatroomAuthInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getInput()

◆ getRandomValues()

◆ getSize()

◆ insert()

◆ render()

◆ setCtrlPath()

◆ setIsReadOnly()

◆ setSize()

◆ setValueByArray()

◆ uuidV4()

Field Documentation

◆ $ctrl_path

◆ $isReadOnly

◆ $size

◆ $values

◆ DEFAULT_SHAPE

◆ NAME_AUTH_PROP_1

◆ NAME_AUTH_PROP_2