Relais
extends AbstractHelper
in package
Relais view helper
Tags
Table of Contents
- $config : Config
- Relais configuration (or null if none found)
- $loginUrl : string
- Login URL
- __construct() : mixed
- Constructor.
- getSearchLink() : string
- Create a Relais search link from a record driver.
- renderButtonIfActive() : string
- Render a button if Relais is active.
Properties
$config
Relais configuration (or null if none found)
protected
Config
$config
$loginUrl
Login URL
protected
string
$loginUrl
Methods
__construct()
Constructor.
public
__construct(Config $config, string $loginUrl) : mixed
Parameters
- $config : Config
-
Relais configuration (or null if none found)
- $loginUrl : string
-
Login base URL
Return values
mixed —getSearchLink()
Create a Relais search link from a record driver.
public
getSearchLink(object $driver) : string
Parameters
- $driver : object
-
Record driver
Return values
string —renderButtonIfActive()
Render a button if Relais is active.
public
renderButtonIfActive([object $driver = null ]) : string
Parameters
- $driver : object = null
-
Record driver