EmployeeHandler
This class contains the functions to perform the following:
| api | |
|---|---|
| package | simPROAPI |
| subpackage | Staff |
| author | Nathan Muir |
| version | 2011-08-15 |
| uses | \global\StaffHandler |
AttachmentsRetrieve(mixed $CompanyID, int $EmployeeID) : array
This function retrieves the list of attachemnts for the provided employee id
| uses | \StaffHandler::RetrieveAttachments() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
intThe employee member to retrieve licences for
arrayFlag(int $CompanyID, int $EmployeeID) : bool
This function flags a particular employee as exported
intthe Company ID. In single company builds, this is 0.
intThe employee to flag as exported
boolFlagList(int $CompanyID, array $EmployeeIDs) : array
This function flags a list of employees as exported
intthe Company ID. In single company builds, this is 0.
arrayThe employee list to flag as exported
arrayInsert(int $CompanyID, array $EmployeeDetails) : int
<?php
array_keys($EmployeeDetails) == array(
"EmployeeName",
"HomeAddress",
"HomeSuburb",
"HomeState",
"HomePostcode",
"HomeCountry",
"Phone1",
"Mobile",
"Fax",
"Email",
"Active",
"TaxFileNo",
"AccountName",
"BSB",
"AccountNo",
"DateOfBirth",
"DateOfCommencement",
"Export",
"CustomFields",
"Position"
);
?>
intthe company id
arrayan associative array of employee information.
intLicenceInsert(int $CompanyID, int $EmployeeID, array $LicenceDetails = array()) : bool
<?php
array_keys($LicenceDetails) == array (
'LicenceName',
'LicenceReference',
'LicenceExpiry',
)
This function inserts a licence for a particular employee
intthe Company ID. In single company builds, this is 0.
intemployee ID to link the licence.
arrayan associative array of licence information
boolLicencesRetrieve(int $CompanyID, int $EmployeeID) : array
This function retrieves licences for the provided employee id
| uses | \StaffHandler::RetrieveLicences() |
|---|
intthe Company ID. In single company builds, this is 0.
intThe employee member to retrieve licences for
arrayLicencesSearch(mixed $CompanyID, string $Search = '') : array
This function retrieves licences for all employees under a company
mixedthe Company ID. In single company builds, this is 0.
stringThe search string for the licence name.
arrayRetrieve(mixed $CompanyID, int $EmployeeID) : array
This function retrieves a employee with a specific ID
| uses | \EmployeeHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
intemployee id
arrayRetrieveAll(mixed $CompanyID) : array
This function retrieves a list of employees
| uses | \EmployeeHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
arrayRetrieveCurrent(array $Detail = array()) : array
This function retrieves the currently logged in user as well as the server time
| uses | \EmployeeHandler::RetrieveList() |
|---|
arraythe specification of which details to return - ("Zones","Departments","Companies","Billing"). Null/Empty/Empty array will return none.
arrayRetrieveExport(mixed $CompanyID) : array
This function retrieves a list of employees that are ready for export
| uses | \EmployeeHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
arrayRetrieveList(mixed $CompanyID, array $EmployeeIDs, array $Detail = array()) : array
This function retrieves details on the provided list of employee ids
| uses | \StaffHandler::RetrieveList() |
|---|---|
| used_by | \EmployeeHandler::Search() |
| used_by | \EmployeeHandler::SearchFields() |
| used_by | \EmployeeHandler::Retrieve() |
| used_by | \EmployeeHandler::RetrieveCurrent() |
| used_by | \EmployeeHandler::RetrieveExport() |
| used_by | \EmployeeHandler::RetrieveAll() |
| used_by | \StaffHandler::RetrieveList() |
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
arraylist of Employee ID's to retrieve.
arraythe specification of which details to return - ("Zones","Departments","Companies","BillRates"). Null/Empty/Empty array will return none.
arraySearch(mixed $CompanyID, string $Search = '%', array $Detail = array()) : array
This function retrieve's a list of employee who's name matches the search term.
| uses | \EmployeeHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
stringThe search text for the employee. Can use % for wildcards.
arraythe specification of which details to return - ("Zones","Departments","Companies","Billing"). Null/Empty/Empty array will return none.
arraySearchFields(mixed $CompanyID, array $SearchTerms) : array
This function retrieve's a list of employees who's set of fields match their associated values
Implemented Search Terms are: SalesPerson, ProjectManagerID, UserName, Zone, ZoneName, Export
| uses | \EmployeeHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
arrayAn associative array of Search Fields[key] and their search terms [value]
arrayTotalCount(int $CompanyID) : array
This function returns the total number of Employees that are not archived
intthe Company ID. In single company builds, this is 0.
arrayUnFlag(int $CompanyID, int $EmployeeID) : bool
This function Unflags a particular employee as exported
intthe Company ID. In single company builds, this is 0.
intThe employee to Unflag as exported
boolUnFlagList(int $CompanyID, array $EmployeeIDs) : array
This function Unflags a list of employees as exported
intthe Company ID. In single company builds, this is 0.
arrayThe employee list to Unflag as exported
arrayUpdate(int $CompanyID, int $EmployeeID, array $EmployeeDetails) : bool
<?php
array_keys($EmployeeDetails) == array(
"EmployeeName",
"HomeAddress",
"HomeSuburb",
"HomeState",
"HomePostcode",
"HomeCountry",
"Phone1",
"Mobile",
"Fax",
"Email",
"Active",
"TaxFileNo",
"AccountName",
"BSB",
"AccountNo",
"DateOfBirth",
"DateOfCommencement",
"Export",
"CustomFields",
"Position"
);
?>
intthe company id
intThe employee id to update with the supplied information
arrayan associative array of employee information.
bool