<?php
/**
 * The LMS family's event types, shared by LearnDash and LifterLMS.
 *
 * @package ActivityLog404
 */

namespace ActivityLog404\Events\Integrations;

defined( 'ABSPATH' ) || exit;

/**
 * One set of types for every LMS. Lesson and topic completions are not
 * logged (a course of forty lessons is forty rows per student); the course
 * completion stands for them. A named deferral.
 */
final class Lms {

	public const ENROLLED         = 'lms_enrolled';
	public const UNENROLLED       = 'lms_unenrolled';
	public const COURSE_COMPLETED = 'lms_course_completed';
	public const QUIZ_COMPLETED   = 'lms_quiz_completed';
	public const GROUP_JOINED     = 'lms_group_joined';
	public const GROUP_LEFT       = 'lms_group_left';

	/**
	 * @return array<string, string>
	 */
	public static function event_types(): array {
		return array(
			self::ENROLLED         => 'Course Enrolment',
			self::UNENROLLED       => 'Course Unenrolment',
			self::COURSE_COMPLETED => 'Course Completed',
			self::QUIZ_COMPLETED   => 'Quiz Completed',
			self::GROUP_JOINED     => 'Added to Group',
			self::GROUP_LEFT       => 'Removed from Group',
		);
	}

	/**
	 * A quiz score as a number for details, or null.
	 *
	 * @param mixed $value A percentage or grade.
	 */
	public static function score( $value ): ?float {
		return is_numeric( $value ) ? round( (float) $value, 2 ) : null;
	}
}