Attributes

Pages can have attributes. Attributes are used to store data that is needed to process the user's input. It can be stored inside the page class as a property or passed to the next page as constructor arguments.

Define attributes

You can define attributes in the page class as properties:

class RegistrationPage extends Page
{
    protected ?string $name = null;
    
    protected ?int $age = null;

    // ...
}

Pass attributes to the next page

You can pass attributes to the next page as constructor arguments:

public function answer(IncomingMessageInterface $message)
{
    return new FinishRegistrationPage(
        name: $this->name,
        age: $this->age,
        password: $message->getText(),
    );
}

And then you can access these attributes in the next page:

class FinishRegistrationPage extends Page
{
    protected string $name;
    
    protected int $age;
    
    protected string $password;

    public function show()
    {
        return TextOutgoingMessage::make([
            "Your name is {$this->name}, you are {$this->age} years old,",
            "and your password is {$this->password}"
        ]);
    }
    
    // ...
}

Store objects in attributes

You can store objects in attributes. For example, the incoming message to process it later:

class RegistrationPage extends Page
{
    protected ?IncomingMessageInterface $incomingMessage = null;
    
    // ...

    public function answer(IncomingMessageInterface $message)
    {
        if ($this->incomingMessage === null) {
            $this->incomingMessage = $message;
            return TextOutgoingMessage::make('Forward this?');
        }
        
        if ($message->isText('yes')) {
            return ForwardOutgoingMessage::make($this->incomingMessage);
        }
    }
}