Documentation

EmployeesPublicController extends BasePublicApiController
in package

Tags
Path

("/employees") Class EmployeesPublicController

category
subpackage

Api\Controllers

Table of Contents

HOOK_NAME  = 'api_employee_auth_hook'
$authManager  : mixed
$metaManager  : MetaManager
$tagsManager  : TagsManager
$translator  : Translator
$container  : Container
$database  : Explorer
$employeeModule  : EmployeesModule
$employeesManager  : EmployeesManager
$modelHooks  : ModelHooks|object
__construct()  : mixed
authEmployee()  : ApiResponse
getEmployee()  : ApiResponse
getForFamily()  : ApiResponse
getFromNumber()  : ApiResponse
getEmployeeArray()  : array<string|int, mixed>
getEmployees()  : Selection

Constants

Properties

Methods

__construct()

public __construct(Container $container, Explorer $database) : mixed
Parameters
$container : Container
$database : Explorer
Return values
mixed —

authEmployee()

public authEmployee(ApiRequest $request, ApiResponse $response) : ApiResponse
Parameters
$request : ApiRequest
$response : ApiResponse
Tags
Path

("/auth")

Method

("POST")

throws
JsonException
Return values
ApiResponse —

getEmployee()

public getEmployee(ApiRequest $request, ApiResponse $response) : ApiResponse
Parameters
$request : ApiRequest
$response : ApiResponse
Tags
Path

("/get")

Method

("GET")

throws
JsonException
Return values
ApiResponse —

getForFamily()

public getForFamily(ApiRequest $request, ApiResponse $response) : ApiResponse
Parameters
$request : ApiRequest
$response : ApiResponse
Tags
Path

("/getForFamily")

Method

("GET")

throws
JsonException
Return values
ApiResponse —

getFromNumber()

public getFromNumber(ApiRequest $request, ApiResponse $response) : ApiResponse
Parameters
$request : ApiRequest
$response : ApiResponse
Tags
Path

("/getForNumber")

Method

("GET")

throws
JsonException
Return values
ApiResponse —

getEmployeeArray()

private getEmployeeArray(Selection $employees[, mixed $is_full = false ]) : array<string|int, mixed>
Parameters
$employees : Selection
$is_full : mixed = false
Tags
throws
JsonException
Return values
array<string|int, mixed> —

getEmployees()

private getEmployees(mixed $param, mixed $value) : Selection
Parameters
$param : mixed
$value : mixed
Return values
Selection —

Search results