ilDataCollectionUiAdapter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDataCollectionUiAdapter:

Collaboration diagram for ilDataCollectionUiAdapter:

Public Member Functions
	addOnLoadJavaScriptCode (string $a_code)
	addJavaScriptFile (string $filePath)
	displayFailureMessage (string $message)
	displaySuccessMessage (string $message)
	displayErrorMessage (string $message)
	displayInfoMessage (string $message)
	addLocatorItem (string $title, string $link, int $itemId)
	resetTabs ()
	setBackTab (string $label, string $link)
	addDataCollectionEndpointToNavigationHistory (int $refId, string $link)
	addCssFile (string $filePath)
	addPermaLinkTableView (int $refId, int $tableviewId)
	setContent (string $content)
	addOnLoadJavaScriptCode (string $a_code)
	addJavaScriptFile (string $filePath)
	addCssFile (string $filePath)
	displayFailureMessage (string $message)
	displaySuccessMessage (string $message)
	displayErrorMessage (string $message)
	displayInfoMessage (string $message)
	addPermaLinkTableView (int $refId, int $tableviewId)
	setContent (string $content)
	addDataCollectionEndpointToNavigationHistory (int $refId, string $link)
	addLocatorItem (string $title, string $link, int $itemId)

Static Public Member Functions
static	new ()

Static Protected Attributes
static self	$instance = null

Private Member Functions
	__construct (ilGlobalTemplateInterface $tpl, ILIAS\DI\UIServices $ui, ilTabsGUI $tabs, ilErrorHandling $error, ilLocatorGUI $locatorGui, ilHelpGUI $help, ilNavigationHistory $navigationHistory)

Private Attributes
ilGlobalTemplateInterface	$tpl
ILIAS DI UIServices	$ui
ilTabsGUI	$tabs
ilErrorHandling	$error
ilLocatorGUI	$locatorGui
ilNavigationHistory	$navigationHistory

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

__construct()

ilDataCollectionUiAdapter::__construct ( ilGlobalTemplateInterface  $tpl, ILIAS\DI\UIServices  $ui, ilTabsGUI  $tabs, ilErrorHandling  $error, ilLocatorGUI  $locatorGui, ilHelpGUI  $help, ilNavigationHistory  $navigationHistory  )

private

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

      {
        $this->tpl = $tpl;
        $this->ui = $ui;
        $this->tabs = $tabs;
        $this->error = $error;
        $this->locatorGui = $locatorGui;
        $this->navigationHistory = $navigationHistory;
 
        $help->setScreenIdComponent("dcl");
    }

References $error, $locatorGui, $navigationHistory, $tabs, $tpl, $ui, error(), ilHelpGUI\setScreenIdComponent(), ILIAS\Repository\tabs(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

addCssFile()

ilDataCollectionUiAdapter::addCssFile

(

string

$filePath

)

Implements ilDataCollectionUiPort.

Definition at line 118 of file class.ilDataCollectionUiAdapter.php.

                                                : void
    {
        $this->tpl->addCss($filePath);
    }

addDataCollectionEndpointToNavigationHistory()

ilDataCollectionUiAdapter::addDataCollectionEndpointToNavigationHistory	(	int	$refId,
		string	$link
	)

Implements ilDataCollectionUiPort.

Definition at line 113 of file class.ilDataCollectionUiAdapter.php.

                                                                                          : void
    {
        $this->navigationHistory->addItem($refId, $link, "dcl");
    }

References $refId.

addJavaScriptFile()

ilDataCollectionUiAdapter::addJavaScriptFile

(

string

$filePath

)

Implements ilDataCollectionUiPort.

Definition at line 72 of file class.ilDataCollectionUiAdapter.php.

                                                       : void
    {
        $this->ui->mainTemplate()->addJavaScript($filePath);
    }

References ILIAS\Repository\ui().

Here is the call graph for this function:

addLocatorItem()

ilDataCollectionUiAdapter::addLocatorItem	(	string	$title,
		string	$link,
		int	$itemId
	)

Implements ilDataCollectionUiPort.

Definition at line 97 of file class.ilDataCollectionUiAdapter.php.

                                                                            : void
    {
        $this->locatorGui->addItem($title, $link, "", $itemId);
    }

addOnLoadJavaScriptCode()

ilDataCollectionUiAdapter::addOnLoadJavaScriptCode

(

string

$a_code

)

Implements ilDataCollectionUiPort.

Definition at line 67 of file class.ilDataCollectionUiAdapter.php.

                                                           : void
    {
        $this->tpl->addOnLoadCode($a_code);
    }

addPermaLinkTableView()

ilDataCollectionUiAdapter::addPermaLinkTableView	(	int	$refId,
		int	$tableviewId
	)

Implements ilDataCollectionUiPort.

Definition at line 123 of file class.ilDataCollectionUiAdapter.php.

                                                                       : void
    {
        $this->tpl->setPermanentLink("dcl", $refId, "_" . $tableviewId);
    }

References $refId.

displayErrorMessage()

ilDataCollectionUiAdapter::displayErrorMessage

(

string

$message

)

Implements ilDataCollectionUiPort.

Definition at line 87 of file class.ilDataCollectionUiAdapter.php.

                                                        : void
    {
        $this->error->raiseError($message);
    }

References error().

Here is the call graph for this function:

displayFailureMessage()

ilDataCollectionUiAdapter::displayFailureMessage

(

string

$message

)

Implements ilDataCollectionUiPort.

Definition at line 77 of file class.ilDataCollectionUiAdapter.php.

                                                          : void
    {
        $this->ui->mainTemplate()->setOnScreenMessage('failure', $message, true);
    }

References ILIAS\Repository\ui().

Here is the call graph for this function:

displayInfoMessage()

ilDataCollectionUiAdapter::displayInfoMessage

(

string

$message

)

Implements ilDataCollectionUiPort.

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

                                                       : void
    {
        $this->ui->mainTemplate()->setOnScreenMessage('info', $message, true);
    }

References ILIAS\Repository\ui().

Here is the call graph for this function:

displaySuccessMessage()

ilDataCollectionUiAdapter::displaySuccessMessage

(

string

$message

)

Implements ilDataCollectionUiPort.

Definition at line 82 of file class.ilDataCollectionUiAdapter.php.

                                                          : void
    {
        $this->ui->mainTemplate()->setOnScreenMessage('success', $message, true);
    }

References ILIAS\Repository\ui().

Here is the call graph for this function:

new()

static ilDataCollectionUiAdapter::new ( )

static

Definition at line 49 of file class.ilDataCollectionUiAdapter.php.

                                : self
    {
        if (is_null(static::$instance) === true) {
            global $DIC;
            static::$instance = new self(
                $DIC["tpl"],
                $DIC->ui(),
                $DIC->tabs(),
                $DIC['ilErr'],
                $DIC['ilLocator'],
                $DIC['ilHelp'],
                $DIC['ilNavigationHistory']
            );
        }
 
        return static::$instance;
    }

References $DIC.

Referenced by ilObjDataCollectionGUI\__construct(), and ilDataCollectionOutboundsAdapter\getDataCollectionUi().

Here is the caller graph for this function:

resetTabs()

ilDataCollectionUiAdapter::resetTabs

(

)

Definition at line 102 of file class.ilDataCollectionUiAdapter.php.

                               : void
    {
        $this->tabs->clearTargets();
        $this->tabs->clearSubTabs();
    }

References ILIAS\Repository\tabs().

Here is the call graph for this function:

setBackTab()

ilDataCollectionUiAdapter::setBackTab	(	string	$label,
		string	$link
	)

Definition at line 108 of file class.ilDataCollectionUiAdapter.php.

                                                           : void
    {
        $this->tabs->setBackTarget($label, $link);
    }

References ILIAS\Repository\tabs().

Here is the call graph for this function:

setContent()

ilDataCollectionUiAdapter::setContent

(

string

$content

)

Implements ilDataCollectionUiPort.

Definition at line 128 of file class.ilDataCollectionUiAdapter.php.

                                               : void
    {
        $this->tpl->setContent($content);
    }

Field Documentation

$error

ilErrorHandling ilDataCollectionUiAdapter::$error

private

Definition at line 26 of file class.ilDataCollectionUiAdapter.php.

Referenced by __construct().

$instance

self ilDataCollectionUiAdapter::$instance = null

staticprotected

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

$locatorGui

ilLocatorGUI ilDataCollectionUiAdapter::$locatorGui

private

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

Referenced by __construct().

$navigationHistory

ilNavigationHistory ilDataCollectionUiAdapter::$navigationHistory

private

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

Referenced by __construct().

$tabs

ilTabsGUI ilDataCollectionUiAdapter::$tabs

private

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

Referenced by __construct().

$tpl

ilGlobalTemplateInterface ilDataCollectionUiAdapter::$tpl

private

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

Referenced by __construct().

$ui

ILIAS DI UIServices ilDataCollectionUiAdapter::$ui

private

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

Referenced by __construct().

---

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

• Modules/DataCollection/classes/Adapters/Ui/class.ilDataCollectionUiAdapter.php