ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
ilChatroomBlockGUI Class Reference

Class ilChatroomBlockGUI. More...

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

Public Member Functions

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

Static Public Member Functions

static getBlockType ()
static isRepositoryObject ()
static getScreenMode ()

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.

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$ ilChatroomBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

ilChatroomBlockGUI::__construct ( )

Constructor.

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

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

{
global $lng;
parent::__construct();
$lng->loadLanguageModule('chatroom');
$this->setImage(ilUtil::getImagePath('icon_chat.svg'));
$this->setTitle($lng->txt('chat_chatviewer'));
$this->setAvailableDetailLevels(1, 0);
$this->allow_moving = true;
}

+ Here is the call graph for this function:

Member Function Documentation

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

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

References $cmd, and getChatroomSelectionList().

{
switch($cmd)
{
case 'getChatroomSelectionList':
return $this->getChatroomSelectionList();
break;
case 'getMessages':
default;
return $this->getMessages();
break;
}
}

+ Here is the call graph for this function:

static ilChatroomBlockGUI::getBlockType ( )
static
Returns
string

Reimplemented from ilBlockGUI.

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

References $block_type.

{
return self::$block_type;
}
ilChatroomBlockGUI::getChatroomSelectionList ( )
protected

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

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

Referenced by dispatchAsyncCommand().

{
$result = new stdClass();
$result->ok = true;
$chatblock = new ilChatroomBlock();
$result->html = $chatblock->getRoomSelect();
include_once 'Services/JSON/classes/class.ilJsonUtil.php';
echo ilJsonUtil::encode($result);
exit();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilChatroomBlockGUI::getHTML ( )
Returns
string

Reimplemented from ilBlockGUI.

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

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

{
ilYuiUtil::initJson();
$chatSetting = new ilSetting('chatroom');
if($this->getCurrentDetailLevel() == 0 || !$chatSetting->get('chat_enabled', 0) || !(bool)@ilChatroomServerConnector::checkServerConnection())
{
return '';
}
else
{
return parent::getHTML();
}
}

+ Here is the call graph for this function:

static ilChatroomBlockGUI::getScreenMode ( )
static
Returns
string

Reimplemented from ilBlockGUI.

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

References $_GET, and IL_SCREEN_SIDE.

{
switch($_GET['cmd'])
{
default:
return IL_SCREEN_SIDE;
break;
}
}
static ilChatroomBlockGUI::isRepositoryObject ( )
static
Returns
bool

Reimplemented from ilBlockGUI.

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

{
return false;
}

Field Documentation

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: