Stateパターン - PHPデザインパターン

公開： 2018年7月28日

カテゴリ： PHP DesignPatterns
タグ： PHP,Behavior,DesignPatterns,Singleton,State

Stateパターン（ステート・パターン）は、は振る舞いに関するデザインパターン手法の一つで、１つの状態を１つのオブジェクトとして表現し、状態の変更をシンプルに構築できる処理モデルです。

Stateパターンの基本的なクラス図は以下になります。

Stateパターンクラス図

実装例

今回は、ユーザのオンライン・オフラインの状態を切り替える機能をStateパターンで実装し、その流れを見ていきます。

App/State/Interfaces/StateInterface.php

<?php

namespace App\State\Interfaces;

interface StateInterface
{
    public function nextState();
    public function getStatus();
}

状態を切り替えるnextState() メソッドと、状態を返すgetStatus()メソッドを用意しました。

次に、Stateの具象クラスです。先ほど作成したインターフェイスを実装し、オンライン状態とオフライン状態の２つのクラスを定義します。

App/State/OnlineState.php

<?php

namespace App\State;

use App\State\Interfaces\StateInterface;

class OnlineState implements StateInterface
{
    private static $instance = null;

    public static function getInstance()
    {
        if (empty(self::$instance)) {
            self::$instance = new OnlineState();
        }
        return self::$instance;
    }

    public function nextState()
    {
        return OfflineState::getInstance();
    }

    public function getStatus()
    {
        return '<span style="color: blue;">オンライン</span>';
    }

    public final function __clone()
    {
        throw new \Exception('This Instance is Not Clone');
    }

    public final function __wakeup()
    {
        throw new \Exception('This Instance is Not unserialize');
    }
}

App/State/OfflineState.php

<?php

namespace App\State;

use App\State\Interfaces\StateInterface;

class OfflineState implements StateInterface
{
    private static $instance = null;

    public static function getInstance()
    {
        if (empty(self::$instance)) {
            self::$instance = new OfflineState();
        }
        return self::$instance;
    }

    public function nextState()
    {
        return OnlineState::getInstance();
    }

    public function getStatus()
    {
        return '<span style="color: darkgray;">オフライン</span>';
    }

    public final function __clone()
    {
        throw new \Exception('This Instance is Not Clone');
    }

    public final function __wakeup()
    {
        throw new \Exception('This Instance is Not unserialize');
    }
}

状態を表現するStateクラスはSingletonパターンを用いて作成します（１つの状態を表すオブジェクトは複数不要で１つあればよい）。そして、nextState() メソッドで切り替えるべき次の状態を渡しています。

次に、Contextクラスです。今回はユーザとして定義していきます。

App/Context/User.php

<?php

namespace App\Context;

use App\State\OnlineState;

class User
{
    private $name;
    private $state;

    public function __construct($name)
    {
        $this->name = $name;
        $this->state = OnlineState::getInstance();
    }

    public function getName()
    {
        return $this->name;
    }

    public function changeState()
    {
        $this->state = $this->state->nextState();
    }

    public function getStatus()
    {
        return $this->state->getStatus();
    }
}

コンストラクタでは、初期の状態インスタンスをセットしています。
changeState() メソッドで次の状態へ変更しています。ユーザーは自身の処理ではなく、所持しているstateクラスの変更メソッドをただ実行しているだけです。

実装が完了したので、クライアントから利用してみます。

index.php

<?php

use App\Context\User;

$user = new User('rito');

echo sprintf('ユーザ：%s　状態：%s<br><br>', $user->getName(), $user->getStatus());

// 状態を変更する
$user->changeState();

echo sprintf('ユーザ：%s　状態：%s<br><br>', $user->getName(), $user->getStatus());

// 状態を変更する
$user->changeState();

echo sprintf('ユーザ：%s　状態：%s<br><br>', $user->getName(), $user->getStatus());

// 状態を変更する
$user->changeState();

echo sprintf('ユーザ：%s　状態：%s<br><br>', $user->getName(), $user->getStatus());