Yaf_Route_Interface::route

(Yaf >=1.0.0)

Yaf_Route_Interface::routeリクエストをルーティングする

説明

abstract public Yaf_Route_Interface::route(Yaf_Request_Abstract $request): bool

Yaf_Route_Interface::route() は、ルーターを自作するときに唯一実装する必要のあるメソッドです。

注意:

2.3.0 以降では、実装すべきメソッドがひとつ増えました。 Yaf_Route_Interface::assemble() を参照ください。

このメソッドが true を返せば、そこでルーティングが終わります。それ以外の場合は Yaf_Router はルートスタックの次のルーターにリクエストを転送します。

このメソッドは、 Yaf_Request_Abstract::setControllerName()Yaf_Request_Abstract::setActionName() および Yaf_Request_Abstract::setModuleName() を使って ルーティング結果を request に設定します。

リクエストをルーティングしたことを示すため、このメソッドは最後に Yaf_Request_Abstract::setRouted() を呼ぶ必要があります。

パラメータ

request

Yaf_Request_Abstract のインスタンスを返します。

戻り値

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top