class.ilUDFClaimingPlugin.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once("./Services/Component/classes/class.ilPlugin.php");
 
abstract class ilUDFClaimingPlugin extends ilPlugin
{       
        //
        // plugin slot
        // 
        
        final function getComponentType()
        {               
                return IL_COMP_SERVICE;
        }

        final function getComponentName()
        {
                return "User";
        }

        final function getSlot()
        {
                return "UDFClaiming";           
        }

        final function getSlotId()
        {
                return "udfc";
        }
        
        protected final function slotInit()
        {
                require_once "Services/User/classes/class.ilUDFPermissionHelper.php";
        }       
        
        
        //
        // permission
        // 
        
        abstract public function checkPermission($a_user_id, $a_context_type, $a_context_id, $a_action_id, $a_action_sub_id);
        
        
        //
        // db update helper
        // 
        
        public static function hasDBField($a_field_id)
        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT field_id FROM udf_definition".
                        " WHERE field_id = ".$ilDB->quote($a_field_id, "integer"));
                return (bool)$ilDB->numRows($set);      
        }       
        
        protected static function getDBField($a_field_id)
        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT * FROM udf_definition".
                        " WHERE field_id = ".$ilDB->quote($a_field_id, "integer"));
                return $ilDB->fetchAssoc($set);
        }
        
        protected static function isValidFieldType($a_field_type)
        {               
                // needed for the type constants
                require_once "Services/User/classes/class.ilUserDefinedFields.php";
                
                $valid = array(UDF_TYPE_TEXT, UDF_TYPE_SELECT, UDF_TYPE_WYSIWYG);

                return in_array($a_field_type, $valid);
        }
        
        protected static function handleAccesss(array &$fields, array $a_access = null, array $a_existing = null)
        {
                $map = array("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] = array("integer", (int)$a_access[$prop]);
                        }
                        else if(isset($a_existing[$prop]))
                        {
                                $fields[$prop] = array("integer", (int)$a_existing[$prop]);
                        }
                        else 
                        {
                                $fields[$prop] = array("integer", 0);
                        }
                }
        }
        
        public static function createDBField($a_type, $a_title, array $a_access = null, array $a_options = null)
        {
                global $ilDB;
                
                $field_id = $ilDB->nextId("udf_definition");
                
                // validating type
                $a_type = (int)$a_type;
                if(!self::isValidFieldType($a_type))
                {
                        return;
                }       
                
                if($a_type != UDF_TYPE_SELECT)
                {
                        $a_options = null;
                }
                
                // :TODO: check unique title?
                
                $fields = array(                        
                        "field_id" => array("integer", $field_id),              
                        "field_type" => array("integer", $a_type),                      
                        "field_name" => array("text", trim($a_title)),
                        "field_values" => array("text", serialize((array)$a_options))
                );                              
                
                self::handleAccesss($fields, $a_access);        
                
                $ilDB->insert("udf_definition", $fields);
                
                return $field_id;               
        }
        
        public static function updateDBField($a_field_id, $a_title, array $a_access = null, array $a_options = null)
        {
                global $ilDB;                   
                                
                if(self::hasDBField($a_field_id))
                {                       
                        $old = self::getDBField($a_field_id);
                        
                        if($old["field_type"] != UDF_TYPE_SELECT)
                        {
                                $a_options = null;
                        }
                        
                        $fields = array(                                                                
                                "field_name" => array("text", trim($a_title)),
                                "field_values" => array("text", serialize((array)$a_options))
                        );              
                        
                        self::handleAccesss($fields, $a_access, $old);                  
                        
                        $ilDB->update("udf_definition", $fields,
                                array("field_id" => array("integer", $a_field_id)));
                        return true;
                }
                
                return false;
        }
        
        public static function deleteDBField($a_field_id)
        {
                global $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;
        }
}

?>