Files
@ 30c9462fd881
Branch filter:
Location: SlatePermutate/inc/class.schedule.php
30c9462fd881
18.0 KiB
text/x-php
Moved class files into inc
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 | <?php
/*
* Copyright 2010 Nathan Gelderloos, Ethan Zonca, Nathan Phillip Brink
*
* This file is part of SlatePermutate.
*
* SlatePermutate is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* SlatePermutate is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with SlatePermutate. If not, see <http://www.gnu.org/licenses/>.
*/
//**************************************************
// class.schedule.php Author: Nathan Gelderloos
//
// Represents a schedule of a week. Stores the
// classes that are part of that week and calculates
// all the possible permutations.
//**************************************************
include_once('inc/class.course.inc');
include_once 'class.section.php';
include_once 'inc/class.page.php';
/*
* Load a Classes -> Course converter class for the sake of the
* Schedule::__wakeup() magic function.
*/
require_once('inc/class.classes_convert.inc');
class Schedule
{
/*
* Variables for upgrading from saved schedules created when there
* was a class called Classes.
*/
private $classStorage; // array of courses
private $nclasses; // Integer number of classes
/* My member variables. */
private $courses;
private $nPermutations = 0; // Integer number of real permutations
private $possiblePermutations; // Integer number of possible permutations
private $scheduleName; // String name of schedule
private $storage; // Integer array of valid schedules
private $title;
/**
* \brief
* My global identification number. Not defined until the schedule
* is processed and first saved.
*/
private $id;
/**
* The input format of the sections. Only used for the UI. Valid
* values are 'numerous' for custom, 'numbered' for numeric, and 'lettered' for
* alphabetical.
*/
public $section_format;
/**
* \brief
* Create a schedule with the given name.
*/
function __construct($name)
{
$this->courses = array();
$this->scheduleName = $name;
$this->storage = array();
$this->title = "SlatePermutate - Scheduler";
$this->section_format = 'numerous';
/* mark this as an upgraded Schedule class. See __wakeup() */
$this->nclasses = -1;
}
//--------------------------------------------------
// Mutators and Accessors
//--------------------------------------------------
public function getName()
{
return $this->scheduleName;
}
//--------------------------------------------------
// Adds a new class to the schedule.
//--------------------------------------------------
function addCourse($n)
{
$this->courses[] = new Course($n);
}
//--------------------------------------------------
// Adds a section to the desired class.
//--------------------------------------------------
function addSection($course_name, $letter, $time_start, $time_end, $days, $synonym = NULL, $faculty = NULL, $location = NULL, $type = 'lecture')
{
$found = false;
$counter = 0;
foreach ($this->courses as $course)
if (!strcmp($course_name, $course->getName()))
{
$section = $course->section_get($letter);
if (!$section)
{
$section = new Section($letter, array(), $synonym, $faculty);
$course->section_add($section);
}
$section->meeting_add(new SectionMeeting($days, $time_start, $time_end, $location, $type));
return;
}
echo 'Could not find class: ' . $course_name . "<br />\n";
}
//--------------------------------------------------
// Finds all of the possible permutations and stores
// the results in the storage array.
//--------------------------------------------------
function findPossibilities()
{
$this->possiblePermutations = 1;
/* special case: there is nothing entered into the schedule and thus there is one, NULL permutation */
if (!count($this->courses))
{
/* have an empty schedule */
$this->nPermutations = 1;
return;
}
$position = 0;
$counter = 0;
$i = 0;
foreach ($this->courses as $course)
{
$this->possiblePermutations = $this->possiblePermutations * $course->getnsections();
$cs[$i] = 0; // Sets the counter array to all zeroes.
$i ++;
}
// Checks for conflicts in given classes, stores if none found
do
{
$conflict = false;
// Get first class to compare
for ($upCounter = 0; $upCounter < count($this->courses) && !$conflict; $upCounter ++)
{
for ($downCounter = count($this->courses) - 1; $downCounter > $upCounter && !$conflict; $downCounter --)
{
if ($this->courses[$upCounter]->getSection($cs[$upCounter])
->conflictsWith($this->courses[$downCounter]->getSection($cs[$downCounter])))
{
$conflict = TRUE;
break;
}
}
}
// Store to storage if no conflict is found.
if(!$conflict)
{
for($i = 0; $i < count($this->courses); $i++)
{
$this->storage[$this->nPermutations][$i] = $cs[$i];
}
$this->nPermutations++;
}
// Increase the counter by one to get the next combination of class sections.
$cs[$position] = $cs[$position] + 1;
// Check to make sure the counter is still valid.
$valid = false;
while(!$valid)
{
if($cs[$position] == $this->courses[$position]->getnsections())
{
$cs[$position] = 0;
$position++;
// This is for the very last permutation. Even
// though the combination is not actually true
// the larger while loop will end before any
// new combinations are performed.
if($position == count($this->courses))
{
$valid = true;
} else {
$cs[$position]++;
}
} else {
$valid = true;
$position = 0;
}
}
$counter++;
} while($counter < $this->possiblePermutations);
}
//--------------------------------------------------
// Prints out the possible permutations in tables.
//--------------------------------------------------
function writeoutTables()
{
$filled = false;
$time = array(700,730,800,830,900,930,1000,1030,1100,1130,1200,1230,1300,1330,1400,1430,1500,1530,1600,1630,1700,1730,1800,1830,1900,1930,2000,2030,2100,2130, 2200);
define('SP_PERMUTATIONS_PER_PAGE', 256); /** @TODO: Define this in config.inc */
$npages = ceil($this->nPermutations / SP_PERMUTATIONS_PER_PAGE);
$page = 0;
if (isset($_REQUEST['page']))
$page = $_REQUEST['page'];
/*
* only display the ``this page doesn't exist'' 404 if there is at
* least one permutation. Otherwise, we give an irrelevant 404 for
* users with no permutations.
*/
if ($this->nPermutations && $page >= $npages)
Page::show_404('Unable to find page ' . $page . ', there are only ' . $this->nPermutations . ' non-conflicting permutations, for a total of ' . $npages . ' pages.');
/* zero-based */
$first_permutation = $page * SP_PERMUTATIONS_PER_PAGE;
$last_permutation = min($this->nPermutations, $first_permutation + SP_PERMUTATIONS_PER_PAGE);
$footcloser = '';
if(isset($_REQUEST['print']) && $_REQUEST['print'] != ''){
$headcode = array('jQuery', 'jQueryUI', 'uiTabsKeyboard', 'outputStyle', 'outputPrintStyle', 'displayTables');
}
else {
$headcode = array('outputStyle', 'jQuery', 'jQueryUI', 'uiTabsKeyboard', 'displayTables');
}
$outputPage = new Page(htmlentities($this->getName()), $headcode);
if(isset($_REQUEST['print'])) {
echo '<script type="text/javascript">';
echo 'jQuery(document).ready( function() {';
/* If user entered items to print */
if($_REQUEST['print'] != 'all'){
echo 'jQuery(\'.section\').hide();';
$items = explode(',', $_REQUEST['print']);
foreach($items as $item){
echo 'jQuery(\'#tabs-'.$item.'\').show();';
}
}
echo '}); '; /* Close document.ready for jQuery */
echo 'window.print(); </script>';
echo '<p><a href="'.$_SERVER['SCRIPT_NAME'].'?s=' . $this->id_get() . '">« Return to normal view</a> </p>';
}
else {
echo '<script type="text/javascript">';
echo ' jQuery(document).ready( function() {';
echo ' jQuery("#tabs").tabs();';
echo ' jQuery("#sharedialog").dialog({ modal: true, width: 550, resizable: false, draggable: false, autoOpen: false });';
echo ' jQuery("#share").click( function() {
jQuery("#sharedialog").dialog("open");
});';
echo ' jQuery(\'#printItems\').click( function() {
window.location = "'.$_SERVER['SCRIPT_NAME'].'?s='.$this->id_get().'&print=" + (jQuery(\'#tabs\').tabs(\'option\',\'selected\') + 1);
});
jQuery(\'#cancelItems\').click( function() {
jQuery(\'#selectItemsInput\').hide();
});';
echo ' });
</script>';
echo '<div id="sharedialog" title="Share Schedule"><p>You can share your schedule with the URL below:</p><p>' . htmlentities($outputPage->gen_share_url($this->id_get())) . '</p></div>';
echo '<p><span id="printItems"><a href="#">Print</a></span> :: <span id="share"><a href="#">Share</a></span> :: <a href="input.php">Home</a></p>';
echo '<p class="centeredtext">Having problems? <a href="feedback.php">Let us know</a>.</p>';
echo '<p class="centeredtext graytext"><em>Keyboard Shortcut: Left and right arrow keys switch between schedules</em></p>';
}
echo "\n";
if($this->nPermutations > 0)
{
echo '<div id="regDialog" title="Registration Codes"><p>Enter these codes into your school\'s online course registration system to register for classes:</p><div id="regDialogList"></div></div>';
echo '<div id="tabs">' . "\n" .
'<div id="show-box" class="show-buttons">
<form>
<label><strong>Display:</strong></label>
<input id="show-prof" name="show-prof" type="checkbox" checked="checked" /><label for="show-prof">Professor</label>
<input id="show-location" name="show-location" type="checkbox" /><label for="show-location">Room</label>
<input id="show-synonym" name="show-synonym" type="checkbox" /><label for="show-synonym">Synonym</label>
<div id="regCodes"><label><a href="#">Registration Codes</a></label></div>
</form>
</div> <!-- id="show-box" -->'
. '<div id="the-tabs"><ul>' . "\n";
for($nn = $first_permutation + 1; $nn <= $last_permutation; $nn++)
{
echo "<li><a href=\"#tabs-" . $nn . "\"> " . $nn . " </a></li>\n";
}
echo " </ul></div>\n \n";
echo " <div id=\"pagers\">\n";
/* Previous button */
if ($page > 0)
echo ' <div id="pager-previous" class="pager left"><a href="' . htmlentities($this->url($this->id, $page - 1)) . '">« Previous</a></div>' . "\n";
/* Next button */
if ($page + 1 < $npages)
echo ' <div id="pager-next" class="pager right"><a href="' . htmlentities($this->url($this->id, $page + 1)) . '">Next »</a></div>' . "\n";
echo " </div> <!-- id=\"pagers\" -->\n";
echo " <div class=\"scroller\">\n"
. " <div class=\"scontent\">\n";
for($i = $first_permutation; $i < $last_permutation; $i++)
{
$syns = array();
echo ' <div class="section" id="tabs-' . ($i+1) . "\">\n";
// Beginning of table
echo " <table style=\"empty-cells:show;\" border=\"1\" cellspacing=\"0\">\n";
// Header row
echo " <tr>\n"
. ' <td class="none permuteNum">' . ($i + 1) . "</td>\n"
. " <td class=\"day\">Monday</td>\n"
. " <td class=\"day\">Tuesday</td>\n"
. " <td class=\"day\">Wednesday</td>\n"
. " <td class=\"day\">Thursday</td>\n"
. " <td class=\"day\">Friday</td>\n"
. " </tr>\n";
$last_meeting = array();
$rowspan = array(0, 0, 0, 0, 0);
for($r = 0; $r < (count($time)-1); $r++)
{
echo " <tr>\n"
. " <td class=\"time\">" . $this->prettyTime($time[$r]) . "</td>\n";
for($dayLoop = 0; $dayLoop < 5; $dayLoop++)
{
/* Makes sure there is not a class already in progress */
if($rowspan[$dayLoop] <= 0)
{
for($j = 0; $j < count($this->courses); $j++)
{
$class = $this->courses[$j];
$section_index = $this->storage[$i][$j];
$section = $class->getSection($section_index);
/* iterate through all of a class's meeting times */
$meetings = $section->getMeetings();
/* find any meeting which are going on at this time */
$current_meeting = NULL;
foreach ($meetings as $meeting)
{
if ($meeting->getDay($dayLoop)
&& $meeting->getStartTime() >= $time[$r]
&& $meeting->getStartTime() < $time[$r+1])
{
$current_meeting = $meeting;
}
}
if ($current_meeting)
{
/* calculate how many rows this section should span */
for ($my_r = $r; $current_meeting->getEndTime() > $time[$my_r]; $my_r ++)
;
$rowspan[$dayLoop] = $my_r - $r;
$single_multi = 'single';
if ($rowspan[$dayLoop] > 1)
$single_multi = 'multi';
echo ' <td rowspan="' . $rowspan[$dayLoop]
. '" class="' . $single_multi . ' class' . $j
. '" title="prof: ' . htmlentities($section->getProf(), ENT_QUOTES)
. ', room: ' . htmlentities($current_meeting->getLocation(), ENT_QUOTES)
. ', type: ' . htmlentities($current_meeting->type_get(), ENT_QUOTES) . '">'
. htmlentities($class->getName(), ENT_QUOTES) . '-'
. htmlentities($section->getLetter(), ENT_QUOTES) . "\n"
. '<span class="prof block">' . htmlentities($section->getProf(), ENT_QUOTES) . "</span>\n"
. '<span class="location block">' . htmlentities($current_meeting->getLocation(), ENT_QUOTES) . "</span>\n"
. '<span class="synonym block">' . htmlentities($section->getSynonym(), ENT_QUOTES) . "</span>\n"
. "</td>\n";
$syns[$section->getSynonym()] = $section->getSynonym();
$filled = TRUE;
}
}
}
if ($rowspan[$dayLoop] > 0)
{
$filled = TRUE;
$rowspan[$dayLoop] --;
}
/* If the cell was not filled, fill it with an empty cell. */
if(!$filled)
{
echo " <td class=\"none\"> </td>\n";
}
$filled = FALSE;
}
// End of row
echo " </tr>\n";
}
echo '<div class="syns syns'.$i.'">'. json_encode($syns) . '</div>';
// End of table
echo " </table>\n"
. ' </div> <!-- id="section' . ($i + 1) . "\" -->\n";
}
echo $table
. " </div> <!-- class=\"scontent\" -->\n"
. " </div> <!-- class=\"scroller\" -->\n"
. "</div> <!-- id=\"my-glider\" -->\n"
. $footcloser; // Closes off the content div
} else {
echo '<html><body><p>There are no possible schedules. Please try again.</p></body></html>';
}
/* edit button */
if ($id = $this->id_get())
echo '<form method="get" action="input.php"><p><input type="hidden" name="s" value="' . $id . '" /><input class="gray" id="editbutton" type="submit" value="edit" /></p></form>';
echo "<p id=\"possiblestats\">There were a total of " . $this->possiblePermutations . " possible permutations. Only " . $this->nPermutations . " permutations had no class conflicts.</p>";
$outputPage->foot();
}
//--------------------------------------------------
// Changes the title of the page.
//--------------------------------------------------
function changeTitle($t)
{
$this->title = $t;
}
//--------------------------------------------------
// Make the time "pretty"
//--------------------------------------------------
function prettyTime($t){
if($t > 1259)
{
$t = ($t-1200);
return substr($t, 0, strlen($t)-2) . ":" . substr($t, strlen($t)-2, strlen($t)) . " PM";
} else {
return substr($t, 0, strlen($t)-2) . ":" . substr($t, strlen($t)-2, strlen($t)) . " AM";
}
}
/**
* \brief
* fetch the number of classes
*/
function nclasses_get()
{
return count($this->courses);
}
/**
* \brief
* fetch a specified class by its key
*/
function class_get($class_key)
{
return $this->courses[$class_key];
}
/**
* \brief
* Set my global ID.
*
* Only to be called by schedule_store_store().
*/
function id_set($id)
{
$this->id = $id;
}
/*
* \brief
* Get my global ID.
*/
function id_get()
{
return $this->id;
}
/**
* \brief
* Write out a relative URL for a particular schedule.
*
* Takes into account the $clean_urls setting.
*
* \param $id
* The ID of the schedule to link to. Defaults to the current schedule object.
* \param $page
* The page of the schedule to link to. Defaults to 0.
* \return
* A string, the URL used to access this schedule. Remember that
* if this string is inserted into an XHTML document,
* htmlentities() must be called on it.
*/
function url($id = NULL, $page = 0)
{
global $clean_urls;
$url = '';
if (!$clean_urls)
$url .= 'process.php?s=';
if (!$id)
$id = $this->id;
$url .= (int)$id;
if ($clean_urls)
$url .= '?';
else
$url .= '&';
if ($page)
$url .= 'page=' . (int)$page . '&';
return $url;
}
/**
* \brief
* A magic function which tries to upgrade old serialized sections
* to the new format.
*/
function __wakeup()
{
if ($this->nclasses == -1)
/* this Schedule doesn't need to be upgraded from Classes to Course */
return;
$this->courses = array();
foreach ($this->classStorage as $classes)
{
$this->courses[] = $classes->to_course();
}
$this->nclasses = -1;
}
}
|