CI / Tests (PHP 8.1) (pull_request) Successful in 47s
CI / Tests (PHP 8.2) (pull_request) Successful in 47s
CI / PHPStan (pull_request) Successful in 3m12s
CI / Tests (PHP 8.3) (pull_request) Successful in 2m42s
CI / Build Plugin Zip (pull_request) Skipped
CI / No Debug Code (pull_request) Successful in 3s
CI / Coding Standards (pull_request) Successful in 2m52s
Cancelling a lesson that was already paid for now credits the student that money instead of leaving it as a manual refund, and the daily scheduled-billing scan applies any available credit against their due charges before emailing the notice. - New us_credits ledger + us_payments.credit_applied column (Payment::netDue). - PaymentService::creditForCancelledLesson issues a per-lesson share of the covering payment's total; wired into all three cancel paths (student self-cancel, instructor status update, admin student-detail cancel). - PaymentService::applyCredits draws credit down FIFO across a run's charges, marking a fully-covered charge paid-by-credit; the notice shows the credit applied and reduced total, and the admin queue shows net due. - Student detail page shows a student's credit balance and history. Ships as part of the unreleased 1.2.0 (same release as scheduled billing). Tests: composer test (585), composer lint, composer cs all pass. Co-Authored-By: Claude Opus 4.8 <[email protected]>
190 lines
7.5 KiB
PHP
190 lines
7.5 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
namespace Unsupervised\Schedular\Auth;
|
|
|
|
use Unsupervised\Schedular\Availability\AvailabilityRepository;
|
|
use Unsupervised\Schedular\Booking\BookingRepository;
|
|
use Unsupervised\Schedular\Booking\Lesson;
|
|
use Unsupervised\Schedular\GroupClass\Enrollment;
|
|
use Unsupervised\Schedular\GroupClass\EnrollmentRepository;
|
|
use Unsupervised\Schedular\Offering\OfferingRepository;
|
|
use Unsupervised\Schedular\Payment\BillingMethodResolver;
|
|
use Unsupervised\Schedular\Payment\Payment;
|
|
use Unsupervised\Schedular\Val;
|
|
|
|
class StudentController {
|
|
|
|
public function __construct(
|
|
private BookingRepository $bookings,
|
|
private AvailabilityRepository $availability,
|
|
private OfferingRepository $offerings,
|
|
private EnrollmentRepository $enrollments,
|
|
private BillingMethodResolver $resolver,
|
|
private StudentHistory $history,
|
|
private StudentActions $actions,
|
|
) {}
|
|
|
|
public function renderPage(): void {
|
|
if ( ! current_user_can( RoleManager::CAP_MANAGE_STUDENTS ) ) {
|
|
wp_die( esc_html__( 'You do not have permission to view students.', 'unsupervised-schedular' ) );
|
|
}
|
|
|
|
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- read-only student selector.
|
|
$studentId = absint( Val::int( $_GET['student_id'] ?? 0 ) );
|
|
$student = $studentId > 0 ? get_userdata( $studentId ) : false;
|
|
|
|
if ( $student && in_array( RoleManager::STUDENT, (array) $student->roles, true ) ) {
|
|
$this->renderDetail( $student );
|
|
return;
|
|
}
|
|
|
|
$students = array_map(
|
|
fn( \WP_User $user ): array => [
|
|
'id' => (int) $user->ID,
|
|
'name' => $user->display_name,
|
|
'email' => $user->user_email,
|
|
'registered' => $user->user_registered,
|
|
'upcoming' => $this->bookings->countUpcomingForStudent( (int) $user->ID ),
|
|
'enrolments' => $this->enrollments->countActiveForStudent( (int) $user->ID ),
|
|
],
|
|
array_filter(
|
|
get_users(
|
|
[
|
|
'role' => RoleManager::STUDENT,
|
|
'orderby' => 'display_name',
|
|
'order' => 'ASC',
|
|
]
|
|
),
|
|
static fn( mixed $user ): bool => $user instanceof \WP_User
|
|
)
|
|
);
|
|
|
|
$pageSlug = 'us-students';
|
|
include USC_PLUGIN_DIR . 'templates/admin/students.php';
|
|
}
|
|
|
|
private function renderDetail( \WP_User $student ): void {
|
|
$canBilling = current_user_can( RoleManager::CAP_MANAGE_BILLING );
|
|
|
|
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- routing only; each action below verifies its own nonce.
|
|
$action = sanitize_key( Val::string( wp_unslash( $_POST['usc_action'] ?? '' ) ) );
|
|
|
|
$notice = '';
|
|
$error = '';
|
|
|
|
if ( $canBilling && 'set_billing' === $action && check_admin_referer( 'usc_student_billing' ) ) {
|
|
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- nonce checked above.
|
|
$method = sanitize_key( Val::string( wp_unslash( $_POST['payment_method'] ?? '' ) ) );
|
|
if ( in_array( $method, Payment::VALID_METHODS, true ) ) {
|
|
update_user_meta( (int) $student->ID, BillingMethodResolver::META_METHOD, $method );
|
|
} else {
|
|
delete_user_meta( (int) $student->ID, BillingMethodResolver::META_METHOD );
|
|
}
|
|
}
|
|
|
|
if ( 'update_account' === $action && check_admin_referer( 'usc_student_actions' ) ) {
|
|
// phpcs:disable WordPress.Security.NonceVerification.Missing -- nonce checked above.
|
|
$displayName = sanitize_text_field( Val::string( wp_unslash( $_POST['display_name'] ?? '' ) ) );
|
|
$email = sanitize_email( Val::string( wp_unslash( $_POST['user_email'] ?? '' ) ) );
|
|
// phpcs:enable WordPress.Security.NonceVerification.Missing
|
|
|
|
$result = $this->actions->updateAccount( (int) $student->ID, $displayName, $email );
|
|
if ( $result instanceof \WP_Error ) {
|
|
$error = $result->get_error_message();
|
|
} else {
|
|
$notice = __( 'Account details updated.', 'unsupervised-schedular' );
|
|
$fresh = get_userdata( (int) $student->ID );
|
|
$student = $fresh instanceof \WP_User ? $fresh : $student;
|
|
}
|
|
}
|
|
|
|
if ( 'cancel_lesson' === $action && check_admin_referer( 'usc_student_actions' ) ) {
|
|
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- nonce checked above.
|
|
$lessonId = absint( Val::int( $_POST['lesson_id'] ?? 0 ) );
|
|
if ( $this->actions->cancelLesson( $lessonId, (int) $student->ID ) ) {
|
|
$notice = __( 'Lesson cancelled.', 'unsupervised-schedular' );
|
|
} else {
|
|
$error = __( 'This lesson could not be cancelled.', 'unsupervised-schedular' );
|
|
}
|
|
}
|
|
|
|
if ( 'withdraw_enrollment' === $action && check_admin_referer( 'usc_student_actions' ) ) {
|
|
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- nonce checked above.
|
|
$enrollmentId = absint( Val::int( $_POST['enrollment_id'] ?? 0 ) );
|
|
if ( $this->actions->withdrawEnrollment( $enrollmentId, (int) $student->ID ) ) {
|
|
$notice = __( 'Enrolment withdrawn.', 'unsupervised-schedular' );
|
|
} else {
|
|
$error = __( 'This enrolment could not be withdrawn.', 'unsupervised-schedular' );
|
|
}
|
|
}
|
|
|
|
$billingOverride = Val::string( get_user_meta( (int) $student->ID, BillingMethodResolver::META_METHOD, true ) );
|
|
$billingDefault = $this->resolver->defaultMethod();
|
|
|
|
$now = current_time( 'mysql' );
|
|
$rows = array_map(
|
|
fn( Lesson $lesson ): array => $this->lessonRow( $lesson ),
|
|
$this->bookings->findByStudent( (int) $student->ID )
|
|
);
|
|
|
|
$schedule = StudentSchedule::partition( $rows, $now );
|
|
$upcoming = $schedule['upcoming'];
|
|
$past = $schedule['past'];
|
|
|
|
$enrolments = array_map(
|
|
function ( Enrollment $enrollment ): array {
|
|
$offering = $this->offerings->findById( $enrollment->offeringId );
|
|
|
|
return [
|
|
'id' => (int) $enrollment->id,
|
|
'offering' => $offering ? $offering->title : (string) $enrollment->offeringId,
|
|
'status' => $enrollment->status,
|
|
];
|
|
},
|
|
$this->enrollments->findByStudent( (int) $student->ID )
|
|
);
|
|
|
|
$acceptances = $this->history->policyAcceptances( (int) $student->ID );
|
|
$registrationInfo = $this->history->registrationInfo( (int) $student->ID );
|
|
$intake = $this->history->intakeAnswers( (int) $student->ID );
|
|
$payments = $canBilling ? $this->history->payments( (int) $student->ID ) : [];
|
|
$credits = $canBilling ? $this->history->credits( (int) $student->ID ) : [];
|
|
$creditBalance = $canBilling ? $this->history->creditBalance( (int) $student->ID ) : 0.0;
|
|
$creditCurrency = $this->creditCurrency( $credits );
|
|
|
|
$backUrl = admin_url( 'admin.php?page=us-students' );
|
|
include USC_PLUGIN_DIR . 'templates/admin/student-detail.php';
|
|
}
|
|
|
|
/**
|
|
* Currency to label the credit balance with — taken from the student's credits
|
|
* (they share a currency in practice), defaulting to CAD when they have none.
|
|
*
|
|
* @param list<array{created_at: string, amount: float, remaining: float, currency: string, reason: string, status: string}> $credits
|
|
*/
|
|
private function creditCurrency( array $credits ): string {
|
|
return [] !== $credits ? (string) $credits[0]['currency'] : 'CAD';
|
|
}
|
|
|
|
/**
|
|
* Build a display row for a lesson (slot time, offering, instructor, status).
|
|
*
|
|
* @return array<string, mixed>
|
|
*/
|
|
private function lessonRow( Lesson $lesson ): array {
|
|
$slot = $this->availability->findById( $lesson->slotId );
|
|
$offering = null !== $lesson->offeringId ? $this->offerings->findById( $lesson->offeringId ) : null;
|
|
$instructor = get_userdata( $lesson->instructorId );
|
|
|
|
return [
|
|
'id' => (int) $lesson->id,
|
|
'start_dt' => $slot ? $slot->startDt : '',
|
|
'end_dt' => $slot ? $slot->endDt : '',
|
|
'offering' => $offering ? $offering->title : '—',
|
|
'instructor' => $instructor ? $instructor->display_name : (string) $lesson->instructorId,
|
|
'status' => $lesson->status,
|
|
];
|
|
}
|
|
}
|