5include_once(
"./Services/Component/classes/class.ilPlugin.php");
 
   28        return "AdvancedMetaData";
 
   33        return "AdvancedMDClaiming";
 
   43        require_once 
"Services/AdvancedMetaData/classes/class.ilAdvancedMDPermissionHelper.php";
 
   78        $set = 
$ilDB->query(
"SELECT record_id FROM adv_md_record" .
 
   79            " WHERE record_id = " . 
$ilDB->quote($a_record_id, 
"integer"));
 
   80        return (
bool) 
$ilDB->numRows($set);
 
   92    public static function createDBRecord($a_title, $a_description, $a_active, array $a_obj_types)
 
   96        $record_id = 
$ilDB->nextId(
"adv_md_record");
 
   99            "record_id" => array(
"integer", $record_id),
 
  100            "import_id" => array(
"text", 
'il_' . IL_INST_ID . 
'_adv_md_record_' . $record_id),
 
  101            "title" => array(
"text", trim($a_title)),
 
  102            "description" => array(
"text", trim($a_description)),
 
  103            "active" => array(
"integer", (
int) $a_active)
 
  105        $ilDB->insert(
"adv_md_record", $fields);
 
  119    protected static function isValidObjType($a_obj_type, $a_is_substitution = 
false)
 
  122        $valid = array(
"crs", 
"cat", 
"book", 
"wiki", 
"glo", 
"orgu", 
"prg");
 
  124        if (!$a_is_substitution) {
 
  129        return in_array($a_obj_type, 
$valid);
 
  142        foreach ($a_obj_types as 
$type) {
 
  143            if (!is_array(
$type)) {
 
  147                $subtype = strtolower(trim(
$type[1]));
 
  151            if (self::isValidObjType(
$type)) {
 
  153                    "record_id" => array(
"integer", $a_record_id),
 
  154                    "obj_type" => array(
"text", 
$type),
 
  155                    "sub_type" => array(
"text", $subtype)
 
  157                $ilDB->insert(
"adv_md_record_objs", $fields);
 
  172    public static function updateDBRecord($a_record_id, $a_title, $a_description, $a_active, array $a_obj_types)
 
  176        if (self::hasDBRecord($a_record_id)) {
 
  178                "title" => array(
"text", trim($a_title)),
 
  179                "description" => array(
"text", trim($a_description)),
 
  180                "active" => array(
"integer", (
int) $a_active)
 
  185                array(
"record_id" => array(
"integer", $a_record_id))
 
  188            $ilDB->manipulate(
"DELETE FROM adv_md_record_objs" .
 
  189                " WHERE record_id = " . 
$ilDB->quote($a_record_id, 
"integer"));
 
  209        if (self::hasDBRecord($a_record_id)) {
 
  210            $ilDB->manipulate(
"DELETE FROM adv_md_record" .
 
  211                " WHERE record_id = " . 
$ilDB->quote($a_record_id, 
"integer"));
 
  228        $set = 
$ilDB->query(
"SELECT field_id FROM adv_mdf_definition" .
 
  229            " WHERE field_id = " . 
$ilDB->quote($a_field_id, 
"integer"));
 
  230        return (
bool) 
$ilDB->numRows($set);
 
  245        $sql = 
"SELECT max(position) pos" .
 
  246            " FROM adv_mdf_definition" .
 
  247            " WHERE record_id = " . 
$ilDB->quote($a_record_id, 
"integer");
 
  248        $set = 
$ilDB->query($sql);
 
  249        if (
$ilDB->numRows($set)) {
 
  250            $pos = 
$ilDB->fetchAssoc($set);
 
  251            return (
int) $pos[
"pos"];
 
  268    public static function createDBField($a_record_id, 
$a_type, $a_title, $a_description = 
null, $a_searchable = 
false, array $a_definition = 
null)
 
  272        if (!self::hasDBRecord($a_record_id)) {
 
  276        $field_id = 
$ilDB->nextId(
"adv_mdf_definition");
 
  280        if ($a_type < 1 || $a_type > 8) {
 
  287            "record_id" => array(
"integer", $a_record_id),
 
  288            "field_id" => array(
"integer", $field_id),
 
  289            "import_id" => array(
"text", 
"il_" . IL_INST_ID . 
"_adv_md_field_" . $field_id),
 
  290            "field_type" => array(
"integer", 
$a_type),
 
  291            "position" => array(
"integer", $pos),
 
  292            "title" => array(
"text", trim($a_title)),
 
  293            "description" => array(
"text", trim($a_description)),
 
  294            "searchable" => array(
"integer", (
int) $a_searchable)
 
  297            $fields[
"field_values"] = array(
"text", serialize($a_definition));
 
  299        $ilDB->insert(
"adv_mdf_definition", $fields);
 
  314    public static function updateDBField($a_field_id, $a_title, $a_description = 
null, $a_searchable = 
false, array $a_definition = 
null)
 
  318        if (self::hasDBField($a_field_id)) {
 
  320                "field_id" => array(
"integer", $a_field_id),
 
  321                "title" => array(
"text", trim($a_title)),
 
  322                "description" => array(
"text", trim($a_description)),
 
  323                "searchable" => array(
"integer", (
int) $a_searchable)
 
  326                $fields[
"field_values"] = array(
"text", serialize($a_definition));
 
  329                "adv_mdf_definition",
 
  331                array(
"field_id" => array(
"integer", $a_field_id))
 
  349        if (self::hasDBField($a_field_id)) {
 
  350            $ilDB->manipulate(
"DELETE FROM adv_mdf_definition" .
 
  351                " WHERE field_id = " . 
$ilDB->quote($a_field_id, 
"integer"));
 
  369        $set = 
$ilDB->query(
"SELECT * FROM adv_md_substitutions" .
 
  370            " WHERE obj_type = " . 
$ilDB->quote($a_obj_type, 
"text"));
 
  371        if (
$ilDB->numRows($set)) {
 
  373            $res[
"hide_description"] = array(
"integer", (
bool) 
$res[
"hide_description"]);
 
  374            $res[
"hide_field_names"] = array(
"integer", (
bool) 
$res[
"hide_field_names"]);
 
  376            if ($a_include_field_data) {
 
  377                $res[
"substitution"] = array(
"text", (array) unserialize(
$res[
"substitution"]));
 
  379                unset(
$res[
"substitution"]);
 
  381            unset(
$res[
"obj_type"]);
 
  399        if (self::isValidObjType($a_obj_type, 
true)) {
 
  405                $fields = array(
"obj_type" => array(
"text", $a_obj_type));
 
  408            $fields[
"hide_description"] = array(
"integer", !(
bool) $a_show_description);
 
  409            $fields[
"hide_field_names"] = array(
"integer", !(
bool) $a_show_field_names);
 
  412                $ilDB->insert(
"adv_md_substitutions", $fields);
 
  415                    "adv_md_substitutions",
 
  417                    array(
"obj_type" => array(
"text", $a_obj_type))
 
  435        if (self::isValidObjType($a_obj_type, 
true)) {
 
  437            $fields = $fields[
"substitution"][1];
 
  438            foreach ($fields as $field) {
 
  439                if ($field[
"field_id"] == $a_field_id) {
 
  460        if (self::isValidObjType($a_obj_type, 
true)) {
 
  466                $fields = $fields[
"substitution"][1];
 
  470            foreach ($fields as $idx => $field) {
 
  471                if ($field[
"field_id"] == $a_field_id) {
 
  472                    $fields[$idx][
"bold"] = (bool) $a_bold;
 
  473                    $fields[$idx][
"newline"] = (bool) $a_newline;
 
  480                    "field_id" => $a_field_id
 
  481                    ,
"bold" => (
bool) $a_bold
 
  482                    ,
"newline" => (
bool) $a_newline
 
  486            $fields = array(
"substitution"=>array(
"text", serialize($fields)));
 
  488                "adv_md_substitutions",
 
  490                array(
"obj_type" => array(
"text", $a_obj_type))
 
  507        if (self::isValidObjType($a_obj_type, 
true)) {
 
  512                $fields = $fields[
"substitution"][1];
 
  516            foreach ($fields as $idx => $field) {
 
  517                if ($field[
"field_id"] == $a_field_id) {
 
  518                    unset($fields[$idx]);
 
  524                $fields = array(
"substitution"=>array(
"text", serialize($fields)));
 
  526                    "adv_md_substitutions",
 
  528                    array(
"obj_type" => array(
"text", $a_obj_type))
 
An exception for terminatinating execution or to throw for unit testing.
Abstract parent class for all advanced md claiming plugin classes.
static getDBSubstitution($a_obj_type, $a_include_field_data=false)
Get substitution DB data for object type.
static deleteDBField($a_field_id)
Delete field db entry.
getComponentType()
Get Component Type.
static getDBFieldLastPosition($a_record_id)
Get last position of record.
static removeDBFieldSubstitution($a_obj_type, $a_field_id)
Remove field substitution entry in DB.
static hasDBFieldSubstitution($a_obj_type, $a_field_id)
Is substitution active for field in object type.
slotInit()
Object initialization done by slot.
static updateDBField($a_field_id, $a_title, $a_description=null, $a_searchable=false, array $a_definition=null)
Update field db entry.
static deleteDBRecord($a_record_id)
Delete record db entry.
static updateDBRecord($a_record_id, $a_title, $a_description, $a_active, array $a_obj_types)
Update record db entry.
static createDBRecord($a_title, $a_description, $a_active, array $a_obj_types)
Create record db entry.
static hasDBField($a_field_id)
Check if field has db entry.
static isValidObjType($a_obj_type, $a_is_substitution=false)
Validate object type.
static hasDBRecord($a_record_id)
Check if record has db entry.
static createDBField($a_record_id, $a_type, $a_title, $a_description=null, $a_searchable=false, array $a_definition=null)
Create field db entry.
static saveRecordObjTypes($a_record_id, array $a_obj_types)
Save object type assignments for record.
getComponentName()
Get Component Name.
checkPermission($a_user_id, $a_context_type, $a_context_id, $a_action_id, $a_action_sub_id)
Check permission.
static setDBFieldSubstitution($a_obj_type, $a_field_id, $a_bold=false, $a_newline=false)
Update field substitution entry in DB.
static setDBSubstitution($a_obj_type, $a_show_description, $a_show_field_names)
Set substitution DB entry (for object type)
foreach($_POST as $key=> $value) $res