ポリシー¶

ポリシーの作成¶

src/Policyディレクトリにポリシーを作成できます。 ポリシークラスには、実装が期待される共通の基本クラスまたはインターフェースがありません。アプリケーションクラスは、一致するポリシークラスに「解決」されます。ポリシーの解決方法については、ポリシーリゾルバーセクションを参照してください。

通常、ポリシーはsrc/Policyに配置し、Policyクラスのサフィックスを使用します。ここでは、アプリケーションでArticleエンティティのポリシークラスを作成します。src/Policy/ArticlePolicy.phpに次のコンテンツを追加します：

<?php
namespace App\Policy;

use App\Model\Entity\Article;
use Authorization\IdentityInterface;

class ArticlePolicy
{
}

エンティティに加えて、テーブルオブジェクトとクエリはポリシーを解決できます。 クエリオブジェクトのrepository()メソッドが呼び出され、テーブル名に基づいてポリシークラスが生成されます。 App\Model\Table\ArticlesTableのテーブルクラスは、App\Policy\ArticlesTablePolicyにマップされます。

ポリシーメソッドの記述¶

先ほど作成したポリシークラスは、現時点ではあまり機能しません。 ユーザーが記事を更新できるかどうかを確認できるメソッドを定義しましょう：

public function canUpdate(IdentityInterface $user, Article $article)
{
    return $user->id == $article->user_id;
}

ポリシーメソッドは、成功を示すためにtrueまたはResultオブジェクトを返す必要があります。 他のすべての値は失敗として解釈されます。

認証されていないユーザーを処理する場合、ポリシーメソッドは$userパラメーターにnullを受け取ります。 匿名ユーザーのポリシーメソッドを自動的に失敗させる場合は、IdentityInterfaceタイプヒントを使用できます。

ポリシー結果オブジェクト¶

ブール値に加えて、ポリシーメソッドはResultオブジェクトを返すことができます。 Resultオブジェクトにより、ポリシーが成功/失敗した理由についてより多くのコンテキストを提供できます：

use Authorization\Policy\Result;

public function canUpdate(IdentityInterface $user, Article $article)
{
    if ($user->id == $article->user_id) {
        return new Result(true);
    }
    // Results let you define a 'reason' for the failure.
    return new Result(false, 'not-owner');
}

trueでない戻り値またはResultInterfaceオブジェクトは失敗と見なされます。

namespace App\Policy;

class ArticlesPolicy
{
    public function scopeIndex($user, $query)
    {
        return $query->where(['Articles.user_id' => $user->getIdentifier()]);
    }
}

namespace App\Policy;

use Authorization\Policy\BeforePolicyInterface;

class ArticlesPolicy implements BeforePolicyInterface
{
    public function before($user, $resource, $action)
    {
        if ($user->getOriginalData()->is_admin) {
            return true;
        }
        // fall through
    }
}