You are here

Home » API reference » Opigno module 3.x » ModuleResultForm.php

class ModuleResultForm in Opigno module 3.x

Same name and namespace in other branches
  1. 8 src/Form/ModuleResultForm.php \Drupal\opigno_module\Form\ModuleResultForm

Class ModuleResultForm.

@package Drupal\opigno_module\Form

Hierarchy

Expanded class hierarchy of ModuleResultForm

1 string reference to 'ModuleResultForm'
opigno_module.routing.yml in ./opigno_module.routing.yml
opigno_module.routing.yml

File

src/Form/ModuleResultForm.php, line 20

Namespace

Drupal\opigno_module\Form
View source 
class ModuleResultForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'opigno_module_result_form';
  }

  /**
   * Title callback for the form.
   */
  public function formTitle(OpignoModule $opigno_module = NULL) {
    return $this
      ->t('Edit module result for %module_name', [
      '%module_name' => $opigno_module
        ->getName(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, OpignoModule $opigno_module = NULL, UserModuleStatus $user_module_status = NULL) {

    // Get attempt answers.
    $form['answers'] = [
      '#type' => 'fieldset',
      '#tree' => TRUE,
    ];
    $answers = $user_module_status
      ->getAnswers();
    foreach ($answers as $answer_id => $answer) {
      $answer_activity = $answer
        ->getActivity();
      $answer_type = $answer
        ->getType();
      if (!$answer_activity
        ->hasField('opigno_evaluation_method')) {
        continue;
      }
      elseif (!$answer_activity
        ->get('opigno_evaluation_method')
        ->getValue()[0]['value']) {
        continue;
      }
      $form['answers'][$answer_id] = [
        '#type' => 'fieldset',
        '#title' => Link::createFromRoute($this
          ->t('Activity: %activity', [
          '%activity' => $answer_activity
            ->getName(),
        ]), 'entity.opigno_activity.canonical', [
          'opigno_activity' => $answer_activity
            ->id(),
        ])
          ->toString(),
      ];
      $question_markup = '';
      $answer_markup = '';
      switch ($answer_type) {
        case 'opigno_file_upload':
          $answer_markup = $answer->opigno_file
            ->view('full');
          $question_markup = $answer_activity->opigno_body
            ->view('full');
          break;
        case 'opigno_long_answer':
          $answer_markup = $answer->opigno_body
            ->view('full');
          $question_markup = $answer_activity->opigno_body
            ->view('full');
          break;
        case 'opigno_slide':
          $question_markup = \Drupal::entityTypeManager()
            ->getViewBuilder('opigno_answer')
            ->view($answer);
          break;
        case 'opigno_h5p':

          // Get xApiData.

          /* @var $db_connection \Drupal\Core\Database\Connection */
          $db_connection = \Drupal::service('database');
          $query = $db_connection
            ->select('opigno_h5p_user_answer_results', 'ohr')
            ->fields('ohr')
            ->condition('ohr.answer_id', $answer
            ->id());
          $result = $query
            ->execute()
            ->fetchAll();
          $question_markup = [];
          if ($result) {
            foreach ($result as $xapi_data) {
              $H5PReport = H5PReport::getInstance();
              $reportHtml = $H5PReport
                ->generateReport($xapi_data);
              $question_markup[] = [
                '#markup' => $reportHtml,
              ];
            }
          }
          break;
        case 'opigno_scorm':
          break;
        case 'opigno_tincan':
          break;
      }
      if (!empty($question_markup)) {
        $form['answers'][$answer_id]['question_markup'] = $question_markup;
        $form['answers'][$answer_id]['question_markup']['#weight'] = -10;
      }
      if (!empty($answer_markup)) {
        $form['answers'][$answer_id]['answer_markup'] = $answer_markup;
        $form['answers'][$answer_id]['answer_markup']['#weight'] = -9;
      }
      $max_score = $this
        ->getAnswerMaxScore($answer);
      $form['answers'][$answer_id]['score'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Score'),
        '#default_value' => $answer
          ->getScore(),
        '#required' => TRUE,
        '#field_suffix' => "<span>/{$max_score}</span>",
        '#attributes' => [
          'class' => [
            'max-score',
          ],
        ],
      ];
    }
    $form['#attached']['library'][] = 'opigno_module/module_results_form';
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save score'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $answer_storage = \Drupal::entityTypeManager()
      ->getStorage('opigno_answer');
    $form_values = $form_state
      ->getValues();
    foreach ($form_values['answers'] as $answer_id => $value) {

      // Check if score is lower than maxScore.
      if (isset($value['score'])) {
        $answer = $answer_storage
          ->load($answer_id);
        $max_score = $this
          ->getAnswerMaxScore($answer);
        if (intval($value['score'] > intval($max_score))) {
          $form_state
            ->setErrorByName('score', $this
            ->t("Score can't be greater than maxScore."));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $build_info = $form_state
      ->getBuildInfo();
    $module = $build_info['args'][0];
    $user_status = $build_info['args'][1];
    $answer_storage = \Drupal::entityTypeManager()
      ->getStorage('opigno_answer');
    $form_values = $form_state
      ->getValues();
    foreach ($form_values['answers'] as $answer_id => $value) {
      if (isset($value['score'])) {
        $answer = $answer_storage
          ->load($answer_id);
        $answer
          ->setScore($value['score']);
        $answer
          ->setEvaluated(1);
        $answer
          ->save();

        // Send email to the user.
        $this
          ->sendEmailToManager($module, $user_status, $answer);
      }
    }
    $score = $user_status
      ->calculateScore();
    $max_score = $user_status
      ->calculateMaxScore();
    if ($max_score > 0) {
      $percents = round($score / $max_score * 100);
    }
    else {
      $percents = 100;
    }
    $user_status
      ->setScore((int) $percents);
    $user_status
      ->setMaxScore($max_score);
    $user_status
      ->setEvaluated(1);
    $user_status
      ->save();
    if (function_exists('opigno_learning_path_get_all_steps')) {
      $module_id = $module
        ->id();
      $uid = $user_status
        ->get('user_id')
        ->getValue();
      $uid = $uid[0]['target_id'];
      $gid = $user_status
        ->get('learning_path')
        ->getValue();
      $gid = $gid[0]['target_id'];
      $step = [];
      $steps = opigno_learning_path_get_all_steps($gid, $uid);
      if ($steps) {
        foreach ($steps as $item) {
          if ($item["id"] == $module_id) {
            $step = $item;
            break;
          }
        }
      }
      if ($step) {

        // Save module step achievements.
        opigno_learning_path_save_step_achievements($gid, $uid, $step, isset($step["parent"]) ? $step["parent"] : 0);
      }

      // Save training achievements.
      opigno_learning_path_save_achievements($gid, $uid);
    }
    $form_state
      ->setRedirect('view.opigno_score_modules.opigno_not_evaluated');
  }

  /**
   * Send Email to user.
   */
  public function sendEmailToManager($module, $user_status, $answer) {
    if (!$module instanceof OpignoModule || !$user_status instanceof UserModuleStatus || !$answer instanceof OpignoAnswer) {
      return;
    }
    $student = $user_status
      ->get('user_id')->entity;
    $manager = \Drupal::currentUser();
    $global_config = \Drupal::config('system.site');
    $sitename = $global_config
      ->get('name');
    $config = \Drupal::config('opigno_learning_path.learning_path_settings');
    $student_activity_notify = $config
      ->get('opigno_learning_path_students_answer_is_reviewed_notify');
    $student_activity = $config
      ->get('opigno_learning_path_students_answer_is_reviewed');
    if (empty($student_activity_notify) || empty($student_activity) || !$student instanceof UserInterface) {
      return;
    }

    // Send email to student.
    $email = $student
      ->getEmail();
    $lang = $student
      ->getPreferredLangcode();
    $params = [];
    $params['subject'] = t('@sitename Module review', [
      '@sitename' => $sitename,
    ]);
    $student_activity = str_replace('[sitename]', $sitename, $student_activity);
    $student_activity = str_replace('[user]', $student
      ->getAccountName(), $student_activity);
    $student_activity = str_replace('[manager]', $manager
      ->getAccountName(), $student_activity);
    $student_activity = str_replace('[module]', $module
      ->getName(), $student_activity);
    $params['message'] = $student_activity;
    \Drupal::service('plugin.manager.mail')
      ->mail('opigno_learning_path', 'opigno_learning_path_user_notify', $email, $lang, $params);
  }

  /**
   * Returns answer max score.
   */
  protected function getAnswerMaxScore(OpignoAnswerInterface $answer) {

    /* @var $db_connection \Drupal\Core\Database\Connection */
    $db_connection = \Drupal::service('database');
    $max_score = 0;
    $activity = $answer
      ->getActivity();
    $score_query = $db_connection
      ->select('opigno_module_relationship', 'omr')
      ->fields('omr', [
      'max_score',
    ])
      ->condition('omr.parent_id', $answer
      ->getModule()
      ->id())
      ->condition('omr.parent_vid', $answer
      ->getModule()
      ->getRevisionId())
      ->condition('omr.child_id', $activity
      ->id())
      ->condition('omr.child_vid', $activity
      ->getRevisionId());
    $score_result = $score_query
      ->execute()
      ->fetchObject();
    if ($score_result) {
      $max_score = $score_result->max_score;
    }
    return $max_score;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
ModuleResultForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ModuleResultForm::formTitle public function Title callback for the form.
ModuleResultForm::getAnswerMaxScore protected function Returns answer max score.
ModuleResultForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ModuleResultForm::sendEmailToManager public function Send Email to user.
ModuleResultForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ModuleResultForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.