WebVIEP Plugin

RicdClientSettings

FinalYes

Table of Contents

Constants

DEFAULT_BASE_URL  = 'https://eut.projekt.onl'
DEFAULT_UNAVAILABLE_MESSAGE  = 'RICD search failed. The external RICD server is sometimes slow or unavailable due to its prototype state – please try again once or twice. Please check if %s is reachable.'
OPTION_KEY  = 'webviep_ricd_base_url'
OPTION_UNAVAILABLE_MESSAGE  = 'webviep_ricd_unavailable_msg'

Methods

getBaseUrl()  : string
Get configured base URL (falls back to default).
getUnavailableMessage()  : string
Get message displayed when RICD is unavailable.
updateBaseUrl()  : void
Update the base URL for the RICD client.
updateUnavailableMessage()  : void
Update the fallback message when RICD is unavailable.
normalize()  : string
Normalize a URL by trimming trailing slashes.

Constants

DEFAULT_UNAVAILABLE_MESSAGE

public mixed DEFAULT_UNAVAILABLE_MESSAGE = 'RICD search failed. The external RICD server is sometimes slow or unavailable due to its prototype state – please try again once or twice. Please check if %s is reachable.'

OPTION_UNAVAILABLE_MESSAGE

public mixed OPTION_UNAVAILABLE_MESSAGE = 'webviep_ricd_unavailable_msg'

Methods

getBaseUrl()

Get configured base URL (falls back to default).

public getBaseUrl() : string
Return values
string

getUnavailableMessage()

Get message displayed when RICD is unavailable.

public getUnavailableMessage() : string
Return values
string

updateBaseUrl()

Update the base URL for the RICD client.

public updateBaseUrl(string $rawUrl) : void
Parameters
$rawUrl : string

Raw URL input.

updateUnavailableMessage()

Update the fallback message when RICD is unavailable.

public updateUnavailableMessage(string $rawMessage) : void
Parameters
$rawMessage : string

Message text.

normalize()

Normalize a URL by trimming trailing slashes.

private normalize(string $url) : string
Parameters
$url : string

URL to normalize.

Return values
string

        
On this page

Search results