ContractorHandler
This class contains the functions to perform the following:
| api | |
|---|---|
| package | simPROAPI |
| subpackage | Staff |
| author | Nathan Muir, Michael West, Daniel Sanders [add other contributors] |
| version | 2011-08-15 |
| uses | \global\StaffHandler |
| uses | \global\InvoiceHandler |
| used-by | AccPayContactHandler |
AttachmentsRetrieve(int $CompanyID, int $ContractorStaffID) : array
This function retrieves the list of attachemnts for the provided contractor id
| uses | \StaffHandler::RetrieveAttachments() |
|---|
intthe Company ID. In single company builds, this is 0.
intThe contractor staff member to retrieve attachments for
arrayInsert(int $CompanyID, array $ContractorDetails) : int
<?php
array_keys($ContractorDetails) == array(
"CompanyName",
"MailAddress",
"MailSuburb",
"MailState",
"MailPostcode",
"MailCountry",
"Phone1",
"Mobile",
"Fax",
"Email",
"TaxNumber",
"AccountName",
"BSB",
"AccountNo",
"PaymentTerm",
"PaymentTermType",
"Tax"
);
?>
intthe company id
arrayan associative array of supplier information.
intLicencesRetrieve(int $CompanyID, int $ContractorStaffID) : array
This function retrieves licences for the provided employee id
| uses | \StaffHandler::RetrieveLicences() |
|---|
intthe Company ID. In single company builds, this is 0.
intThe contractor to retrieve licences for
arrayLicencesSearch(int $CompanyID, string $Search = '') : array
This function retrieves licences for all employees under a company
intthe Company ID. In single company builds, this is 0.
stringThe search string for the licence name.
arrayRetrieve(mixed $CompanyID, int $ContractorStaffID) : array
This function retrieves a contractor with a specific ID
| uses | \ContractorHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
intthe contractor's staff id.
arrayRetrieveList(mixed $CompanyID, array $ContractorStaffIDs, array $Detail = array()) : array
This function retrieves details on the provided list of contractor ids
| used_by | \AccPayContactHandler::Search() |
|---|---|
| used_by | \AccPayContactHandler::Retrieve() |
| used_by | \AccPayContactHandler::RetrieveExport() |
| used_by | \AccPayContactHandler::RetrieveAll() |
| used_by | \StaffHandler::RetrieveList() |
| used_by | \ContractorHandler::Search() |
| used_by | \ContractorHandler::SearchFields() |
| used_by | \ContractorHandler::RetrieveStaff() |
| used_by | \ContractorHandler::Retrieve() |
| used_by | \InventoryJournalHandler::RetrieveExport() |
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
arraylist of Contractor Staff ID's to retrieve.
arraythe specification of which details to return - ("Zones","Departments","Companies","BillRates"). Null/Empty/Empty array will return none.
arrayRetrieveStaff(mixed $CompanyID, int $ContractorID) : array
This function retrieves a list of staff under a contractor company.
| uses | \ContractorHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
intthe ContractorID to retreive their staff for.
arraySearch(mixed $CompanyID, string $Search = '%', array $Detail = array()) : array
This function retrieve's a list of contractor who's company name matches the search term.
| uses | \ContractorHandler::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 contractor company name. 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 contractors who's set of fields match their associated values
Implemented Search Terms are: CompanyName,ContactName,Zone,ZoneName,Export
| uses | \ContractorHandler::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(mixed $CompanyID) : int
This function retrieves the total number of contractors in the system
| used_by | \AccPayContactHandler::TotalCount() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
intUpdate(int $CompanyID, int $ContractorStaffID, array $ContractorDetails) : bool
<?php
array_keys($ContractorDetails) == array(
"CompanyName",
"MailAddress",
"MailSuburb",
"MailState",
"MailPostcode",
"Country",
"Phone1",
"Mobile",
"Fax",
"Email",
"id",
"Active",
"TaxNumber",
"AccountName",
"bsb",
"AccountNo",
"PaymentTerm",
"PaymentTermType"
);
?>
intthe company id
intThe contractor id to update with the supplied information
arrayan associative array of contractor information.
bool