GRADEME-153: PHPCS/CBF syntax cleanup.

logan-reynolds · logan-reynolds · commit 41f27ccf284f · 2022-02-10T21:39:48.000-06:00
diff --git a/block_grade_me.php b/block_grade_me.php
@@ -43,7 +43,7 @@ public function get_content() {
             return $this->content;
         }
 
-        require_once($CFG->dirroot.'/blocks/grade_me/lib.php');
+        require_once($CFG->dirroot . '/blocks/grade_me/lib.php');
         $PAGE->requires->jquery();
         $PAGE->requires->js('/blocks/grade_me/javascript/grademe.js');
 
@@ -101,11 +101,11 @@ public function get_content() {
 
             foreach ($enabledplugins as $plugin => $a) {
                 if (has_capability($a['capability'], $context)) {
-                    $fn = 'block_grade_me_query_'.$plugin;
+                    $fn = 'block_grade_me_query_' . $plugin;
                     $pluginfn = $fn($gradebookusers);
                     if ($pluginfn !== false) {
                         list($sql, $inparams) = $fn($gradebookusers);
-                        $query = block_grade_me_query_prefix().$sql.block_grade_me_query_suffix($plugin);
+                        $query = block_grade_me_query_prefix() . $sql . block_grade_me_query_suffix($plugin);
                         $values = array_merge($inparams, $params);
                         $rs = $DB->get_recordset_sql($query, $values);
 
@@ -115,8 +115,8 @@ public function get_content() {
                                 $iteminstance = $r->iteminstance;
                                 $userid = $r->userid;
                                 $attemptnumber = $r->attemptnumber;
-                                $sql = 'select MAX(attemptnumber) from {assign_submission} where assignment = '.$iteminstance .
-                                       ' and userid = '.$userid;
+                                $sql = 'select MAX(attemptnumber) from {assign_submission} where assignment = ' . $iteminstance .
+                                       ' and userid = ' . $userid;
                                 $maxattempt = $DB->get_field_sql($sql);
                                 if ($maxattempt == $attemptnumber) {
                                     $gradeables = block_grade_me_array($gradeables, $r);
@@ -157,11 +157,11 @@ public function get_content() {
         if (!empty($this->content->text)) {
              // Expand/Collapse button.
              $expand = '<button class="btn btn-sm btn-outline-secondary" type="button" onclick="togglecollapseall();">' .
-                get_string('expand', 'block_grade_me').'</button>';
+                get_string('expand', 'block_grade_me') . '</button>';
 
-            $this->content->text = $expand.'<dl>'.$this->content->text.'</dl><div class="excess">'.$additional.'</div>';
+            $this->content->text = $expand . '<dl>' . $this->content->text . '</dl><div class="excess">' . $additional . '</div>';
         } else if (empty($this->content->text) && $showempty) {
-            $this->content->text .= '<div class="excess">'.get_string('nothing', 'block_grade_me').'</div>'."\n";
+            $this->content->text .= '<div class="excess">' . get_string('nothing', 'block_grade_me') . '</div>' . "\n";
         }
 
         return $this->content;
diff --git a/db/access.php b/db/access.php
@@ -48,4 +48,4 @@
 
         'clonepermissionsfrom' => 'moodle/site:manageblocks'
     )
-);
+);
diff --git a/db/upgrade.php b/db/upgrade.php
@@ -79,7 +79,7 @@ function xmldb_block_grade_me_upgrade($oldversion, $block) {
 
     if ($oldversion < 2015102402) {
         if (!$dbman->table_exists('block_grade_me_quiz_ngrade')) {
-            $dbman->install_one_table_from_xmldb_file(__DIR__.'/install.xml', 'block_grade_me_quiz_ngrade');
+            $dbman->install_one_table_from_xmldb_file(__DIR__ . '/install.xml', 'block_grade_me_quiz_ngrade');
         }
         $DB->delete_records('block_grade_me_quiz_ngrade');
         // Pre populate block_grade_me_quiz_ngrade table.
diff --git a/lib.php b/lib.php
@@ -54,8 +54,8 @@ function block_grade_me_query_suffix($mod) {
     $query = " AND bgm.courseid = ? AND bgm.itemmodule = '$mod') allitems";
     $maxage = get_config(null, 'block_grade_me_maxage');
     if (!empty($maxage) && is_numeric($maxage)) {
-        $maxtimesubmitted = time()-((int)$maxage * DAYSECS);
-        $query .= " WHERE allitems.timesubmitted >= ".$maxtimesubmitted;
+        $maxtimesubmitted = time() - ((int)$maxage * DAYSECS);
+        $query .= " WHERE allitems.timesubmitted >= " . $maxtimesubmitted;
     }
     return $query;
 }
@@ -69,12 +69,12 @@ function block_grade_me_enabled_plugins() {
     $enabledplugins = array();
     $plugins = get_list_of_plugins('blocks/grade_me/plugins');
     foreach ($plugins as $plugin) {
-        $pluginfile = $CFG->dirroot.'/blocks/grade_me/plugins/'.$plugin.'/'.$plugin.'_plugin.php';
+        $pluginfile = $CFG->dirroot . '/blocks/grade_me/plugins/' . $plugin . '/' . $plugin . '_plugin.php';
         if (file_exists($pluginfile)) {
-            $enablekey = 'block_grade_me_enable'.$plugin;
+            $enablekey = 'block_grade_me_enable' . $plugin;
             if (isset($CFG->$enablekey) && $CFG->$enablekey == true) {
                 include_once($pluginfile);
-                $requiredcapabilityfunc = 'block_grade_me_required_capability_'.$plugin;
+                $requiredcapabilityfunc = 'block_grade_me_required_capability_' . $plugin;
                 if (function_exists($requiredcapabilityfunc)) {
                     $enabledplugins = array_merge($enabledplugins, $requiredcapabilityfunc());
                 }
@@ -115,29 +115,29 @@ function block_grade_me_tree($course) {
     // Get time format string.
     $datetimestring = get_string('datetime', 'block_grade_me', array());
     // Grading image.
-    $gradeimg = $CFG->wwwroot.'/blocks/grade_me/pix/check_mark.png';
+    $gradeimg = $CFG->wwwroot . '/blocks/grade_me/pix/check_mark.png';
     // Define text variable.
     $text = '';
 
     $courseid = $course['meta']['courseid'];
     $coursename = $course['meta']['coursename'];
     unset($course['meta']);
 
-    $gradebooklink = $CFG->wwwroot.'/grade/report/index.php?id='.$courseid.'" title="'.
+    $gradebooklink = $CFG->wwwroot . '/grade/report/index.php?id=' . $courseid . '" title="' .
         get_string('link_gradebook_icon', 'block_grade_me', array('course_name' => $coursename));
     $altgradebook = get_string('alt_gradebook', 'block_grade_me', array('course_name' => $coursename));
     $gradebookicon = $OUTPUT->pix_icon('i/grades', $altgradebook, null, array('class' => 'gm_icon'));
-    $courselink = $CFG->wwwroot.'/course/view.php?id='.$courseid;
+    $courselink = $CFG->wwwroot . '/course/view.php?id=' . $courseid;
     $coursetitle = get_string('link_gradebook', 'block_grade_me', array('course_name' => $coursename));
-    $text .= '<div><dt id="courseid'.$courseid.'" class="cmod">
+    $text .= '<div><dt id="courseid' . $courseid . '" class="cmod">
                 <div tabindex=0 class="toggle open fa fa-caret-right" aria-hidden="true"
-                    onclick="$(\'dt#courseid'.$courseid.' > div.toggle\')
-                    .toggleClass(\'open\');$(\'dt#courseid'.$courseid.' ~ dd\')
+                    onclick="$(\'dt#courseid' . $courseid . ' > div.toggle\')
+                    .toggleClass(\'open\');$(\'dt#courseid' . $courseid . ' ~ dd\')
                     .toggleClass(\'block_grade_me_hide\');">
                         <span class="sr-only">Toggle Section</span>
                 </div>
-                <a href="'.$courselink.'" class="grademe-course-name"'.$coursetitle.'">'.$coursename.'</a>
-              </dt>'."\n";
+                <a href="' . $courselink . '" class="grademe-course-name"' . $coursetitle . '">' . $coursename . '</a>
+              </dt>' . "\n";
     $text .= "\n";
 
     ksort($course);
@@ -148,31 +148,32 @@ function block_grade_me_tree($course) {
         $coursemoduleid = $item['meta']['coursemoduleid'];
         unset($item['meta']);
 
-        $modulelink = $CFG->wwwroot.'/mod/'.$itemmodule.'/view.php?id='.$coursemoduleid;
+        $modulelink = $CFG->wwwroot . '/mod/' . $itemmodule . '/view.php?id=' . $coursemoduleid;
         $gradelink = $CFG->wwwroot;
         if ($itemmodule == 'assignment') {
-            $gradelink .= '/mod/assignment/submissions.php?id='.$coursemoduleid;
+            $gradelink .= '/mod/assignment/submissions.php?id=' . $coursemoduleid;
         } else if ($itemmodule == 'quiz') {
-            $gradelink .= '/mod/quiz/report.php?id='.$coursemoduleid;
+            $gradelink .= '/mod/quiz/report.php?id=' . $coursemoduleid;
         } else {
             $gradelink = $modulelink;
         }
         $moduletitle = get_string('link_mod', 'block_grade_me', array('mod_name' => $itemmodule));
         $moduleicon = $OUTPUT->pix_icon('icon', $moduletitle, $itemmodule, array('class' => 'gm_icon'));
 
-        $text .= '<dd id="cmid'.$coursemoduleid.'" class="module">'."\n";  // Open module.
-        $text .= '<div class="dd-wrap">'."\n";
+        $text .= '<dd id="cmid' . $coursemoduleid . '" class="module">' . "\n";  // Open module.
+        $text .= '<div class="dd-wrap">' . "\n";
         $text .= '<div tabindex=0 class="toggle fa fa-caret-right" aria-hidden="true"
-                    onclick="$(\'dd#cmid'.$coursemoduleid.' > div div.toggle\')
-                    .toggleClass(\'open\');$(\'dd#cmid'.$coursemoduleid.' > ul\')
+                    onclick="$(\'dd#cmid' . $coursemoduleid . ' > div div.toggle\')
+                    .toggleClass(\'open\');$(\'dd#cmid' . $coursemoduleid . ' > ul\')
                     .toggleClass(\'block_grade_me_hide\');">
                         <span class="sr-only">Toggle Section</span>
-                    </div>'."\n";
-        $text .= '<a href="'.$gradelink.'" class="grademe-course-icon" title="'.$moduletitle.'">'.$moduleicon.'</a>'."\n";
-        $text .= '<a href="'.$modulelink.'" class="grademe-mod-name" title="'.$moduletitle.'">'.$itemname.'</a>'."\n";
-        $text .= '<span class="badge badge-pill badge-primary">'.count($item).'</span>'."\n";
-        $text .= '</div>'."\n";
-        $text .= '<ul class="gradable-list block_grade_me_hide">'."\n";
+                    </div>' . "\n";
+        $text .= '<a href="' . $gradelink . '" class="grademe-course-icon" title="'
+                 . $moduletitle . '">' . $moduleicon . '</a>' . "\n";
+        $text .= '<a href="' . $modulelink . '" class="grademe-mod-name" title="' . $moduletitle . '">' . $itemname . '</a>' . "\n";
+        $text .= '<span class="badge badge-pill badge-primary">' . count($item) . '</span>' . "\n";
+        $text .= '</div>' . "\n";
+        $text .= '<ul class="gradable-list block_grade_me_hide">' . "\n";
 
         ksort($item);
 
@@ -183,21 +184,22 @@ function block_grade_me_tree($course) {
 
             $submissionlink = $CFG->wwwroot;
             if ($itemmodule == 'assignment') {
-                $submissionlink .= '/mod/assignment/submissions.php?id='.$coursemoduleid.'&amp;userid=' . $userid .
+                $submissionlink .= '/mod/assignment/submissions.php?id=' . $coursemoduleid . '&amp;userid=' . $userid .
                     '&amp;mode=single&amp;filter=0&amp;offset=0';
             } else if ($itemmodule == 'assign') {
                 $submissionlink .= "/mod/assign/view.php?id=$coursemoduleid&action=grade&userid=$userid";
             } else if ($itemmodule == 'data') {
-                $submissionlink .= '/mod/data/view.php?rid='.$submissionid.'&amp;mode=single';
+                $submissionlink .= '/mod/data/view.php?rid=' . $submissionid . '&amp;mode=single';
             } else if ($itemmodule == 'forum') {
                 $forumdiscussionid = $submission['meta']['forum_discussion_id'];
-                $submissionlink .= '/mod/forum/discuss.php?d='.$forumdiscussionid.'#p'.$submissionid;
+                $submissionlink .= '/mod/forum/discuss.php?d=' . $forumdiscussionid . '#p' . $submissionid;
             } else if ($itemmodule == 'glossary') {
-                $submissionlink .= '/mod/glossary/view.php?id='.$coursemoduleid.'#postrating'.$submissionid;
+                $submissionlink .= '/mod/glossary/view.php?id=' . $coursemoduleid . '#postrating' . $submissionid;
             } else if ($itemmodule == 'quiz') {
-                $submissionlink .= '/mod/quiz/review.php?attempt='.$submissionid;
+                $submissionlink .= '/mod/quiz/review.php?attempt=' . $submissionid;
             } else if ($itemmodule == 'lesson') {
-                $submissionlink .= '/mod/lesson/essay.php?id='.$coursemoduleid.'&mode=grade&attemptid='.$submissionid.'&sesskey='.sesskey();
+                $submissionlink .= '/mod/lesson/essay.php?id=' . $coursemoduleid . '&mode=grade&attemptid='
+                                   . $submissionid . '&sesskey=' . sesskey();
             }
 
             unset($submission['meta']);
@@ -208,28 +210,29 @@ function block_grade_me_tree($course) {
             $user = $DB->get_record('user', array('id' => $userid));
 
             $userfirst = $user->firstname;
-            $userfirstlast = $user->firstname.' '.$user->lastname;
+            $userfirstlast = $user->firstname . ' ' . $user->lastname;
             $userprofiletitle = get_string('link_user_profile', 'block_grade_me', array('first_name' => $userfirst));
 
             $text .= '<li class="gradable">';  // Open gradable.
-            $text .= '<a class="gradable-icon" href="'.$submissionlink.'" title="'.$submissiontitle.'">
+            $text .= '<a class="gradable-icon" href="' . $submissionlink . '" title="' . $submissiontitle . '">
                         <i class="fa fa-check" aria-hidden="true"></i>
-                        <span class="sr-only">'.$submissiontitle.'</span>
+                        <span class="sr-only">' . $submissiontitle . '</span>
                       </a>';
             $text .= '<div class="gradable-wrap">';
-            $text .= '<a class="gradable-user" href="'.$CFG->wwwroot.'/user/view.php?id='.$userid.'&amp;course='.$courseid.'" title="'.$userprofiletitle.'">';
+            $text .= '<a class="gradable-user" href="' . $CFG->wwwroot . '/user/view.php?id=' . $userid
+                     . '&amp;course=' . $courseid . '" title="' . $userprofiletitle . '">';
             $text .= $userfirstlast;
             $text .= '</a>';
-            $text .= '<div class="gradable-date">'.userdate($timesubmitted, $datetimestring).'</div>';
+            $text .= '<div class="gradable-date">' . userdate($timesubmitted, $datetimestring) . '</div>';
             $text .= '</div>';
-            $text .= '</li>'."\n";  // End gradable.
+            $text .= '</li>' . "\n";  // End gradable.
         }
 
-        $text .= '</ul>'."\n";
-        $text .= '</dd>'."\n";  // Close module.
+        $text .= '</ul>' . "\n";
+        $text .= '</dd>' . "\n";  // Close module.
     }
 
-    $text .= '</div>'."\n";
+    $text .= '</div>' . "\n";
 
     return $text;
 }
@@ -260,7 +263,7 @@ function block_grade_me_cache_grade_data() {
         $lastrun = '0';
     }
 
-    // See if the block has been added course wide
+    // See if the block has been added course wide.
     $paramsystem = array('site-index', 'my-index', '*');
     $sqlsystem = "SELECT count(b.id) bcount
                    FROM {block_instances} b
@@ -312,7 +315,7 @@ function block_grade_me_cache_grade_data() {
                          AND u.deleted = 0";
         $validcourse = $DB->count_records_sql($sqlcourse, array('courseid' => $cid));
         if ($validcourse > '0') {
-            $paramscourse =array();
+            $paramscourse = array();
             $paramscourse['itemtype'] = 'mod';
 
             $paramscourse['id'] = $cid;
@@ -339,7 +342,7 @@ function block_grade_me_cache_grade_data() {
                     'iteminstance'  => $rec->iteminstance,
                     'courseid'      => $rec->courseid
                 );
-                $fragment = 'itemtype = :itemtype AND itemmodule = :itemmodule AND '.
+                $fragment = 'itemtype = :itemtype AND itemmodule = :itemmodule AND ' .
                             'iteminstance = :iteminstance AND courseid = :courseid';
                 $params = array(
                     'itemname' => $rec->itemname,
@@ -362,12 +365,12 @@ function block_grade_me_cache_grade_data() {
                     $DB->update_record('block_grade_me', $params);
                 }
             }
-            /**
-             * Build the quiz table per course. Cannot do this in bulk
-             * because temp tables can cause large disk usage.
-             * First get the list of quiz attempts for a course with manualgraded questions,
-             * and that have active students in them.
-             **/
+            //
+            // Build the quiz table per course. Cannot do this in bulk
+            // because temp tables can cause large disk usage.
+            // First get the list of quiz attempts for a course with manualgraded questions,
+            // and that have active students in them.
+            //
 
             $sqlquizlist = "SELECT mq.id quizid, mqa.id quiattemptid, mqa.userid, mq.course, mqa.uniqueid,
                             qna.id questionattemptid
diff --git a/plugins/data/data_plugin.php b/plugins/data/data_plugin.php
@@ -57,4 +57,4 @@ function block_grade_me_query_data($gradebookusers) {
              )";
 
     return array($query, $inparams);
-}
+}
diff --git a/plugins/lesson/lesson_plugin.php b/plugins/lesson/lesson_plugin.php
@@ -52,4 +52,4 @@ function block_grade_me_query_lesson($gradebookusers) {
        WHERE la.userid $insql AND l.grade > 0 AND la.useranswer LIKE ?";
     $inparams[] = '%s:6:"graded";i:0%';
     return array($query, $inparams);
-}
+}
diff --git a/plugins/quiz/quiz_plugin.php b/plugins/quiz/quiz_plugin.php
@@ -14,8 +14,10 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+defined('MOODLE_INTERNAL') || die();
+
 global $CFG;
-require_once($CFG->dirroot.'/question/engine/states.php');
+require_once($CFG->dirroot . '/question/engine/states.php');
 
 require_once($CFG->dirroot . '/question/engine/lib.php');
 
diff --git a/plugins/turnitintooltwo/turnitintooltwo_plugin.php b/plugins/turnitintooltwo/turnitintooltwo_plugin.php
@@ -48,4 +48,4 @@ function block_grade_me_query_turnitintooltwo($gradebookusers) {
    LEFT JOIN {block_grade_me} bgm ON bgm.courseid = t.course AND bgm.iteminstance = t.id
        WHERE ts.userid $insql AND t.grade > 0 AND ts.submission_grade IS NOT NULL";
     return array($query, $inparams);
-}
+}
diff --git a/quiz_update_ngrade.php b/quiz_update_ngrade.php
@@ -23,9 +23,9 @@
  * @copyright  (C) 2016 Remote Learner.net Inc http://www.remote-learner.net
  */
 
-require_once(__DIR__.'/../../config.php');
+require_once(__DIR__ . '/../../config.php');
 
-$PAGE->set_url(new moodle_url($CFG->wwwroot.'/blocks/grade_me/quiz_update_ngrade.php'));
+$PAGE->set_url(new moodle_url($CFG->wwwroot . '/blocks/grade_me/quiz_update_ngrade.php'));
 $PAGE->set_pagelayout('admin');
 $PAGE->set_context(context_system::instance());
 $title = get_string("quiz_update_ngrade_complete", "block_grade_me");
@@ -41,4 +41,4 @@
 $record = $DB->get_record_sql("SELECT COUNT(DISTINCT questionattemptstepid) count FROM {block_grade_me_quiz_ngrade}");
 echo \html_writer::tag('h2', $title);
 echo \html_writer::tag('p', get_string("quiz_update_ngrade_success", "block_grade_me", $record->count));
-echo $OUTPUT->footer();
+echo $OUTPUT->footer();
diff --git a/settings.php b/settings.php
diff --git a/tests/behat/behat_block_grade_me.php b/tests/behat/behat_block_grade_me.php
diff --git a/tests/grade_me_test.php b/tests/grade_me_test.php

Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,4 @@`
`48`	`48`
`49`	`49`	`'clonepermissionsfrom' => 'moodle/site:manageblocks'`
`50`	`50`	`)`
`51`		`-);`
	`51`	`+);`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ function xmldb_block_grade_me_upgrade($oldversion, $block) {`
`79`	`79`
`80`	`80`	`if ($oldversion < 2015102402) {`
`81`	`81`	`if (!$dbman->table_exists('block_grade_me_quiz_ngrade')) {`
`82`		`- $dbman->install_one_table_from_xmldb_file(__DIR__.'/install.xml', 'block_grade_me_quiz_ngrade');`
	`82`	`+ $dbman->install_one_table_from_xmldb_file(__DIR__ . '/install.xml', 'block_grade_me_quiz_ngrade');`
`83`	`83`	`}`
`84`	`84`	`$DB->delete_records('block_grade_me_quiz_ngrade');`
`85`	`85`	`// Pre populate block_grade_me_quiz_ngrade table.`
-Original file line number
+Diff line change
              )";
     return array($query, $inparams);
 -}
 +}