★ 0 フォロワー

インターフェース yii\web\UrlRuleInterface

実装クラスyii\rest\UrlRuleyii\web\CompositeUrlRuleyii\web\GroupUrlRuleyii\web\UrlRule
利用可能バージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/web/UrlRuleInterface.php

UrlRuleInterface は、URLルールクラスで実装されるべきインターフェースです。

公開メソッド

継承メソッドを隠す

メソッド 説明 定義元
createUrl() 与えられたルートとパラメータに基づいてURLを作成します。 yii\web\UrlRuleInterface
parseRequest() 与えられたリクエストを解析し、対応するルートとパラメータを返します。 yii\web\UrlRuleInterface

メソッドの詳細

継承メソッドを隠す

編集 表示 createUrl() public abstract method

与えられたルートとパラメータに基づいてURLを作成します。

public abstract string|boolean createUrl ( $manager, $route, $params )
$manager yii\web\UrlManager

URLマネージャー

$route string

ルート。先頭と末尾にスラッシュを含んではいけません。

$params array

パラメータ

戻り値 string|boolean

作成されたURL、またはこのルールがこのURLの作成に使用できない場合はfalse。

                public function createUrl($manager, $route, $params);

            
編集 表示 parseRequest() public abstract method

与えられたリクエストを解析し、対応するルートとパラメータを返します。

public abstract array|boolean parseRequest ( $manager, $request )
$manager yii\web\UrlManager

URLマネージャー

$request yii\web\Request

リクエストコンポーネント

戻り値 array|boolean

解析結果。ルートとパラメータは配列として返されます。falseの場合、このルールはこのパス情報を解析するために使用できません。

                public function parseRequest($manager, $request);