UrlPreview
Table of Contents
Methods
- buildPreview() : string|null
- Returns HTML code for page preview.
- checkUserReadAccess() : bool
- Returns true if current user has read access to the page.
- getImAttach() : CIMMessageParamAttach|false
- Returns attach to display in the messenger.
- getImRich() : mixed
- getPreview() : array<string|int, mixed>
- Returns preview for landing.
- resolveLandingId() : int|null
- Resolve landing id by landing path.
Methods
buildPreview()
Returns HTML code for page preview.
public
static buildPreview(array<string|int, mixed> $params) : string|null
Parameters
- $params : array<string|int, mixed>
-
Params data.
Return values
string|nullcheckUserReadAccess()
Returns true if current user has read access to the page.
public
static checkUserReadAccess(array<string|int, mixed> $params, int $userId) : bool
Parameters
- $params : array<string|int, mixed>
-
Expected keys: siteCode[, folderCode, pageCode].
- $userId : int
-
Current user's id.
Return values
boolgetImAttach()
Returns attach to display in the messenger.
public
static getImAttach(array<string|int, mixed> $params) : CIMMessageParamAttach|false
Parameters
- $params : array<string|int, mixed>
-
Expected keys: siteCode[, folderCode, pageCode].
Return values
CIMMessageParamAttach|falsegetImRich()
public
static getImRich(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
getPreview()
Returns preview for landing.
public
static getPreview(int $landingId) : array<string|int, mixed>
Parameters
- $landingId : int
-
Landing id.
Return values
array<string|int, mixed>resolveLandingId()
Resolve landing id by landing path.
public
static resolveLandingId(string $landingPath) : int|null
Parameters
- $landingPath : string
-
Landing url.