woothemes / sensei

includes/class-sensei-emails.php

Doc Comments +5 added lines, -1 removed lines

@@ -40,6 +40,7 @@ 
 	 * Constructor for the email class hooks in all emails that can be sent.
 	 *
 	 * @access public
+	 * @param string $file
 	 * @return void
 	 */
 	function __construct( $file ) {
@@ -140,7 +141,7 @@ 
 	 * Wraps a message in the sensei mail template.
 	 *
 	 * @access public
-	 * @param mixed $content
+	 * @param null|string $content
 	 * @return string
 	 */
 	function wrap_message( $content ) {
@@ -198,6 +199,9 @@ 
 		remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
 	}
 
+	/**
+	 * @param string $email_template
+	 */
 	function get_content( $email_template ) {
 
 		$message = $this->load_template( $email_template );

includes/class-sensei-grading.php

Doc Comments +5 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
 	 * Constructor
 	 * @since  1.3.0
      *
-     * @param $file
+     * @param string $file
 	 */
 	public function __construct ( $file ) {
 		$this->name = __( 'Grading', 'woothemes-sensei' );
@@ -330,6 +330,7 @@ 
 	/**
 	 * Return array of valid statuses for either Course or Lesson
 	 * @since  1.7.0
+	 * @param string $type
 	 * @return array
 	 */
 	public function get_stati( $type ) {
@@ -529,7 +530,7 @@ 
      * the grades as the Grader selected theme and saves the total grade and
      * individual question grades.
      *
-     * @return bool
+     * @return false|null
      */
     public function admin_process_grading_submission() {
 
@@ -906,8 +907,8 @@ 
      * Grading logic specifically for the gap fill questions
      *
      * @since 1.9.0
-     * @param $question_id
-     * @param $user_answer
+     * @param integer $question_id
+     * @param string $user_answer
      *
      * @return bool | int false or the grade given to the user answer
      */

includes/class-sensei-list-table.php

Doc Comments +1 added lines

@@ -44,6 +44,7 @@
 	/**
 	 * Constructor
 	 * @since  1.2.0
+	 * @param string $token
 	 * @return  void
 	 */
 	public function __construct ( $token ) {

includes/class-sensei-messages.php

Doc Comments +1 added lines, -1 removed lines

@@ -299,7 +299,7 @@
      * @param  integer $sender_id   ID of sender
      * @param  integer $receiver_id ID of receiver
      * @param  string  $message     Message content
-     * @param  string  $post_id     ID of post related to message
+     * @param  integer  $post_id     ID of post related to message
      * @return mixed                Message ID on success, boolean false on failure
      */
     private function save_new_message_post( $sender_id = 0, $receiver_id = 0, $message = '', $post_id = 0 ) {

includes/class-sensei-question.php

Doc Comments +2 added lines, -2 removed lines

@@ -402,7 +402,7 @@ 
      * This function simply loads the question type template
      *
      * @since 1.9.0
-     * @param $question_type
+     * @param string $question_type
      */
     public static function load_question_template( $question_type ){
 
@@ -487,7 +487,7 @@ 
      * Get the questions media markup
      *
      * @since 1.9.0
-     * @param $question_id
+     * @param string $question_id
      * @return string
      */
     public static function get_the_question_media( $question_id ){

includes/class-sensei-quiz.php

Doc Comments +4 added lines, -5 removed lines

@@ -123,7 +123,7 @@ 
      *
      * This function hooks into the quiz page and accepts the answer form save post.
      * @since 1.7.3
-     * @return bool $saved;
+     * @return boolean|null $saved;
      */
     public function user_save_quiz_answers_listener(){
 
@@ -214,7 +214,7 @@ 
 	 * @param int $lesson_id
 	 * @param int $user_id
 	 *
-	 * @return array $answers or false
+	 * @return boolean $answers or false
 	 */
 	public function get_user_answers( $lesson_id, $user_id ){
 
@@ -707,7 +707,7 @@ 
       *      @type int $question_id
       *      @type int $question_grade
       * }
-      * @param $lesson_id
+      * @param integer $lesson_id
       * @param $user_id (Optional) will use the current user if not supplied
       *
       * @return bool
@@ -754,7 +754,7 @@ 
       *
       * @since 1.7.4
       *
-      * @param $lesson_id
+      * @param integer $lesson_id
       * @param $user_id (Optional) will use the current user if not supplied
       *
       * @return array $user_quiz_grades or false if none exists for this users
@@ -1090,7 +1090,6 @@ 
       * Filter the single title and add the Quiz to it.
       *
       * @param string $title
-      * @param int $id title post id
       * @return string $quiz_title
       */
      public static function single_quiz_title( $title, $post_id ){

includes/class-sensei-settings-api.php

Doc Comments +1 added lines, -1 removed lines

@@ -793,7 +793,7 @@
 	 * Return an array of field types expecting an array value returned.
 	 * @access protected
 	 * @since  1.0.0
-	 * @return void
+	 * @return string[]
 	 */
 	protected function get_array_field_types () {
 		return array( 'multicheck' );

includes/class-sensei-teacher.php

Doc Comments +3 added lines, -4 removed lines

@@ -363,7 +363,7 @@ 
      *
      * @param $course_id
      * @param $new_teacher_id
-     * @return void
+     * @return false|null
      */
     public static function update_course_modules_author( $course_id ,$new_teacher_id ){
 
@@ -454,7 +454,7 @@ 
      * @since 1.8.0
      * @access public
      * @parameters
-     * @return array $users user id array
+     * @return boolean $users user id array
      */
     public function update_course_lessons_author ( $course_id, $new_author  ){
 
@@ -843,8 +843,7 @@ 
      * This function hooks into wp_insert_post
      *
      * @since 1.8.0
-     * @param int $course_id
-     * @return bool
+     * @return false|null
      */
     public function notify_admin_teacher_course_creation( $new_status, $old_status, $post ){
 

includes/class-sensei-updates.php

Doc Comments +8 added lines, -8 removed lines

@@ -455,7 +455,7 @@ 
 	 *
 	 * @since  1.1.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function assign_role_caps() {
 		foreach ( $this->parent->post_types->role_caps as $role_cap_set  ) {
@@ -480,7 +480,7 @@ 
 	 *
 	 * @since 1.3.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function set_default_quiz_grade_type() {
 		$args = array(	'post_type' 		=> 'quiz',
@@ -502,7 +502,7 @@ 
 	 *
 	 * @since 1.3.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function set_default_question_type() {
 		$args = array(	'post_type' 		=> 'question',
@@ -532,7 +532,7 @@ 
 	 *
 	 * @since 1.3.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function update_question_answer_data( $n = 50, $offset = 0 ) {
 
@@ -1429,8 +1429,8 @@ 
 	 *
 	 * @global type $woothemes_sensei
 	 * @global type $wpdb
-	 * @param type $n
-	 * @param type $offset
+	 * @param integer $n
+	 * @param integer $offset
 	 * @return boolean
 	 */
 	function status_changes_repair_course_statuses( $n = 50, $offset = 0 ) {
@@ -1674,8 +1674,8 @@ 
 	 * Update the comment counts for all Courses and Lessons now that sensei comments will no longer be counted.
 	 *
 	 * @global type $wpdb
-	 * @param type $n
-	 * @param type $offset
+	 * @param integer $n
+	 * @param integer $offset
 	 * @return boolean
 	 */
 	public function update_comment_course_lesson_comment_counts( $n = 50, $offset = 0 ) {