3.6. Спомен

3.6.1. Предназначение

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).

Шаблон е реализиран с три обекта: Originator (Оригинатор), a Caretaker (Пазител) и Memento (Спомен).

Memento - обект, който * съдържа конкретна уникална снимка на състоянието * на всеки обект или ресурс: низ, число, масив, екземпляр на клас и така нататък. Уникалността в този случай не означава забрана за съществуването на подобни състояния в различни моментни снимки. Това означава, че състояние може да бъде извлечено като независим клон. Всеки обект, съхраняван в Memento, трябва да бъде * пълно копие на оригиналния обект, а не препратка * към оригиналния обект. Обектът Memento е „непрозрачен обект“ (обектът, който никой не може или не трябва да променя).

Originator - това е обект, който съдържа * действителното състояние на външен обект е строго определен тип *. Originator е в състояние да създаде уникално копие на това състояние и да го върне увито в спомен. Originator не знае историята на промените. Можете да зададете конкретно състояние на Originator отвън, което ще се счита за действително. Originator трябва да се увери, че дадено състояние съответства на разрешения тип обект. Originator може (но не трябва) да има някакви методи, но те * не могат да правят промени в състоянието на запазения обект *.

Caretaker * контролира историята на състояния *. Той може да прави промени в обект; взима решение за запазване на състоянието на външен обект в Originator; поиска моментна снимка на текущото състояние от Originator; или зададе състоянието на Originator еквивалентно на някаква снимка от историята.

3.6.2. Примери

• To seed генератор на псевдослучайни числа

• Състоянието в краен автомат

• Контрол за междинни състояния на ORM Model преди запазване

3.6.3. UML Диаграма

3.6.4. Код

Можете също да намерите този код в GitHub

Memento.php

<?php

declare(strict_types=1);

namespace DesignPatterns\Behavioral\Memento;

class Memento
{
    public function __construct(private State $state)
    {
    }

    public function getState(): State
    {
        return $this->state;
    }
}

State.php

<?php

declare(strict_types=1);

namespace DesignPatterns\Behavioral\Memento;

use InvalidArgumentException;

class State implements \Stringable
{
    public const STATE_CREATED = 'created';
    public const STATE_OPENED = 'opened';
    public const STATE_ASSIGNED = 'assigned';
    public const STATE_CLOSED = 'closed';

    private string $state;

    /**
     * @var string[]
     */
    private static array $validStates = [
        self::STATE_CREATED,
        self::STATE_OPENED,
        self::STATE_ASSIGNED,
        self::STATE_CLOSED,
    ];

    public function __construct(string $state)
    {
        self::ensureIsValidState($state);

        $this->state = $state;
    }

    private static function ensureIsValidState(string $state)
    {
        if (!in_array($state, self::$validStates)) {
            throw new InvalidArgumentException('Invalid state given');
        }
    }

    public function __toString(): string
    {
        return $this->state;
    }
}

Ticket.php

<?php

declare(strict_types=1);

namespace DesignPatterns\Behavioral\Memento;

/**
 * Ticket is the "Originator" in this implementation
 */
class Ticket
{
    private State $currentState;

    public function __construct()
    {
        $this->currentState = new State(State::STATE_CREATED);
    }

    public function open()
    {
        $this->currentState = new State(State::STATE_OPENED);
    }

    public function assign()
    {
        $this->currentState = new State(State::STATE_ASSIGNED);
    }

    public function close()
    {
        $this->currentState = new State(State::STATE_CLOSED);
    }

    public function saveToMemento(): Memento
    {
        return new Memento(clone $this->currentState);
    }

    public function restoreFromMemento(Memento $memento)
    {
        $this->currentState = $memento->getState();
    }

    public function getState(): State
    {
        return $this->currentState;
    }
}

3.6.5. Тест

Tests/MementoTest.php

<?php

declare(strict_types=1);

namespace DesignPatterns\Behavioral\Memento\Tests;

use DesignPatterns\Behavioral\Memento\State;
use DesignPatterns\Behavioral\Memento\Ticket;
use PHPUnit\Framework\TestCase;

class MementoTest extends TestCase
{
    public function testOpenTicketAssignAndSetBackToOpen()
    {
        $ticket = new Ticket();

        // open the ticket
        $ticket->open();
        $openedState = $ticket->getState();
        $this->assertSame(State::STATE_OPENED, (string) $ticket->getState());

        $memento = $ticket->saveToMemento();

        // assign the ticket
        $ticket->assign();
        $this->assertSame(State::STATE_ASSIGNED, (string) $ticket->getState());

        // now restore to the opened state, but verify that the state object has been cloned for the memento
        $ticket->restoreFromMemento($memento);

        $this->assertSame(State::STATE_OPENED, (string) $ticket->getState());
        $this->assertNotSame($openedState, $ticket->getState());
    }
}