includes/notifications/controllers/class.llms.notification.controller.quiz.failed.php
<?php
/**
* Notification Controller: Quiz Failed
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 6.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Quiz Failed
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Notification_Controller_Quiz_Failed extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var string
*/
public $id = 'quiz_failed';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_quiz_failed' );
/**
* @var LLMS_Quiz
* @since 3.8.0
*/
public $quiz;
/**
* Determines if test notifications can be sent
*
* @var array
*/
protected $testable = array(
'basic' => false,
'email' => true,
);
/**
* Callback function called when a quiz is failed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param array $quiz_id WP Post ID of a LifterLMS quiz
* @return void
* @since 3.8.0
* @version 3.16.6
*/
public function action_callback( $student_id = null, $quiz_id = null ) {
$this->user_id = $student_id;
$this->post_id = $quiz_id;
$this->quiz = llms_get_post( $quiz_id );
if ( ! $this->quiz ) {
return;
}
$this->course = $this->quiz->get_course();
$this->send();
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications.
*
* @since 3.24.0
* @since 6.1.0 Fixed access of protected LLMS_Abstract_Query properties.
* Fixed issue where void was returned instead of an empty array if the type was 'email'.
*
* @param string $type Notification type [basic|email].
* @return array
*/
public function get_test_settings( $type ) {
if ( 'email' !== $type ) {
return array();
}
$query = new LLMS_Query_Quiz_Attempt(
array(
'per_page' => 25,
'status' => 'fail',
)
);
$options = array(
'' => '',
);
$attempts = array();
$results = $query->get_results();
if ( $query->has_results() ) {
foreach ( $query->get_attempts() as $attempt ) {
$quiz = llms_get_post( $attempt->get( 'quiz_id' ) );
$student = llms_get_student( $attempt->get( 'student_id' ) );
if ( $attempt && $student ) {
$options[ $attempt->get( 'id' ) ] = esc_attr( sprintf( __( 'Attempt #%1$d for Quiz "%2$s" by %3$s', 'lifterlms' ), $attempt->get( 'id' ), $quiz->get( 'title' ), $student->get_name() ) );
}
}
}
return array(
array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-placeholder' => __( 'Select a failed quiz', 'lifterlms' ),
),
'default' => '',
'id' => 'attempt_id',
'desc' => '<br/>' . __( 'Send yourself a test notification using information from the selected quiz.', 'lifterlms' ),
'options' => $options,
'title' => __( 'Send a Test', 'lifterlms' ),
'type' => 'select',
),
);
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.13.1
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'course_author':
if ( $this->course ) {
$uid = $this->course->get( 'author' );
} else {
$uid = $this->quiz->post->post_author;
}
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.24.0
*/
public function get_title() {
return __( 'Quizzes: Quiz Failed', 'lifterlms' );
}
/**
* Send a test notification to the currently logged in users
* Extending classes should redefine this in order to properly setup the controller with post_id and user_id data
*
* @param string $type notification type [basic|email]
* @param array $data array of test notification data as specified by $this->get_test_data()
* @return int|false
* @since 3.24.0
* @version 3.24.0
*/
public function send_test( $type, $data = array() ) {
if ( empty( $data['attempt_id'] ) ) {
return;
}
$attempt = new LLMS_Quiz_Attempt( $data['attempt_id'] );
$this->user_id = $attempt->get( 'student_id' );
$this->post_id = $attempt->get( 'quiz_id' );
$this->quiz = llms_get_post( $attempt->get( 'quiz_id' ) );
$this->course = $this->quiz->get_course();
return parent::send_test( $type );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'course_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Quiz_Failed::instance();