Streamlining Student Interaction with Tutor Controller

Welcome to the next step in our journey of building a personal tutor service. In the previous lesson, we explored the TutorService class, which acts as a bridge between managing tutoring session data and generating responses. Now, we will focus on the TutorController, a crucial component that manages tutoring sessions and handles student queries by interacting with both the model and service layers. The controller is responsible for orchestrating the flow of data between the student interface and the backend services, ensuring that student interactions are processed efficiently and effectively.

Implementing the TutorController Class

The TutorController class is the heart of our controller layer. It is responsible for managing tutoring sessions and processing student queries. Let's begin by examining the structure of the TutorController class. PHP<?php require_once __DIR__ . '/../../Services/TutorService.php'; use app\Service\TutorService; class TutorController { private array $testSession = []; private TutorService $tutorService; public function __construct() { $this->tutorService = new TutorService(); } } In this snippet, we: Use the TutorService class for managing tutoring data and processing student queries. Initialize the TutorController with an instance of TutorService. Create a $testSession array to simulate session management for testing purposes. The $testSession is a simple array used to simulate session management for testing purposes. It allows us to mimic the behavior of student sessions typically managed by a web application or browser. In a real-world scenario, student sessions help track individual students as they interact with a web application, maintaining their state and data across multiple requests. By using $testSession, we can focus on testing the core functionality of the TutorController without needing a full session management system. Once we are confident that the controller works correctly, we will later integrate a more robust session management solution when developing our RESTful API.

Ensuring Student Session

Before creating a tutoring session, we need to ensure that a student session exists. The ensureStudentSession method checks if a student ID is present in the $testSession. If not, it generates a new student ID. PHPpublic function ensureStudentSession(): string { if (!isset($this->testSession['student_id'])) { $this->testSession['student_id'] = uniqid('', true); } return $this->testSession['student_id']; } This method ensures that a student session is available by checking the $testSession array for a student_id. If it doesn't exist, a new student ID is generated using uniqid('', true) and stored in the session. The method then returns the student ID, either the newly created one or the existing one.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

PHP

<?php

require_once __DIR__ . '/../../Services/TutorService.php';

use app\Service\TutorService;

class TutorController
{
    private array $testSession = [];
    private TutorService $tutorService;

    public function __construct()
    {
        $this->tutorService = new TutorService();
    }
}

PHP

public function createSession(): array
{
    $studentId = $this->testSession['student_id'] ?? null;
    if (!$studentId) {
        return ['error' => 'Session expired', 'code' => 401];
    }
    
    $sessionId = $this->tutorService->createSession($studentId);
    return [
        'session_id' => $sessionId,
        'message' => 'Tutoring session created successfully'
    ];
}

PHP

public function sendQuery(string $sessionId, string $studentQuery): array
{
    $studentId = $this->testSession['student_id'] ?? null;
    if (!$studentId) {
        return ['error' => 'Session expired', 'code' => 401];
    }
    
    if (!$sessionId || !$studentQuery) {
        return ['error' => 'Missing session_id or query', 'code' => 400];
    }
        
    try {
        $tutorResponse = $this->tutorService->processQuery($studentId, $sessionId, $studentQuery);
        return ['message' => $tutorResponse];
    } catch (\ValueError $e) {
        return ['error' => $e->getMessage(), 'code' => 404];
    } catch (\RuntimeException $e) {
        return ['error' => $e->getMessage(), 'code' => 500];
    }
}

PHP

require_once 'controllers/TutorController.php';

// Initialize the TutorController
$tutorController = new TutorController();

// Ensure a student session for testing
$studentId = $tutorController->ensureStudentSession();

// Create a new tutoring session
$sessionResponse = $tutorController->createSession();

if (isset($sessionResponse['error'])) {
    echo "Error {$sessionResponse['code']}: {$sessionResponse['error']}\n";
} else {
    $sessionId = $sessionResponse['session_id'];
    echo "Tutoring session created with session_id: {$sessionId}\n";

    // Example query handling
    $studentQuery = "What are the key differences between mitosis and meiosis?";

    $response = $tutorController->sendQuery($sessionId, $studentQuery);

    if (isset($response['error'])) {
        echo "Error {$response['code']}: {$response['error']}\n";
    } else {
        echo "Tutor Response: {$response['message']}\n";
    }
}

PHP

public function createSession(): array
{
    $studentId = $this->testSession['student_id'] ?? null;
    if (!$studentId) {
        return ['error' => 'Session expired', 'code' => 401];
    }
    
    $sessionId = $this->tutorService->createSession($studentId);
    return [
        'session_id' => $sessionId,
        'message' => 'Tutoring session created successfully'
    ];
}

PHP

public function sendQuery(string $sessionId, string $studentQuery): array
{
    $studentId = $this->testSession['student_id'] ?? null;
    if (!$studentId) {
        return ['error' => 'Session expired', 'code' => 401];
    }
    
    if (!$sessionId || !$studentQuery) {
        return ['error' => 'Missing session_id or query', 'code' => 400];
    }
        
    try {
        $tutorResponse = $this->tutorService->processQuery($studentId, $sessionId, $studentQuery);
        return ['message' => $tutorResponse];
    } catch (\ValueError $e) {
        return ['error' => $e->getMessage(), 'code' => 404];
    } catch (\RuntimeException $e) {
        return ['error' => $e->getMessage(), 'code' => 500];
    }
}

PHP

require_once 'controllers/TutorController.php';

// Initialize the TutorController
$tutorController = new TutorController();

// Ensure a student session for testing
$studentId = $tutorController->ensureStudentSession();

// Create a new tutoring session
$sessionResponse = $tutorController->createSession();

if (isset($sessionResponse['error'])) {
    echo "Error {$sessionResponse['code']}: {$sessionResponse['error']}\n";
} else {
    $sessionId = $sessionResponse['session_id'];
    echo "Tutoring session created with session_id: {$sessionId}\n";

    // Example query handling
    $studentQuery = "What are the key differences between mitosis and meiosis?";

    $response = $tutorController->sendQuery($sessionId, $studentQuery);

    if (isset($response['error'])) {
        echo "Error {$response['code']}: {$response['error']}\n";
    } else {
        echo "Tutor Response: {$response['message']}\n";
    }
}

Streamlining Student Interaction with Tutor Controller

Implementing the TutorController Class

Ensuring Student Session

Join the 1M+ learners on CodeSignal

Creating a New Tutoring Session

Handling Student Queries

Integrating the Tutor Controller in the Main Application

Summary and Next Steps