Building a Session Manager in PHP for a Personal Tutor System
Building the Session Manager
Welcome back! In the previous lesson, we explored the importance of a robust system prompt and how it guides the behavior of our personal tutor. Now, we will delve into the next step of our journey: building the Session Manager. This lesson will focus on the model layer of the MVC (Model-View-Controller) architecture, which is crucial for organizing and managing data in a structured way. The SessionManager class will be the core component of our model layer, responsible for managing tutoring session data effectively. By the end of this lesson, you will understand how to create, manage, and retrieve session data using the SessionManager class.
Initializing the SessionManager
The SessionManager class is designed to handle the storage and management of tutoring session data. It serves as the backbone of our tutor's data management system. We'll start by setting up the class and then gradually add methods to handle session creation, message addition, and conversation retrieval.
Let's begin by defining the SessionManager class and its constructor. The constructor initializes an empty array, $this->sessions, which will store all session data.
PHP
class SessionManager { private $sessions; public function __construct() { $this->sessions = []; // student_id -> session_id -> session_data }}
In this setup, $this->sessions is a nested array where the first key is the student_id, and the second key is the session_id. This structure allows us to efficiently manage multiple tutoring sessions for different students.
Creating a New Session
Join the 1M+ learners on CodeSignal
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal
Next, we'll add the createSession method. This method is responsible for creating a new session entry for a student. It takes three parameters: $studentId, $sessionId, and $systemPrompt.
PHP
class SessionManager { private $sessions; public function __construct() { $this->sessions = []; } public function createSession($studentId, $sessionId, $systemPrompt) { if (!isset($this->sessions[$studentId])) { $this->sessions[$studentId] = []; } $this->sessions[$studentId][$sessionId] = [ 'system_prompt' => $systemPrompt, 'messages' => [] ]; }}
The createSession method checks if the $studentId exists in $this->sessions. If not, it creates a new entry. Then, it initializes the session with the provided $systemPrompt and an empty array for messages.
Retrieving a Session
Adding Messages to a Session
Retrieving the Full Conversation
Creating and Managing Sessions
Adding and Retrieving Messages
Retrieving Conversation
Summary and Preparation for Practice
In this lesson, we explored the SessionManager class and its role in managing tutoring session data within the model layer of our application. We learned how to create and manage sessions, add messages, and retrieve conversation histories. The SessionManager is a crucial component for organizing session data, ensuring that our personal tutor can handle multiple tutoring sessions efficiently.
As you move on to the practice exercises, take the opportunity to experiment with modifying and extending the SessionManager functionality. This hands-on practice will reinforce the concepts covered in this lesson and prepare you for the next steps in our course. Keep up the great work, and I look forward to seeing your progress!
To access a specific tutoring session, we need the getSession method. This method retrieves a session based on the $studentId and $sessionId.
PHP
public function getSession($studentId, $sessionId) { return $this->sessions[$studentId][$sessionId] ?? null;}
The getSession method uses the null coalescing operator to safely access the nested array, returning the session data if it exists.
Now, let's add the addMessage method. This method allows us to append messages to a session. It requires the $studentId, $sessionId, $role, and $content of the message.
PHP
public function addMessage($studentId, $sessionId, $role, $content) { $session = $this->getSession($studentId, $sessionId); if ($session) { $session['messages'][] = ["role" => $role, "content" => $content]; }}
The addMessage method first retrieves the session using getSession. If the session exists, it appends the message to the session's message array.
Finally, we'll implement the getConversation method. This method returns the entire conversation, including the system prompt and all messages.
PHP
public function getConversation($studentId, $sessionId) { $session = $this->getSession($studentId, $sessionId); if ($session) { return array_merge( [["role" => "system", "content" => $session['system_prompt']]], $session['messages'] ); } return [];}
The getConversation method retrieves the session and constructs an array starting with the system prompt, followed by the session messages. If the session does not exist, it returns an empty array.
By following these steps, we've built a fully functional SessionManager class that can create and manage tutoring sessions, add messages, and retrieve conversation histories.
To create a new tutoring session, we use the createSession method. This method takes three parameters: $studentId, $sessionId, and $systemPrompt. It initializes a new session entry in the $this->sessions array. If the $studentId does not already exist in the array, a new entry is created. The session entry includes the system prompt and an empty array for messages.
Here's an example of how to create a new tutoring session:
PHP
function loadSystemPrompt() { try { return file_get_contents('data/system_prompt.txt'); } catch (Exception $e) { echo "Error loading system prompt: " . $e->getMessage(); return "You are a helpful tutor."; }}// Load the system prompt$systemPrompt = loadSystemPrompt();// Initialize the session manager$manager = new SessionManager();// Create a new tutoring session$studentId = "student_test";$sessionId = "session_test";$manager->createSession($studentId, $sessionId, $systemPrompt);
In this example, we initialize a SessionManager instance and create a new tutoring session for a student with the ID "student_test". The session is identified by "session_test" and is initialized with a system prompt. This setup allows us to manage tutoring session data efficiently.
Once a session is created, we can add messages to it using the addMessage method. This method requires the $studentId, $sessionId, $role, and $content of the message. The role indicates whether the message is from the student or the tutor assistant. The message is then appended to the session's message array.
Here's how you can add messages to a tutoring session:
PHP
// Add some messages to the session$manager->addMessage($studentId, $sessionId, "user", "Hello, I need help with geometry.");$manager->addMessage($studentId, $sessionId, "assistant", "Hi there! What specific geometry topic are you struggling with?");
In this example, we add a student message, "Hello, I need help with geometry.", and an assistant response, "Hi there! What specific geometry topic are you struggling with?", to the session. The addMessage method ensures that messages are stored in the correct session entry.
To retrieve the entire conversation, including the system prompt, we use the getConversation method. This method returns an array of messages, starting with the system prompt followed by the session messages.
PHP
// Retrieve the full conversation$conversation = $manager->getConversation($studentId, $sessionId);// Display the session detailsecho "Session ID: $sessionId\n\n";foreach ($conversation as $message) { echo "Role: " . $message['role'] . "\n"; echo "Message:\n" . $message['content'] . "\n\n";}
The getConversation method compiles the session history, allowing us to access the full context of the conversation. This is particularly useful when we need to provide the full conversation history to ensure contextual responses.
