Lizmap Web Client 3.11.0

permalinkCtrl extends jController
in package

Manage short link permalink.

Tags
author

3liz

copyright

2026 3liz

see
http://3liz.com
license

Mozilla Public License : http://www.mozilla.org/MPL/

Table of Contents

Properties

$permalinkParameters  : mixed
$project  : null|string
$repository  : null|string

Methods

add()  : jResponseJson
Inserts a new permalink record. Returns the permalink id if no errors occur.
error()  : jResponseJson
Return error message to the client.
get()  : jResponseJson
Get the given permalink record by id, returns an error if the record does not exists.
index()  : jResponseJson
Permalink controller entrypoint.
encodeJsonParameters()  : string
Validates client permalink parameters. Returns the corresponding json encoded string.
getPermalinkHash()  : string
Get sha256 hash for the given encoded permalink string.

Properties

$permalinkParameters

protected mixed $permalinkParameters = array('bbox', 'layers', 'styles', 'opacities', 'categories')

Methods

add()

Inserts a new permalink record. Returns the permalink id if no errors occur.

public add() : jResponseJson
Return values
jResponseJson

error()

Return error message to the client.

public error() : jResponseJson
Return values
jResponseJson

get()

Get the given permalink record by id, returns an error if the record does not exists.

public get() : jResponseJson
Return values
jResponseJson

index()

Permalink controller entrypoint.

public index() : jResponseJson
Return values
jResponseJson

encodeJsonParameters()

Validates client permalink parameters. Returns the corresponding json encoded string.

private encodeJsonParameters() : string
Return values
string

getPermalinkHash()

Get sha256 hash for the given encoded permalink string.

private getPermalinkHash(string $permalink) : string
Parameters
$permalink : string
Return values
string
On this page

Search results