ScriptManager
extends AutoService
in package
implements
HookInterface
Manage the iframe entry-point script.
Tags
Table of Contents
Interfaces
- HookInterface
- Interface HookInterface
Constants
- CHECK_NAME = 'iframeInstall'
- The symbolic of the system status-check which monitors the script.
Properties
Methods
- getCurrent() : string|null
- getMeta() : array<string|int, mixed>|null
- Read metadata about the existing script.
- getPath() : string
- Get the local path to the IFRAME entry-point.
- hook_civicrm_check() : void
- install() : void
- isInstallable() : bool
- render() : string
- Generate the literal code for the entry-point script.
- relativize() : string
- Convert the absolute path of $target to a relative path (as seen from $base).
Constants
CHECK_NAME
The symbolic of the system status-check which monitors the script.
public
mixed
CHECK_NAME
= 'iframeInstall'
Properties
$iframe
protected
Iframe
$iframe
Tags
Methods
getCurrent()
public
getCurrent() : string|null
Return values
string|nullgetMeta()
Read metadata about the existing script.
public
getMeta() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetPath()
Get the local path to the IFRAME entry-point.
public
getPath() : string
Return values
stringhook_civicrm_check()
public
hook_civicrm_check(mixed &$messages[, mixed $statusNames = [] ][, mixed $includeDisabled = FALSE ]) : void
Parameters
- $messages : mixed
- $statusNames : mixed = []
- $includeDisabled : mixed = FALSE
Tags
install()
public
install() : void
isInstallable()
public
isInstallable() : bool
Return values
boolrender()
Generate the literal code for the entry-point script.
public
render(string $sourceClass) : string
Parameters
- $sourceClass : string
-
Ex: 'Civi\Iframe\EntryPoint\Drupal'
Return values
stringrelativize()
Convert the absolute path of $target to a relative path (as seen from $base).
protected
relativize(string $target, string $base) : string
This variant will attempt to use ../.
Parameters
- $target : string
- $base : string