arGUI Class Reference

Collaboration diagram for arGUI:

Public Member Functions
	__construct ($record_type, ilPlugin $plugin_object=null)
	executeCommand ()
	multiAction ($action_name="")
	customMultiAction ($action_name="", $ids=null)
	save (arEditGUI $edit_gui)
	getRecordCreatedMessage ()
	delete ($id)
	getDeleteRecordsConfirmationMessage ()
	getDeleteRecordConfirmationMessage ()
	deleteItems ()
	getDeleteRecordsMessage ()
	getDeleteRecordMessage ()
	setLngPrefix ($lng_prefix)
	getLngPrefix ()
	txt ($txt, $plugin_txt=true)

Protected Attributes
	$ctrl
	$tpl
	$access
	$lng
	ilLanguage More...
	$plugin_object = null
	$record_type = ""
	$ar
	$lng_prefix = ""

Detailed Description

Author

Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version

2.0.7

Definition at line 12 of file class.arGUI.php.

Constructor & Destructor Documentation

__construct()

arGUI::__construct	(		$record_type,
		ilPlugin	$plugin_object = null
	)

Parameters

	$record_type
ilPlugin	$plugin_object

Definition at line 53 of file class.arGUI.php.

References $DIC, $ilCtrl, $lng, $plugin_object, $record_type, $tpl, and setLngPrefix().

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilAccess = $DIC['ilAccess'];
        $lng = $DIC['lng'];

        $this->lng = $lng;

        if ($plugin_object) {
            $this->setLngPrefix($plugin_object->getPrefix());
            $plugin_object->loadLanguageModule();
        }

        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->access = $ilAccess;
        $this->plugin_object = $plugin_object;
        $this->record_type = $record_type;
        $this->ar = new $record_type();
    }

Here is the call graph for this function:

Member Function Documentation

customMultiAction()

arGUI::customMultiAction	(		$action_name = "",
			$ids = null
	)

Parameters

string	$action_name
null	$ids

Definition at line 170 of file class.arGUI.php.

References $id, add(), save(), and League\Flysystem\Adapter\Polyfill\update().

Referenced by multiAction().

    {
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

arGUI::delete

(

$id

)

Parameters

$id

Definition at line 265 of file class.arGUI.php.

References $id, getDeleteRecordConfirmationMessage(), getDeleteRecordsConfirmationMessage(), and ilUtil\sendQuestion().

    {
        $this->deleteMultiple(array( $id ));
    }

Here is the call graph for this function:

deleteItems()

arGUI::deleteItems

(

)

Definition at line 308 of file class.arGUI.php.

References $_POST, $i, $id, getDeleteRecordMessage(), and getDeleteRecordsMessage().

    {
        $nr_ids = $_POST['nr_ids'];
        for ($i = 0; $i < $nr_ids; $i++) {
            $id = $_POST['delete_id_' . $i];
            $record = $this->ar->find($id);
            $record->delete();
        }
        if ($i == 1) {
            ilUtil::sendSuccess($this->getDeleteRecordMessage(), true);
        } else {
            ilUtil::sendSuccess($this->getDeleteRecordsMessage(), true);
        }

        $this->ctrl->redirect($this, "index");
    }

Here is the call graph for this function:

executeCommand()

arGUI::executeCommand

(

)

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

References $_GET, $_POST, arIndexTableGUI\domid_decode(), and multiAction().

    {
        $cmd = $this->ctrl->getCmd();
        switch ($cmd) {
            case "edit":
            case "update":
            case "view":
            case "delete":
                $this->$cmd(arIndexTableGUI::domid_decode($_GET['ar_id']));
                break;
            case "multiAction":
                $action_name = $_POST["index_table_multi_action_2"];
                $this->multiAction($action_name);
                break;
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getDeleteRecordConfirmationMessage()

arGUI::getDeleteRecordConfirmationMessage

(

)

Returns

string

Definition at line 302 of file class.arGUI.php.

References txt().

Referenced by delete().

    {
        return $this->txt(('delete_record_confirmation'), true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDeleteRecordMessage()

arGUI::getDeleteRecordMessage

(

)

Returns

string

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

References txt().

Referenced by deleteItems().

    {
        return $this->txt(('record_deleted'), true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDeleteRecordsConfirmationMessage()

arGUI::getDeleteRecordsConfirmationMessage

(

)

Returns

string

Definition at line 293 of file class.arGUI.php.

References txt().

Referenced by delete().

    {
        return $this->txt(('delete_records_confirmation'), true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDeleteRecordsMessage()

arGUI::getDeleteRecordsMessage

(

)

Returns

string

Definition at line 329 of file class.arGUI.php.

References txt().

Referenced by deleteItems().

    {
        return $this->txt(('records_deleted'), true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLngPrefix()

arGUI::getLngPrefix

(

)

Returns

string

Definition at line 356 of file class.arGUI.php.

References $lng_prefix.

Referenced by txt().

    {
        return $this->lng_prefix;
    }

Here is the caller graph for this function:

getRecordCreatedMessage()

arGUI::getRecordCreatedMessage

(

)

Returns

string

Definition at line 242 of file class.arGUI.php.

References $id, and txt().

Referenced by save().

    {
        return $this->txt(('record_created'), true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

multiAction()

arGUI::multiAction

(

$action_name = ""

)

Parameters

string

$action_name

Definition at line 141 of file class.arGUI.php.

References $_POST, $id, customMultiAction(), arIndexTableGUI\domid_decode(), ilUtil\sendFailure(), and txt().

Referenced by executeCommand().

    {
        $ids = array();
        if ($_POST['id']) {
            foreach ($_POST['id'] as $id) {
                $ids[] = arIndexTableGUI::domid_decode($id);
            }
        }

        if (empty($ids)) {
            ilUtil::sendFailure($this->txt("no_checkbox", false), true);
            $this->ctrl->redirect($this, "index");
        }

        switch ($action_name) {
            case "delete":
                $this->deleteMultiple($ids);
                break;
            default:
                $this->customMultiAction($action_name, $ids);
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

arGUI::save

(

arEditGUI

$edit_gui

)

Parameters

arEditGUI

$edit_gui

Definition at line 228 of file class.arGUI.php.

References ilPropertyFormGUI\getHTML(), and getRecordCreatedMessage().

Referenced by customMultiAction().

    {
        if ($edit_gui->saveObject()) {
            ilUtil::sendSuccess($this->getRecordCreatedMessage());
            $this->ctrl->redirect($this, "index");
        } else {
            $this->tpl->setContent($edit_gui->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setLngPrefix()

arGUI::setLngPrefix

(

$lng_prefix

)

Parameters

string

$lng_prefix

Definition at line 347 of file class.arGUI.php.

References $lng_prefix.

Referenced by __construct().

    {
        $this->lng_prefix = $lng_prefix;
    }

Here is the caller graph for this function:

txt()

arGUI::txt	(		$txt,
			$plugin_txt = true
	)

Parameters

	$txt
bool	$plugin_txt

Returns

string

Definition at line 368 of file class.arGUI.php.

References $txt, and getLngPrefix().

Referenced by getDeleteRecordConfirmationMessage(), getDeleteRecordMessage(), getDeleteRecordsConfirmationMessage(), getDeleteRecordsMessage(), getRecordCreatedMessage(), and multiAction().

    {
        if ($this->getLngPrefix() != "" && $plugin_txt) {
            return $this->lng->txt($this->getLngPrefix() . "_" . $txt, $this->getLngPrefix());
        } else {
            return $this->lng->txt($txt);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

arGUI::$access

protected

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

$ar

arGUI::$ar

protected

Definition at line 42 of file class.arGUI.php.

$ctrl

arGUI::$ctrl

protected

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

$lng

arGUI::$lng

protected

ilLanguage

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

Referenced by __construct().

$lng_prefix

arGUI::$lng_prefix = ""

protected

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

Referenced by getLngPrefix(), and setLngPrefix().

$plugin_object

arGUI::$plugin_object = null

protected

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

Referenced by __construct().

$record_type

arGUI::$record_type = ""

protected

Definition at line 38 of file class.arGUI.php.

Referenced by __construct().

$tpl

arGUI::$tpl

protected

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

Referenced by __construct().

---

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

• Services/ActiveRecord/Views/class.arGUI.php