Router
extends AutoService
in package
AutoService is a base-class for defining a service (in Civi's service-container).
Tags
Table of Contents
Methods
- getLayout() : string
- invoke() : void
- isAllowedRoute() : bool
- invokeBasic() : void
- Execute and display the requested route. Apply basic formatting.
- invokeCms() : void
- invokeRaw() : void
- print() : void
- Wrapper around print because we cannot call lagnuage constructs using a variable name
Methods
getLayout()
public
getLayout() : string
Return values
string —'basic' or 'raw' or 'cms'
invoke()
public
invoke(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
-
Some mix of:
- route: string, eg "civicrm/event/info"
- printPage: function(string), Print an exact web page response
- drupalKernel: The HTTP kernel handling the iframe request in D8/9/10/11
- drupalRequest: The HTTP object representing the iframe request in D8/9/10/11
Tags
isAllowedRoute()
public
isAllowedRoute(string $route) : bool
Parameters
- $route : string
Return values
boolinvokeBasic()
Execute and display the requested route. Apply basic formatting.
protected
invokeBasic(array<string|int, mixed> $params) : void
This means that CMS navigation and theming are disabled. However, HTML <HEAD> and Civi theming are enabled.
Parameters
- $params : array<string|int, mixed>
-
Open-ended parameters provided by the entry-script (
iframe.php).
Tags
invokeCms()
protected
invokeCms(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
invokeRaw()
protected
invokeRaw(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
print()
Wrapper around print because we cannot call lagnuage constructs using a variable name
protected
static print(string $html) : void
Parameters
- $html : string