3.6. Memento

3.6.1. Rôle

It provides the ability to restore an object to it’s previous state (undo via rollback) or to gain access to state of the object, without revealing it’s implementation (i.e., the object is not required to have a function to return the current state).

Le pattern Memento est mis en œuvre avec trois objets : Originator, Caretaker et un Memento.

Memento - Objet contenant un instantané concret et unique de l’état de tout objet ou ressource : chaîne de caractères, nombre, tableau, instance de classe, etc. L’unicité dans ce cas n’implique pas l’interdiction de l’existence d’états similaires dans différents instantanés. Cela signifie que l’état peut être extrait en tant que clone indépendant. Tout objet stocké dans le Memento doit être une copie complète de l’objet original plutôt qu’une référence à l’objet original. L’objet Mémento est un « objet opaque » (l’objet que personne ne peut ou ne doit modifier).

Originator - Objet contenant l’état réel d’un objet externe de type strictement spécifié. L’Originator est capable de créer une copie unique de cet état et de la renvoyer enveloppée dans un Memento. L’Originator ne connaît pas l’historique des changements. Vous pouvez définir un état concret pour l’Originator depuis l’extérieur, qui sera considéré comme réel. L’Originator doit s’assurer que l’état donné correspond au type d’objet autorisé. L’Originator peut (mais ne doit pas) avoir des méthodes, mais elles ne peuvent pas modifier l’état de l’objet sauvegardé.

Caretaker - Objet contrôlant l’historique des états. Il peut apporter des modifications à un objet, prendre la décision de sauvegarder l’état d’un objet externe dans l’Originator, demander à l’Originator un instantané de l’état actuel, ou mettre l’état de l’Originator en équivalence avec un instantané de l’histoire.

3.6.2. Exemples

  • La source d’un générateur de nombres pseudo-aléatoires

  • L’état dans une machine à états finis

  • Contrôle des états intermédiaires du modèle ORM <http://en.wikipedia.org/wiki/Object-relational_mapping> avant la sauvegarde

3.6.3. Diagramme UML

Alt Momento UML Diagram

3.6.4. Code

Vous pouvez également trouver ce code sur GitHub

Memento.php

 1<?php
 2
 3declare(strict_types=1);
 4
 5namespace DesignPatterns\Behavioral\Memento;
 6
 7class Memento
 8{
 9    public function __construct(private State $state)
10    {
11    }
12
13    public function getState(): State
14    {
15        return $this->state;
16    }
17}

State.php

 1<?php
 2
 3declare(strict_types=1);
 4
 5namespace DesignPatterns\Behavioral\Memento;
 6
 7use InvalidArgumentException;
 8
 9class State implements \Stringable
10{
11    public const STATE_CREATED = 'created';
12    public const STATE_OPENED = 'opened';
13    public const STATE_ASSIGNED = 'assigned';
14    public const STATE_CLOSED = 'closed';
15
16    private string $state;
17
18    /**
19     * @var string[]
20     */
21    private static array $validStates = [
22        self::STATE_CREATED,
23        self::STATE_OPENED,
24        self::STATE_ASSIGNED,
25        self::STATE_CLOSED,
26    ];
27
28    public function __construct(string $state)
29    {
30        self::ensureIsValidState($state);
31
32        $this->state = $state;
33    }
34
35    private static function ensureIsValidState(string $state)
36    {
37        if (!in_array($state, self::$validStates)) {
38            throw new InvalidArgumentException('Invalid state given');
39        }
40    }
41
42    public function __toString(): string
43    {
44        return $this->state;
45    }
46}

Ticket.php

 1<?php
 2
 3declare(strict_types=1);
 4
 5namespace DesignPatterns\Behavioral\Memento;
 6
 7/**
 8 * Ticket is the "Originator" in this implementation
 9 */
10class Ticket
11{
12    private State $currentState;
13
14    public function __construct()
15    {
16        $this->currentState = new State(State::STATE_CREATED);
17    }
18
19    public function open()
20    {
21        $this->currentState = new State(State::STATE_OPENED);
22    }
23
24    public function assign()
25    {
26        $this->currentState = new State(State::STATE_ASSIGNED);
27    }
28
29    public function close()
30    {
31        $this->currentState = new State(State::STATE_CLOSED);
32    }
33
34    public function saveToMemento(): Memento
35    {
36        return new Memento(clone $this->currentState);
37    }
38
39    public function restoreFromMemento(Memento $memento)
40    {
41        $this->currentState = $memento->getState();
42    }
43
44    public function getState(): State
45    {
46        return $this->currentState;
47    }
48}

3.6.5. Test

Tests/MementoTest.php

 1<?php
 2
 3declare(strict_types=1);
 4
 5namespace DesignPatterns\Behavioral\Memento\Tests;
 6
 7use DesignPatterns\Behavioral\Memento\State;
 8use DesignPatterns\Behavioral\Memento\Ticket;
 9use PHPUnit\Framework\TestCase;
10
11class MementoTest extends TestCase
12{
13    public function testOpenTicketAssignAndSetBackToOpen()
14    {
15        $ticket = new Ticket();
16
17        // open the ticket
18        $ticket->open();
19        $openedState = $ticket->getState();
20        $this->assertSame(State::STATE_OPENED, (string) $ticket->getState());
21
22        $memento = $ticket->saveToMemento();
23
24        // assign the ticket
25        $ticket->assign();
26        $this->assertSame(State::STATE_ASSIGNED, (string) $ticket->getState());
27
28        // now restore to the opened state, but verify that the state object has been cloned for the memento
29        $ticket->restoreFromMemento($memento);
30
31        $this->assertSame(State::STATE_OPENED, (string) $ticket->getState());
32        $this->assertNotSame($openedState, $ticket->getState());
33    }
34}