ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilChatroomBlockGUI Class Reference

Class ilChatroomBlockGUI. More...

+ Inheritance diagram for ilChatroomBlockGUI:
+ Collaboration diagram for ilChatroomBlockGUI:

Public Member Functions

 __construct ()
 Constructor. More...
 
 getHTML ()
 
- Public Member Functions inherited from ilBlockGUI
 ilBlockGUI ()
 Constructor. More...
 
 addHeaderLink ($a_href, $a_text, $status=true)
 
 getHeaderLinks ()
 
 setData ($a_data)
 Set Data. More...
 
 getData ()
 Get Data. More...
 
 setBigMode ($a_bigmode)
 Set Big Mode. More...
 
 getBigMode ()
 Get Big Mode. More...
 
 setBlockId ($a_block_id=0)
 Set Block Id. More...
 
 getBlockId ()
 Get Block Id. More...
 
 setAvailableDetailLevels ($a_max, $a_min=0)
 Set Available Detail Levels. More...
 
 setCurrentDetailLevel ($a_currentdetaillevel)
 Set Current Detail Level. More...
 
 setGuiObject (&$a_gui_object)
 Set GuiObject. More...
 
 getGuiObject ()
 Get GuiObject. More...
 
 getCurrentDetailLevel ()
 Get Current Detail Level. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. More...
 
 setImage ($a_image)
 Set Image. More...
 
 getImage ()
 Get Image. More...
 
 setOffset ($a_offset)
 Set Offset. More...
 
 getOffset ()
 Get Offset. More...
 
 correctOffset ()
 
 setLimit ($a_limit)
 Set Limit. More...
 
 getLimit ()
 Get Limit. More...
 
 setEnableEdit ($a_enableedit)
 Set EnableEdit. More...
 
 getEnableEdit ()
 Get EnableEdit. More...
 
 setRepositoryMode ($a_repositorymode)
 Set RepositoryMode. More...
 
 getRepositoryMode ()
 Get RepositoryMode. More...
 
 setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
 Set Footer Info. More...
 
 getFooterInfo ($a_hide_and_icon=false)
 Get Footer Info. More...
 
 setSubtitle ($a_subtitle)
 Set Subtitle. More...
 
 getSubtitle ()
 Get Subtitle. More...
 
 setRefId ($a_refid)
 Set Ref Id (only used if isRepositoryObject() is true). More...
 
 getRefId ()
 Get Ref Id (only used if isRepositoryObject() is true). More...
 
 setAdminCommands ($a_admincommands)
 Set Administration Commmands. More...
 
 getAdminCommands ()
 Get Administration Commmands. More...
 
 setColSpan ($a_colspan)
 Set Columns Span. More...
 
 getColSpan ()
 Get Columns Span. More...
 
 setEnableDetailRow ($a_enabledetailrow)
 Set EnableDetailRow. More...
 
 getEnableDetailRow ()
 Get EnableDetailRow. More...
 
 setEnableNumInfo ($a_enablenuminfo)
 Set Enable Item Number Info. More...
 
 getEnableNumInfo ()
 Get Enable Item Number Info. More...
 
 setProperties ($a_properties)
 This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
 
 getProperty ($a_property)
 
 setProperty ($a_property, $a_value)
 
 setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
 Set Row Template Name. More...
 
 getNavParameter ()
 
 getDetailParameter ()
 
 getConfigParameter ()
 
 getMoveParameter ()
 
 getRowTemplateName ()
 Get Row Template Name. More...
 
 getRowTemplateDir ()
 Get Row Template Directory. More...
 
 addBlockCommand ($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
 Add Block Command. More...
 
 getBlockCommands ()
 Get Block commands. More...
 
 addHeaderCommand ($a_href, $a_text, $a_as_close=false)
 Add Header Block Command. More...
 
 getHeaderCommands ()
 Get Header Block commands. More...
 
 addFooterLink ($a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
 Add a footer text/link. More...
 
 getFooterLinks ()
 Get footer links. More...
 
 clearFooterLinks ()
 Clear footer links. More...
 
 handleDetailLevel ()
 Handle read/write current detail level. More...
 
 getHTML ()
 Handle config status. More...
 
 fillHeaderCommands ()
 Fill header commands block. More...
 
 fillHeaderTitleBlock ()
 Fill header title block (title and. More...
 
 setDataSection ($a_content)
 Call this from overwritten fillDataSection(), if standard row based data is not used. More...
 
 fillDataSection ()
 Standard implementation for row based data. More...
 
 fillRow ($a_set)
 
 fillFooter ()
 
 fillPreviousNext ()
 Fill previous/next row. More...
 
 setPreviousNextLinks ()
 Get previous/next linkbar. More...
 
 fillFooterLinks ($a_top=false, $a_numinfo="")
 Fill footer links. More...
 
 fillDetailRow ()
 Fill Detail Setting Row. More...
 

Static Public Member Functions

static getBlockType ()
 
static isRepositoryObject ()
 
static getScreenMode ()
 
static getBlockType ()
 
static isRepositoryObject ()
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 

Static Public Attributes

static $block_type = 'chatviewer'
 

Protected Member Functions

 dispatchAsyncCommand ($cmd)
 
 getChatroomSelectionList ()
 
- Protected Member Functions inherited from ilBlockGUI
 fillRowColor ($a_placeholder="CSS_ROW")
 
 preloadData (array $data)
 Can be overwritten in subclasses. More...
 

Additional Inherited Members

- Protected Attributes inherited from ilBlockGUI
 $data = array()
 
 $colspan = 1
 
 $enablenuminfo = true
 
 $detail_min = 0
 
 $detail_max = 0
 
 $bigmode = false
 
 $footer_links = array()
 
 $block_id = 0
 
 $header_commands = array()
 
 $allow_moving = true
 
 $move = array("left" => false, "right" => false, "up" => false, "down" => false)
 
 $enabledetailrow = true
 
 $header_links = array()
 
 $footerinfo = false
 
 $footerinfo_icon = false
 
 $block_commands = array()
 
 $max_count = false
 
 $close_command = false
 
 $image = false
 
 $property = false
 
 $nav_value = ""
 
 $css_row = ""
 
 $dropdown
 

Detailed Description

Class ilChatroomBlockGUI.

Author
Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$ @ilCtrl_IsCalledBy ilChatroomBlockGUI: ilColumnGUI

Definition at line 17 of file class.ilChatroomBlockGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomBlockGUI::__construct ( )

Constructor.

Definition at line 28 of file class.ilChatroomBlockGUI.php.

29 {
30 global $lng;
31
32 parent::__construct();
33
34 $lng->loadLanguageModule('chatroom');
35
36 $this->setImage(ilUtil::getImagePath('icon_chat.svg'));
37 $this->setTitle($lng->txt('chat_chatviewer'));
38 $this->setAvailableDetailLevels(1, 0);
39 $this->allow_moving = true;
40 }
setImage($a_image)
Set Image.
setAvailableDetailLevels($a_max, $a_min=0)
Set Available Detail Levels.
setTitle($a_title)
Set Title.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
global $lng
Definition: privfeed.php:40

References $lng, ilUtil\getImagePath(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setImage(), and ilBlockGUI\setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ dispatchAsyncCommand()

ilChatroomBlockGUI::dispatchAsyncCommand (   $cmd)
protected
Parameters
$cmd

Definition at line 189 of file class.ilChatroomBlockGUI.php.

190 {
191 switch($cmd)
192 {
193 case 'getChatroomSelectionList':
194 return $this->getChatroomSelectionList();
195 break;
196
197 case 'getMessages':
198 default;
199 return $this->getMessages();
200 break;
201 }
202 }
$cmd
Definition: sahs_server.php:35

References $cmd, and getChatroomSelectionList().

+ Here is the call graph for this function:

◆ getBlockType()

static ilChatroomBlockGUI::getBlockType ( )
static
Returns
string

Reimplemented from ilBlockGUI.

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

47 {
48 return self::$block_type;
49 }

References $block_type.

◆ getChatroomSelectionList()

ilChatroomBlockGUI::getChatroomSelectionList ( )
protected

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

205 {
206 $result = new stdClass();
207 $result->ok = true;
208
209 $chatblock = new ilChatroomBlock();
210 $result->html = $chatblock->getRoomSelect();
211
212 include_once 'Services/JSON/classes/class.ilJsonUtil.php';
214 exit();
215 }
$result
static encode($mixed, $suppress_native=false)
exit
Definition: login.php:54

References $result, ilJsonUtil\encode(), and exit.

Referenced by dispatchAsyncCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getHTML()

ilChatroomBlockGUI::getHTML ( )
Returns
string

Reimplemented from ilBlockGUI.

Definition at line 92 of file class.ilChatroomBlockGUI.php.

93 {
95
96 $chatSetting = new ilSetting('chatroom');
97 if($this->getCurrentDetailLevel() == 0 || !$chatSetting->get('chat_enabled', 0) || !(bool)ilChatroomServerConnector::checkServerConnection())
98 {
99 return '';
100 }
101 else
102 {
103 return parent::getHTML();
104 }
105 }
getCurrentDetailLevel()
Get Current Detail Level.
ILIAS Setting Class.
static initJson()
Init YUI JSON component.

References ilChatroomServerConnector\checkServerConnection(), ilBlockGUI\getCurrentDetailLevel(), and ilYuiUtil\initJson().

+ Here is the call graph for this function:

◆ getScreenMode()

static ilChatroomBlockGUI::getScreenMode ( )
static
Returns
string

Reimplemented from ilBlockGUI.

Definition at line 64 of file class.ilChatroomBlockGUI.php.

65 {
66 switch($_GET['cmd'])
67 {
68 default:
69 return IL_SCREEN_SIDE;
70 break;
71 }
72 }
$_GET["client_id"]
const IL_SCREEN_SIDE

References $_GET, and IL_SCREEN_SIDE.

◆ isRepositoryObject()

static ilChatroomBlockGUI::isRepositoryObject ( )
static
Returns
bool

Reimplemented from ilBlockGUI.

Definition at line 55 of file class.ilChatroomBlockGUI.php.

56 {
57 return false;
58 }

Field Documentation

◆ $block_type

ilChatroomBlockGUI::$block_type = 'chatviewer'
static

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

Referenced by getBlockType().


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