smtech / canvas-management

common.inc.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 
 use smtech\CanvasManagement\Toolbox;
 use smtech\ReflexiveCanvasLTI\LTI\ToolProvider;
-use smtech\ReflexiveCanvasLTI\Exception\ConfigurationException;
 use Battis\DataUtilities;
 
 @session_start(); // TODO suppressing warnings is wrong

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 if (empty($_SESSION[Toolbox::class])) {
     $_SESSION[Toolbox::class] = Toolbox::fromConfiguration(CONFIG_FILE);
 }
-$toolbox =& $_SESSION[Toolbox::class];
+$toolbox = & $_SESSION[Toolbox::class];
 
 /* set the Tool Consumer's instance URL, if present */
 if (empty($_SESSION[CANVAS_INSTANCE_URL]) &&

one-offs/archive-inbox.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 require_once('common.inc.php');
 
 use Battis\BootstrapSmarty\NotificationMessage;
-
 use smtech\StMarksSmarty\StMarksSmarty;
 
 $toolbox->getSmarty()->enable(StMarksSmarty::MODULE_DATEPICKER);

src/Toolbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
     /**
      * Configure course and account navigation placements
      *
-     * @return Generator
+     * @return \smtech\LTI\Configuration\Generator
      */
     public function getGenerator()
     {

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use Battis\BootstrapSmarty\NotificationMessage;
 use Battis\HierarchicalSimpleCache;
-
 use smtech\LTI\Configuration\Option;
 
 class Toolbox extends \smtech\StMarksReflexiveCanvasLTI\Toolbox

Spacing +1 added lines, -1 removed lines

@@ -136,7 +136,7 @@
                 print_r($this->getAPI()->last_request, true) .
                 '</pre><p>Last Headers</p><pre>' .
                 print_r($this->getAPI()->last_headers, true) .
-                '</pre><p>Error Message</p><pre>' . $e->getMessage() .'</pre>',
+                '</pre><p>Error Message</p><pre>' . $e->getMessage() . '</pre>',
             NotificationMessage::ERROR
         );
     }

courses/publish-courses.php

Spacing +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
                 );
                 $list[] = "<a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/{$course['id']}\">{$course['name']}</a>";
             }
-            $toolbox->smarty_addMessage($courses->count(). ' courses published', implode(', ', $list), NotificationMessage::GOOD);
+            $toolbox->smarty_addMessage($courses->count() . ' courses published', implode(', ', $list), NotificationMessage::GOOD);
         } catch (Exception $e) {
             $toolbox->exceptionErrorMessage($e);
         }

custom-preferences/color-blocks.php

Spacing +1 added lines, -2 removed lines

@@ -61,8 +61,7 @@
                     $sections = $toolbox->api_get("courses/{$course['id']}/sections");
                     foreach ($sections as $section) {
                         $sis_course_id = (isset($parentCourses[$section['sis_section_id']]) ?
-                                $parentCourses[$section['sis_section_id']] :
-                                false
+                                $parentCourses[$section['sis_section_id']] : false
                             );
                         if ($sis_course_id === false) {
                             $parentCourse = $course;

custom-preferences/assign-user-roles.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 
 $cache = new \Battis\HierarchicalSimpleCache($sql, basename(__DIR__));
 $cache->pushKey(basename(__FILE__, '.php'));
-$cache->setLifetime(60*60);
+$cache->setLifetime(60 * 60);
 
 define('STEP_INSTRUCTIONS', 1);
 define('STEP_LISTING', 2);

custom-preferences/apply-enrollment-rules.php

Spacing +1 added lines, -1 removed lines

@@ -5,7 +5,7 @@
 use Battis\BootstrapSmarty\NotificationMessage;
 
 $cache = new \Battis\HierarchicalSimpleCache($sql, basename(__DIR__) . '/' . basename(__FILE__, '.php'));
-$cache->setLifetime(60*60);
+$cache->setLifetime(60 * 60);
 
 define('ENROLL', true);
 // DELETE is the enrollment ID to be deleted (i.e. not a boolean value)

enrollment/download-enrollments.php

Spacing +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
                                 );
                             }
                         }
-                        $cache->setCache('enrollments', $data, 15*60);
+                        $cache->setCache('enrollments', $data, 15 * 60);
                     }
                     $toolbox->smarty_assign('account', $_REQUEST['account']);
                     $toolbox->smarty_assign('term', $_REQUEST['term']);

enrollment/enroll-users.php

Switch Indentation +143 added lines, -143 removed lines

@@ -32,170 +32,170 @@
 }
 
 switch ($step) {
-    case STEP_CONFIRM:
-        try {
-            $users = $toolbox->explodeCommaAndNewlines($_REQUEST['users']);
-
-            if (empty($_REQUEST['course'])) {
-                $toolbox->smarty_addMessage(
-                    'Course',
-                    'was not selected, so no enrollments can happen',
-                    NotificationMessage::ERROR
-                );
-                $step = STEP_INSTRUCTIONS;
-            } else {
-                $sections = $toolbox->cache_get("courses/{$_REQUEST['course']}");
-                if (empty($sections)) {
-                    $section = array();
-                    $courses = $toolbox->api_get(
-                        'accounts/1/courses',
-                        array(
-                            'search_term' => $_REQUEST['course']
-                        )
+        case STEP_CONFIRM:
+            try {
+                $users = $toolbox->explodeCommaAndNewlines($_REQUEST['users']);
+
+                if (empty($_REQUEST['course'])) {
+                    $toolbox->smarty_addMessage(
+                        'Course',
+                        'was not selected, so no enrollments can happen',
+                        NotificationMessage::ERROR
                     );
-                    foreach ($courses as $course) {
-                        $courseSections = $toolbox->api_get("courses/{$course['id']}/sections");
-                        if ($courseSections->count() == 0) {
-                            /* we have only the "magic" default section */
-                            $sections[] = array('course' => $course);
-                        } else {
-                            foreach ($courseSections as $section) {
-                                $sections[] = array(
-                                    'course' => $course,
-                                    'section' => $section
-                                );
+                    $step = STEP_INSTRUCTIONS;
+                } else {
+                    $sections = $toolbox->cache_get("courses/{$_REQUEST['course']}");
+                    if (empty($sections)) {
+                        $section = array();
+                        $courses = $toolbox->api_get(
+                            'accounts/1/courses',
+                            array(
+                                'search_term' => $_REQUEST['course']
+                            )
+                        );
+                        foreach ($courses as $course) {
+                            $courseSections = $toolbox->api_get("courses/{$course['id']}/sections");
+                            if ($courseSections->count() == 0) {
+                                /* we have only the "magic" default section */
+                                $sections[] = array('course' => $course);
+                            } else {
+                                foreach ($courseSections as $section) {
+                                    $sections[] = array(
+                                        'course' => $course,
+                                        'section' => $section
+                                    );
+                                }
                             }
                         }
+                        $toolbox->cache_set("courses/{$_REQUEST['course']}", $sections, CACHE_LIFETIME);
                     }
-                    $toolbox->cache_set("courses/{$_REQUEST['course']}", $sections, CACHE_LIFETIME);
-                }
 
-                if (empty($sections)) {
-                    $toolbox->smarty_addMessage(
-                        'No Courses',
-                        "matched your search term '{$_REQUEST['course']}'.",
-                        NotificationMessage::WARNING
-                    );
-                    $step = STEP_INSTRUCTIONS;
+                    if (empty($sections)) {
+                        $toolbox->smarty_addMessage(
+                            'No Courses',
+                            "matched your search term '{$_REQUEST['course']}'.",
+                            NotificationMessage::WARNING
+                        );
+                        $step = STEP_INSTRUCTIONS;
+                    }
                 }
-            }
 
-            if ($step == STEP_CONFIRM) {
-                if (!empty($users)) {
-                    $confirm = array();
-                    foreach ($users as $term) {
-                        $confirm[$term] = $toolbox->cache_get("users/$term");
-                        if ($confirm[$term] === false) {
-                            $confirm[$term] = $toolbox->api_get(
-                                'accounts/1/users',
-                                array(
-                                    'search_term' => $term,
-                                    'include[]' => 'term'
-                                )
-                            );
-                            $toolbox->cache_set("users/$term", $confirm[$term], CACHE_LIFETIME);
+                if ($step == STEP_CONFIRM) {
+                    if (!empty($users)) {
+                        $confirm = array();
+                        foreach ($users as $term) {
+                            $confirm[$term] = $toolbox->cache_get("users/$term");
+                            if ($confirm[$term] === false) {
+                                $confirm[$term] = $toolbox->api_get(
+                                    'accounts/1/users',
+                                    array(
+                                        'search_term' => $term,
+                                        'include[]' => 'term'
+                                    )
+                                );
+                                $toolbox->cache_set("users/$term", $confirm[$term], CACHE_LIFETIME);
+                            }
                         }
-                    }
 
-                    $toolbox->smarty_assign('sections', $sections);
-                    $toolbox->smarty_assign('terms', $toolbox->getTermList());
-                    $toolbox->smarty_assign('confirm', $confirm);
-                    $toolbox->smarty_assign('roles', $toolbox->api_get('accounts/1/roles')); // TODO make this account-specific
-                    $toolbox->smarty_assign('formHidden', array('step' => STEP_ENROLL));
-                    $toolbox->smarty_display(basename(__FILE__, '.php') . '/confirm.tpl');
-                    break;
-                } else {
-                    $toolbox->smarty_addMessage(
-                        'Users',
-                        'were not selected, so no enrollments can happen.',
-                        NotificationMessage::ERROR
-                    );
-                    $step = STEP_INSTRUCTIONS;
-                }
-            }
-        } catch (Pest_Exception $e) {
-            $toolbox->exceptionErrorMessage($e);
-        }
-
-        /* flow into STEP_ENROLL (and STEP_INSTRUCTIONS) */
-
-    case STEP_ENROLL:
-        try {
-            if ($step == STEP_ENROLL) {
-                $courseEnrollment = false;
-                if (empty($_REQUEST['section'])) {
-                    if (!empty($_REQUEST['course'])) {
-                        $courseEnrollment = true;
+                        $toolbox->smarty_assign('sections', $sections);
+                        $toolbox->smarty_assign('terms', $toolbox->getTermList());
+                        $toolbox->smarty_assign('confirm', $confirm);
+                        $toolbox->smarty_assign('roles', $toolbox->api_get('accounts/1/roles')); // TODO make this account-specific
+                        $toolbox->smarty_assign('formHidden', array('step' => STEP_ENROLL));
+                        $toolbox->smarty_display(basename(__FILE__, '.php') . '/confirm.tpl');
+                        break;
                     } else {
                         $toolbox->smarty_addMessage(
-                            'Course or Section',
-                            'Missing from enrollment request.',
+                            'Users',
+                            'were not selected, so no enrollments can happen.',
                             NotificationMessage::ERROR
                         );
                         $step = STEP_INSTRUCTIONS;
                     }
                 }
+            } catch (Pest_Exception $e) {
+                $toolbox->exceptionErrorMessage($e);
+            }
 
-                if (empty($_REQUEST['users'])) {
-                    $toolbox->smarty_addMessage(
-                        'Users',
-                        'missing from enrollment request.',
-                        NotificationMessage::ERROR
-                    );
-                } elseif ($step == STEP_ENROLL) {
-                    $count = 0;
-                    foreach ($_REQUEST['users'] as $user) {
-                        $enrollment = $toolbox->api_post(
-                            (
-                                $courseEnrollment ?
-                                "/courses/{$_REQUEST['course']}/enrollments" :
-                                "/sections/{$_REQUEST['section']}/enrollments"
-                            ),
-                            array(
-                                'enrollment[user_id]' => $user['id'],
-                                'enrollment[role_id]' => $user['role'],
-                                'enrollment[enrollment_state]' => 'active',
-                                'enrollment[notify]' => (empty($user['notify']) ? 'false' : $user['notify'])
-                            )
-                        );
-                        if (!empty($enrollment['id'])) {
-                            $count++;
-                        } // FIXME should really list errors, no?
-                    }
+            /* flow into STEP_ENROLL (and STEP_INSTRUCTIONS) */
 
-                    if ($courseEnrollment) {
-                        $course = $_REQUEST['course'];
-                    } else {
-                        $section = $toolbox->api_get("sections/{$_REQUEST['section']}");
-                        $course = $section['course_id'];
+        case STEP_ENROLL:
+            try {
+                if ($step == STEP_ENROLL) {
+                    $courseEnrollment = false;
+                    if (empty($_REQUEST['section'])) {
+                        if (!empty($_REQUEST['course'])) {
+                            $courseEnrollment = true;
+                        } else {
+                            $toolbox->smarty_addMessage(
+                                'Course or Section',
+                                'Missing from enrollment request.',
+                                NotificationMessage::ERROR
+                            );
+                            $step = STEP_INSTRUCTIONS;
+                        }
                     }
 
-                    // FIXME no longer have the course ID… link is broken
-                    $toolbox->smarty_addMessage(
-                        'Success',
-                        "<a target=\"_top\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/$course/users\">$count users enrolled</a>",
-                        NotificationMessage::GOOD
-                    );
+                    if (empty($_REQUEST['users'])) {
+                        $toolbox->smarty_addMessage(
+                            'Users',
+                            'missing from enrollment request.',
+                            NotificationMessage::ERROR
+                        );
+                    } elseif ($step == STEP_ENROLL) {
+                        $count = 0;
+                        foreach ($_REQUEST['users'] as $user) {
+                            $enrollment = $toolbox->api_post(
+                                (
+                                    $courseEnrollment ?
+                                    "/courses/{$_REQUEST['course']}/enrollments" :
+                                    "/sections/{$_REQUEST['section']}/enrollments"
+                                ),
+                                array(
+                                    'enrollment[user_id]' => $user['id'],
+                                    'enrollment[role_id]' => $user['role'],
+                                    'enrollment[enrollment_state]' => 'active',
+                                    'enrollment[notify]' => (empty($user['notify']) ? 'false' : $user['notify'])
+                                )
+                            );
+                            if (!empty($enrollment['id'])) {
+                                $count++;
+                            } // FIXME should really list errors, no?
+                        }
+
+                        if ($courseEnrollment) {
+                            $course = $_REQUEST['course'];
+                        } else {
+                            $section = $toolbox->api_get("sections/{$_REQUEST['section']}");
+                            $course = $section['course_id'];
+                        }
+
+                        // FIXME no longer have the course ID… link is broken
+                        $toolbox->smarty_addMessage(
+                            'Success',
+                            "<a target=\"_top\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/$course/users\">$count users enrolled</a>",
+                            NotificationMessage::GOOD
+                        );
 
-                    $_REQUEST = array();
+                        $_REQUEST = array();
+                    }
                 }
+            } catch (Pest_Exception $e) {
+                $toolbox->exceptionErrorMessage($e);
+            }
+
+            /* fall through to STEP_INSTRUCTION */
+
+        case STEP_INSTRUCTIONS:
+        default:
+            if (!empty($_REQUEST['users'])) {
+                $toolbox->smarty_assign('users', $_REQUEST['users']);
             }
-        } catch (Pest_Exception $e) {
-            $toolbox->exceptionErrorMessage($e);
-        }
-
-        /* fall through to STEP_INSTRUCTION */
-
-    case STEP_INSTRUCTIONS:
-    default:
-        if (!empty($_REQUEST['users'])) {
-            $toolbox->smarty_assign('users', $_REQUEST['users']);
-        }
-        if (!empty($_REQUEST['course'])) {
-            $toolbox->smarty_assign('course', $_REQUEST['course']);
-        }
-
-        $toolbox->smarty_assign('roles', $roles);
-        $toolbox->smarty_assign('formHidden', array('step' => STEP_CONFIRM));
-        $toolbox->smarty_display(basename(__FILE__, '.php') . '/instructions.tpl');
+            if (!empty($_REQUEST['course'])) {
+                $toolbox->smarty_assign('course', $_REQUEST['course']);
+            }
+
+            $toolbox->smarty_assign('roles', $roles);
+            $toolbox->smarty_assign('formHidden', array('step' => STEP_CONFIRM));
+            $toolbox->smarty_display(basename(__FILE__, '.php') . '/instructions.tpl');
 }

Spacing +1 added lines, -2 removed lines

@@ -148,8 +148,7 @@
                         $enrollment = $toolbox->api_post(
                             (
                                 $courseEnrollment ?
-                                "/courses/{$_REQUEST['course']}/enrollments" :
-                                "/sections/{$_REQUEST['section']}/enrollments"
+                                "/courses/{$_REQUEST['course']}/enrollments" : "/sections/{$_REQUEST['section']}/enrollments"
                             ),
                             array(
                                 'enrollment[user_id]' => $user['id'],