메소드 | 설명 | |
---|---|---|
__construct ( ) | ||
configureAdminMenu ( |
Configures the admin menu which is supposed to contain only administration related items such as "Websites", "Users" or "Settings". | |
configureTopMenu ( |
Configures the top menu which is supposed to contain analytics related items such as the "All Websites Dashboard". | |
urlForDefaultUserParams ( boolean $websiteId = false, boolean $defaultPeriod = false, boolean $defaultDate = false ) : string | Returns the &idSite=X&period=Y&date=Z query string fragment, fetched from current logged-in user's preferences. |
메소드 | 설명 | |
---|---|---|
urlForAction ( string $controllerAction, array $additionalParams = [] ) : array | Generates a URL for the given action. In your plugin controller you have to create a method with the same name as this method will be executed when a user clicks on the menu item. If you want to generate a URL for the action of another module, meaning not your plugin, you should use the method {@link urlForModuleAction()}. | |
urlForActionWithDefaultUserParams ( string $controllerAction, array $additionalParams = [] ) : array | Generates a URL to the given action of the current module, and it will also append some URL query parameters from the User preferences: idSite, period, date. If you do not need the parameters idSite, period and date to be generated use {@link urlForAction()} instead. | |
urlForDefaultAction ( array $additionalParams = [] ) : array | Generates a URL for the default action of the plugin controller. | |
urlForModuleAction ( string $module, string $controllerAction, array $additionalParams = [] ) : array | null | Generates a URL for the given action of the given module. We usually do not recommend to use this method as you should make sure the method of that module actually exists. If the plugin owner of that module changes the method in a future version your link might no longer work. If you want to link to an action of your controller use the method {@link urlForAction()}. Note: We will generate a link only if the given module is installed and activated. | |
urlForModuleActionWithDefaultUserParams ( string $module, string $controllerAction, array $additionalParams = [] ) : array | null | Generates a URL to the given action of the given module, and it will also append some URL query parameters from the User preferences: idSite, period, date. If you do not need the parameters idSite, period and date to be generated use {@link urlForModuleAction()} instead. |
메소드 | 설명 | |
---|---|---|
checkisValidCallable ( $module, $action ) | ||
getModule ( ) |
public configureAdminMenu ( |
||
$menu |
public configureTopMenu ( |
||
$menu |
protected urlForActionWithDefaultUserParams ( string $controllerAction, array $additionalParams = [] ) : array | ||
$controllerAction | string | The name of the action that should be executed within your controller |
$additionalParams | array | Optional URL parameters that will be appended to the URL |
리턴 | array | Returns the array of query parameter names and values to the given module action and idSite date and period. |
protected urlForDefaultAction ( array $additionalParams = [] ) : array | ||
$additionalParams | array | Optional URL parameters that will be appended to the URL |
리턴 | array |
protected urlForModuleAction ( string $module, string $controllerAction, array $additionalParams = [] ) : array | null | ||
$module | string | The name of the module/plugin the action belongs to. The module name is case sensitive. |
$controllerAction | string | The name of the action that should be executed within your controller |
$additionalParams | array | Optional URL parameters that will be appended to the URL |
리턴 | array | null | Returns null if the given module is either not installed or not activated. Returns the array of query parameter names and values to the given module action otherwise. |
protected urlForModuleActionWithDefaultUserParams ( string $module, string $controllerAction, array $additionalParams = [] ) : array | null | ||
$module | string | The name of the module/plugin the action belongs to. The module name is case sensitive. |
$controllerAction | string | The name of the action that should be executed within your controller |
$additionalParams | array | Optional URL parameters that will be appended to the URL |
리턴 | array | null | Returns the array of query parameter names and values to the given module action and idSite date and period. Returns null if the module or action is invalid. |