Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 1.12 KB

URL-Checkers.md

File metadata and controls

31 lines (18 loc) · 1.12 KB
Raw

URL Checkers

To provide an abstract and framework agnostic solution there are URL checkers implemented that allow you to customize the comparision of the current URL if needed. For example to another frameworks routing.

URL checkers use setter methods and sometimes constructor args to set configuration options.

Included Checkers

DefaultUrlChecker

The default checker allows you to compare an URL by regex or string URLs.

Option setters:

  • setCheckFullUrl(bool $check): To compare the full URL, including protocol, host and port or not. Default is false
  • setUseRegex(bool $useRegex): Compares the URL by a regular expression provided in the $loginUrls argument of the checker.

CakeRouterUrlChecker

Option setters:

Use this checker if you want to use the array notation of CakePHPs routing system. The checker also works with named routes.

  • setCheckFullUrl(bool $check): To compare the full URL, including protocol, host and port or not. Default is false

Implementing your own Checker

An URL checker must implement the \Phauthentication\Authentication\UrlChecker\UrlCheckterInterface.