chamilo/chamilo-lms

View on GitHub
public/main/lp/lp_subscribe_users.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

/* For licensing terms, see /license.txt */

use Chamilo\CourseBundle\Repository\CLpRelUserRepository;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\CoreBundle\Entity\SessionRelCourseRelUser;
use Chamilo\CoreBundle\Entity\User;
use Chamilo\CourseBundle\Entity\CLpRelUser;
use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CLp;

require_once __DIR__.'/../inc/global.inc.php';

api_protect_course_script();

$subscriptionSettings = learnpath::getSubscriptionSettings();
if (false == $subscriptionSettings['allow_add_users_to_lp']) {
    api_not_allowed(true);
}
$is_allowed_to_edit = api_is_allowed_to_edit(false, true, false, false);

if (!$is_allowed_to_edit) {
    api_not_allowed(true);
}

$lpId = isset($_GET['lp_id']) ? (int) $_GET['lp_id'] : 0;

if (empty($lpId)) {
    api_not_allowed(true);
}

$allowUserGroups = ('true' === api_get_setting('lp.allow_lp_subscription_to_usergroups'));
$currentUser = api_get_user_entity(api_get_user_id());
$repo = Container::getLpRepository();
/** @var CLp $entity */
$entity = $repo->find($lpId);
$oLP = new learnpath($entity, api_get_course_info(), api_get_user_id());

$interbreadcrumb[] = [
    'url' => 'lp_controller.php?action=list&'.api_get_cidreq(),
    'name' => get_lang('Learning paths'),
];

$interbreadcrumb[] = [
    'url' => api_get_self().'?action=add_item&lp_id='.$oLP->get_id().'&'.api_get_cidreq(),
    'name' => $oLP->getNameNoTags(),
];

$courseId = api_get_course_int_id();
$courseCode = api_get_course_id();
$sessionId = api_get_session_id();

$url = api_get_self().'?'.api_get_cidreq().'&lp_id='.$lpId;
$em = Database::getManager();
$courseRepo = Container::getCourseRepository();

/** @var CLpRelUserRepository $cLpRelUserRepo */
$cLpRelUserRepo = $em->getRepository(CLpRelUser::class);

/** @var Session $session */
$session = null;
if (!empty($sessionId)) {
    $session = api_get_session_entity($sessionId);
}

$course = api_get_course_entity($courseId);
$subscribedUsers = [];

// Getting subscribe users to the course.
if (!$session) {
    $subscribedUsers = $courseRepo->getSubscribedStudents($course)
        ->getQuery()
        ->getResult();
} else {
    $list = $session->getSessionRelCourseRelUsersByStatus($course, Session::STUDENT);
    if ($list) {
        /** @var SessionRelCourseRelUser $sessionCourseUser */
        foreach ($list as $sessionCourseUser) {
            $subscribedUsers[$sessionCourseUser->getUser()->getId()] = $sessionCourseUser->getUser();
        }
    }
}

// Getting all users in a nice format.
$choices = [];
/** @var User $user */
foreach ($subscribedUsers as $user) {
    $choices[$user->getId()] = $user->getCompleteNameWithClasses();
}

// Getting subscribed users to a LP.
$subscribedUsersInLp = $cLpRelUserRepo->getUsersSubscribedToItem(
    $entity,
    $course,
    $session
);

$selectedChoices = [];
foreach ($subscribedUsersInLp as $users) {
    /** @var CLpRelUser $users */
    $selectedChoices[] = $users->getUser()->getId();
}

//Building the form for Users
$formUsers = new FormValidator('lp_edit', 'post', $url);
$formUsers->addElement('hidden', 'user_form', 1);

$userMultiSelect = $formUsers->addMultiSelect(
    'users',
    get_lang('Users'),
    $choices
);
$formUsers->addButtonSave(get_lang('Save'));

$defaults = [];

if (!empty($selectedChoices)) {
    $defaults['users'] = $selectedChoices;
}

$formUsers->setDefaults($defaults);

// Subscribed groups to a LP
$links = $entity->getResourceNode()->getResourceLinks();

// Building the form for Groups
$form = new FormValidator('lp_edit', 'post', $url);
$form->addElement('hidden', 'group_form', 1);

// Group list
$groupList = \CourseManager::get_group_list_of_course(
    api_get_course_id(),
    api_get_session_id(),
    1,
    true
);
$groupChoices = array_column($groupList, 'name', 'id');

$selectedGroupChoices = [];
foreach ($links as $link) {
    if (null !== $link->getGroup()) {
        $selectedGroupChoices[] = $link->getGroup()->getIid();
    }
}

$groupMultiSelect = $form->addMultiSelect(
    'groups',
    get_lang('Groups'),
    $groupChoices
);

$form->addButtonSave(get_lang('Save'));

if ($allowUserGroups) {
    $formUserGroup = new FormValidator('usergroup_form', 'post', $url);
    $formUserGroup->addHidden('usergroup_form', 1);

    $userGroup = new UserGroupModel();
    $conditions = [];
    $conditions['where'] = [' usergroup.course_id = ? ' => $courseId];
    $groups = $userGroup->getUserGroupInCourse($conditions);
    $allOptions = array_column($groups, 'name', 'id');
    $items = $userGroup->getGroupsByLp($lpId, $courseId, $sessionId);

    $selectedUserGroupChoices = [];
    if (!empty($items)) {
        foreach ($items as $data) {
            if (isset($allOptions[$data['usergroup_id']])) {
                $selectedUserGroupChoices[] = $data['usergroup_id'];
            }
        }
    }

    $userGroupMultiSelect = $formUserGroup->addMultiSelect(
        'usergroups',
        get_lang('Classes'),
        $allOptions
    );

    $formUserGroup->setDefaults(['usergroups' => $selectedUserGroupChoices]);
    $formUserGroup->addButtonSave(get_lang('Save'));
    $sessionCondition = api_get_session_condition($sessionId, true);
    if ($formUserGroup->validate()) {
        $values = $formUserGroup->getSubmitValues();
        $table = Database::get_course_table(TABLE_LP_REL_USERGROUP);
        if (isset($values['usergroups'])) {
            $userGroups = $values['usergroups'];
            foreach ($selectedUserGroupChoices as $userGroupId) {
                $userGroupId = (int) $userGroupId;
                if (!in_array($userGroupId, $userGroups)) {
                    $sql = "DELETE FROM $table
                            WHERE
                                c_id = $courseId AND
                                lp_id = $lpId AND
                                usergroup_id = $userGroupId
                                $sessionCondition
                            ";
                    Database::query($sql);

                    $userList = $userGroup->get_users_by_usergroup($userGroupId);
                    $cLpRelUserRepo->unsubcribeUsersToItem(
                        $course,
                        $entity,
                        $userList,
                        $session
                    );
                }
            }

            foreach ($userGroups as $userGroupId) {
                $userGroupId = (int) $userGroupId;
                $sql = "SELECT id FROM $table
                        WHERE
                            c_id = $courseId AND
                            lp_id = $lpId AND
                            usergroup_id = $userGroupId
                            $sessionCondition
                            ";
                $result = Database::query($sql);

                if (0 == Database::num_rows($result)) {
                    $params = [
                        'lp_id' => $lpId,
                        'c_id' => $courseId,
                        'usergroup_id' => $userGroupId,
                        'created_at' => api_get_utc_datetime(),
                    ];
                    if (!empty($sessionId)) {
                        $params['session_id'] = $sessionId;
                    }
                    Database::insert($table, $params);
                }
            }

            $groups = $userGroup->getGroupsByLp($lpId, $courseId, $sessionId);
            $userList = [];
            foreach ($groups as $groupId) {
                $userList = $userGroup->get_users_by_usergroup($groupId);
                $cLpRelUserRepo->subscribeUsersToItem(
                    $currentUser,
                    $course,
                    $entity,
                    $session,
                    $userList,
                    false
                );
            }

            Display::addFlash(Display::return_message(get_lang('Updated')));
        } else {
            foreach ($groups as $group) {
                $userList = $userGroup->get_users_by_usergroup($group['id']);
                $cLpRelUserRepo->unsubcribeUsersToItem(
                    $course,
                    $entity,
                    $userList,
                    $session
                );
            }

            // Clean all
            $sql = "DELETE FROM $table
                    WHERE
                        c_id = $courseId AND
                        lp_id = $lpId
                        $sessionCondition
                    ";
            Database::query($sql);
        }
        header("Location: $url");
        exit;
    }
}

$defaults = [];
if (!empty($selectedChoices)) {
    $defaults['users'] = $selectedChoices;
}

$formUsers->setDefaults($defaults);
$defaults = [];
if (!empty($selectedGroupChoices)) {
    $defaults['groups'] = $selectedGroupChoices;
}
$form->setDefaults($defaults);

if ($form->validate()) {
    $values = $form->getSubmitValues();

    // Subscribing users
    $users = isset($values['users']) ? $values['users'] : [];
    $userForm = isset($values['user_form']) ? $values['user_form'] : [];

    if (!empty($userForm)) {
        $cLpRelUserRepo->subscribeUsersToItem(
            $currentUser,
            $course,
            $entity,
            $session,
            $users
        );
        Display::addFlash(Display::return_message(get_lang('Update successful')));
    }

    // Subscribing groups
    $groups = isset($values['groups']) ? $values['groups'] : [];
    $groupForm = isset($values['group_form']) ? $values['group_form'] : [];

    if (!empty($groupForm)) {
        if (!empty($selectedGroupChoices)) {
            $diff = array_diff($selectedGroupChoices, $groups);
            if (!empty($diff)) {
                foreach ($diff as $groupIdToDelete) {
                    foreach ($links as $link) {
                        if ($link->getGroup() && $link->getGroup()->getIid()) {
                            $em->remove($link);
                        }
                    }
                }
                $em->flush();
            }
        }

        foreach ($groups as $groupId) {
            $group = api_get_group_entity($groupId);
            $entity->addGroupLink($course, $group);
        }

        $em->persist($entity);
        $em->flush();

        Display::addFlash(Display::return_message(get_lang('Update successful')));
    }

    header("Location: $url");
    exit;
}

$message = Display::return_message(get_lang('Note that if the inscription of users in a category is available, then if you have already subscribe user to the category it will override the inscription of users here in the Learning Path'));
$headers = [
    get_lang('Subscribe users to learning path'),
    get_lang('Subscribe groups to learning path'),
];

$items = [$formUsers->toHtml(), $form->toHtml()];

if ($allowUserGroups) {
    $headers[] = get_lang('SubscribeUserGroupsToLp');
    $items[] = $formUserGroup->toHtml();
}
$menu = $oLP->build_action_menu(true, false, true, false);

$tpl = new Template();
$tabs = Display::tabs($headers, $items);
$tpl->assign('content', $menu.$message.$tabs);
$tpl->display_one_col_template();