You are here

Home » API reference » Opigno Learning path 8 » LearningPathMembersForm.php

class LearningPathMembersForm in Opigno Learning path 8

Same name and namespace in other branches
  1. 3.x src/Form/LearningPathMembersForm.php \Drupal\opigno_learning_path\Form\LearningPathMembersForm

Group overview form.

Hierarchy

Expanded class hierarchy of LearningPathMembersForm

1 string reference to 'LearningPathMembersForm'
opigno_learning_path.routing.yml in ./opigno_learning_path.routing.yml
opigno_learning_path.routing.yml

File

src/Form/LearningPathMembersForm.php, line 16

Namespace

Drupal\opigno_learning_path\Form
View source 
class LearningPathMembersForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $student_manager_role = 'learning_path-user_manager';
    $content_manager_role = 'learning_path-content_manager';
    $class_manager_role = 'opigno_class-class_manager';

    /** @var \Drupal\group\Entity\Group $group */
    $group = \Drupal::routeMatch()
      ->getParameter('group');
    $group_bundle = $group
      ->bundle();

    // Check if user has uncompleted steps.
    $validation = LearningPathValidator::stepsValidate($group);
    if ($validation instanceof RedirectResponse) {
      return $validation;
    }

    // If not a learning_path or class, returns
    // default '/group/{group}/members' view.
    if (!in_array($group_bundle, [
      'opigno_class',
      'learning_path',
    ])) {
      $view = Views::getView('group_members');
      if (!$view || !$view
        ->access('page_1')) {
        return $form;
      }
      $form[] = [
        '#type' => 'view',
        '#name' => 'group_members',
        '#display_id' => 'page_1',
        '#title' => $view
          ->getTitle(),
        '#arguments' => [
          $group
            ->id(),
        ],
      ];
      return $form;
    }
    if ($group_bundle == 'learning_path') {
      $form['#prefix'] = '<div id="group_members_list">';
      $form['#suffix'] = '</div>';
      $content_types = [
        'group_content_type_27efa0097d858',
        'group_content_type_af9d804582e19',
        'learning_path-group_membership',
      ];
      $group_content_ids = \Drupal::entityQuery('group_content')
        ->condition('gid', $group
        ->id())
        ->condition('type', $content_types, 'IN')
        ->sort('changed', 'DESC')
        ->execute();
      $content = \Drupal::entityTypeManager()
        ->getStorage('group_content')
        ->loadMultiple($group_content_ids);
    }
    else {
      $content = $group
        ->getContent();
    }
    $users = [];
    $classes = [];

    /** @var \Drupal\group\Entity\GroupContentInterface $item */
    foreach ($content as $item) {
      $entity = $item
        ->getEntity();
      if ($entity === NULL) {
        continue;
      }
      $type = $entity
        ->getEntityTypeId();
      $bundle = $entity
        ->bundle();
      if ($type === 'user') {
        $users[$entity
          ->id()] = [
          'group content' => $item,
          'entity' => $entity,
        ];
      }
      elseif ($type === 'group' && $bundle === 'opigno_class') {
        $classes[$entity
          ->id()] = [
          'group content' => $item,
          'entity' => $entity,
        ];
      }
    }
    $individual_members = $users;
    if ($group_bundle != 'opigno_class') {
      $form[] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'class',
          ],
        ],
        'search' => [
          '#type' => 'textfield',
          '#autocomplete_route_name' => 'opigno_learning_path.membership.find_users_in_group_autocomplete',
          '#autocomplete_route_parameters' => [
            'group' => $group
              ->id(),
          ],
          '#placeholder' => t('Search a user'),
          '#attributes' => [
            'id' => 'class_members_search',
            'class' => [
              'class_members_search',
            ],
          ],
        ],
      ];
    }

    // Set members data for users in group classes.
    foreach ($classes as $class) {
      $member_count = 0;
      $members = array_filter($users, function ($user) use ($class) {

        /** @var \Drupal\group\Entity\Group $class_entity */
        $class_entity = $class['entity'];
        return $class_entity
          ->getMember($user['entity']) !== FALSE;
      });
      $individual_members = array_diff_key($individual_members, $members);

      // Get class members view as renderable array.
      $class_id = $class['entity']
        ->id();
      $args = [
        $class_id,
      ];
      $view_id = 'opigno_group_members_table';
      $display = 'group_members_block';
      $members_view = Views::getView($view_id);
      if (is_object($members_view)) {
        $members_view->storage
          ->set('group_members', array_keys($users));
        $members_view
          ->setArguments($args);
        $members_view
          ->setDisplay($display);
        $members_view
          ->preExecute();
        $members_view
          ->execute();
        $members_view_renderable = $members_view
          ->buildRenderable($display, $args);
        $member_count = $members_view->total_rows;
      }

      /** @var \Drupal\group\Entity\GroupContentInterface $class_group_content */
      $class_group_content = $class['group content'];
      $member_since_value = $class_group_content
        ->get('created')
        ->getValue()[0]['value'];
      $member_since = date('d/m/Y', $member_since_value);

      /** @var \Drupal\group\Entity\Group $class_entity */
      $class_entity = $class['entity'];
      $form[] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'class',
          ],
        ],
        'class_delete' => [
          '#type' => 'submit',
          '#value' => $this
            ->t('&times;'),
          '#submit' => [],
          '#attributes' => [
            'id' => 'class_delete_' . $class_entity
              ->id(),
            'class' => [
              'class_delete',
            ],
          ],
        ],
        'title' => [
          '#type' => 'html_tag',
          '#tag' => 'h2',
          '#value' => $class_entity
            ->label(),
          '#attributes' => [
            'class' => [
              'class_title',
            ],
          ],
        ],
        'member_since' => [
          '#type' => 'html_tag',
          '#tag' => 'p',
          '#value' => $this
            ->t('In the learning path since : @date', [
            '@date' => $member_since,
          ]),
          '#attributes' => [
            'class' => [
              'class_member_since',
            ],
          ],
        ],
        'members' => [
          '#type' => 'table',
          '#attributes' => [
            'class' => [
              'class_members',
            ],
          ],
          '#header' => [
            $this
              ->t('<span class="class_members_count">@count</span> Members', [
              '@count' => $member_count,
            ]),
          ],
        ],
        'members_table' => !empty($members_view_renderable) ? [
          '#type' => 'html_tag',
          '#tag' => 'div',
          '#value' => render($members_view_renderable),
          '#attributes' => [
            'id' => 'class-' . $class_entity
              ->id(),
            'class' => [
              'class_members',
              'class_members_row',
            ],
            'data-class' => $class_entity
              ->id(),
            'style' => 'display:none;',
          ],
        ] : [],
        'hide' => [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'class_hide',
            ],
          ],
          [
            '#type' => 'html_tag',
            '#tag' => 'span',
            '#value' => $this
              ->t('Hide'),
            '#attributes' => [
              'class' => [
                'class_hide_text',
              ],
            ],
          ],
        ],
        'show' => [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'class_show',
            ],
          ],
          [
            '#type' => 'html_tag',
            '#tag' => 'span',
            '#value' => $this
              ->t('Show'),
            '#attributes' => [
              'class' => [
                'class_show_text',
              ],
            ],
          ],
        ],
      ];
    }
    if (!empty($individual_members)) {
      $rows = array_map(function ($member_info) use ($group, $student_manager_role, $content_manager_role, $class_manager_role) {

        /** @var \Drupal\group\Entity\GroupContentInterface $user_group_content */
        $user_group_content = $member_info['group content'];
        $member_since_value = $user_group_content
          ->get('created')
          ->getValue()[0]['value'];

        /** @var \Drupal\user\Entity\User $user_entity */
        $user_entity = $member_info['entity'];
        $member = $group
          ->getMember($user_entity);
        $roles = $member
          ->getRoles();
        $has_sm_role = isset($roles[$student_manager_role]);
        $has_cm_role = isset($roles[$content_manager_role]);
        $has_class_manager_role = isset($roles[$class_manager_role]);
        $member_pending = FALSE;
        if ($group
          ->hasField('field_learning_path_visibility')) {
          $member_pending = !LearningPathAccess::statusGroupValidation($group, $user_entity);
        }
        if ($member_pending) {
          $text = $this
            ->t('Waiting for validation');
          $member_since = [
            '#markup' => $text,
          ];
        }
        else {
          $member_since = date('d/m/Y', $member_since_value);
          $member_since = [
            '#markup' => $member_since,
          ];
        }
        $gid = $group
          ->id();
        $cid = $user_group_content
          ->id();
        $delete_url = Url::fromUri("internal:/group/{$gid}/content/{$cid}/delete");
        return [
          'class' => 'class_members_row',
          'id' => 'individual_' . $user_entity
            ->id(),
          'data' => [
            $user_entity
              ->getDisplayName(),
            [
              'class' => 'class_member_since' . ($member_pending ? ' class_member_since_pending' : ''),
              'id' => 'class_member_validate_' . $user_entity
                ->id(),
              'data' => $member_since,
            ],
            [
              'data' => [
                '#type' => 'submit',
                '#value' => $this
                  ->t('Toggle Student Manager'),
                '#submit' => [],
                '#attributes' => [
                  'id' => 'class_member_toggle_sm_' . $user_entity
                    ->id(),
                  'class' => array_merge([
                    'class_member_toggle_sm',
                  ], $has_sm_role ? [
                    'class_member_toggle_sm_active',
                  ] : []),
                ],
              ],
            ],
            [
              'data' => [
                '#type' => 'submit',
                '#value' => $this
                  ->t('Toggle Content Manager'),
                '#submit' => [],
                '#attributes' => [
                  'id' => 'class_member_toggle_cm_' . $user_entity
                    ->id(),
                  'class' => array_merge([
                    'class_member_toggle_cm',
                  ], $has_cm_role ? [
                    'class_member_toggle_cm_active',
                  ] : []),
                ],
              ],
            ],
            [
              'data' => [
                '#type' => 'submit',
                '#value' => $this
                  ->t('Toggle Class Manager'),
                '#submit' => [],
                '#attributes' => [
                  'id' => 'class_member_toggle_class_manager_' . $user_entity
                    ->id(),
                  'class' => array_merge([
                    'class_member_toggle_class_manager',
                  ], $has_class_manager_role ? [
                    'class_member_toggle_class_manager_active',
                  ] : []),
                ],
              ],
            ],
            [
              'class' => 'class_member_delete_wrapper',
              'data' => [
                '#type' => 'link',
                '#title' => [
                  'data' => [
                    '#markup' => '&times;',
                  ],
                ],
                '#url' => $delete_url,
                '#attributes' => [
                  'id' => 'class_member_delete_' . $user_entity
                    ->id(),
                  'class' => [
                    'class_member_delete',
                  ],
                ],
              ],
            ],
          ],
        ];
      }, $individual_members);
      $member_count = count($individual_members);
      $form[] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'class',
          ],
        ],
        'title' => [
          '#type' => 'html_tag',
          '#tag' => 'h2',
          '#value' => $this
            ->t('Learners not in a class'),
          '#attributes' => [
            'class' => [
              'class_title',
            ],
          ],
        ],
        'search' => [
          '#type' => 'textfield',
          '#autocomplete_route_name' => 'opigno_learning_path.membership.find_users_in_group_autocomplete',
          '#autocomplete_route_parameters' => [
            'group' => $group
              ->id(),
          ],
          '#placeholder' => t('Search a user'),
          '#attributes' => [
            'id' => 'individual_members_search',
            'class' => [
              'class_members_search',
            ],
          ],
        ],
        'members' => [
          '#type' => 'table',
          '#attributes' => [
            'class' => [
              'class_members',
            ],
          ],
          '#header' => [
            [
              'class' => 'class_members_header_member_count',
              'data' => $this
                ->t('<span class="class_members_count">@count</span> Members', [
                '@count' => $member_count,
              ]),
            ],
            [
              'class' => 'class_members_header_member_since',
              'data' => $this
                ->t('Enrolled Since'),
            ],
            $this
              ->t('Student Manager'),
            $this
              ->t('Content Manager'),
            $this
              ->t('Class Manager'),
            '',
          ],
          '#rows' => $rows,
        ],
        'hide' => [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'class_hide',
            ],
          ],
          [
            '#type' => 'html_tag',
            '#tag' => 'span',
            '#value' => $this
              ->t('Hide'),
            '#attributes' => [
              'class' => [
                'class_hide_text',
              ],
            ],
          ],
        ],
        'show' => [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'class_show',
            ],
          ],
          [
            '#type' => 'html_tag',
            '#tag' => 'span',
            '#value' => $this
              ->t('Show'),
            '#attributes' => [
              'class' => [
                'class_show_text',
              ],
            ],
          ],
        ],
      ];
    }

    // Remove not needed roles for classes.
    if ($group_bundle == 'opigno_class' && !empty($form[0])) {
      unset($form[0]['title']);
      foreach ($form[0]['members']['#rows'] as $key => $row) {
        unset($form[0]['members']['#rows'][$key]['data'][2]);
        unset($form[0]['members']['#rows'][$key]['data'][3]);
      }
      unset($form[0]['members']['#header'][2]);
      unset($form[0]['members']['#header'][3]);
    }
    elseif ($group_bundle == 'learning_path') {
      $form_array_keys = array_keys($form);
      $last_key = end($form_array_keys);
      foreach ($form[$last_key]['members']['#rows'] as $key => $row) {
        unset($form[$last_key]['members']['#rows'][$key]['data'][4]);
      }
      unset($form[$last_key]['members']['#header'][4]);
    }
    $form['#attached']['library'][] = 'opigno_learning_path/member_overview';
    $form['#attached']['library'][] = 'opigno_learning_path/member_add';
    $form['#attached']['drupalSettings']['opigno_learning_path']['gid'] = $group
      ->id();
    $form['#attached']['drupalSettings']['opigno_learning_path']['student_manager_role'] = $student_manager_role;
    $form['#attached']['drupalSettings']['opigno_learning_path']['content_manager_role'] = $content_manager_role;
    $form['#attached']['drupalSettings']['opigno_learning_path']['class_manager_role'] = $class_manager_role;
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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. Overrides UrlGeneratorTrait::redirect
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LearningPathMembersForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
LearningPathMembersForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LearningPathMembersForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.