smtech /
grading-analytics
| Conditions | 23 |
| Paths | 4325 |
| Total Lines | 188 |
| Code Lines | 109 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 35 | function collectStatistics($term, $api, $sql, $metadata) |
||
| 36 | { |
||
| 37 | // TODO make this configurable |
||
| 38 | $courses = $api->get( |
||
| 39 | '/accounts/132/courses', |
||
| 40 | array( |
||
| 41 | 'with_enrollments' => 'true', |
||
| 42 | 'enrollment_term_id' => $term |
||
| 43 | ) |
||
| 44 | ); |
||
| 45 | |||
| 46 | // so that everything has a consistent benchmark |
||
| 47 | $timestamp = time(); |
||
| 48 | |||
| 49 | foreach ($courses as $course) { |
||
| 50 | $statistic = array( |
||
| 51 | 'timestamp' => date(DATE_ISO8601, $timestamp), |
||
| 52 | 'course[id]' => $course['id'], |
||
| 53 | 'course[name]' => $course['name'], |
||
| 54 | 'course[account_id]' => $course['account_id'], |
||
| 55 | 'gradebook_url' => 'https://' . parse_url($metadata['CANVAS_API_URL'], PHP_URL_HOST) . "/courses/{$course['id']}/gradebook2", |
||
| 56 | 'assignments_due_count' => 0, |
||
| 57 | 'dateless_assignment_count' => 0, |
||
| 58 | 'created_after_due_count' => 0, |
||
| 59 | 'gradeable_assignment_count' => 0, |
||
| 60 | 'graded_assignment_count' => 0, |
||
| 61 | 'zero_point_assignment_count' => 0, |
||
| 62 | 'analytics_page' => $metadata['APP_URL'] . "/course-summary.php?course_id={$course['id']}" |
||
| 63 | ); |
||
| 64 | |||
| 65 | $teacherIds = array(); |
||
| 66 | $teacherNames = array(); |
||
| 67 | $teachers = $api->get( |
||
| 68 | "/courses/{$course['id']}/enrollments", |
||
| 69 | array( |
||
| 70 | 'type[]' => 'TeacherEnrollment' |
||
| 71 | ) |
||
| 72 | ); |
||
| 73 | foreach ($teachers as $teacher) { |
||
| 74 | $teacherIds[] = $teacher['user']['id']; |
||
| 75 | $teacherNames[] = $teacher['user']['sortable_name']; |
||
| 76 | } |
||
| 77 | $statistic['teacher[id]s'] = serialize($teacherIds); |
||
| 78 | $statistic['teacher[sortable_name]s'] = serialize($teacherNames); |
||
| 79 | |||
| 80 | $account = $api->get("/accounts/{$course['account_id']}"); |
||
| 81 | $statistic['account[name]'] = $account['name']; |
||
| 82 | |||
| 83 | // ignore classes with no teachers (how do they even exist? weird.) |
||
| 84 | if (count($teacherIds) != 0) { |
||
| 85 | $statistic['student_count'] = 0; |
||
| 86 | $students = $api->get( |
||
| 87 | "/courses/{$course['id']}/enrollments", |
||
| 88 | array( |
||
| 89 | 'type[]' => 'StudentEnrollment' |
||
| 90 | ) |
||
| 91 | ); |
||
| 92 | $statistic['student_count'] = $students->count(); |
||
| 93 | |||
| 94 | // ignore classes with no students |
||
| 95 | if ($statistic['student_count'] != 0) { |
||
| 96 | $assignments = $api->get( |
||
| 97 | "/courses/{$course['id']}/assignments" |
||
| 98 | ); |
||
| 99 | |||
| 100 | $gradedSubmissionsCount = 0; |
||
| 101 | $turnAroundTimeTally = 0; |
||
| 102 | $leadTimeTally = 0; |
||
| 103 | $createdModifiedHistogram = array( |
||
| 104 | HISTOGRAM_CREATED => hoursRange(0, 86400, 3600, '', 0), |
||
| 105 | HISTOGRAM_MODIFIED => hoursRange(0, 86400, 3600, '', 0) |
||
| 106 | ); |
||
| 107 | |||
| 108 | foreach ($assignments as $assignment) { |
||
| 109 | // ignore unpublished assignments |
||
| 110 | if ($assignment['published'] == true) { |
||
| 111 | // check for due dates |
||
| 112 | $dueDate = new DateTime($assignment['due_at']); |
||
| 113 | $dueDate->setTimeZone(new DateTimeZone(SCHOOL_TIME_ZONE)); |
||
| 114 | if (($timestamp - $dueDate->getTimestamp()) > 0) { |
||
| 115 | $statistic['assignments_due_count']++; |
||
| 116 | |||
| 117 | // update created_modified_histogram |
||
| 118 | $createdAt = new DateTime($assignment['created_at']); |
||
| 119 | $createdAt->setTimeZone(new DateTimeZone(SCHOOL_TIME_ZONE)); |
||
| 120 | $updatedAt = new DateTime($assignment['updated_at']); |
||
| 121 | $updatedAt->setTimeZone(new DateTimeZone(SCHOOL_TIME_ZONE)); |
||
| 122 | $createdModifiedHistogram[HISTOGRAM_CREATED][$createdAt->format('g:00 a')]++; |
||
| 123 | if ($createdAt != $updatedAt) { |
||
| 124 | $createdModifiedHistogram[HISTOGRAM_MODIFIED][$updatedAt->format('g:00 a')]++; |
||
| 125 | } |
||
| 126 | |||
| 127 | // tally lead time on the assignment |
||
| 128 | $leadTimeTally += strtotime($assignment['due_at']) - strtotime($assignment['created_at']); |
||
| 129 | |||
| 130 | // was the assignment created after it was due? |
||
| 131 | if (strtotime($assignment['due_at']) < strtotime($assignment['created_at'])) { |
||
| 132 | $statistic['created_after_due_count']++; |
||
| 133 | } |
||
| 134 | |||
| 135 | // ignore ungraded assignments |
||
| 136 | if ($assignment['grading_type'] != 'not_graded') { |
||
| 137 | $statistic['gradeable_assignment_count']++; |
||
| 138 | $hasBeenGraded = false; |
||
| 139 | |||
| 140 | // tally zero point assignments |
||
| 141 | if ($assignment['points_possible'] == '0') { |
||
| 142 | $statistic['zero_point_assignment_count']++; |
||
| 143 | } |
||
| 144 | |||
| 145 | // build submission statistic |
||
| 146 | $submissions = $api->get( |
||
| 147 | "/courses/{$course['id']}/assignments/{$assignment['id']}/submissions" |
||
| 148 | ); |
||
| 149 | foreach ($submissions as $submission) { |
||
| 150 | if ($submission['workflow_state'] == 'graded') { |
||
| 151 | if ($hasBeenGraded == false) { |
||
| 152 | $hasBeenGraded = true; |
||
| 153 | $statistic['graded_assignment_count']++; |
||
| 154 | } |
||
| 155 | $gradedSubmissionsCount++; |
||
| 156 | $turnAroundTimeTally += max( |
||
| 157 | 0, |
||
| 158 | strtotime($submission['graded_at']) - strtotime($assignment['due_at']) |
||
| 159 | ); |
||
| 160 | } |
||
| 161 | } |
||
| 162 | |||
| 163 | if (!$hasBeenGraded) { |
||
| 164 | if (array_key_exists('oldest_ungraded_assignment_due_date', $statistic)) { |
||
| 165 | if (strtotime($assignment['due_at']) < strtotime($statistic['oldest_ungraded_assignment_due_date'])) { |
||
| 166 | $statistic['oldest_ungraded_assignment_due_date'] = $assignment['due_at']; |
||
| 167 | $statistic['oldest_ungraded_assignment_url'] = $assignment['html_url']; |
||
| 168 | $statistic['oldest_ungraded_assignment_name'] = $assignment['name']; |
||
| 169 | } |
||
| 170 | } else { |
||
| 171 | $statistic['oldest_ungraded_assignment_due_date'] = $assignment['due_at']; |
||
| 172 | $statistic['oldest_ungraded_assignment_url'] = $assignment['html_url']; |
||
| 173 | $statistic['oldest_ungraded_assignment_name'] = $assignment['name']; |
||
| 174 | } |
||
| 175 | } |
||
| 176 | } |
||
| 177 | } else { |
||
| 178 | $statistic['dateless_assignment_count']++; |
||
| 179 | } |
||
| 180 | } |
||
| 181 | } |
||
| 182 | |||
| 183 | $statistic['created_modified_histogram'] = serialize($createdModifiedHistogram); |
||
| 184 | |||
| 185 | // calculate average submissions graded per assignment (if non-zero) |
||
| 186 | if ($statistic['gradeable_assignment_count'] && $statistic['student_count']) { |
||
| 187 | $statistic['average_submissions_graded'] = $gradedSubmissionsCount / ($statistic['gradeable_assignment_count'] * $statistic['student_count']); |
||
| 188 | } |
||
| 189 | |||
| 190 | // calculate the average lead-time on assignments |
||
| 191 | if ($statistic['assignments_due_count']) { |
||
| 192 | $statistic['average_assignment_lead_time'] = $leadTimeTally / $statistic['assignments_due_count'] / 60 / 60 / 24; |
||
| 193 | } |
||
| 194 | |||
| 195 | // calculate average grading turn-around per submission |
||
| 196 | if ($gradedSubmissionsCount) { |
||
| 197 | $statistic['average_grading_turn_around'] = $turnAroundTimeTally / $gradedSubmissionsCount / 60 / 60 / 24; |
||
| 198 | } |
||
| 199 | |||
| 200 | $query = "INSERT INTO `course_statistics`"; |
||
| 201 | $fields = array(); |
||
| 202 | $values = array(); |
||
| 203 | while (list($field, $value) = each($statistic)) { |
||
| 204 | $fields[] = $field; |
||
| 205 | $values[] = $value; |
||
| 206 | } |
||
| 207 | $query .= ' (`' . implode('`, `', $fields) . "`) VALUES ('" . implode("', '", $values) . "')"; |
||
| 208 | $result = $sql->query($query); |
||
| 209 | /* displayError( |
||
| 210 | array( |
||
| 211 | 'gradedSubmissionsCount' => $gradedSubmissionsCount, |
||
| 212 | 'turnAroundTimeTally' => $turnAroundTimeTally, |
||
| 213 | 'statistic' => $statistic, |
||
| 214 | 'query' => $query, |
||
| 215 | 'result' => $result |
||
| 216 | ), |
||
| 217 | true |
||
| 218 | ); */ |
||
| 219 | } |
||
| 220 | } |
||
| 221 | } |
||
| 222 | } |
||
| 223 | |||
| 255 |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.