Accordion user interface class. More...

Collaboration diagram for ilAccordionGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get id. More...

	setOrientation ($a_orientation)
	Set Orientation. More...

	getOrientation ()
	Get Orientation. More...

	setContainerClass ($a_containerclass)
	Set Container CSS Class. More...

	getContainerClass ()
	Get Container CSS Class. More...

	setInnerContainerClass ($a_containerclass)
	Set inner Container CSS Class. More...

	getInnerContainerClass ()
	Get inner Container CSS Class. More...

	setHeaderClass ($a_headerclass)
	Set Header CSS Class. More...

	getHeaderClass ()
	Get Header CSS Class. More...

	setActiveHeaderClass ($a_h_class)
	Set active header class. More...

	getActiveHeaderClass ()
	Get active Header CSS Class. More...

	setContentClass ($a_contentclass)
	Set Content CSS Class. More...

	getContentClass ()
	Get Content CSS Class. More...

	setContentWidth ($a_contentwidth)
	Set ContentWidth. More...

	getContentWidth ()
	Get ContentWidth. More...

	setContentHeight ($a_contentheight)
	Set ContentHeight. More...

	getContentHeight ()
	Get ContentHeight. More...

	setBehaviour ($a_val)
	Set behaviour "ForceAllOpen" \| "FirstOpen" \| "AllClosed". More...

	getBehaviour ()
	Get behaviour. More...

	setUseSessionStorage ($a_val)
	Set use session storage. More...

	getUseSessionStorage ()
	Get use session storage. More...

	setAllowMultiOpened ($a_val)
	Set allow multi opened. More...

	getAllowMultiOpened ()
	Get allow multi opened. More...

	setShowAllElement ($a_val)
	Set show all element. More...

	getShowAllElement ()
	Get show all element. More...

	setHideAllElement ($a_val)
	Set hide all element. More...

	getHideAllElement ()
	Get hide all element. More...

	addItem ($a_header, $a_content, $a_force_open=false)
	Add item. More...

	getItems ()
	Get all items. More...

	getHTML ()
	Get accordion html. More...

Static Public Member Functions
static	addJavaScript ()
	Add javascript files that are necessary to run accordion. More...

static	addCss ()
	Add required css. More...

Data Fields
const	VERTICAL = "vertical"

const	HORIZONTAL = "horizontal"

const	FORCE_ALL_OPEN = "ForceAllOpen"

const	FIRST_OPEN = "FirstOpen"

const	ALL_CLOSED = "AllClosed"

Protected Attributes
	$items = array()

	$force_open = array()

	$use_session_storage = false

	$allow_multi_opened = false

	$show_all_element = null

	$hide_all_element = null

Static Protected Attributes
static	$accordion_cnt = 0

Detailed Description

Accordion user interface class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id:$

Definition at line 11 of file class.ilAccordionGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAccordionGUI::__construct ( )

Constructor.

Definition at line 30 of file class.ilAccordionGUI.php.

References setOrientation(), and VERTICAL.

         {
                 $this->setOrientation(ilAccordionGUI::VERTICAL);
         }

Here is the call graph for this function:

Member Function Documentation

◆ addCss()

static ilAccordionGUI::addCss ( )

static

Add required css.

Definition at line 338 of file class.ilAccordionGUI.php.

References $tpl.

Referenced by ilTableTemplatesTableGUI\__construct(), ilObjStyleSheetGUI\_getTemplatePreview(), getHTML(), ilPCIIMTriggerEditorGUI\getImageMapTableHTML(), ilPCTabsGUI\initForm(), ilLMPresentationGUI\layout(), and ilPageObjectGUI\showPage().

         {
                 global $tpl;
                 
                 $tpl->addCss("./Services/Accordion/css/accordion.css");
         }

Here is the caller graph for this function:

◆ addItem()

ilAccordionGUI::addItem	(	$a_header,
		$a_content,
		$a_force_open = `false`
	)

Add item.

Definition at line 348 of file class.ilAccordionGUI.php.

References $items.

         {
                 $this->items[] = array("header" => $a_header,
                         "content" => $a_content, "force_open" => $a_force_open);
                 
                 if($a_force_open)
                 {
                         $this->force_open[] = sizeof($this->items);
                 }
         }

◆ addJavaScript()

static ilAccordionGUI::addJavaScript ( )

static

Add javascript files that are necessary to run accordion.

Definition at line 322 of file class.ilAccordionGUI.php.

References $tpl, ilYuiUtil\initConnection(), and iljQueryUtil\initjQueryUI().

Referenced by ilPCIIMTriggerEditorGUI\getImageMapTableHTML(), ilLMPresentationGUI\layout(), and ilPageObjectGUI\showPage().

         {
                 global $tpl;
 
 
                 include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                 ilYuiUtil::initConnection();
 
                 include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
                 iljQueryUtil::initjQueryUI();
                 $tpl->addJavaScript("./Services/Accordion/js/accordion.js", true, 3);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveHeaderClass()

ilAccordionGUI::getActiveHeaderClass ( )

Get active Header CSS Class.

Returns: string Active header CSS Class

Definition at line 154 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->active_headerclass;
         }

Here is the caller graph for this function:

◆ getAllowMultiOpened()

ilAccordionGUI::getAllowMultiOpened ( )

Get allow multi opened.

Returns: bool allow multiple accordions being opened

Definition at line 274 of file class.ilAccordionGUI.php.

References $allow_multi_opened.

Referenced by getHTML().

         {
                 return $this->allow_multi_opened;
         }

Here is the caller graph for this function:

◆ getBehaviour()

ilAccordionGUI::getBehaviour ( )

Get behaviour.

Returns

Definition at line 234 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->behaviour;
         }

Here is the caller graph for this function:

◆ getContainerClass()

ilAccordionGUI::getContainerClass ( )

Get Container CSS Class.

Returns: string Container CSS Class

Definition at line 94 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->containerclass;
         }

Here is the caller graph for this function:

◆ getContentClass()

ilAccordionGUI::getContentClass ( )

Get Content CSS Class.

Returns: string Content CSS Class

Definition at line 174 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->contentclass;
         }

Here is the caller graph for this function:

◆ getContentHeight()

ilAccordionGUI::getContentHeight ( )

Get ContentHeight.

Returns: integer ContentHeight

Definition at line 214 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->contentheight;
         }

Here is the caller graph for this function:

◆ getContentWidth()

ilAccordionGUI::getContentWidth ( )

Get ContentWidth.

Returns: integer ContentWidth

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

Referenced by getHTML().

         {
                 return $this->contentwidth;
         }

Here is the caller graph for this function:

◆ getHeaderClass()

ilAccordionGUI::getHeaderClass ( )

Get Header CSS Class.

Returns: string Header CSS Class

Definition at line 134 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->headerclass;
         }

Here is the caller graph for this function:

◆ getHideAllElement()

ilAccordionGUI::getHideAllElement ( )

Get hide all element.

Returns: string ID of hide all html element

Definition at line 314 of file class.ilAccordionGUI.php.

References $hide_all_element.

Referenced by getHTML().

         {
                 return $this->hide_all_element;
         }

Here is the caller graph for this function:

◆ getHTML()

ilAccordionGUI::getHTML ( )

Get accordion html.

Definition at line 370 of file class.ilAccordionGUI.php.

References $ilUser, $options, $tpl, addCss(), ilJsonUtil\encode(), getActiveHeaderClass(), getAllowMultiOpened(), getBehaviour(), getContainerClass(), getContentClass(), getContentHeight(), getContentWidth(), getHeaderClass(), getHideAllElement(), getId(), getInnerContainerClass(), getItems(), getOrientation(), getShowAllElement(), getUseSessionStorage(), HORIZONTAL, and VERTICAL.

         {
                 global $ilUser;
                 
                 self::$accordion_cnt++;
                 
                 $or_short = ($this->getOrientation() == ilAccordionGUI::HORIZONTAL)
                         ? "H"
                         : "V";
                         
                 $width = (int) $this->getContentWidth();
                 $height = (int) $this->getContentHeight();
                 if ($this->getOrientation() == ilAccordionGUI::HORIZONTAL)
                 {
                         if ($width == 0)
                         {
                                 $width = 200;
                         }
                         if ($height == 0)
                         {
                                 $height = 100;
                         }
                 }
                 
                 $this->addJavascript();
                 $this->addCss();
                 
                 $tpl = new ilTemplate("tpl.accordion.html", true, true, "Services/Accordion");
                 foreach ($this->getItems() as $item)
                 {
                         $tpl->setCurrentBlock("item");
                         $tpl->setVariable("HEADER", $item["header"]);
                         $tpl->setVariable("CONTENT", $item["content"]);
                         $tpl->setVariable("HEADER_CLASS", $this->getHeaderClass()
                                 ? $this->getHeaderClass() : "il_".$or_short."AccordionHead");
                         $tpl->setVariable("CONTENT_CLASS", $this->getContentClass()
                                 ? $this->getContentClass() : "il_".$or_short."AccordionContent");
 
                         if ($this->getBehaviour() != self::FORCE_ALL_OPEN)
                         {
                                 $tpl->setVariable("HIDE_CONTENT_CLASS", "ilAccHideContent");
                         }
 
                         $tpl->setVariable("OR_SHORT", $or_short);
                         
                         $tpl->setVariable("INNER_CONTAINER_CLASS", $this->getInnerContainerClass()
                                 ? $this->getInnerContainerClass() : "il_".$or_short."AccordionInnerContainer");
 
 
                         if ($height > 0)
                         {
                                 $tpl->setVariable("HEIGHT", "height:".$height."px;");
                         }
                         if ($height > 0 && $this->getOrientation() == ilAccordionGUI::HORIZONTAL)
                         {
                                 $tpl->setVariable("HHEIGHT", "height:".$height."px;");
                         }
                         $tpl->parseCurrentBlock();
                 }
 
                 $tpl->setVariable("CONTAINER_CLASS", $this->getContainerClass()
                         ? $this->getContainerClass() : "il_".$or_short."AccordionContainer");
 
                 $options["orientation"] = $this->getOrientation();
                 $options["int_id"] = $this->getId();
 
                 if ($this->getUseSessionStorage() && $this->getId() != "")
                 {                       
                         include_once("./Services/Accordion/classes/class.ilAccordionPropertiesStorage.php");
                         $stor = new ilAccordionPropertiesStorage();
                         
                         $ctab = $stor->getProperty($this->getId(), $ilUser->getId(),
                                 "opened");
                         $ctab_arr = explode(";", $ctab);
 
                         foreach ($this->force_open as $fo)
                         {
                                 if (!in_array($fo, $ctab_arr))
                                 {
                                         $ctab_arr[] = $fo;
                                 }
                         }
                         $ctab = implode(";", $ctab_arr);
 
                         if ($ctab == "0") {
                                 $ctab = "";
                         }
 
                         $options["initial_opened"] = $ctab;
                         $options["save_url"] = "./ilias.php?baseClass=ilaccordionpropertiesstorage&cmd=setOpenedTab".
                                 "&accordion_id=".$this->getId()."&user_id=".$ilUser->getId();
                 }
 
                 $options["behaviour"] = $this->getBehaviour();
                 if ($this->getOrientation() == ilAccordionGUI::HORIZONTAL)
                 {
                         $options["toggle_class"] = 'il_HAccordionToggleDef';
                         $options["toggle_act_class"] = 'il_HAccordionToggleActiveDef';
                         $options["content_class"] = 'il_HAccordionContentDef';
                 }
                 else
                 {
                         $options["toggle_class"] = 'il_VAccordionToggleDef';
                         $options["toggle_act_class"] = 'il_VAccordionToggleActiveDef';
                         $options["content_class"] = 'il_VAccordionContentDef';
                 }
 
 
                 if ($width > 0)
                 {
                         $options["width"] = $width;
                 }
                 else
                 {
                         $options["width"] = null;
                 }
                 if ($width > 0 && $this->getOrientation() == ilAccordionGUI::VERTICAL)
                 {
                         $tpl->setVariable("CWIDTH", 'style="width:'.$width.'px;"');
                 }
 
                 if ($this->head_class_set)
                 {
                         $options["active_head_class"] = $this->getActiveHeaderClass();
                 }
                 else
                 {
                         if ($this->getOrientation() == ilAccordionGUI::VERTICAL)
                         {
                                 $options["active_head_class"] = "il_HAccordionHeadActive";
                         }
                         else
                         {
                                 $options["active_head_class"] =  "il_VAccordionHeadActive";
                         }
                 }
 
                 $options["height"] = null;
                 $options["id"] = 'accordion_'.$this->getId().'_'.self::$accordion_cnt;
                 $options["multi"] = (bool) $this->getAllowMultiOpened();
                 $options["show_all_element"] = $this->getShowAllElement();
                 $options["hide_all_element"] = $this->getHideAllElement();
 
                 include_once("./Services/JSON/classes/class.ilJsonUtil.php");
                 $tpl->setVariable("OPTIONS", $str = ilJsonUtil::encode($options));
                 $tpl->setVariable("ACC_ID", $options["id"]);
 //echo "<br><br><br><br><br><br>".$str;
                 return $tpl->get();
         }

Here is the call graph for this function:

◆ getId()

ilAccordionGUI::getId ( )

Get id.

Returns: string id

Definition at line 50 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getInnerContainerClass()

ilAccordionGUI::getInnerContainerClass ( )

Get inner Container CSS Class.

Returns: string Container CSS Class

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

Referenced by getHTML().

         {
                 return $this->icontainerclass;
         }

Here is the caller graph for this function:

◆ getItems()

ilAccordionGUI::getItems ( )

Get all items.

Definition at line 362 of file class.ilAccordionGUI.php.

References $items.

Referenced by getHTML().

         {
                 return $this->items;
         }

Here is the caller graph for this function:

◆ getOrientation()

ilAccordionGUI::getOrientation ( )

Get Orientation.

Returns: string Orientation

Definition at line 74 of file class.ilAccordionGUI.php.

Referenced by getHTML().

         {
                 return $this->orientation;
         }

Here is the caller graph for this function:

◆ getShowAllElement()

ilAccordionGUI::getShowAllElement ( )

Get show all element.

Returns: string ID of show all html element

Definition at line 294 of file class.ilAccordionGUI.php.

References $show_all_element.

Referenced by getHTML().

         {
                 return $this->show_all_element;
         }

Here is the caller graph for this function:

◆ getUseSessionStorage()

ilAccordionGUI::getUseSessionStorage ( )

Get use session storage.

Returns: bool use session storage

Definition at line 254 of file class.ilAccordionGUI.php.

References $use_session_storage.

Referenced by getHTML().

         {
                 return $this->use_session_storage;
         }

Here is the caller graph for this function:

◆ setActiveHeaderClass()

ilAccordionGUI::setActiveHeaderClass ( $a_h_class )

Set active header class.

Parameters

string $a_h_class Active Header CSS Class

Definition at line 144 of file class.ilAccordionGUI.php.

         {
                 $this->active_headerclass = $a_h_class;
         }

◆ setAllowMultiOpened()

ilAccordionGUI::setAllowMultiOpened ( $a_val )

Set allow multi opened.

Parameters

bool $a_val allow multiple accordions being opened

Definition at line 264 of file class.ilAccordionGUI.php.

         {
                 $this->allow_multi_opened = $a_val;
         }

◆ setBehaviour()

ilAccordionGUI::setBehaviour ( $a_val )

Set behaviour "ForceAllOpen" | "FirstOpen" | "AllClosed".

Parameters

string behaviour

Definition at line 224 of file class.ilAccordionGUI.php.

         {
                 $this->behaviour = $a_val;
         }

◆ setContainerClass()

ilAccordionGUI::setContainerClass ( $a_containerclass )

Set Container CSS Class.

Parameters

string $a_containerclass Container CSS Class

Definition at line 84 of file class.ilAccordionGUI.php.

         {
                 $this->containerclass = $a_containerclass;
         }

◆ setContentClass()

ilAccordionGUI::setContentClass ( $a_contentclass )

Set Content CSS Class.

Parameters

string $a_contentclass Content CSS Class

Definition at line 164 of file class.ilAccordionGUI.php.

         {
                 $this->contentclass = $a_contentclass;
         }

◆ setContentHeight()

ilAccordionGUI::setContentHeight ( $a_contentheight )

Set ContentHeight.

Parameters

integer $a_contentheight ContentHeight

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

         {
                 $this->contentheight = $a_contentheight;
         }

◆ setContentWidth()

ilAccordionGUI::setContentWidth ( $a_contentwidth )

Set ContentWidth.

Parameters

integer $a_contentwidth ContentWidth

Definition at line 184 of file class.ilAccordionGUI.php.

         {
                 $this->contentwidth = $a_contentwidth;
         }

◆ setHeaderClass()

ilAccordionGUI::setHeaderClass ( $a_headerclass )

Set Header CSS Class.

Parameters

string $a_headerclass Header CSS Class

Definition at line 124 of file class.ilAccordionGUI.php.

         {
                 $this->headerclass = $a_headerclass;
         }

◆ setHideAllElement()

ilAccordionGUI::setHideAllElement ( $a_val )

Set hide all element.

Parameters

string $a_val ID of hide all html element

Definition at line 304 of file class.ilAccordionGUI.php.

         {
                 $this->hide_all_element = $a_val;
         }

◆ setId()

ilAccordionGUI::setId ( $a_val )

Set id.

Parameters

string id

Definition at line 40 of file class.ilAccordionGUI.php.

         {
                 $this->id = $a_val;
         }

◆ setInnerContainerClass()

ilAccordionGUI::setInnerContainerClass ( $a_containerclass )

Set inner Container CSS Class.

Parameters

string $a_containerclass Container CSS Class

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

         {
                 $this->icontainerclass = $a_containerclass;
         }

◆ setOrientation()

ilAccordionGUI::setOrientation ( $a_orientation )

Set Orientation.

Parameters

string $a_orientation Orientation

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

References HORIZONTAL, and VERTICAL.

Referenced by __construct().

         {
                 if (in_array($a_orientation,
                         array(ilAccordionGUI::VERTICAL, ilAccordionGUI::HORIZONTAL)))
                 {
                         $this->orientation = $a_orientation;
                 }
         }

Here is the caller graph for this function:

◆ setShowAllElement()

ilAccordionGUI::setShowAllElement ( $a_val )

Set show all element.

Parameters

string $a_val ID of show all html element

Definition at line 284 of file class.ilAccordionGUI.php.

         {
                 $this->show_all_element = $a_val;
         }

◆ setUseSessionStorage()

ilAccordionGUI::setUseSessionStorage ( $a_val )

Set use session storage.

Parameters

bool $a_val use session storage

Definition at line 244 of file class.ilAccordionGUI.php.

         {
                 $this->use_session_storage = $a_val;
         }

Field Documentation

◆ $accordion_cnt

ilAccordionGUI::$accordion_cnt = 0

staticprotected

Definition at line 15 of file class.ilAccordionGUI.php.

◆ $allow_multi_opened

ilAccordionGUI::$allow_multi_opened = false

protected

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

Referenced by getAllowMultiOpened().

◆ $force_open

ilAccordionGUI::$force_open = array()

protected

Definition at line 14 of file class.ilAccordionGUI.php.

◆ $hide_all_element

ilAccordionGUI::$hide_all_element = null

protected

Definition at line 19 of file class.ilAccordionGUI.php.

Referenced by getHideAllElement().

◆ $items

ilAccordionGUI::$items = array()

protected

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

Referenced by addItem(), and getItems().

◆ $show_all_element

ilAccordionGUI::$show_all_element = null

protected

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

Referenced by getShowAllElement().

◆ $use_session_storage

ilAccordionGUI::$use_session_storage = false

protected

Definition at line 16 of file class.ilAccordionGUI.php.

Referenced by getUseSessionStorage().

◆ ALL_CLOSED

const ilAccordionGUI::ALL_CLOSED = "AllClosed"

Definition at line 25 of file class.ilAccordionGUI.php.

◆ FIRST_OPEN

const ilAccordionGUI::FIRST_OPEN = "FirstOpen"

Definition at line 24 of file class.ilAccordionGUI.php.

Referenced by ilObjectGUI\getCreationFormsHTML(), ilHelpGUI\showHelp(), and ilContainerObjectiveGUI\showObjectives().

◆ FORCE_ALL_OPEN

const ilAccordionGUI::FORCE_ALL_OPEN = "ForceAllOpen"

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

Referenced by ilObjRoleGUI\permObject().

◆ HORIZONTAL

const ilAccordionGUI::HORIZONTAL = "horizontal"

Definition at line 22 of file class.ilAccordionGUI.php.

Referenced by ilObjStyleSheetGUI\accordiontestObject(), getHTML(), and setOrientation().

◆ VERTICAL

const ilAccordionGUI::VERTICAL = "vertical"

Definition at line 21 of file class.ilAccordionGUI.php.

Referenced by __construct(), ilObjStyleSheetGUI\accordiontestObject(), getHTML(), and setOrientation().

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

Services/Accordion/classes/class.ilAccordionGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCss()

◆ addItem()

◆ addJavaScript()

◆ getActiveHeaderClass()

◆ getAllowMultiOpened()

◆ getBehaviour()

◆ getContainerClass()

◆ getContentClass()

◆ getContentHeight()

◆ getContentWidth()

◆ getHeaderClass()

◆ getHideAllElement()

◆ getHTML()

◆ getId()

◆ getInnerContainerClass()

◆ getItems()

◆ getOrientation()

◆ getShowAllElement()

◆ getUseSessionStorage()

◆ setActiveHeaderClass()

◆ setAllowMultiOpened()

◆ setBehaviour()

◆ setContainerClass()

◆ setContentClass()

◆ setContentHeight()

◆ setContentWidth()

◆ setHeaderClass()

◆ setHideAllElement()

◆ setId()

◆ setInnerContainerClass()

◆ setOrientation()

◆ setShowAllElement()

◆ setUseSessionStorage()

Field Documentation

◆ $accordion_cnt

◆ $allow_multi_opened

◆ $force_open

◆ $hide_all_element

◆ $items

◆ $show_all_element

◆ $use_session_storage

◆ ALL_CLOSED

◆ FIRST_OPEN

◆ FORCE_ALL_OPEN

◆ HORIZONTAL

◆ VERTICAL