class LearningPathMembershipController in Opigno Learning path 8
Same name and namespace in other branches
- 3.x src/Controller/LearningPathMembershipController.php \Drupal\opigno_learning_path\Controller\LearningPathMembershipController
Controller for the actions related to LP membership.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\opigno_learning_path\Controller\LearningPathMembershipController
Expanded class hierarchy of LearningPathMembershipController
File
- src/
Controller/ LearningPathMembershipController.php, line 23
Namespace
Drupal\opigno_learning_path\ControllerView source
class LearningPathMembershipController extends ControllerBase {
/**
* Database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
/**
* Form builder.
*
* @var \Drupal\Core\Form\FormBuilder
*/
protected $formBuilder;
/**
* LearningPathMembershipController constructor.
*/
public function __construct(Connection $connection, FormBuilderInterface $formBuilder) {
$this->connection = $connection;
$this->formBuilder = $formBuilder;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('database'), $container
->get('form_builder'));
}
/**
* Callback for opening the create members modal form.
*/
public function createMembersFormModal() {
$form = $this->formBuilder
->getForm('Drupal\\opigno_learning_path\\Form\\LearningPathCreateMemberForm');
$command = new OpenModalDialogCommand($this
->t('Create new members'), $form);
$response = new AjaxResponse();
$response
->addCommand($command);
return $response;
}
/**
* Callback for opening the create members modal form.
*/
public function createUserFormModal() {
$form = $this->formBuilder
->getForm('Drupal\\opigno_learning_path\\Form\\LearningPathCreateUserForm');
$command = new OpenModalDialogCommand($this
->t('2/2 create a new user'), $form);
$response = new AjaxResponse();
$response
->addCommand($command);
return $response;
}
/**
* Callback for opening the create members modal form.
*/
public function createClassFormModal() {
$form = $this->formBuilder
->getForm('Drupal\\opigno_learning_path\\Form\\LearningPathCreateClassForm');
$command = new OpenModalDialogCommand($this
->t('Create a new class'), $form);
$response = new AjaxResponse();
$response
->addCommand($command);
return $response;
}
/**
* Returns response for the autocompletion.
*
* @param \Drupal\group\Entity\Group $group
* Group.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* A JSON response containing the autocomplete suggestions.
*/
public function addUserToTrainingAutocomplete(Group $group) {
$matches = [];
$is_class = $group
->getGroupType()
->id() == 'opigno_class';
$string = \Drupal::request()->query
->get('q');
if ($string !== NULL) {
$like_string = '%' . $this->connection
->escapeLike($string) . '%';
// Find users by email or name.
$query = \Drupal::entityQuery('user')
->condition('uid', 0, '<>');
$cond_group = $query
->orConditionGroup()
->condition('mail', $like_string, 'LIKE')
->condition('name', $like_string, 'LIKE');
$query = $query
->condition($cond_group)
->sort('name')
->range(0, 20);
$uids = $query
->execute();
$users = User::loadMultiple($uids);
/** @var \Drupal\user\Entity\User $user */
foreach ($users as $user) {
$id = $user
->id();
$name = $user
->getDisplayName();
// Skip users that already members of the current group.
if ($group
->getMember($user) !== FALSE) {
continue;
}
$matches[] = [
'value' => "{$name} (User #{$id})",
'label' => "{$name} (User #{$id})",
'type' => 'user',
'id' => 'user_' . $id,
];
}
if (!$is_class) {
// Find classes by name.
$query = \Drupal::entityQuery('group')
->condition('type', 'opigno_class')
->condition('label', $like_string, 'LIKE')
->sort('label')
->range(0, 20);
$gids = $query
->execute();
$classes = Group::loadMultiple($gids);
$db_connection = \Drupal::service('database');
/** @var \Drupal\group\Entity\Group $class */
foreach ($classes as $class) {
// Check if class already added.
$is_class_added = $db_connection
->select('group_content_field_data', 'g_c_f_d')
->fields('g_c_f_d', [
'id',
])
->condition('gid', $group
->id())
->condition('entity_id', $class
->id())
->condition('type', 'group_content_type_27efa0097d858')
->execute()
->fetchField();
if (!$is_class_added) {
// If class haven't added yet.
$id = $class
->id();
$name = $class
->label();
$matches[] = [
'value' => "{$name} (Group #{$id})",
'label' => "{$name} (Group #{$id})",
'type' => 'group',
'id' => 'class_' . $id,
];
}
}
}
}
return new JsonResponse($matches);
}
/**
* Returns response for the autocompletion.
*
* @param \Drupal\group\Entity\Group $group
* Group.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* A JSON response containing the autocomplete suggestions.
*/
public function addUserToClassAutocomplete(Group $group) {
$matches = [];
$string = \Drupal::request()->query
->get('q');
if ($string !== NULL) {
$like_string = '%' . $this->connection
->escapeLike($string) . '%';
// Find users by email or name.
$query = \Drupal::entityQuery('user')
->condition('uid', 0, '<>')
->condition('name', $like_string, 'LIKE')
->sort('name')
->range(0, 20);
$uids = $query
->execute();
$count = count($uids);
if ($count < 20) {
$range = 20 - $count;
$query = \Drupal::entityQuery('user')
->condition('uid', 0, '<>')
->condition('mail', $like_string, 'LIKE')
->sort('name')
->range(0, $range);
$uids = array_merge($uids, $query
->execute());
}
$users = User::loadMultiple($uids);
/** @var \Drupal\user\Entity\User $user */
foreach ($users as $user) {
$id = $user
->id();
$name = $user
->getDisplayName();
$matches[] = [
'value' => "{$name} ({$id})",
'label' => "{$name} ({$id})",
'type' => 'user',
'id' => 'user_' . $id,
];
}
}
return new JsonResponse($matches);
}
/**
* Returns users of current group for the autocompletion.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* A JSON response containing the autocomplete suggestions.
*/
public function findUsersInGroupAutocomplete() {
$matches = [];
$string = \Drupal::request()->query
->get('q');
if ($string) {
$like_string = '%' . $this->connection
->escapeLike($string) . '%';
/** @var \Drupal\group\Entity\Group $curr_group */
$curr_group = \Drupal::routeMatch()
->getParameter('group');
// Find users by email or name.
$query = \Drupal::entityQuery('user')
->condition('uid', 0, '<>');
$cond_group = $query
->orConditionGroup()
->condition('mail', $like_string, 'LIKE')
->condition('name', $like_string, 'LIKE');
$query = $query
->condition($cond_group)
->sort('name');
$uids = $query
->execute();
$users = User::loadMultiple($uids);
/** @var \Drupal\user\Entity\User $user */
foreach ($users as $user) {
$id = $user
->id();
$name = $user
->getDisplayName();
// Remove users that are not members of current group.
if ($curr_group
->getMember($user) === FALSE) {
continue;
}
$matches[] = [
'value' => "{$name} ({$id})",
'label' => $name,
'id' => $id,
];
}
}
return new JsonResponse($matches);
}
/**
* Ajax callback for searching user in a training classes.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
* @param string $class_id
* Class group ID.
* @param string $uid
* User ID.
*
* @return \Drupal\Core\Ajax\AjaxResponse
* Ajax command or empty.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
public function findGroupMember(Group $group, $class_id, $uid) {
$response = new AjaxResponse();
if ($class_id === '0') {
$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);
$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,
];
}
}
if ($classes) {
foreach ($classes as $class) {
$view_id = 'opigno_group_members_table';
$display = 'group_members_block';
$args = [
$class['entity']
->id(),
];
$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
->setItemsPerPage(0);
$members_view
->execute();
if (!empty($members_view->result)) {
foreach ($members_view->result as $key => $item) {
$member = $item->_entity
->getEntity();
if ($member
->id() == $uid) {
$display_default = $members_view->storage
->getDisplay('default');
$per_page = $display_default["display_options"]["pager"]["options"]["items_per_page"];
$current_page = intdiv($key, $per_page);
$class_id = $class['entity']
->id();
break 2;
}
}
}
}
}
if (isset($current_page)) {
$selector = '#class-' . $class_id . ' .views-element-container';
$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
->setCurrentPage($current_page);
$members_view
->preExecute();
$members_view
->execute();
$members_view_renderable = $members_view
->buildRenderable($display, $args);
$response
->addCommand(new ReplaceCommand($selector, $members_view_renderable));
}
}
}
}
return $response;
}
/**
* Ajax callback used in opigno_learning_path_member_overview.js.
*
* Removes member from learning path.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* Response.
*/
public function deleteUser() {
/** @var \Drupal\group\Entity\Group $group */
$group = \Drupal::routeMatch()
->getParameter('group');
if (!isset($group)) {
throw new NotFoundHttpException();
}
$uid = \Drupal::request()->query
->get('user_id');
$user = User::load($uid);
if (!isset($user)) {
throw new NotFoundHttpException();
}
$member = $group
->getMember($user);
if (!isset($member)) {
throw new NotFoundHttpException();
}
$group
->removeMember($user);
return new JsonResponse();
}
/**
* Ajax callback used in opigno_learning_path_member_overview.js.
*
* Removes class from learning path.
*/
public function deleteClass() {
/** @var \Drupal\group\Entity\Group $group */
$group = \Drupal::routeMatch()
->getParameter('group');
$class_id = \Drupal::request()->query
->get('class_id');
$class = Group::load($class_id);
if (!isset($group) || !isset($class)) {
throw new NotFoundHttpException();
}
$content = $group
->getContent();
$account = $this
->currentUser();
/** @var \Drupal\group\Entity\GroupContentInterface $item */
foreach ($content as $item) {
$entity = $item
->getEntity();
$type = $entity
->getEntityTypeId();
$bundle = $entity
->bundle();
if ($type === 'group' && $bundle === 'opigno_class' && $entity
->id() === $class
->id()) {
$item
->delete();
break;
}
}
return new JsonResponse();
}
/**
* Ajax callback used in opigno_learning_path_member_overview.js.
*
* Toggles user role in learning path.
*/
public function toggleRole() {
/** @var \Drupal\group\Entity\Group $group */
$group = \Drupal::routeMatch()
->getParameter('group');
$query = \Drupal::request()->query;
$uid = $query
->get('uid');
$user = User::load($uid);
$role = $query
->get('role');
if (!isset($group) || !isset($user) || !isset($role)) {
throw new NotFoundHttpException();
}
$member = $group
->getMember($user);
if (!isset($member)) {
throw new NotFoundHttpException();
}
$group_content = $member
->getGroupContent();
$values = $group_content
->get('group_roles')
->getValue();
$found = FALSE;
foreach ($values as $index => $value) {
if ($value['target_id'] === $role) {
$found = TRUE;
unset($values[$index]);
break;
}
}
if ($found === FALSE) {
$values[] = [
'target_id' => $role,
];
}
$group_content
->set('group_roles', $values);
$group_content
->save();
return new JsonResponse();
}
/**
* Ajax callback used in opigno_learning_path_member_overview.js.
*
* Validates user role in learning path.
*/
public function validate() {
/** @var \Drupal\group\Entity\Group $group */
$group = \Drupal::routeMatch()
->getParameter('group');
$gid = $group
->id();
$uid = \Drupal::request()->query
->get('user_id');
$user = User::load($uid);
if (!isset($group) || !isset($user)) {
throw new NotFoundHttpException();
}
$member = $group
->getMember($user);
if (!isset($member)) {
throw new NotFoundHttpException();
}
$group_content = $member
->getGroupContent();
$query = \Drupal::database()
->merge('opigno_learning_path_group_user_status')
->key('mid', $group_content
->id())
->insertFields([
'mid' => $group_content
->id(),
'uid' => $uid,
'gid' => $gid,
'status' => 1,
'message' => '',
])
->updateFields([
'uid' => $uid,
'gid' => $gid,
'status' => 1,
'message' => '',
]);
$result = $query
->execute();
if ($result) {
// Invalidate cache.
$tags = $member
->getCacheTags();
\Drupal::service('cache_tags.invalidator')
->invalidateTags($tags);
// Set notification.
$message = $this
->t('Enrollment validated to a new training "@name"', [
'@name' => $group
->label(),
]);
$url = Url::fromRoute('entity.group.canonical', [
'group' => $group
->id(),
])
->toString();
opigno_set_message($uid, $message, $url);
$config = \Drupal::config('opigno_learning_path.learning_path_settings');
$send_to_users = $config
->get('opigno_learning_path_notify_users');
if ($send_to_users) {
// Send email.
$module = 'opigno_learning_path';
$key = 'opigno_learning_path_membership_validated';
$email = $user
->getEmail();
$lang = $user
->getPreferredLangcode();
$params = [];
$params['subject'] = $this
->t('Your membership to the training @training has been approved', [
'@training' => $group
->label(),
]);
$site_config = \Drupal::config('system.site');
$link = $group
->toUrl()
->setAbsolute()
->toString();
$args = [
'@username' => $user
->getDisplayName(),
'@training' => $group
->label(),
':link' => $link,
'@link_text' => $link,
'@platform' => $site_config
->get('name'),
];
$params['message'] = $this
->t('Dear @username
Your membership to the training @training has been approved. You can now access this training at: <a href=":link">@link_text</a>
@platform', $args);
\Drupal::service('plugin.manager.mail')
->mail($module, $key, $email, $lang, $params);
}
}
return new JsonResponse();
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
ControllerBase:: |
protected | property | The configuration factory. | |
|
ControllerBase:: |
protected | property | The current user service. | 1 |
|
ControllerBase:: |
protected | property | The entity form builder. | |
|
ControllerBase:: |
protected | property | The entity manager. | |
|
ControllerBase:: |
protected | property | The entity type manager. | |
|
ControllerBase:: |
protected | property | The key-value storage. | 1 |
|
ControllerBase:: |
protected | property | The language manager. | 1 |
|
ControllerBase:: |
protected | property | The module handler. | 2 |
|
ControllerBase:: |
protected | property | The state service. | |
|
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
|
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
|
ControllerBase:: |
private | function | Returns the service container. | |
|
ControllerBase:: |
protected | function | Returns the current user. | 1 |
|
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
|
ControllerBase:: |
protected | function | Retrieves the entity manager service. | |
|
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
|
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
|
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
|
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
|
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
|
ControllerBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
|
LearningPathMembershipController:: |
protected | property | Database connection. | |
|
LearningPathMembershipController:: |
protected | property |
Form builder. Overrides ControllerBase:: |
|
|
LearningPathMembershipController:: |
public | function | Returns response for the autocompletion. | |
|
LearningPathMembershipController:: |
public | function | Returns response for the autocompletion. | |
|
LearningPathMembershipController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
|
LearningPathMembershipController:: |
public | function | Callback for opening the create members modal form. | |
|
LearningPathMembershipController:: |
public | function | Callback for opening the create members modal form. | |
|
LearningPathMembershipController:: |
public | function | Callback for opening the create members modal form. | |
|
LearningPathMembershipController:: |
public | function | Ajax callback used in opigno_learning_path_member_overview.js. | |
|
LearningPathMembershipController:: |
public | function | Ajax callback used in opigno_learning_path_member_overview.js. | |
|
LearningPathMembershipController:: |
public | function | Ajax callback for searching user in a training classes. | |
|
LearningPathMembershipController:: |
public | function | Returns users of current group for the autocompletion. | |
|
LearningPathMembershipController:: |
public | function | Ajax callback used in opigno_learning_path_member_overview.js. | |
|
LearningPathMembershipController:: |
public | function | Ajax callback used in opigno_learning_path_member_overview.js. | |
|
LearningPathMembershipController:: |
public | function | LearningPathMembershipController constructor. | |
|
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
|
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
|
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
|
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
|
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
|
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
|
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
|
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
|
MessengerTrait:: |
public | function | Sets the messenger. | |
|
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
|
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
|
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
|
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
|
UrlGeneratorTrait:: |
protected | property | The url generator. | |
|
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
|
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
|
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |