Issue #2843890 by Da_Cloud: Coding Standards

Author: da_cloud

DEVELOPER.md

@@ -11,11 +11,14 @@ Hooks for interacting with a quiz:
 
 ## Developing new question types
 
-You need to create a new module that extends the existing question type core. The truefalse or multichoice question types are good places to start.
+You need to create a new module that extends the existing question type core.
+The truefalse or multichoice question types are good places to start.
 Here are the steps:
 
 1. Create a new module.
-2. Use your module's .install file to create the necessary tables for property and answer storage.
+2. Use your module's .install file to create the necessary tables for property
+   and answer storage.
 3. Make sure you module implements `hook_quiz_question_info()`.
 4. Define classes that extend `QuizQuestion` and `QuizQuestionResponse`.
-   For a complete example, see `multichoice.classes.inc` or `truefalse.classes.inc`.
+   For a complete example, see `multichoice.classes.inc` or
+   `truefalse.classes.inc`.

INSTALL.md

@@ -2,15 +2,17 @@
 
 1. Copy the entire quiz/ folder into your modules directory.
 
-2. Log in to your site as an administrator, and go to the Administer >> Site building >> Modules
-   section. Enable both the Quiz module, the Quiz Question module and at least one question type module
-   (for example, Multichoice).
+2. Log in to your site as an administrator, and go to the Administer >> Site
+   building >> Modules section. Enable both the Quiz module, the Quiz Question
+   module and at least one question type module (for example, Multichoice).
 
 ## How to create a quiz
 
 1. Create a basic quiz by going to Create content >> Quiz. You will have
    the opportunity to set many options if you would like.
 
-2. Finally, add questions to the quiz by clicking the "Quiz" tab and then "Manage questions". Here you can create a new question, or use the question bank to add a previously used question.
+2. Finally, add questions to the quiz by clicking the "Quiz" tab and then
+   "Manage questions". Here you can create a new question, or use the question
+   bank to add a previously used question.
 
 3. After adding questions, click the "Take" tab to take the Quiz!

README.md

@@ -1,4 +1,8 @@
-The Quiz module lets you create graded assessments in Drupal. A Quiz is given as a series of questions. Answers are then stored in the database. Scores and results are displayed during or after the quiz. Administrators can provide automatic or manual feedback. See all the features below! This module can be used as
+The Quiz module lets you create graded assessments in Drupal. A Quiz is given as
+a series of questions. Answers are then stored in the database. Scores and
+results are displayed during or after the quiz. Administrators can provide
+automatic or manual feedback. See all the features below! This module can be
+used as
 
 *   an object in a larger LMS, or a supplemental classroom activity
 *   a standalone activity (audio, video, rich text in questions/answers)
@@ -8,7 +12,8 @@ The Quiz module lets you create graded assessments in Drupal. A Quiz is given as
 ## Features
 
 *   Extensive Views, Rules integration through Entity API
-*   Integration with H5P making 20+ [content types](http://h5p.org/content-types-and-applications) available
+*   Integration with H5P making 20+
+    [content types](http://h5p.org/content-types-and-applications) available
 *   OO Question API
 *   Very configurable feedback times and options
 *   Pre-attempt questionnaires (through Field API)
@@ -30,7 +35,8 @@ The Quiz module lets you create graded assessments in Drupal. A Quiz is given as
 
 ## Question types included
 
-*   H5P - 20 [H5P content types](http://h5p.org/content-types-and-applications) available
+*   H5P - 20 [H5P content types](http://h5p.org/content-types-and-applications)
+    available
     *   4.x - included
     *   5.x - https://www.drupal.org/project/quiz_h5p
 *   True or false
@@ -40,27 +46,38 @@ The Quiz module lets you create graded assessments in Drupal. A Quiz is given as
 *   Scale
 *   Question directions
 *   Matching
-*   Drag and drop (with lines) - moved to https://www.drupal.org/project/quiz_ddlines
+*   Drag and drop (with lines) - moved to
+    https://www.drupal.org/project/quiz_ddlines
 
 ## Quiz addons
 
-*   [Charts](http://drupal.org/project/charts) - used by Quiz stats to render some useful data
-*   [jQuery Countdown](http://drupal.org/project/jquery_countdown) - provides jQuery timer for timed quizzes
-*   [Views Data Export](http://drupal.org/project/views_data_export) - export Quiz results and user answers
+*   [Charts](http://drupal.org/project/charts) - used by Quiz stats to render
+    some useful data
+*   [jQuery Countdown](http://drupal.org/project/jquery_countdown) - provides
+    jQuery timer for timed quizzes
+*   [Views Data Export](http://drupal.org/project/views_data_export) - export
+    Quiz results and user answers
 
 ## Other modules we like
 
 *   [H5P - HTML5 learning objects](https://www.drupal.org/project/h5p)
-*   [Course](https://www.drupal.org/project/course) - put multiple quizzes together
-*   [Certificate](https://www.drupal.org/project/certificate) - award a certificate after passing a Course/Quiz
+*   [Course](https://www.drupal.org/project/course) - put multiple quizzes
+    together
+*   [Certificate](https://www.drupal.org/project/certificate) - award a
+    certificate after passing a Course/Quiz
 
-Check out the [Quiz affiliated modules wiki](http://groups.drupal.org/node/177684) to see a fuller list of modules that extend quiz.
+Check out the
+[Quiz affiliated modules wiki](http://groups.drupal.org/node/177684)
+to see a fuller list of modules that extend quiz.
 
 ## Upgrading from 7.x-4.x
 
 If you do not have any custom question modules, an upgrade to 5.x is easy.
 
-**Note:** There are core issues with MySQL 5.7, but only during the upgrade. See [here](https://www.drupal.org/node/2812685#comment-11702775) if you have to use MySQL 5.7 and Drupal 7. If you do have custom question modules, they may have to be updated slightly to work with the 5.x version.
+**Note:** There are core issues with MySQL 5.7, but only during the upgrade. See
+[here](https://www.drupal.org/node/2812685#comment-11702775) if you have to use
+MySQL 5.7 and Drupal 7. If you do have custom question modules, they may have to
+be updated slightly to work with the 5.x version.
 
 ## Roadmap
 
@@ -75,16 +92,31 @@ If you do not have any custom question modules, an upgrade to 5.x is easy.
 
 ## Support
 
-We have a big community supporting Quiz, and it's getting bigger! Let's make this the best assessment engine, ever. [IRC](https://drupal.org/irc), in #drupal-course (for Quiz, Course, Certificate module support) [IRC](https://drupal.org/irc), in #drupal-edu (general edu talk) [Drupal groups](https://groups.drupal.org/quiz) [The issue queue](https://www.drupal.org/project/issues/quiz)
+We have a big community supporting Quiz, and it's getting bigger! Let's make
+this the best assessment engine, ever. [IRC](https://drupal.org/irc),
+in #drupal-course (for Quiz, Course, Certificate module support)
+[IRC](https://drupal.org/irc), in #drupal-edu (general edu talk), 
+[Drupal groups](https://groups.drupal.org/quiz),
+[The issue queue](https://www.drupal.org/project/issues/quiz)
 
 ## Help out
 
-Please continue to help out with cleaning up the issue queue! https://drupal.org/node/2280951 Have a feature request? Please open an issue in the issue queue!
+Please continue to help out with cleaning up the issue queue!
+https://drupal.org/node/2280951 Have a feature request? Please open an issue in
+the issue queue!
 
 ## Drupal 8
 
-The D7 version of this module is being cleaned up so that a migration/port to D8 will be easier.
+The D7 version of this module is being cleaned up so that a migration/port to
+D8 will be easier.
 
 ## Credits
 
-Many users have contributed lots of feature requests and bug reports. Previous maintainers also deserve a lot of credit! Join the Quiz group at http://groups.drupal.org/quiz to get involved! **Quiz is currently being sponsored by:** djdevin@[DLC Solutions](http://www.dlc-solutions.com)/[EthosCE](http://www.ethosce.com) for the 7.x-5.x branch **Previous sponsors** [The e-learning company Amendor](http://amendor.com) [The Norwegian Centre for ICT in Education](http://iktsenteret.no/english) [Norwegian Centre for Integrated Care and Telemedicine](http://telemed.no/)
+Many users have contributed lots of feature requests and bug reports. Previous
+maintainers also deserve a lot of credit! Join the Quiz group at
+http://groups.drupal.org/quiz to get involved! **Quiz is currently being
+sponsored by:** djdevin@[DLC Solutions](http://www.dlc-solutions.com)/
+[EthosCE](http://www.ethosce.com) for the 7.x-5.x branch **Previous sponsors**
+[The e-learning company Amendor](http://amendor.com),
+[The Norwegian Centre for ICT in Education](http://iktsenteret.no/english),
+[Norwegian Centre for Integrated Care and Telemedicine](http://telemed.no/)

UPGRADING.md

@@ -10,4 +10,5 @@ If you do not have any custom question modules, an upgrade to 5.x is easy.
 6. Verify that existing results work
 7. Done!
 
-If you encounter any errors during update, please post them to https://www.drupal.org/project/issues/quiz
+If you encounter any errors during update, please post them to
+https://www.drupal.org/project/issues/quiz

includes/Quiz.class.inc

@@ -2,4 +2,4 @@
 
 class Quiz extends Entity {
 
-}
+}

includes/QuizMetadataController.class.inc

@@ -2,7 +2,7 @@
 
 class QuizMetadataController extends EntityDefaultMetadataController {
 
-  function entityPropertyInfo() {
+  public function entityPropertyInfo() {
     $info = parent::entityPropertyInfo();
 
     $info['node']['properties']['quiz']['label'] = t('Quiz');

includes/QuizQuestionController.class.inc

@@ -2,4 +2,4 @@
 
 class QuizQuestionController extends EntityAPIController {
 
-}
+}

includes/QuizQuestionMetadataController.class.inc

@@ -2,7 +2,7 @@
 
 class QuizQuestionMetadataController extends EntityDefaultMetadataController {
 
-  function entityPropertyInfo() {
+  public function entityPropertyInfo() {
     $info = parent::entityPropertyInfo();
 
     $info['quiz_question']['properties']['nid']['type'] = 'node';

includes/QuizQuestionRelationship.class.inc

@@ -2,4 +2,4 @@
 
 class QuizQuestionRelationship extends Entity {
 
-}
+}

includes/QuizQuestionRelationshipController.class.inc

@@ -2,4 +2,4 @@
 
 class QuizQuestionRelationshipController extends EntityAPIController {
 
-}
+}

includes/QuizQuestionRelationshipMetadataController.class.inc

@@ -2,7 +2,7 @@
 
 class QuizQuestionRelationshipMetadataController extends EntityDefaultMetadataController {
 
-  function entityPropertyInfo() {
+  public function entityPropertyInfo() {
     $info = parent::entityPropertyInfo();
 
     $info['quiz_question_relationship']['properties']['child_nid']['type'] = 'node';

includes/QuizResult.class.inc

@@ -9,7 +9,7 @@ class QuizResult extends Entity {
    *
    * @return QuizResultAnswer[]
    */
-  function getLayout() {
+  public function getLayout() {
     $layouts = drupal_static('quiz_result_layout', array());
 
     if (!isset($layouts[$this->identifier()])) {
@@ -58,7 +58,10 @@ class QuizResult extends Entity {
     $quiz = node_load($this->nid, $this->vid);
     $user = user_load($this->uid);
 
-    return t('@user\'s @quiz result in "@title"', array('@user' => format_username($user), '@quiz' => QUIZ_NAME, '@title' => $quiz->title));
+    return t('@user\'s @quiz result in "@title"', array(
+      '@user' => format_username($user),
+      '@quiz' => QUIZ_NAME, '@title' => $quiz->title,
+    ));
   }
 
 }

includes/QuizResultAnswerMetadataController.class.inc

@@ -2,7 +2,7 @@
 
 class QuizResultAnswerMetadataController extends EntityDefaultMetadataController {
 
-  function entityPropertyInfo() {
+  public function entityPropertyInfo() {
     $info = parent::entityPropertyInfo();
 
     $info['quiz_result_answer']['properties']['result_id']['type'] = 'quiz_result';

includes/QuizResultController.class.inc

@@ -2,7 +2,7 @@
 
 class QuizResultController extends EntityAPIController {
 
-  function delete($ids, \DatabaseTransaction $transaction = NULL) {
+  public function delete($ids, \DatabaseTransaction $transaction = NULL) {
     foreach ($ids as $result_id) {
       // Fire the question types' implementations of question attempts deletion.
       $sql = 'SELECT result_id, question_nid, question_vid FROM {quiz_node_results_answers}
@@ -27,9 +27,10 @@ class QuizResultController extends EntityAPIController {
    *
    * @param type $entity
    * @param \DatabaseTransaction $transaction
-   * @return boolean
+   *
+   * @return bool
    */
-  function save($entity, \DatabaseTransaction $transaction = NULL) {
+  public function save($entity, \DatabaseTransaction $transaction = NULL) {
     if (empty($entity->time_start)) {
       $entity->time_start = REQUEST_TIME;
     }
@@ -56,8 +57,6 @@ class QuizResultController extends EntityAPIController {
       }
     }
 
-
-
     // Save the Quiz result.
     parent::save($entity, $transaction);
 
@@ -68,7 +67,6 @@ class QuizResultController extends EntityAPIController {
       // Call @deprecated hook_quiz_begin().
       module_invoke_all('quiz_begin', $quiz, $entity->result_id);
 
-
       // Create question list.
       $questions = quiz_build_question_list($quiz);
       if ($questions === FALSE) {
@@ -97,9 +95,9 @@ class QuizResultController extends EntityAPIController {
       }
 
       if (!empty($entity->build_on_last)) {
-        // Build on the last attempt the user took. If this quiz has build on last
-        // attempt set, we need to search for a previous attempt with the same
-        // version of the current quiz.
+        // Build on the last attempt the user took. If this quiz has build on
+        // last attempt set, we need to search for a previous attempt with the
+        // same version of the current quiz.
         $quiz_result_old = self::findOldResult($entity);
         // Now clone the answers on top of the new result.
         quiz_clone_quiz_result($quiz_result_old, $entity);
@@ -114,7 +112,7 @@ class QuizResultController extends EntityAPIController {
    * will return the first completed result found.
    */
   public static function findOldResult($quiz_result) {
-    $efq = new EntityFieldQuery;
+    $efq = new EntityFieldQuery();
     $result = $efq->entityCondition('entity_type', 'quiz_result')
       ->propertyCondition('uid', $quiz_result->uid)
       ->propertyCondition('nid', $quiz_result->nid)
@@ -156,10 +154,13 @@ class QuizResultController extends EntityAPIController {
       // Loop through all the questions and get their feedback.
       $question_node = node_load($question['nid'], $question['vid']);
 
-
       $instance = _quiz_question_response_get_instance($entity->result_id, $question_node);
       if ($instance->getQuizQuestion()->hasFeedback()) {
-        $qras = entity_load('quiz_result_answer', FALSE, array('result_id' => $entity->result_id, 'question_nid' => $question_node->nid, 'question_vid' => $question_node->vid));
+        $qras = entity_load('quiz_result_answer', FALSE, array(
+          'result_id' => $entity->result_id,
+          'question_nid' => $question_node->nid,
+          'question_vid' => $question_node->vid,
+        ));
         $qra = reset($qras);
 
         $feedback = $qra->view();

includes/QuizResultMetadataController.class.inc

@@ -2,7 +2,7 @@
 
 class QuizResultMetadataController extends EntityDefaultMetadataController {
 
-  function entityPropertyInfo() {
+  public function entityPropertyInfo() {
     $info = parent::entityPropertyInfo();
 
     $info['quiz_result']['properties']['nid']['type'] = 'node';

includes/views/handlers/quiz_views_handler_field_quiz_question_result_answer.inc

@@ -5,7 +5,7 @@ class quiz_views_handler_field_quiz_question_result_answer extends views_handler
   /**
    * Working with node table, adding active credit types to it.
    */
-  function construct() {
+  public function construct() {
     parent::construct();
     $this->additional_fields['result_id'] = array(
       'table' => 'quiz_node_results',
@@ -16,12 +16,12 @@ class quiz_views_handler_field_quiz_question_result_answer extends views_handler
   /**
    * Add fields, alias.
    */
-  function query() {
+  public function query() {
     $this->add_additional_fields();
     $this->field_alias = $this->aliases['result_id'];
   }
 
-  function option_definition() {
+  public function option_definition() {
     $options = parent::option_definition();
 
     $options['question_nid'] = array(
@@ -36,7 +36,7 @@ class quiz_views_handler_field_quiz_question_result_answer extends views_handler
     return $options;
   }
 
-  function pre_render(&$values) {
+  public function pre_render(&$values) {
     $this->items = array();
 
     $result_ids = array();
@@ -62,7 +62,7 @@ class quiz_views_handler_field_quiz_question_result_answer extends views_handler
     }
   }
 
-  function render_item($count, $item) {
+  public function render_item($count, $item) {
     return parent::render_items($item);
   }
 

includes/views/handlers/quiz_views_handler_filter_quiz_question.inc

@@ -5,15 +5,15 @@
  */
 class quiz_views_handler_filter_quiz_question extends views_handler_filter_boolean_operator {
 
-  function query() {
+  public function query() {
     $this->ensure_my_table();
     $field = "$this->table_alias.$this->real_field";
     $types = array_keys(quiz_get_question_types());
     $in = $this->value ? 'IN' : 'NOT IN';
     $this->query->add_where($this->options['group'], db_and()->condition($field, $types, $in));
   }
 
-  function get_value_options() {
+  public function get_value_options() {
     $this->value_options = array(
       1 => t('Yes'),
       0 => t('No'),

includes/views/quiz.views.inc

@@ -3,7 +3,6 @@
 /**
  * @file
  * This file provides metadata to the Views 2 API for views integration.
- *
  */
 
 /**