Class ilAsyncOutputHandler Handles the output for async-requests. More...

Collaboration diagram for ilAsyncOutputHandler:

Public Member Functions
	__construct ($content=null, $heading=null, array $windows_properties=array())

	terminate (string $type=self::OUTPUT_MODAL)
	Output content in different ways self::OUTPUT_MODAL: Output as bootstrap modal self::OUTPUT_EMPTY: Only content without ILIAS-layout. More...

	getContent ()
	Returns the content of the modal output. More...

	setContent ($content)
	Sets the content of the modal output. More...

	getHeading ()
	Return the heading of a modal. More...

	setHeading ($heading)
	Sets the heading of a modal-output. More...

	getWindowProperties ()
	Return all window properties. More...

	setWindowProperties (array $window_properties)
	Set windows properties. More...

Static Public Member Functions
static	encodeAsyncResponse (array $data=array())
	Encode data as json for async output. More...

static	handleAsyncOutput (string $normal_content, string $async_content=null, bool $apply_to_tpl=true)
	Handles async output. More...

Protected Attributes
	$content

	$heading

array	$window_properties

Private Attributes
const	OUTPUT_MODAL = "output_modal"

const	OUTPUT_EMPTY = "output_empty"

Detailed Description

Class ilAsyncOutputHandler Handles the output for async-requests.

The class allows to generate the basic structure of a bootstrap-modal (for modal-content)

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

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

Constructor & Destructor Documentation

◆ __construct()

ilAsyncOutputHandler::__construct	(		$content = `null`,
			$heading = `null`,
		array	$windows_properties = `array()`
	)

Definition at line 48 of file class.ilAsyncOutputHandler.php.

References $content, and $heading.

     {
         $this->content = $content;
         $this->heading = $heading;
         $this->window_properties = $windows_properties;
     }

Member Function Documentation

◆ encodeAsyncResponse()

static ilAsyncOutputHandler::encodeAsyncResponse ( array $data = array() )

static

Encode data as json for async output.

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

References $data, and $DIC.

Referenced by ilObjStudyProgrammeGUI\afterSave(), ilObjStudyProgrammeTreeGUI\cancel(), ilObjStudyProgrammeGUI\cancel(), ilObjStudyProgrammeTreeGUI\cancelDelete(), ilObjStudyProgrammeTreeGUI\confirmedDelete(), ilObjStudyProgrammeTreeGUI\createNewLeaf(), ilObjStudyProgrammeGUI\save(), ilObjStudyProgrammeTreeGUI\saveTreeOrder(), and ilObjStudyProgrammeSettingsGUI\update().

                                                                      : string
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
 
         $data['cmd'] = $ilCtrl->getCmd();
 
         return json_encode($data, JSON_THROW_ON_ERROR);
     }

Here is the caller graph for this function:

◆ getContent()

ilAsyncOutputHandler::getContent ( )

Returns the content of the modal output.

Returns: mixed

Definition at line 137 of file class.ilAsyncOutputHandler.php.

References $content.

Referenced by terminate().

     {
         return $this->content;
     }

Here is the caller graph for this function:

◆ getHeading()

ilAsyncOutputHandler::getHeading ( )

Return the heading of a modal.

Returns: mixed

Definition at line 157 of file class.ilAsyncOutputHandler.php.

References $heading.

Referenced by terminate().

     {
         return $this->heading;
     }

Here is the caller graph for this function:

◆ getWindowProperties()

ilAsyncOutputHandler::getWindowProperties ( )

Return all window properties.

Definition at line 175 of file class.ilAsyncOutputHandler.php.

References $window_properties.

                                          : array
     {
         return $this->window_properties;
     }

◆ handleAsyncOutput()

static ilAsyncOutputHandler::handleAsyncOutput	(	string	$normal_content,
		string	$async_content = `null`,
		bool	$apply_to_tpl = `true`
	)

static

Handles async output.

Returns: string|void

Definition at line 104 of file class.ilAsyncOutputHandler.php.

References $content, $DIC, $http, $tpl, and exit.

Referenced by ilObjStudyProgrammeGUI\afterSave(), ilObjStudyProgrammeGUI\cancel(), ilObjStudyProgrammeTreeGUI\executeCommand(), and ilObjStudyProgrammeSettingsGUI\update().

       {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $tpl = $DIC['tpl'];
         $http = $DIC['http'];
 
         $content = ($ilCtrl->isAsynch() && $async_content !== null) ? $async_content : $normal_content;
 
         if ($ilCtrl->isAsynch()) {
             $http->saveResponse(
                 $http->response()
                     ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html')
                     ->withBody(Streams::ofString($content))
             );
             $http->sendResponse();
             $http->close();
             exit();
         } elseif ($apply_to_tpl) {
             $tpl->setContent($content);
         } else {
             return $content;
         }
     }

Here is the caller graph for this function:

◆ setContent()

ilAsyncOutputHandler::setContent ( $content )

Sets the content of the modal output.

Parameters

mixed $content

Definition at line 147 of file class.ilAsyncOutputHandler.php.

References $content.

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

◆ setHeading()

ilAsyncOutputHandler::setHeading ( $heading )

Sets the heading of a modal-output.

Parameters

mixed $heading

Definition at line 167 of file class.ilAsyncOutputHandler.php.

References $heading.

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

◆ setWindowProperties()

ilAsyncOutputHandler::setWindowProperties ( array $window_properties )

Set windows properties.

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

References $window_properties.

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

◆ terminate()

ilAsyncOutputHandler::terminate ( string $type = self::OUTPUT_MODAL )

Output content in different ways self::OUTPUT_MODAL: Output as bootstrap modal self::OUTPUT_EMPTY: Only content without ILIAS-layout.

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

References $tpl, $type, exit, getContent(), and getHeading().

                                                               : void
     {
         if ($type === self::OUTPUT_MODAL) {
             $tpl = new ilTemplate('tpl.modal_content.html', false, false, 'Modules/StudyProgramme');
             $tpl->setVariable('HEADING', $this->getHeading());
             $tpl->setVariable('BODY', $this->getContent());
 
             //TODO: implement window properties
             /*foreach($this->window_properties as $key => $value) {
                 if($value) {
                     $tpl->activeBlock($key);
                 } else {
                     $tpl->removeBlockData($key);
                 }
             }*/
 
             echo $tpl->get();
             exit();
         }
 
         if ($type === self::OUTPUT_EMPTY) {
             echo $this->getContent();// TODO PHP8-REVIEW I sugges to use the HTTP service instead of echo/exit
             exit();
         }
     }