<?php
/**
 * ModulteilDeskriptor.php
 * Model class for Modulteil-Deskriptoren (table mvv_modulteil_deskriptor)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * @author      Peter Thienel <thienel@data-quest.de>
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 * @since       3.5
 *
 * @property string $id alias column for deskriptor_id
 * @property string $deskriptor_id database column
 * @property string $modulteil_id database column
 * @property I18NString $bezeichnung database column
 * @property I18NString|null $voraussetzung database column
 * @property I18NString|null $kommentar database column
 * @property I18NString|null $kommentar_kapazitaet database column
 * @property I18NString|null $kommentar_wl_praesenz database column
 * @property I18NString|null $kommentar_wl_bereitung database column
 * @property I18NString|null $kommentar_wl_selbst database column
 * @property I18NString|null $kommentar_wl_pruef database column
 * @property I18NString|null $pruef_vorleistung database column
 * @property I18NString|null $pruef_leistung database column
 * @property I18NString|null $kommentar_pflicht database column
 * @property string $author_id database column
 * @property string $editor_id database column
 * @property int $mkdate database column
 * @property int $chdate database column
 * @property SimpleORMapCollection<DatafieldEntryModel> $datafields has_many DatafieldEntryModel
 * @property Modulteil $modulteil belongs_to Modulteil
 */

class ModulteilDeskriptor extends ModuleManagementModel
{
    use MvvReplaceDataFieldsTrait;

    protected static function configure($config = [])
    {
        $config['db_table'] = 'mvv_modulteil_deskriptor';

        $config['belongs_to']['modulteil'] = [
            'class_name' => Modulteil::class,
            'foreign_key' => 'modulteil_id',
            'assoc_func' => 'findCached',
        ];

        $config['has_many']['datafields'] = [
            'class_name' => DatafieldEntryModel::class,
            'assoc_foreign_key' =>
                function($model, $params) {
                    $model->setValue('range_id', $params[0]->deskriptor_id);
                },
            'assoc_func' => 'findByModel',
            'on_delete' => 'delete',
            'on_store' => 'store',
            'foreign_key' =>
                function($m) {
                    return [$m];
                }
        ];

        $config['additional_fields']['abschnitt_assignments']['get'] =
            fn(ModulteilDeskriptor $md): SimpleORMapCollection => $md->modulteil->abschnitt_assignments;

        $config['i18n_fields']['bezeichnung'] = true;
        $config['i18n_fields']['voraussetzung'] = true;
        $config['i18n_fields']['kommentar'] = true;
        $config['i18n_fields']['kommentar_kapazitaet'] = true;
        $config['i18n_fields']['kommentar_wl_praesenz'] = true;
        $config['i18n_fields']['kommentar_wl_bereitung'] = true;
        $config['i18n_fields']['kommentar_wl_selbst'] = true;
        $config['i18n_fields']['kommentar_wl_pruef'] = true;
        $config['i18n_fields']['pruef_vorleistung'] = true;
        $config['i18n_fields']['pruef_leistung'] = true;
        $config['i18n_fields']['kommentar_pflicht'] = true;

        parent::configure($config);
    }

    public function __construct($id = null)
    {
        parent::__construct($id);
        $this->object_real_name = _('Modulteil-Deskriptor');
    }

    /**
     * @see ModuleManagementModel::getClassDisplayName
     */
    public static function getClassDisplayName($long = false)
    {
        return _('Modulteil-Deskriptor');
    }

    /**
     * Inherits the status of the parent modulteil.
     *
     * @see ModuleManagementModel::getStatus()
     * @return string The status (see mvv_config.php)
     */
    public function getStatus()
    {
        if ($this->modulteil) {
            return $this->modulteil->getStatus();
        }
        if ($this->isNew()) {
            return $GLOBALS['MVV_MODUL']['STATUS']['default'];
        }
        return parent::getStatus();
    }

    /**
     * Returns the language identifier as the variant of the descriptor object.
     *
     * @see ModuleManagementModel::getVariant()
     * @return string The language identifier.
     */
    public function getVariant(): string
    {
        if (self::getLanguage() === Config::get()->MVV_DEFAULT_LANGUAGE) {
            return '';
        }
        $splitted_code = explode('_', self::getLanguage());
        return mb_strtoupper($splitted_code[0] ?? '');
    }

    /**
     * Deletes the translation in the given language of this descriptor.
     *
     * @param string $language The language of the translation to delete.
     * @return int The number of deleted translated fields.
     */
    public function deleteTranslation($language)
    {
        return I18NString::removeAllTranslations($this->id, 'mvv_modulteil_deskriptor', $language);
    }
}