class RecipientsPlugin in Opigno Learning path 3.x

Class RecipientsPlugin.

Plugin annotation

@LearningPathMembers(
  id="recipients_plugin",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\opigno_learning_path\LearningPathMembersPluginBase implements LearningPathMembersPluginInterface
    • class \Drupal\opigno_learning_path\Plugin\LearningPathMembers\RecipientsPlugin

File

src/Plugin/LearningPathMembers/RecipientsPlugin.php, line 16

Namespace

Drupal\opigno_learning_path\Plugin\LearningPathMembers

class RecipientsPlugin extends LearningPathMembersPluginBase {

  /**
   * {@inheritdoc}
   */
  public function getMembersForm(array &$form, FormStateInterface $form_state, User $current_user, bool $hide = FALSE) {

    // Get the groups, this allows to filter the available users.
    $show_all = $current_user
      ->hasPermission('message anyone regardless of groups');
    $users = opigno_messaging_get_all_recipients($show_all);
    $options = [];
    foreach ($users as $user) {
      $options[$user
        ->id()] = $user
        ->getDisplayName();
    }

    // Remove the current users from the list of users
    // that once can send a message to.
    if (isset($options[$current_user
      ->id()])) {
      unset($options[$current_user
        ->id()]);
    }

    // Sort the users by name.
    uasort($options, 'strcasecmp');
    $form['users_to_send'] = [
      '#title' => t('Select the users you want to send a message to'),
      '#type' => 'entity_selector',
      '#options' => $options,
      '#weight' => -1,
      '#multiple' => TRUE,
      '#prefix' => $hide ? '<div id="users-to-send" class="hidden">' : '<div id="users-to-send">',
      '#suffix' => '</div>',
    ];
  }

  /**
   * Custom ajax callback.
   *
   * Updates the list of available users to send message to
   * once the group is changed.
   */
  public static function updateMembersAjax(array $form, FormStateInterface $form_state) {
    $current_user = \Drupal::currentUser();
    $show_all = $current_user
      ->hasPermission('message anyone regardless of groups');

    // Get the current values that are selected.
    $current_selected_users = $form_state
      ->getValue('users_to_send');

    // Keep the users that were previously selected as selected.
    foreach ($current_selected_users as $uid) {
      $form['users_to_send']['#default_value'][$uid] = $uid;
    }

    // Remove from the list of option users the ones that are not selected.
    foreach ($form['users_to_send']['#options'] as $uid => $name) {
      if (!in_array($uid, $form['users_to_send']['#default_value'])) {
        unset($form['users_to_send']['#options'][$uid]);
      }
    }

    // Add to the users of the new group to the options.
    $class_id = $form_state
      ->getValue('class');
    $learning_path_id = $form_state
      ->getValue('learning_path');
    if (!is_numeric($class_id)) {
      $class_id = 0;
    }
    if (!is_numeric($learning_path_id)) {
      $learning_path_id = 0;
    }
    $class_users = opigno_messaging_get_user_for_group($class_id, $show_all);
    $learning_path_users = opigno_messaging_get_user_for_group($learning_path_id, $show_all);
    if (!empty($class_id) && !empty($learning_path_id)) {

      // Chosen both class or training.
      $users = array_uintersect($class_users, $learning_path_users, function ($user1, $user2) {

        /** @var \Drupal\user\UserInterface $user1 */

        /** @var \Drupal\user\UserInterface $user2 */
        return $user2
          ->id() - $user1
          ->id();
      });
    }
    elseif (!empty($class_id) || !empty($learning_path_id)) {

      // Chosen only class or training.
      $users = array_merge($class_id ? $class_users : [], $learning_path_id ? $learning_path_users : []);
    }
    else {

      // No class or training were chosen.
      $users = opigno_messaging_get_all_recipients($show_all);
    }
    foreach ($users as $user) {

      /** @var \Drupal\user\UserInterface $user */
      $form['users_to_send']['#options'][$user
        ->id()] = $user
        ->getDisplayName();
    }

    // Remove the current users from the list of users
    // that once can send a message to.
    if (isset($form['users_to_send']['#options'][$current_user
      ->id()])) {
      unset($form['users_to_send']['#options'][$current_user
        ->id()]);
    }
    uasort($form['users_to_send']['#options'], 'strcasecmp');
    return $form['users_to_send'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LearningPathMembersPluginBase::getGroupMembersIds	public	function	Returns group members uids.
LearningPathMembersPluginBase::getId	public	function	Get plugin id. Overrides LearningPathMembersPluginInterface::getId
LearningPathMembersPluginBase::__construct	public	function	LearningPathMembersPluginBase constructor. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RecipientsPlugin::getMembersForm	public	function	Get members form. Overrides LearningPathMembersPluginBase::getMembersForm
RecipientsPlugin::updateMembersAjax	public static	function	Custom ajax callback.