Lizmap Web Client 3.10.0

Utils
in package

Table of Contents

Methods

getLastPartPath()  : string
Extracts and returns last part of a given path with a trailing slash.
isValidBooleanValue()  : bool
Validates whether the given value represents a boolean true value.
verifyVars()  : void
Verifies the validity of the provided group and right parameters against existing groups and rights.
getAllGroups()  : array<string|int, mixed>
Retrieves and returns a list of all group IDs.

Methods

getLastPartPath()

Extracts and returns last part of a given path with a trailing slash.

public static getLastPartPath(string $path) : string
Parameters
$path : string

the directory path to process

Return values
string

the last portion of the path, formatted with a trailing slash

isValidBooleanValue()

Validates whether the given value represents a boolean true value.

public static isValidBooleanValue(mixed $value) : bool
Parameters
$value : mixed

The value to validate. Can be of any data type.

Return values
bool

returns true if the value represents a boolean true value, otherwise false

verifyVars()

Verifies the validity of the provided group and right parameters against existing groups and rights.

public static verifyVars(null|string $group, null|string $right, string $key) : void
Parameters
$group : null|string

the name of the group to validate

$right : null|string

the name of the right to validate

$key : string

the key used to fetch the list of rights

Tags
throws
ApiException

getAllGroups()

Retrieves and returns a list of all group IDs.

private static getAllGroups(object $manager) : array<string|int, mixed>
Parameters
$manager : object

the manager object from which group information is retrieved

Return values
array<string|int, mixed>

an array of group IDs


        
On this page

Search results