TimeTrex API Manual

Permission
in package

Table of Contents

$cached_permission_children_ids  : mixed
$cached_permission_levels  : mixed
$cached_permissions  : mixed
AuthenticationTypeDenied()  : bool
Check()  : bool
checkAuthenticationType()  : bool
Check to make sure the authentication type is at least this level.
getLastUpdatedDate()  : bool
getLevel()  : bool|int
getPermissionChildren()  : array<string|int, mixed>|bool|mixed|null
getPermissionFilterData()  : array<string|int, mixed>|bool
getPermissionHierarchyChildren()  : mixed
getPermissionHierarchySQL()  : string
getPermissionIsChildIsOwnerFilterSQL()  : array<string|int, mixed>|bool|string
getPermissionIsChildIsOwnerSQL()  : string
getPermissions()  : array<string|int, mixed>
isChild()  : bool
Checks if the row_object_id is in the src_object_list array,
isOwner()  : bool
Checks if the row_object_id is created by the current user
isPermissionChild()  : bool
PermissionDenied()  : bool
Query()  : bool
Redirect()  : bool

Properties

$cached_permission_children_ids

private mixed $cached_permission_children_ids = []

Methods

AuthenticationTypeDenied()

public AuthenticationTypeDenied([bool $result = false ][, string $description = null ]) : bool
Parameters
$result : bool = false
$description : string = null
Return values
bool —

Check()

public Check( $section,  $name[, string $user_id = null ][, string $company_id = null ]) : bool
Parameters
$section :
$name :
$user_id : string = null

UUID

$company_id : string = null

UUID

Return values
bool —

checkAuthenticationType()

Check to make sure the authentication type is at least this level.

public checkAuthenticationType(int $type_id) : bool
Parameters
$type_id : int
Return values
bool —

getLastUpdatedDate()

public getLastUpdatedDate([string $user_id = null ][, string $company_id = null ]) : bool
Parameters
$user_id : string = null

UUID

$company_id : string = null

UUID

Return values
bool —

getLevel()

public getLevel([string $user_id = null ][, string $company_id = null ]) : bool|int
Parameters
$user_id : string = null

UUID

$company_id : string = null

UUID

Return values
bool|int —

getPermissionChildren()

public getPermissionChildren( $section,  $name[, string $user_id = null ][, string $company_id = null ]) : array<string|int, mixed>|bool|mixed|null
Parameters
$section :
$name :
$user_id : string = null

UUID

$company_id : string = null

UUID

Return values
array<string|int, mixed>|bool|mixed|null —

getPermissionFilterData()

public getPermissionFilterData( $section,  $name[, string $user_id = null ]) : array<string|int, mixed>|bool
Parameters
$section :
$name :
$user_id : string = null

UUID

Return values
array<string|int, mixed>|bool —

getPermissionHierarchyChildren()

public getPermissionHierarchyChildren(string $company_id, string $user_id) : mixed
Parameters
$company_id : string

UUID

$user_id : string

UUID

Return values
mixed —

getPermissionHierarchySQL()

public static getPermissionHierarchySQL(string $company_id, string $user_id,  $outer_column) : string
Parameters
$company_id : string

UUID

$user_id : string

UUID

$outer_column :
Return values
string —

getPermissionIsChildIsOwnerFilterSQL()

public static getPermissionIsChildIsOwnerFilterSQL( $filter_data,  $outer_column_name) : array<string|int, mixed>|bool|string
Parameters
$filter_data :
$outer_column_name :
Return values
array<string|int, mixed>|bool|string —

getPermissionIsChildIsOwnerSQL()

public static getPermissionIsChildIsOwnerSQL(string $id,  $inner_column[, bool $append_comma = true ][, null $special_child_id = null ]) : string
Parameters
$id : string

UUID

$inner_column :
$append_comma : bool = true
$special_child_id : null = null
Return values
string —

getPermissions()

public getPermissions(string $user_id, string $company_id) : array<string|int, mixed>
Parameters
$user_id : string

UUID

$company_id : string

UUID

Return values
array<string|int, mixed> —

isChild()

Checks if the row_object_id is in the src_object_list array,

public isChild(string $row_object_id,  $src_object_list[, string $current_user_id = null ]) : bool
Parameters
$row_object_id : string

UUID

$src_object_list :
$current_user_id : string = null

UUID

Return values
bool —

isOwner()

Checks if the row_object_id is created by the current user

public isOwner( $object_created_by[, null $object_assigned_to = null ][, string $current_user_id = null ]) : bool
Parameters
$object_created_by :
$object_assigned_to : null = null
$current_user_id : string = null

UUID

Return values
bool —

isPermissionChild()

public isPermissionChild(string $user_id, string|array<string|int, string> $permission_children_ids) : bool
Parameters
$user_id : string

UUID

$permission_children_ids : string|array<string|int, string>

UUID

Return values
bool —

PermissionDenied()

public PermissionDenied([bool $result = false ][, string $description = null ]) : bool
Parameters
$result : bool = false
$description : string = null
Return values
bool —

Query()

public Query( $section,  $name[, string $user_id = null ][, string $company_id = null ]) : bool
Parameters
$section :
$name :
$user_id : string = null

UUID

$company_id : string = null

UUID

Return values
bool —

Redirect()

public Redirect( $result) : bool
Parameters
$result :
Return values
bool —

Search results