/**
* Does all the checks necessary to assign a student and makes the assignment
*
* The $room_id and $bed_id fields are optional, but one or the other must be specificed
*
* @param Student $student
* @param Integer $term
* @param Integer $room_id
* @param Integer $bed_id
* @param Integer $meal_plan
* @param String $notes
* @param boolean $lottery
* @param string $reason
* @throws InvalidArgumentException
* @throws AssignmentException
* @throws DatabaseException
* @throws Exception
*/
public static function assignStudent(Student $student, $term, $room_id = NULL, $bed_id = NULL, $meal_plan, $notes = "", $lottery = FALSE, $reason)
{
/**
* Can't check permissions here because there are some student-facing commands that needs to make assignments (e.g.
* the lottery/re-application code)
*
* if(!UserStatus::isAdmin() || !Current_User::allow('hms', 'assignment_maintenance')) {
* PHPWS_Core::initModClass('hms', 'exception/PermissionException.php');
* throw new PermissionException('You are not allowed to edit student assignments.');
* }
*/
PHPWS_Core::initModClass('hms', 'HMS_Residence_Hall.php');
PHPWS_Core::initModClass('hms', 'HMS_Floor.php');
PHPWS_Core::initModClass('hms', 'HMS_Room.php');
PHPWS_Core::initModClass('hms', 'HMS_Bed.php');
PHPWS_Core::initModClass('hms', 'HMS_Activity_Log.php');
PHPWS_Core::initModClass('hms', 'BannerQueue.php');
PHPWS_Core::initModClass('hms', 'AssignmentHistory.php');
PHPWS_Core::initModClass('hms', 'exception/AssignmentException.php');
$username = $student->getUsername();
// Make sure a username was entered
if (!isset($username) || $username == '') {
throw new InvalidArgumentException('Bad username.');
}
$username = strtolower($username);
if ($student->getType() == TYPE_WITHDRAWN) {
throw new AssignmentException('Invalid student type. Student is withdrawn.');
}
if (HMS_Assignment::checkForAssignment($username, $term)) {
throw new AssignmentException('The student is already assigned.');
}
if (isset($bed_id)) {
// A bed_id was given, so create that bed object
$vacant_bed = new HMS_Bed($bed_id);
if (!$vacant_bed) {
throw new AssignmentException('Null bed object.');
}
// Get the room that this bed is in
$room = $vacant_bed->get_parent();
} else {
if (isset($room_id)) {
// A room_id was given, so create that room object
$room = new HMS_Room($room_id);
// And find a vacant bed in that room
$beds = $room->getBedsWithVacancies();
$vacant_bed = $beds[0];
} else {
// Both the bed and room IDs were null, so return an error
throw new AssignmentException('No room nor bed specified.');
}
}
if (!$room) {
throw new AssignmentException('Null room object.');
}
// Make sure the room has a vacancy
if (!$room->has_vacancy()) {
throw new AssignmentException('The room is full.');
}
// Make sure the room is not offline
if ($room->offline) {
throw new AssignmentException('The room is offline');
}
// Double check that the bed is in the same term as we're being requested to assign for
if ($vacant_bed->getTerm() != $term) {
throw new AssignmentException('The bed\'s term and the assignment term do not match.');
}
// Double check that the resulting bed is empty
if ($vacant_bed->get_number_of_assignees() > 0) {
throw new AssignmentException('The bed is not empty.');
}
// Issue a warning if the bed was reserved for room change
//TODO Move this to the room change view
/*
if ($vacant_bed->room_change_reserved != 0) {
NQ::simple('hms', hms\NotificationView::WARNING, 'Room was reserved for room change');
}
*/
// Check that the room's gender and the student's gender match
$student_gender = $student->getGender();
if (is_null($student_gender)) {
throw new AssignmentException('Student gender is null.');
}
// Genders must match unless the room is COED
if ($room->getGender() != $student_gender && $room->getGender() != COED) {
throw new AssignmentException('Room gender does not match the student\'s gender.');
}
// We probably shouldn't check permissions inside this method, since sometimes this can be
// called from student-facing interfaces.. But, since I want to be really careful with co-ed rooms,
// I'm going to take the extra step of making sure no students are putting themselves in co-ed rooms.
if ($room->getGender() == COED && !Current_User::allow('hms', 'coed_assignment')) {
throw new AssignmentException('You do not have permission to make assignments for Co-ed rooms.');
}
// Create the floor object
$floor = $room->get_parent();
if (!$floor) {
throw new AssignmentException('Null floor object.');
}
// Create the hall object
$hall = $floor->get_parent();
if (!$hall) {
throw new AssignmentException('Null hall object.');
}
if ($meal_plan == BANNER_MEAL_NONE) {
$meal_plan = NULL;
}
// Determine which meal plan to use
// If this is a freshmen student and they've somehow selected none or low, give them standard
if ($student->getType() == TYPE_FRESHMEN && ($meal_plan == BANNER_MEAL_NONE || $meal_plan == BANNER_MEAL_LOW)) {
$meal_plan = BANNER_MEAL_STD;
// If a student is living in a dorm which requires a meal plan and they've selected none, give them low
} else {
if ($hall->meal_plan_required == 1 && $meal_plan == BANNER_MEAL_NONE) {
$meal_plan = BANNER_MEAL_LOW;
}
}
/**
* ***************************
* Temporary Assignment HACK *
* ***************************
*/
// Check for an assignment in the temp assignment table
$db = new PHPWS_DB('hms_temp_assignment');
$db->addWhere('banner_id', $student->getBannerId());
$result = $db->select();
if (PHPWS_Error::logIfError($result)) {
throw new DatabaseException($result->toString());
}
if (sizeof($result) > 0) {
// Queue an unassign for this student
$soap = SOAP::getInstance(UserStatus::getUsername(), UserStatus::isAdmin() ? SOAP::ADMIN_USER : SOAP::STUDENT_USER);
try {
$soap->removeRoomAssignment($student->getBannerId(), $term, 'TMPR', $result[0]['room_number'], 100);
// Hard-code to 100% refund
} catch (Exception $e) {
throw $e;
}
$db = new PHPWS_DB('hms_temp_assignment');
$db->addValue('banner_id', null);
$db->addWhere('room_number', $result[0]['room_number']);
$db->update();
if (PHPWS_Error::logIfError($result)) {
throw new DatabaseException($result->toString());
}
NQ::simple('hms', hms\NotificationView::WARNING, 'Temporary assignment was removed.');
}
// Send this off to the queue for assignment in banner
$banner_success = BannerQueue::queueAssignment($student, $term, $hall, $vacant_bed, 'HOME', $meal_plan);
if ($banner_success !== TRUE) {
throw new AssignmentException('Error while adding the assignment to the Banner queue.');
}
// Make the assignment in HMS
$assignment = new HMS_Assignment();
$assignment->setBannerId($student->getBannerId());
$assignment->asu_username = $username;
$assignment->bed_id = $vacant_bed->id;
$assignment->term = $term;
$assignment->letter_printed = 0;
$assignment->email_sent = 0;
$assignment->meal_option = $meal_plan;
$assignment->reason = $reason;
$assignment->application_term = $student->getApplicationTerm();
$assignment->class = $student->getComputedClass($term);
// If this was a lottery assignment, flag it as such
if ($lottery) {
$assignment->lottery = 1;
if (!isset($reason)) {
// Automatically tag reason as lottery
$assignment->reason = ASSIGN_LOTTERY;
}
} else {
$assignment->lottery = 0;
}
$result = $assignment->save();
if (!$result || PHPWS_Error::logIfError($result)) {
throw new DatabaseException($result->toString());
}
// Log the assignment
HMS_Activity_Log::log_activity($username, ACTIVITY_ASSIGNED, UserStatus::getUsername(), $term . ' ' . $hall->hall_name . ' ' . $room->room_number . ' ' . $notes);
// Insert assignment into History table
AssignmentHistory::makeAssignmentHistory($assignment);
// Look for roommates and flag their assignments as needing a new letter
$room_id = $assignment->get_room_id();
$room = new HMS_Room($room_id);
// Go to the room level to get all the roommates
$assignees = $room->get_assignees();
// get an array of student objects for those assigned to this room
if (sizeof($assignees) > 1) {
foreach ($assignees as $roommate) {
// Skip this student
if ($roommate->getUsername() == $username) {
continue;
}
$roommate_assign = HMS_Assignment::getAssignment($roommate->getUsername(), $term);
$roommate_assign->letter_printed = 0;
$roommate_assign->email_sent = 0;
$roommate_assign->save();
}
}
// Return Sucess
return true;
}
public function execute(CommandContext $context)
{
PHPWS_Core::initModClass('hms', 'HMS_Room.php');
if (!Current_User::allow('hms', 'room_attributes')) {
PHPWS_Core::initModClass('hms', 'exception/PermissionException.php');
throw new PermissionException('You do not have permission to edit rooms.');
}
$roomId = $context->get('roomId');
$viewCmd = CommandFactory::getCommand('EditRoomView');
$viewCmd->setRoomId($roomId);
// Create the room object given the room_id
$room = new HMS_Room($roomId);
if (!$room) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Invalid room.');
$viewCmd->redirect();
}
// Check if the user is trying to change a room's gender to co-ed.
// If so, make sure the user has the permission to do so.
if ($room->getGender() != $context->get('gender_type') && $context->get('gender_type') == COED) {
if (!Current_User::allow('hms', 'coed_rooms')) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Error: You do not have permission to change the room gender to co-ed. No changes were made.');
$viewCmd->redirect();
}
}
// Compare the room's gender and the gender the user selected
// If they're not equal, call 'can_change_gender' public function
if ($room->gender_type != $context->get('gender_type')) {
if (!$room->can_change_gender($context->get('gender_type'))) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Error: Incompatible genders detected. No changes were made.');
$viewCmd->redirect();
}
}
// Check the default gender in the same way
if ($room->default_gender != $context->get('default_gender')) {
if (!$room->can_change_gender($context->get('default_gender'))) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Error: Default gender incompatable. No changes were made.');
$viewCmd->redirect();
}
}
if ($room->get_number_of_assignees() > 0 && $context->get('offline') == 1) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Error: Cannot take room offline while students are assigned to the room. No changes were made.');
$viewCmd->redirect();
}
// Grab all the input from the form and save the room
//Changed from radio buttons to checkboxes, ternary
//prevents null since only 1 is defined as a return value
//test($_REQUEST['room_number']);
$room->room_number = $context->get('room_number');
$room->gender_type = $context->get('gender_type');
$room->default_gender = $context->get('default_gender');
$rlcReserved = $context->get('rlc_reserved');
if ($rlcReserved != 0) {
$room->setReservedRlcId($rlcReserved);
} else {
$room->setReservedRlcId(null);
}
$room->offline = $context->get('offline') == 1 ? 1 : 0;
$room->reserved = $context->get('reserved') == 1 ? 1 : 0;
$room->ra = $context->get('ra') == 1 ? 1 : 0;
$room->private = $context->get('private') == 1 ? 1 : 0;
$room->overflow = $context->get('overflow') == 1 ? 1 : 0;
$room->parlor = $context->get('parlor') == 1 ? 1 : 0;
$room->ada = $context->get('ada') == 1 ? 1 : 0;
$room->hearing_impaired = $context->get('hearing_impaired') == 1 ? 1 : 0;
$room->bath_en_suite = $context->get('bath_en_suite') == 1 ? 1 : 0;
$reservedReason = $context->get('reserved_reason');
if ($reservedReason == 'none') {
$room->setReserved(0);
} else {
$room->setReserved(1);
}
$room->setReservedReason($reservedReason);
$room->setReservedNotes($context->get('reserved_notes'));
$result = $room->save();
if (!$result || PHPWS_Error::logIfError($result)) {
NQ::simple('hms', hms\NotificationView::ERROR, 'There was a problem saving the room data. No changes were made.');
$viewCmd->redirect();
}
NQ::simple('hms', hms\NotificationView::SUCCESS, 'The room was updated successfully.');
$viewCmd->redirect();
}
public function execute(CommandContext $context)
{
if (!UserStatus::isAdmin() || !Current_User::allow('hms', 'assignment_maintenance')) {
PHPWS_Core::initModClass('hms', 'exception/PermissionException.php');
throw new PermissionException('You do not have permission to assign students.');
}
PHPWS_Core::initModClass('hms', 'HousingApplication.php');
PHPWS_Core::initModClass('hms', 'FallApplication.php');
PHPWS_Core::initModClass('hms', 'HMS_Assignment.php');
PHPWS_Core::initModClass('hms', 'StudentFactory.php');
PHPWS_Core::initModClass('hms', 'HMS_Room.php');
PHPWS_Core::initModClass('hms', 'HMS_Activity_Log.php');
PHPWS_Core::initModClass('hms', 'BannerQueue.php');
// NB: Username must be all lowercase
$username = strtolower(trim($context->get('username')));
$term = Term::getSelectedTerm();
// Setup command to redirect to in case of error
$errorCmd = CommandFactory::getCommand('ShowAssignStudent');
$errorCmd->setUsername($username);
/***
* Input Sanity Checking
*/
// Must supply a user name
if (is_null($username)) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Invalid or missing username.');
$errorCmd->redirect();
}
// Must supply at least a room ID
$roomId = $context->get('room');
if (is_null($roomId) || $roomId == 0) {
NQ::simple('hms', hms\NotificationView::ERROR, 'You must select a room.');
$errorCmd->redirect();
}
// Must choose an assignment type
$assignmentType = $context->get('assignment_type');
if (!isset($assignmentType) || is_null($assignmentType) || $assignmentType < 0) {
NQ::simple('hms', hms\NotificationView::ERROR, 'You must choose an assignment type.');
$errorCmd->redirect();
}
// Check to make sure the student has an application on file
$applicationStatus = HousingApplication::checkForApplication($username, $term);
if ($applicationStatus == FALSE) {
NQ::simple('hms', hms\NotificationView::WARNING, 'Warning: No housing application found for this student in this term.');
}
// If the student is already assigned, redirect to the confirmation screen. If the student is already assigned
// and the confirmation flag is true, then set a flag and proceed.
$moveNeeded = FALSE;
if (HMS_Assignment::checkForAssignment($username, $term)) {
if ($context->get('moveConfirmed') == 'true') {
// Move has been confirmed
$moveNeeded = true;
} else {
// Redirect to the move confirmation interface
$moveConfirmCmd = CommandFactory::getCommand('ShowAssignmentMoveConfirmation');
$moveConfirmCmd->setUsername($username);
$moveConfirmCmd->setRoom($context->get('room'));
$moveConfirmCmd->setBed($context->get('bed'));
$moveConfirmCmd->setMealPlan($context->get('meal_plan'));
$moveConfirmCmd->setAssignmentType($assignmentType);
$moveConfirmCmd->setNotes($context->get('note'));
$moveConfirmCmd->redirect();
}
}
try {
$student = StudentFactory::getStudentByUsername($username, $term);
} catch (StudentNotFoundException $e) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Invalid user name, no such student found.');
$errorCmd->redirect();
}
// Check age, issue a warning for over 25
if (strtotime($student->getDOB()) < strtotime("-25 years")) {
NQ::simple('hms', hms\NotificationView::WARNING, 'Student is 25 years old or older!');
}
$gender = $student->getGender();
if (!isset($gender) || is_null($gender)) {
throw new InvalidArgumentException('Missing student gender.');
}
// Create the room object so we can check gender
$room = new HMS_Room($roomId);
if (!$room) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Error creating the room object.');
$errorCmd->redirect();
}
// Create the hall object for later
$floor = $room->get_parent();
$hall = $floor->get_parent();
// If the room is Co-ed, make sure the user has permission to assign to co-ed rooms
if ($room->getGender() == COED && !Current_User::allow('hms', 'coed_assignment')) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Error: You do not have permission to assign students to co-ed rooms.');
$errorCmd->redirect();
}
// Make sure the student's gender matches the gender of the room, unless the room is co-ed.
if ($room->getGender() != $gender && $room->getGender() != COED) {
// Room gender does not match student's gender, so check if we can change it
if ($room->can_change_gender($gender) && Current_User::allow('hms', 'room_attributes')) {
$room->setGender($gender);
$room->save();
NQ::simple('hms', hms\NotificationView::WARNING, 'Warning: Changing room gender.');
} else {
NQ::simple('hms', hms\NotificationView::ERROR, 'Error: The student\'s gender and the room\'s gender do not match and the room could not be changed.');
$errorCmd->redirect();
}
}
// If the user is attempting to re-assign and has confirmed the move,
// then unassign the student first.
if ($moveNeeded) {
try {
//TODO don't hard-code refund percentage to 100%
HMS_Assignment::unassignStudent($student, $term, '(re-assign)', UNASSIGN_REASSIGN, 100);
} catch (Exception $e) {
NQ::simple('hms', hms\NotificationView::ERROR, "Error deleting current assignment. {$username} was not removed.");
$errorCmd->redirect();
}
}
// Actually try to make the assignment, decide whether to use the room id or the bed id
$bed = $context->get('bed');
try {
if (isset($bed) && $bed != 0) {
HMS_Assignment::assignStudent($student, $term, NULL, $bed, $context->get('meal_plan'), $context->get('note'), false, $context->get('assignment_type'));
} else {
HMS_Assignment::assignStudent($student, $term, $context->get('room'), NULL, $context->get('meal_plan'), $context->get('note'), false, $context->get('assignment_type'));
}
} catch (AssignmentException $e) {
NQ::simple('hms', hms\NotificationView::ERROR, 'Assignment error: ' . $e->getMessage());
$errorCmd->redirect();
}
// Show a success message
if ($context->get('moveConfirmed') == 'true') {
NQ::simple('hms', hms\NotificationView::SUCCESS, 'Successfully moved ' . $username . ' to ' . $hall->hall_name . ' room ' . $room->room_number);
} else {
NQ::simple('hms', hms\NotificationView::SUCCESS, 'Successfully assigned ' . $username . ' to ' . $hall->hall_name . ' room ' . $room->room_number);
}
$successCmd = CommandFactory::getCommand('ShowAssignStudent');
$successCmd->redirect();
}
public function execute(CommandContext $context)
{
// Make sure the user has permission to change room attributes
if (!Current_User::allow('hms', 'room_attributes')) {
echo json_encode(false);
die;
}
// Get the values from the request
$id = $context->get('id');
$element = $context->get('field');
$value = $context->get('value');
// Make sure the required values were passed in on the request
if (is_null($id) || is_null($element) || is_null($value)) {
echo json_encode(false);
die;
}
// Instantiate the room object
try {
$room = new HMS_Room($id);
} catch (Exception $e) {
echo json_encode(false);
die;
}
/**********
* Gender *
*/
// If the user is trying to change the gender, make sure no one is assigned
if ($element == 'gender_type') {
if ($room->get_number_of_assignees() > 0) {
echo json_encode(false);
die;
}
}
// Check if the user is trying to change a room's gender to co-ed.
// If so, make sure the user has the permission to do so.
if ($element == 'gender_type' && $room->getGender() != $value && $value == COED) {
if (!Current_User::allow('hms', 'coed_rooms')) {
echo json_encode(false);
die;
}
}
// If the gender field was changed
if ($element == 'gender_type' && $room->getGender() != $value) {
// Make sure the requested gender is compatiable with the hall/floor
if ($room->can_change_gender($value)) {
$room->setGender($value);
} else {
echo json_encode(false);
die;
}
}
/******************
* Default Gender *
*/
// If default gender was changed
if ($element == 'default_gender' && $room->getDefaultGender() != $value) {
// Make sure the requested default gender is compatiable with the hall/floor
if ($room->can_change_gender($value)) {
$room->setDefaultGender($value);
} else {
echo json_encode(false);
die;
}
}
/* RLC Reservation */
if ($element == 'rlc_reserved') {
if ($value <= 0) {
$room->setReservedRlcId(null);
} else {
$room->setReservedRlcId($value);
}
}
// A switch statement for all the check boxes
switch ($element) {
case 'ra':
$room->setRa($value);
break;
case 'private':
$room->setPrivate($value);
break;
case 'overflow':
$room->setOverflow($value);
break;
case 'ada':
$room->setADA($value);
break;
case 'reserved':
$room->setReserved($value);
break;
case 'offline':
$room->setOffline($value);
break;
}
try {
$room->save();
} catch (Exception $e) {
echo json_encode(false);
die;
}
echo json_encode($room);
die;
}
