class.ilCertificateAdapter.php

Go to the documentation of this file.

<?php

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

abstract class ilCertificateAdapter
{
    protected $lng;

    public function __construct()
    {
        global $DIC;

        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('certificate');
    }

    abstract public function getCertificatePath();
    
    abstract public function getCertificateVariablesForPreview();

    abstract public function getCertificateVariablesForPresentation($params = array());

    abstract public function getCertificateVariablesDescription();

    abstract public function getAdapterType();

    abstract public function getCertificateID();
    
    public function addAdditionalFormElements(&$form, $form_fields)
    {
    }

    public function hasAdditionalFormElements()
    {
        return false;
    }

    public function addFormFieldsFromPOST(&$form_fields)
    {
    }
    
    public function addFormFieldsFromObject(&$form_fields)
    {
    }

    public function saveFormFields(&$form_fields)
    {
    }
    
    public function deleteCertificate()
    {
    }
    
    public function getCertificateFilename($params = array())
    {
        $this->lng->loadLanguageModule("certificate");

        return $this->lng->txt("certificate_file_basename") . ".pdf";
    }
    
    protected function getBaseVariablesDescription($a_enable_last_access = true, $a_enable_completion_date = true)
    {
        $vars = array(
            "USER_LOGIN" => $this->lng->txt("certificate_ph_login"),
            "USER_FULLNAME" => $this->lng->txt("certificate_ph_fullname"),
            "USER_FIRSTNAME" => $this->lng->txt("certificate_ph_firstname"),
            "USER_LASTNAME" => $this->lng->txt("certificate_ph_lastname"),
            "USER_TITLE" => $this->lng->txt("certificate_ph_title"),
            "USER_SALUTATION" => $this->lng->txt("certificate_ph_salutation"),
            "USER_BIRTHDAY" => $this->lng->txt("certificate_ph_birthday"),
            "USER_INSTITUTION" => $this->lng->txt("certificate_ph_institution"),
            "USER_DEPARTMENT" => $this->lng->txt("certificate_ph_department"),
            "USER_STREET" => $this->lng->txt("certificate_ph_street"),
            "USER_CITY" => $this->lng->txt("certificate_ph_city"),
            "USER_ZIPCODE" => $this->lng->txt("certificate_ph_zipcode"),
            "USER_COUNTRY" => $this->lng->txt("certificate_ph_country"),
            "USER_MATRICULATION" => $this->lng->txt("certificate_ph_matriculation")
        );
        
        if ($a_enable_last_access) {
            $vars["USER_LASTACCESS"] = $this->lng->txt("certificate_ph_lastaccess");
        }
        
        $vars["DATE"] = $this->lng->txt("certificate_ph_date");
        $vars["DATETIME"] = $this->lng->txt("certificate_ph_datetime");
        
        if ($a_enable_completion_date) {
            $vars["DATE_COMPLETED"] = $this->lng->txt("certificate_ph_date_completed");
            $vars["DATETIME_COMPLETED"] = $this->lng->txt("certificate_ph_datetime_completed");
        }
        
        return $vars;
    }
    
    protected function getBaseVariablesForPreview($a_enable_last_access = true, $a_enable_completion_date = true)
    {
        $old = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
        
        $vars = array(
            "USER_LOGIN" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_login")),
            "USER_FULLNAME" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_fullname")),
            "USER_FIRSTNAME" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_firstname")),
            "USER_LASTNAME" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_lastname")),
            "USER_TITLE" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_title")),
            "USER_SALUTATION" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_salutation")),
            "USER_BIRTHDAY" => ilDatePresentation::formatDate(new ilDate($this->lng->txt("certificate_var_user_birthday"), IL_CAL_DATE)),
            "USER_INSTITUTION" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_institution")),
            "USER_DEPARTMENT" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_department")),
            "USER_STREET" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_street")),
            "USER_CITY" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_city")),
            "USER_ZIPCODE" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_zipcode")),
            "USER_COUNTRY" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_country")),
            "USER_MATRICULATION" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_matriculation"))
        );
        
        if ($a_enable_last_access) {
            $vars["USER_LASTACCESS"] = ilDatePresentation::formatDate(new ilDateTime(time() - (24 * 60 * 60 * 5), IL_CAL_UNIX));
        };
                
        $vars["DATE"] = ilDatePresentation::formatDate(new ilDate(time(), IL_CAL_UNIX));
        $vars["DATETIME"] = ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX));
        
        if ($a_enable_completion_date) {
            $vars["DATE_COMPLETED"] = ilDatePresentation::formatDate(new ilDate(time() - (24 * 60 * 60 * 5), IL_CAL_UNIX));
            $vars["DATETIME_COMPLETED"] = ilDatePresentation::formatDate(new ilDateTime(time() - (24 * 60 * 60 * 5), IL_CAL_UNIX));
        }
        
        ilDatePresentation::setUseRelativeDates($old);
        
        return $vars;
    }
    

    protected function getBaseVariablesForPresentation($a_user_data, $a_last_access = null, $a_completion_date = false)
    {
        $old = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);

        $salutation = '';
        $gender = $a_user_data['gender'];
        if (is_string($gender) && strlen(trim($gender)) > 0 && strtolower($gender) !== 'n') {
            $salutation = $this->lng->txt("salutation_" . $gender);
        }

        $birthday = "";
        if ($a_user_data["birthday"]) {
            $birthday = ilDatePresentation::formatDate(new ilDate($a_user_data["birthday"], IL_CAL_DATE));
        }
        
        $country = $a_user_data["sel_country"];
        if ($country) {
            $this->lng->loadLanguageModule("meta");
            $country = $this->lng->txt("meta_c_" . $country);
        } else {
            $country = $a_user_data["country"];
        }
        
        $vars = array(
            "USER_LOGIN" => ilUtil::prepareFormOutput(trim($a_user_data["login"])),
            "USER_FULLNAME" => ilUtil::prepareFormOutput(trim($a_user_data["title"] . " " . $a_user_data["firstname"] . " " . $a_user_data["lastname"])),
            "USER_FIRSTNAME" => ilUtil::prepareFormOutput($a_user_data["firstname"]),
            "USER_LASTNAME" => ilUtil::prepareFormOutput($a_user_data["lastname"]),
            "USER_TITLE" => ilUtil::prepareFormOutput($a_user_data["title"]),
            "USER_SALUTATION" => ilUtil::prepareFormOutput($salutation),
            "USER_BIRTHDAY" => ilUtil::prepareFormOutput($birthday),
            "USER_INSTITUTION" => ilUtil::prepareFormOutput($a_user_data["institution"]),
            "USER_DEPARTMENT" => ilUtil::prepareFormOutput($a_user_data["department"]),
            "USER_STREET" => ilUtil::prepareFormOutput($a_user_data["street"]),
            "USER_CITY" => ilUtil::prepareFormOutput($a_user_data["city"]),
            "USER_ZIPCODE" => ilUtil::prepareFormOutput($a_user_data["zipcode"]),
            "USER_COUNTRY" => ilUtil::prepareFormOutput($country),
            "USER_MATRICULATION" => ilUtil::prepareFormOutput($a_user_data["matriculation"])
        );
        
        if ($a_last_access) {
            $vars["USER_LASTACCESS"] = ilDatePresentation::formatDate(new ilDateTime($a_last_access, IL_CAL_DATETIME));
        }
        
        $vars["DATE"] = ilDatePresentation::formatDate(new ilDate(time(), IL_CAL_UNIX));
        $vars["DATETIME"] = ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX));
        
        
        if ($a_completion_date) {
            $vars["DATE_COMPLETED"] = ilDatePresentation::formatDate(new ilDate($a_completion_date, IL_CAL_DATETIME));

            $dateTime = new ilDateTime($a_completion_date, IL_CAL_DATETIME);
            $vars["DATETIME_COMPLETED"] = ilDatePresentation::formatDate($dateTime);
            $vars["DATETIME_COMPLETED_UNIX"] = $dateTime->get(IL_CAL_UNIX);
        }
        
        ilDatePresentation::setUseRelativeDates($old);
        
        return $vars;
    }
    
    protected function getUserCompletionDate($a_user_id, $a_object_id = null)
    {
        if (!$a_object_id) {
            $a_object_id = $this->object->getId();
        }
        include_once "Services/Tracking/classes/class.ilLPStatus.php";
        return ilLPStatus::_lookupStatusChanged($a_object_id, $a_user_id);
    }
    
    public function getUserIdForParams($a_params)
    {
        return $a_params["user_id"];
    }
}