ilUDFClaimingPlugin 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 ilUDFClaimingPlugin:

Collaboration diagram for ilUDFClaimingPlugin:

Public Member Functions
	checkPermission (int $a_user_id, int $a_context_type, int $a_context_id, int $a_action_id, int $a_action_sub_id)
	Check permission. More...
Public Member Functions inherited from ilPlugin
	getMessage ()
	__construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id)
	getPluginName ()
	getId ()
	getVersion ()
	Only very little classes seem to care about this: More...
	getDirectory ()
	Only very little classes seem to care about this: More...
	isActive ()
	Only very little classes seem to care about this: More...
	needsUpdate ()
	install ()
	uninstall ()
	activate ()
	This will update (if required) and activate the plugin. More...
	deactivate ()
	update ()
	loadLanguageModule ()
	Load language module for plugin. More...
	txt (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...
	getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	getStyleSheetLocation (string $a_css_file)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	getGlobalScreenProviderCollection ()
	exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic)
	This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More...
	exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic)
	This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More...

Static Public Member Functions
static	hasDBField (string $a_field_id)
	Check if field has db entry. More...
static	createDBField (int $a_type, string $a_title, array $a_access=null, array $a_options=null)
	Create field db entry. More...
static	updateDBField (int $a_field_id, string $a_title, array $a_access=null, array $a_options=null)
	Update field db entry. More...
static	deleteDBField (int $a_field_id)
	Delete field db entry. More...

Static Protected Member Functions
static	getDBField (string $a_field_id)
	Get existing field values. More...
static	isValidFieldType (int $a_field_type)
	Validate field type. More...
static	handleAccesss (array &$fields, ?array $a_access=null, ?array $a_existing=null)
	Convert access array to DB columns. More...

Additional Inherited Members
Protected Member Functions inherited from ilPlugin
	init ()
	Object initialization. More...
	getPluginInfo ()
	getComponentInfo ()
	getPluginSlotInfo ()
	afterInstall ()
	If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...
	beforeUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
	afterUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
	beforeActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	afterActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	afterDeactivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	updateDatabase ()
	beforeUpdate ()
	If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More...
	afterUpdate ()
	getLanguageHandler ()
	buildLanguageHandler ()
Protected Attributes inherited from ilPlugin
ilDBInterface	$db
ilComponentRepositoryWrite	$component_repository
string	$id
ilPluginLanguage	$language_handler = null
bool	$lang_initialised = false
ProviderCollection	$provider_collection
string	$message = ''

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 Abstract parent class for all udf claiming plugin classes.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

checkPermission()

ilUDFClaimingPlugin::checkPermission ( int  $a_user_id, int  $a_context_type, int  $a_context_id, int  $a_action_id, int  $a_action_sub_id  )

abstract

Check permission.

createDBField()

static ilUDFClaimingPlugin::createDBField ( int  $a_type, string  $a_title, array  $a_access = null, array  $a_options = null  )

static

Create field db entry.

Definition at line 107 of file class.ilUDFClaimingPlugin.php.

References $DIC, $ilDB, and UDF_TYPE_SELECT.

     : ?int {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $field_id = $ilDB->nextId("udf_definition");

        // validating type
        if (!self::isValidFieldType($a_type)) {
            return null;
        }

        if ($a_type != UDF_TYPE_SELECT) {
            $a_options = null;
        }

        // :TODO: check unique title?

        $fields = [
            "field_id" => ["integer", $field_id],
            "field_type" => ["integer", $a_type],
            "field_name" => ["text", trim($a_title)],
            "field_values" => ["text", serialize((array) $a_options)]
        ];

        self::handleAccesss($fields, $a_access);

        $ilDB->insert("udf_definition", $fields);

        return $field_id;
    }

deleteDBField()

static ilUDFClaimingPlugin::deleteDBField ( int  $a_field_id )

static

Delete field db entry.

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

References $DIC, and $ilDB.

                                                         : bool
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if (self::hasDBField($a_field_id)) {
            // :TODO: we are not deleting any values here

            $ilDB->manipulate("DELETE FROM udf_definition" .
                " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
            return true;
        }

        return false;
    }

getDBField()

static ilUDFClaimingPlugin::getDBField ( string  $a_field_id )

staticprotected

Get existing field values.

Definition at line 62 of file class.ilUDFClaimingPlugin.php.

References $DIC, and $ilDB.

                                                            : array // Missing array type.
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $set = $ilDB->query("SELECT * FROM udf_definition" .
            " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
        return $ilDB->fetchAssoc($set);
    }

handleAccesss()

static ilUDFClaimingPlugin::handleAccesss ( array &  $fields, ?array  $a_access = null, ?array  $a_existing = null  )

staticprotected

Convert access array to DB columns.

Definition at line 85 of file class.ilUDFClaimingPlugin.php.

References ILIAS\Repository\int().

     : void {
        $map = ["visible", "changeable", "searchable", "required", "export",
            "course_export", "group_export", "registration_visible", "visible_lua",
            "changeable_lua", "certificate"];
        foreach ($map as $prop) {
            if (isset($a_access[$prop])) {
                $fields[$prop] = ["integer", (int) $a_access[$prop]];
            } elseif (isset($a_existing[$prop])) {
                $fields[$prop] = ["integer", (int) $a_existing[$prop]];
            } else {
                $fields[$prop] = ["integer", 0];
            }
        }
    }

Here is the call graph for this function:

hasDBField()

static ilUDFClaimingPlugin::hasDBField ( string  $a_field_id )

static

Check if field has db entry.

Definition at line 48 of file class.ilUDFClaimingPlugin.php.

References $DIC, and $ilDB.

                                                         : bool
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $set = $ilDB->query("SELECT field_id FROM udf_definition" .
            " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
        return (bool) $ilDB->numRows($set);
    }

isValidFieldType()

static ilUDFClaimingPlugin::isValidFieldType ( int  $a_field_type )

staticprotected

Validate field type.

Definition at line 76 of file class.ilUDFClaimingPlugin.php.

References $valid, UDF_TYPE_SELECT, UDF_TYPE_TEXT, and UDF_TYPE_WYSIWYG.

                                                                 : bool
    {
        $valid = [UDF_TYPE_TEXT, UDF_TYPE_SELECT, UDF_TYPE_WYSIWYG];
        return in_array($a_field_type, $valid);
    }

updateDBField()

static ilUDFClaimingPlugin::updateDBField ( int  $a_field_id, string  $a_title, array  $a_access = null, array  $a_options = null  )

static

Update field db entry.

Definition at line 147 of file class.ilUDFClaimingPlugin.php.

References $DIC, $ilDB, and UDF_TYPE_SELECT.

     : bool {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if (self::hasDBField($a_field_id)) {
            $old = self::getDBField($a_field_id);

            if ($old["field_type"] != UDF_TYPE_SELECT) {
                $a_options = null;
            }

            $fields = [
                "field_name" => ["text", trim($a_title)],
                "field_values" => ["text", serialize((array) $a_options)]
            ];

            self::handleAccesss($fields, $a_access, $old);

            $ilDB->update(
                "udf_definition",
                $fields,
                ["field_id" => ["integer", $a_field_id]]
            );
            return true;
        }

        return false;
    }

---

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

• components/ILIAS/User/classes/class.ilUDFClaimingPlugin.php