ilBiblLibraryGUI Class Reference

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

Collaboration diagram for ilBiblLibraryGUI:

Public Member Functions
	__construct (ilBiblAdminLibraryFacadeInterface $facade)
	ilBiblLibraryGUI constructor. More...
	executeCommand ()
	Execute command. More...
	index ()
	$ilToolbar ilToolbarGUI; More...
	add ()
	add library More...
	delete ()
	delete library More...
	cancel ()
	cancel More...
	update ()
	save changes in library More...
	create ()
	create library More...
	edit ()
	edit library More...

Data Fields
const	F_LIB_ID = 'lib_id'
const	CMD_DELETE = 'delete'
const	CMD_EDIT = 'edit'
const	CMD_INDEX = 'index'
const	CMD_ADD = 'add'

Protected Member Functions
	initTable ()

Protected Attributes
ilBiblAdminLibraryFacadeInterface	$facade
ILIAS Refinery Factory	$refinery
ILIAS HTTP Wrapper WrapperFactory	$wrapper

Private Member Functions
	getInstanceFromRequest ()

Private Attributes
ilGlobalTemplateInterface	$main_tpl

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 Class ilBiblLibraryGUI

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilBiblLibraryGUI::__construct

(

ilBiblAdminLibraryFacadeInterface

$facade

)

ilBiblLibraryGUI constructor.

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

References $DIC, $facade, and ILIAS\Repository\refinery().

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->facade = $facade;
        $this->wrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilBiblLibraryGUI::add

(

)

add library

Definition at line 111 of file class.ilBiblLibraryGUI.php.

                         : void
    {
        $this->checkPermissionAndFail('write');
        $form = new ilBiblLibraryFormGUI($this->facade->libraryFactory()->getEmptyInstance());
        $this->tpl()->setContent($form->getHTML());
    }

cancel()

ilBiblLibraryGUI::cancel

(

)

cancel

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

References ILIAS\Repository\ctrl().

                            : void
    {
        $this->ctrl()->redirect($this, self::CMD_INDEX);
    }

Here is the call graph for this function:

create()

ilBiblLibraryGUI::create

(

)

create library

Definition at line 160 of file class.ilBiblLibraryGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilPropertyFormGUI\setValuesByPost().

                            : void
    {
        $this->checkPermissionAndFail('write');
        $form = new ilBiblLibraryFormGUI($this->facade->libraryFactory()->getEmptyInstance());
        $form->setValuesByPost();
        if ($form->saveObject()) {
            $this->main_tpl->setOnScreenMessage('success', $this->lng()->txt("settings_saved"), true);
            $this->ctrl()->redirect($this, self::CMD_INDEX);
        }
        $this->tpl()->setContent($form->getHTML());
    }

Here is the call graph for this function:

delete()

ilBiblLibraryGUI::delete

(

)

delete library

Definition at line 122 of file class.ilBiblLibraryGUI.php.

References ILIAS\Repository\ctrl(), and getInstanceFromRequest().

                            : void
    {
        $this->checkPermissionAndFail('write');
        $ilBibliographicSetting = $this->getInstanceFromRequest();
        $ilBibliographicSetting->delete();
        $this->ctrl()->redirect($this, self::CMD_INDEX);
    }

Here is the call graph for this function:

edit()

ilBiblLibraryGUI::edit

(

)

edit library

Definition at line 176 of file class.ilBiblLibraryGUI.php.

References ILIAS\Repository\ctrl(), and getInstanceFromRequest().

                          : void
    {
        $this->checkPermissionAndFail('write');
        $this->ctrl()->saveParameter($this, self::F_LIB_ID);
        $ilBibliographicSetting = $this->getInstanceFromRequest();
        $form = new ilBiblLibraryFormGUI($ilBibliographicSetting);
        $this->tpl()->setContent($form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilBiblLibraryGUI::executeCommand

(

)

Execute command.

public

Definition at line 56 of file class.ilBiblLibraryGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        switch ($this->ctrl()->getNextClass()) {
            case null:
                $cmd = $this->ctrl()->getCmd(self::CMD_INDEX);
                $this->{$cmd}();
                break;
        }
    }

Here is the call graph for this function:

getInstanceFromRequest()

ilBiblLibraryGUI::getInstanceFromRequest ( )

private

Definition at line 185 of file class.ilBiblLibraryGUI.php.

References ILIAS\Repository\refinery().

Referenced by delete(), edit(), and update().

                                             : \ilBiblLibraryInterface
    {
        // check Query
        if ($this->wrapper->query()->has(self::F_LIB_ID)) {
            return $this->facade->libraryFactory()
                                ->findById(
                                    $this->wrapper->query()->retrieve(
                                        self::F_LIB_ID,
                                        $this->refinery->kindlyTo()->int()
                                    )
                                );
        }
        // check post
        if ($this->wrapper->post()->has(self::F_LIB_ID)) {
            return $this->facade->libraryFactory()
                                ->findById(
                                    $this->wrapper->post()->retrieve(
                                        self::F_LIB_ID,
                                        $this->refinery->kindlyTo()->int()
                                    )
                                );
        }
        throw new ilException('library not found');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

index()

ilBiblLibraryGUI::index

(

)

$ilToolbar ilToolbarGUI;

Definition at line 71 of file class.ilBiblLibraryGUI.php.

References Vendor\Package\$b, ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), initTable(), and ILIAS\Repository\toolbar().

                           : bool
    {
        if ($this->checkPermissionBoolAndReturn('write')) {
            $b = ilLinkButton::getInstance();
            $b->setCaption(self::CMD_ADD);
            $b->setUrl($this->ctrl()->getLinkTarget($this, self::CMD_ADD));
            $b->setPrimary(true);

            $this->toolbar()->addButtonInstance($b);
        }

        $a_table = $this->initTable();
        $this->tpl()->setContent($a_table->getHTML());

        return true;
    }

Here is the call graph for this function:

initTable()

ilBiblLibraryGUI::initTable ( )

protected

Definition at line 89 of file class.ilBiblLibraryGUI.php.

References ILIAS\LTI\ToolProvider\$settings.

Referenced by index().

                                  : \ilBiblLibraryTableGUI
    {
        $table = new ilBiblLibraryTableGUI($this, $this->checkPermissionBoolAndReturn('write'));
        $settings = $this->facade->libraryFactory()->getAll();
        $result = array();
        foreach ($settings as $set) {
            $result[] = array(
                "id" => $set->getId(),
                "name" => $set->getName(),
                "url" => $set->getUrl(),
                "img" => $set->getImg(),
            );
        }
        $table->setData($result);

        return $table;
    }

Here is the caller graph for this function:

update()

ilBiblLibraryGUI::update

(

)

save changes in library

Definition at line 143 of file class.ilBiblLibraryGUI.php.

References ILIAS\Repository\ctrl(), getInstanceFromRequest(), and ILIAS\Repository\lng().

                            : void
    {
        $this->checkPermissionAndFail('write');
        $ilBibliographicSetting = $this->getInstanceFromRequest();
        $form = new ilBiblLibraryFormGUI($ilBibliographicSetting);
        $form->setValuesByPost();
        if ($form->saveObject()) {
            $this->main_tpl->setOnScreenMessage('success', $this->lng()->txt("settings_saved"), true);
            $this->ctrl()->redirect($this, self::CMD_INDEX);
        }
        $this->tpl()->setContent($form->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$facade

ilBiblAdminLibraryFacadeInterface ilBiblLibraryGUI::$facade

protected

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

Referenced by __construct().

$main_tpl

ilGlobalTemplateInterface ilBiblLibraryGUI::$main_tpl

private

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

$refinery

ILIAS Refinery Factory ilBiblLibraryGUI::$refinery

protected

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

$wrapper

ILIAS HTTP Wrapper WrapperFactory ilBiblLibraryGUI::$wrapper

protected

Definition at line 35 of file class.ilBiblLibraryGUI.php.

CMD_ADD

const ilBiblLibraryGUI::CMD_ADD = 'add'

Definition at line 31 of file class.ilBiblLibraryGUI.php.

CMD_DELETE

const ilBiblLibraryGUI::CMD_DELETE = 'delete'

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

Referenced by ilBiblLibraryTableGUI\fillRow().

CMD_EDIT

const ilBiblLibraryGUI::CMD_EDIT = 'edit'

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

Referenced by ilBiblLibraryTableGUI\fillRow().

CMD_INDEX

const ilBiblLibraryGUI::CMD_INDEX = 'index'

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

Referenced by ilObjBibliographicAdminGUI\view().

F_LIB_ID

const ilBiblLibraryGUI::F_LIB_ID = 'lib_id'

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

Referenced by ilBiblLibraryFormGUI\__construct(), and ilBiblLibraryTableGUI\fillRow().

---

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

• Modules/Bibliographic/classes/Admin/Library/class.ilBiblLibraryGUI.php