ilAccordionGUI Class Reference

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 (ilTemplate $main_tpl=null)
	Add javascript files that are necessary to run accordion. More...
static	addCss ()
	Add required css. More...
static	getLocalJavascriptFiles ()
static	getLocalCssFiles ()

Data Fields
const	VERTICAL = "vertical"
const	HORIZONTAL = "horizontal"
const	FORCE_ALL_OPEN = "ForceAllOpen"
const	FIRST_OPEN = "FirstOpen"
const	ALL_CLOSED = "AllClosed"

Static Public Attributes
static	$owl_path = "./libs/bower/bower_components/owl.carousel/dist"
static	$owl_js_path = "/owl.carousel.js"
static	$owl_css_path = "/assets/owl.carousel.css"

Protected Attributes
	$user
	$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 39 of file class.ilAccordionGUI.php.

References $DIC, setOrientation(), user(), and VERTICAL.

    {
        global $DIC;

        $this->user = $DIC->user();
        $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 359 of file class.ilAccordionGUI.php.

References $DIC, $f, and $tpl.

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

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        foreach (self::getLocalCssFiles() as $f) {
            $tpl->addCss($f);
        }
    }

Here is the caller graph for this function:

addItem()

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

Add item.

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

References $a_content, and $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 ( ilTemplate  $main_tpl = null )

static

Add javascript files that are necessary to run accordion.

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

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

Referenced by ilPCIIMTriggerEditorGUI\__construct(), ilObjStudyProgrammeTreeGUI\initAsyncUIElements(), ilLMPresentationGUI\layout(), and ilPageObjectGUI\showPage().

    {
        global $DIC;

        if ($main_tpl != null) {
            $tpl = $main_tpl;
        } else {
            $tpl = $DIC["tpl"];
        }

        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        ilYuiUtil::initConnection($tpl);

        include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
        iljQueryUtil::initjQueryUI($tpl);

        foreach (self::getLocalJavascriptFiles() as $f) {
            $tpl->addJavaScript($f, 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 167 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 287 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 247 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 107 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 187 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 227 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 207 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 147 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 327 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 416 of file class.ilAccordionGUI.php.

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

    {
        $ilUser = $this->user;
        
        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 62 of file class.ilAccordionGUI.php.

References $id.

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 127 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 408 of file class.ilAccordionGUI.php.

References $items.

Referenced by getHTML().

    {
        return $this->items;
    }

Here is the caller graph for this function:

getLocalCssFiles()

static ilAccordionGUI::getLocalCssFiles ( )

static

Returns

array

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

Referenced by ilCOPageHTMLExport\exportSupportScripts(), ilPCTabs\getCssFiles(), and ilCOPageHTMLExport\getPreparedMainTemplate().

    {
        return array(
            "./Services/Accordion/css/accordion.css",
            self::$owl_path . self::$owl_css_path
        );
    }

Here is the caller graph for this function:

getLocalJavascriptFiles()

static ilAccordionGUI::getLocalJavascriptFiles ( )

static

Returns

array

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

Referenced by ilCOPageHTMLExport\exportSupportScripts(), ilPCTabs\getJavascriptFiles(), and ilCOPageHTMLExport\getPreparedMainTemplate().

    {
        return array(
            "./Services/Accordion/js/accordion.js",
            self::$owl_path . self::$owl_js_path
        );
    }

Here is the caller graph for this function:

getOrientation()

ilAccordionGUI::getOrientation

(

)

Get Orientation.

Returns

string Orientation

Definition at line 87 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 307 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 267 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 157 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 277 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 237 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 97 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 177 of file class.ilAccordionGUI.php.

    {
        $this->contentclass = $a_contentclass;
    }

setContentHeight()

ilAccordionGUI::setContentHeight

(

$a_contentheight

)

Set ContentHeight.

Parameters

integer

$a_contentheight

ContentHeight

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

    {
        $this->contentheight = $a_contentheight;
    }

setContentWidth()

ilAccordionGUI::setContentWidth

(

$a_contentwidth

)

Set ContentWidth.

Parameters

integer

$a_contentwidth

ContentWidth

Definition at line 197 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 137 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 317 of file class.ilAccordionGUI.php.

    {
        $this->hide_all_element = $a_val;
    }

setId()

ilAccordionGUI::setId

(

$a_val

)

Set id.

Parameters

string

id

Definition at line 52 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 117 of file class.ilAccordionGUI.php.

    {
        $this->icontainerclass = $a_containerclass;
    }

setOrientation()

ilAccordionGUI::setOrientation

(

$a_orientation

)

Set Orientation.

Parameters

string

$a_orientation

Orientation

Definition at line 72 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 297 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 257 of file class.ilAccordionGUI.php.

    {
        $this->use_session_storage = $a_val;
    }

Field Documentation

$accordion_cnt

ilAccordionGUI::$accordion_cnt = 0

staticprotected

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

$allow_multi_opened

ilAccordionGUI::$allow_multi_opened = false

protected

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

Referenced by getAllowMultiOpened().

$force_open

ilAccordionGUI::$force_open = array()

protected

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

$hide_all_element

ilAccordionGUI::$hide_all_element = null

protected

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

Referenced by getHideAllElement().

$items

ilAccordionGUI::$items = array()

protected

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

Referenced by addItem(), and getItems().

$owl_css_path

ilAccordionGUI::$owl_css_path = "/assets/owl.carousel.css"

static

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

$owl_js_path

ilAccordionGUI::$owl_js_path = "/owl.carousel.js"

static

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

$owl_path

ilAccordionGUI::$owl_path = "./libs/bower/bower_components/owl.carousel/dist"

static

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

$show_all_element

ilAccordionGUI::$show_all_element = null

protected

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

Referenced by getShowAllElement().

$use_session_storage

ilAccordionGUI::$use_session_storage = false

protected

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

Referenced by getUseSessionStorage().

$user

ilAccordionGUI::$user

protected

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

Referenced by getHTML().

ALL_CLOSED

const ilAccordionGUI::ALL_CLOSED = "AllClosed"

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

Referenced by ilObjMediaPoolGUI\editTitlesAndDescriptions().

FIRST_OPEN

const ilAccordionGUI::FIRST_OPEN = "FirstOpen"

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

Referenced by ilSystemStyleOverviewGUI\cloneSystemStyleForm(), ilObjStudyProgrammeTreeGUI\create(), ilObjectGUI\getCreationFormsHTML(), ilHelpGUI\showHelp(), and ilContainerObjectiveGUI\showObjectives().

FORCE_ALL_OPEN

const ilAccordionGUI::FORCE_ALL_OPEN = "ForceAllOpen"

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

Referenced by ilObjRoleGUI\permObject(), and ilObjRoleTemplateGUI\saveObject().

HORIZONTAL

const ilAccordionGUI::HORIZONTAL = "horizontal"

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

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

VERTICAL

const ilAccordionGUI::VERTICAL = "vertical"

Definition at line 26 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