3.6. Aandenking

3.6.1. Doel

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

Het aandenkenpatroon is geïmplementeerd met drie objecten: de vinder, een verzorger en een aandenken.

Aandenking - een object dat een concrete unieke momentopname van staat van een object of bron bevat: tekenreeks, getal, reeks, een instantie van klasse enzovoort. Het unieke in dit geval impliceert niet het verbod op het bestaan ​​van vergelijkbare staten in verschillende snapshots. Dat betekent dat de staat kan worden geëxtraheerd als de onafhankelijke kloon. Elk object dat in de Aandenking is opgeslagen, moet * een volledige kopie van het originele object zijn in plaats van een verwijzing * naar het originele object. Het Aandenking-object is een “ondoorzichtig object” (het object dat niemand kan of mag veranderen).

Vinder - het is een object dat de * werkelijke status van een extern object bevat, is strikt gespecificeerd type *. De maker kan een unieke kopie van deze staat maken en deze verpakt in een aandenken retourneren. De vinder kent de geschiedenis van veranderingen niet. U kunt van buitenaf een concrete toestand instellen op Vinder, die als werkelijk wordt beschouwd. De Beller moet ervoor zorgen dat de gegeven status overeenkomt met het toegestane type object. De maker kan (maar zou niet moeten) methoden hebben, maar ze * ze kunnen geen wijzigingen aanbrengen in de opgeslagen objectstatus *.

Verzorger * beheert de geschiedenis van de staten *. Hij kan wijzigingen aanbrengen in een object; een beslissing nemen om de staat van een extern object op te slaan in de Vinder; vraag aan de momentopname van de maker van de huidige staat; of stel de Vinder-status in op gelijkwaardigheid met een momentopname uit de geschiedenis.

3.6.2. Bijvoorbeeld

• Het zaad van een pseudo-willekeurige nummergenerator

• De staat in een beperkte toestandsmachine

• Controle voor tussenliggende toestanden van ʻORM Model <https://nl.wikipedia.org/wiki/Objectgeori%C3%ABnteerd> `_ alvorens op te slaan

3.6.3. UML Diagram

3.6.4. Code

Je kan deze broncode terugvinden op 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. Test

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());
    }
}