Streamlining Student Interaction with Tutor Controller | CodeSignal Learn

Streamlining Student Interaction with Tutor Controller | CodeSignal Learn

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.

Sign up

Join the 1M+ learners on CodeSignal

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

One of the primary responsibilities of the TutorController is to create new tutoring sessions. The createSession method handles session creation requests.

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'
    ];
}

In this method, we:

Retrieve the student_id: We first check the $testSession for a student_id.
Handle Session Expiry: If the session has expired (i.e., no student_id is found), we return an error response with an error key and a code of 401.
Create a Tutoring Session: If the session is valid, we call the createSession method of the TutorService with the student ID to create a new tutoring session. We then return a response containing a unique session ID and a success message.

The sendQuery method is responsible for processing student queries and returning the tutor's response or an error message.

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];
    }
}

In this method:

We first check if the student session is valid by retrieving the student_id from the $testSession. If no student_id is found, we return an error response with an error key and a code of 401.
We then validate that both sessionId and studentQuery are provided. If either is missing, we return an error response with an error key and a code of 400.
If all validations pass, we attempt to process the query using the processQuery method of the TutorService. This method takes the studentId, sessionId, and studentQuery as parameters.
If the query is processed successfully, we return the tutor's response in a response format under the message key.
If a ValueError occurs (e.g., if the session ID doesn't exist), we return an error response with an error key and a code of 404.
If a RuntimeException occurs (e.g., if there's an issue with the model), we return an error response with an error key and a code of 500.

To see the TutorController in action, let's integrate it into the main application. This example demonstrates how to create a tutoring session and handle a student query, showcasing the controller's functionality.

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";
    }
}

In this example, we first initialize the TutorController. We ensure a student session is available for testing. We then create a new tutoring session and handle the response. If successful, we simulate a student query about the differences between mitosis and meiosis and use the sendQuery method to process it. The response is checked for errors, and either the error message or the tutor's response is printed. This example demonstrates the flow from ensuring a student session to creating a tutoring session and handling a student query, highlighting the controller's role in managing interactions.