Util

General utilities.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Table of Contents

clean()  : mixed
Sanitize anything.
default_access_control_options()  : array<string|int, mixed>
Get the default access control options.
get_access_control_option()  : mixed
Get an access control option.
get_advanced_default_options()  : array<string|int, mixed>
Get the default options for the advanced plugin.
get_available_roles()  : array<string|int, mixed>
Get available roles for global roles settings
get_document_editing_roles()  : array<string|int, mixed>
Get current document editing roles.
help_tip()  : string
Print an help tooltip.
is_dlp_frontend_ajax()  : mixed
Is DLP frontend AJAX request
is_document_owner_editing_enabled()  : bool
Check if document owner editing is enabled.
sanitize_tooltip()  : string
Sanitize the html content of a tooltip.

Methods

clean()

Sanitize anything.

public static clean(mixed $data) : mixed
Parameters
$data : mixed

The thing to sanitize.

Tags
Return values
mixed

default_access_control_options()

Get the default access control options.

public static default_access_control_options() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

get_access_control_option()

Get an access control option.

public static get_access_control_option(mixed $option_name) : mixed
Parameters
$option_name : mixed
Tags
Return values
mixed

get_advanced_default_options()

Get the default options for the advanced plugin.

public static get_advanced_default_options() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

get_available_roles()

Get available roles for global roles settings

public static get_available_roles() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

get_document_editing_roles()

Get current document editing roles.

public static get_document_editing_roles() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

help_tip()

Print an help tooltip.

public static help_tip(string $tip[, bool $allow_html = false ]) : string
Parameters
$tip : string

help tooltip.

$allow_html : bool = false
Tags
Return values
string

is_dlp_frontend_ajax()

Is DLP frontend AJAX request

public static is_dlp_frontend_ajax() : mixed
Tags
Return values
mixed

is_document_owner_editing_enabled()

Check if document owner editing is enabled.

public static is_document_owner_editing_enabled() : bool
Tags
Return values
bool

sanitize_tooltip()

Sanitize the html content of a tooltip.

private static sanitize_tooltip(string $tooltip) : string
Parameters
$tooltip : string

toolip content

Tags
Return values
string

Search results