Owner
in package
Table of Contents
- $showRoleName : bool
- Show role name.
- $colorsCache : bool|string
- $currentUser : mixed
- $groupIdCache : mixed
- $groupLabelCache : mixed
- $moduleName : bool|string
- Module name or false.
- $ownerLabelCache : mixed
- $searchValue : mixed
- $typeCache : mixed
- $userLabelCache : mixed
- $usersIdsCache : mixed
- changeFavorites() : bool
- Change favorite owner state.
- find() : mixed
- getAccessible() : array<string|int, mixed>
- Get accessible.
- getAccessibleGroupForModule() : array<string|int, mixed>
- Function returns list of accessible users for a module.
- getAccessibleGroups() : array<string|int, mixed>
- Function to get all the accessible groups.
- getAccessibleUsers() : array<string|int, mixed>
- Function to get all the accessible users.
- getAccessibleUsersForModule() : array<string|int, mixed>
- Function returns list of accessible users for a module.
- getAllocation() : array<string|int, mixed>
- Get allocation.
- getAllUsers() : string
- The function retrieves all users with active status.
- getColor() : string
- Get owner color.
- getFavorites() : array<string|int, mixed>
- Gets favorite owners.
- getGroupId() : int
- Function to get the group id for a given group groupname.
- getGroupName() : string
- The function gets the group names.
- getGroups() : array<string|int, mixed>
- Function to get groups.
- getInstance() : self
- Function to get the instance.
- getLabel() : array<string|int, mixed>|int
- Function gets labels.
- getQueryInitUsers() : Query
- Function gets sql query.
- getType() : bool
- Function checks record type.
- getUserLabel() : bool|string
- The function gets the user label.
- getUsers() : array<string|int, mixed>
- Function returns the user key in user array.
- getUsersAndGroupForModuleList() : array<string|int, mixed>
- Get users and group for module list.
- getUsersIds() : array<string|int, mixed>
- The function retrieves user ids with active status.
- initUsers() : array<string|int, mixed>
- Function initiates users list.
- transferOwnership() : mixed
- Transfer ownership records.
- transferOwnershipForWorkflow() : mixed
- Transfer ownership workflow tasks.
Properties
$showRoleName
Show role name.
public
bool
$showRoleName
= false
$colorsCache
protected
static bool|string
$colorsCache
= false
Owners color
$currentUser
protected
mixed
$currentUser
$groupIdCache
protected
static mixed
$groupIdCache
= []
$groupLabelCache
protected
static mixed
$groupLabelCache
= []
$moduleName
Module name or false.
protected
bool|string
$moduleName
= false
$ownerLabelCache
protected
static mixed
$ownerLabelCache
= []
$searchValue
protected
mixed
$searchValue
$typeCache
protected
static mixed
$typeCache
= []
$userLabelCache
protected
static mixed
$userLabelCache
= []
$usersIdsCache
protected
static mixed
$usersIdsCache
= []
Methods
changeFavorites()
Change favorite owner state.
public
changeFavorites(string $ownerFieldType, int $ownerId) : bool
Parameters
- $ownerFieldType : string
- $ownerId : int
Tags
Return values
bool —find()
public
find(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —getAccessible()
Get accessible.
public
getAccessible([string $private = '' ][, bool $fieldType = false ][, bool $translate = false ]) : array<string|int, mixed>
Parameters
- $private : string = ''
- $fieldType : bool = false
- $translate : bool = false
Return values
array<string|int, mixed> —getAccessibleGroupForModule()
Function returns list of accessible users for a module.
public
getAccessibleGroupForModule() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAccessibleGroups()
Function to get all the accessible groups.
public
getAccessibleGroups([mixed $private = '' ][, mixed $fieldType = false ][, mixed $translate = false ]) : array<string|int, mixed>
Parameters
- $private : mixed = ''
- $fieldType : mixed = false
- $translate : mixed = false
Return values
array<string|int, mixed> —getAccessibleUsers()
Function to get all the accessible users.
public
getAccessibleUsers([string $private = '' ][, mixed $fieldType = false ]) : array<string|int, mixed>
Parameters
- $private : string = ''
- $fieldType : mixed = false
Return values
array<string|int, mixed> —getAccessibleUsersForModule()
Function returns list of accessible users for a module.
public
getAccessibleUsersForModule() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAllocation()
Get allocation.
public
getAllocation(string $mode, string $private, string $fieldType) : array<string|int, mixed>
Parameters
- $mode : string
- $private : string
- $fieldType : string
Return values
array<string|int, mixed> —getAllUsers()
The function retrieves all users with active status.
public
static getAllUsers([string $status = 'Active' ]) : string
Parameters
- $status : string = 'Active'
Return values
string —getColor()
Get owner color.
public
static getColor(int $id) : string
Parameters
- $id : int
Return values
string —getFavorites()
Gets favorite owners.
public
getFavorites(string $ownerFieldType) : array<string|int, mixed>
Parameters
- $ownerFieldType : string
Return values
array<string|int, mixed> —getGroupId()
Function to get the group id for a given group groupname.
public
static getGroupId(string $name) : int
Parameters
- $name : string
Return values
int —getGroupName()
The function gets the group names.
public
static getGroupName(int $id) : string
Parameters
- $id : int
Return values
string —getGroups()
Function to get groups.
public
getGroups([bool $addBlank = true ][, string $private = '' ]) : array<string|int, mixed>
Parameters
- $addBlank : bool = true
- $private : string = ''
Return values
array<string|int, mixed> —getInstance()
Function to get the instance.
public
static getInstance([string $moduleName = false ][, mixed $currentUser = false ]) : self
Parameters
- $moduleName : string = false
- $currentUser : mixed = false
Return values
self —getLabel()
Function gets labels.
public
static getLabel(array<string|int, mixed>|int $mixedId) : array<string|int, mixed>|int
Parameters
- $mixedId : array<string|int, mixed>|int
Return values
array<string|int, mixed>|int —getQueryInitUsers()
Function gets sql query.
public
getQueryInitUsers([mixed $private = false ][, mixed $status = false ][, mixed $roles = false ]) : Query
Parameters
- $private : mixed = false
- $status : mixed = false
- $roles : mixed = false
Return values
Query —getType()
Function checks record type.
public
static getType(int $id) : bool
Parameters
- $id : int
Return values
bool —getUserLabel()
The function gets the user label.
public
static getUserLabel(int $id) : bool|string
Parameters
- $id : int
Return values
bool|string —getUsers()
Function returns the user key in user array.
public
getUsers([bool $addBlank = false ][, string $status = 'Active' ][, string|array<string|int, mixed>|int $assignedUser = '' ][, string $private = '' ][, bool $onlyAdmin = false ][, bool $roles = false ]) : array<string|int, mixed>
Parameters
- $addBlank : bool = false
- $status : string = 'Active'
-
User status
- $assignedUser : string|array<string|int, mixed>|int = ''
-
User id
- $private : string = ''
-
Sharing type
- $onlyAdmin : bool = false
-
Show only admin users
- $roles : bool = false
Return values
array<string|int, mixed> —getUsersAndGroupForModuleList()
Get users and group for module list.
public
getUsersAndGroupForModuleList([bool $view = false ][, bool|array<string|int, mixed> $conditions = false ][, string $fieldName = 'assigned_user_id' ]) : array<string|int, mixed>
Parameters
- $view : bool = false
- $conditions : bool|array<string|int, mixed> = false
- $fieldName : string = 'assigned_user_id'
Return values
array<string|int, mixed> —getUsersIds()
The function retrieves user ids with active status.
public
static getUsersIds([string $status = 'Active' ]) : array<string|int, mixed>
Parameters
- $status : string = 'Active'
Return values
array<string|int, mixed> —initUsers()
Function initiates users list.
public
& initUsers([string $status = 'Active' ][, mixed $assignedUser = '' ][, string $private = '' ][, mixed $roles = false ]) : array<string|int, mixed>
Parameters
- $status : string = 'Active'
- $assignedUser : mixed = ''
- $private : string = ''
- $roles : mixed = false
Return values
array<string|int, mixed> —transferOwnership()
Transfer ownership records.
public
static transferOwnership(int $oldId, int $newId) : mixed
Parameters
- $oldId : int
- $newId : int
Return values
mixed —transferOwnershipForWorkflow()
Transfer ownership workflow tasks.
private
static transferOwnershipForWorkflow(type $oldId, type $newId) : mixed
Parameters
- $oldId : type
- $newId : type