Skip to content
This repository has been archived by the owner on Sep 20, 2019. It is now read-only.

Commit

Permalink
Adds Router facade
Browse files Browse the repository at this point in the history
  • Loading branch information
sergeymakinen committed Aug 31, 2016
1 parent b1c6716 commit d396695
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions Router.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?php
/**
* Facades for Yii 2
*
* @see https://github.com/sergeymakinen/yii2-facades
* @copyright Copyright (c) 2016 Sergey Makinen (https://makinen.ru)
* @license https://github.com/sergeymakinen/yii2-facades/blob/master/LICENSE The MIT License
*/

namespace sergeymakinen\facades;

/**
* Router facade.
*
* Facades Yii::$app->get('urlManager') component.
*
* @see \yii\web\UrlManager
* @method static addRules(array $rules, bool $append = true) Adds additional URL rules.
* @method static \yii\base\Behavior attachBehavior(string $name, string|array|\yii\base\Behavior $behavior) Attaches a behavior to this component.
* @method static attachBehaviors(array $behaviors) Attaches a list of behaviors to the component.
* @method static array behaviors() Returns a list of behaviors that this component should behave as.
* @method static string createAbsoluteUrl(string|array $params, string $scheme = null) Creates an absolute URL using the given route and query parameters.
* @method static string createUrl(string|array $params) Creates a URL using the given route and query parameters.
* @method static null|\yii\base\Behavior detachBehavior(string $name) Detaches a behavior from the component.
* @method static detachBehaviors() Detaches all behaviors from the component.
* @method static ensureBehaviors() Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
* @method static string getBaseUrl() Returns the base URL that is used by [[createUrl()]] to prepend to created URLs.
* @method static null|\yii\base\Behavior getBehavior(string $name) Returns the named behavior object.
* @method static \yii\base\Behavior[] getBehaviors() Returns all behaviors attached to this component.
* @method static \yii\caching\Cache|string getCache() Returns the cache object or the application component ID of the cache object.
* @method static bool getEnablePrettyUrl() Returns whether to enable pretty URLs.
* @method static bool getEnableStrictParsing() Returns whether to enable strict parsing.
* @method static string getHostInfo() Returns the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
* @method static string getRouteParam() Returns the GET parameter name for route.
* @method static array getRuleConfig() Returns the default configuration of URL rules.
* @method static array getRules() Returns the rules for creating and parsing URLs when [[enablePrettyUrl]] is true.
* @method static string getScriptUrl() Returns the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
* @method static bool getShowScriptName() Returns whether to show entry script name in the constructed URL.
* @method static string getSuffix() Returns the URL suffix used when in 'path' format.
* @method static bool hasEventHandlers(string $name) Returns a value indicating whether there is any handler attached to the named event.
* @method static bool off(string $name, callable $handler = null) Detaches an existing event handler from this component.
* @method static on(string $name, callable $handler, mixed $data = null, bool $append = true) Attaches an event handler to an event.
* @method static array|bool parseRequest(\yii\web\Request $request) Parses the user request.
* @method static setBaseUrl(string $value) Sets the base URL that is used by [[createUrl()]] to prepend to created URLs.
* @method static setCache(\yii\caching\Cache|string $value) Sets the cache object or the application component ID of the cache object.
* @method static setEnablePrettyUrl(bool $value) Sets whether to enable pretty URLs.
* @method static setEnableStrictParsing(bool $value) Sets whether to enable strict parsing.
* @method static setHostInfo(string $value) Sets the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
* @method static setRouteParam(string $value) Sets the GET parameter name for route.
* @method static setRuleConfig(array $value) Sets the default configuration of URL rules.
* @method static setRules(array $value) Sets the rules for creating and parsing URLs when [[enablePrettyUrl]] is true.
* @method static setScriptUrl(string $value) Sets the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
* @method static setShowScriptName(bool $value) Sets whether to show entry script name in the constructed URL.
* @method static setSuffix(string $value) Sets the URL suffix used when in 'path' format.
* @method static trigger(string $name, \yii\base\Event $event = null) Triggers an event.
*/
class Router extends Facade
{
/**
* @inheritdoc
*/
public static function getFacadeComponentId()
{
return 'urlManager';
}
}

0 comments on commit d396695

Please sign in to comment.