SiteHandler
This class contains the functions to perform the following:
| api | |
|---|---|
| package | simPROAPI |
| subpackage | Sites |
| author | Nathan Muir |
| version | 2011-07-18 |
ContactInsert(int $CompanyID, int $SiteID, array $SiteContactDetails) : bool
<?php
array_keys($SiteContactDetails) == array(
"FirstName",
"LastName",
"Position",
"PhoneNumber",
"Mobile",
"Fax",
"Email"
);
?>
intthe company id
intthe site to add the contact to.
arrayan associative array of site contacts' information.
boolContactRetrieve(int $CompanyID, int $SiteID, int $ContactID = null) : array
| uses | \SiteHandler::ContactRetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
intthe site id, to retrieve Site Contacts for
intthe Contact ID.
arrayContactRetrieveList(int $CompanyID, array $SiteIDs) : array
| used_by | \SiteHandler::ContactRetrieve() |
|---|
intthe Company ID. In single company builds, this is 0.
arraylist of Site ID's to retrieve Site Contacts for
arrayInsert(int $CompanyID, array $SiteDetails) : int
<?php
array_keys($SiteDetails) == array (
'SiteName',
'Address',
'Suburb',
'State',
'Postcode',
'Country',
'MailAddress',
'MailSuburb',
'MailState',
'MailPostcode',
'ContactFirstName',
'ContactLastName',
'ContactPosition',
'Phone',
'Mobile',
'Fax',
'Email',
'Notes',
'ZoneName',
'ZoneID',
'CertificationDay',
'CertificationMonth',
'PostalContact',
'MailCompanyInclude',
'CustomFields'
);
?>
intthe company id
arrayan associative array of site information.
intPreferredTechnician(int $CompanyID, int $SiteID) : array
intthe Company ID. In single company builds, this is 0.
intretrieve details for the specified id
arrayRetrieve(int $CompanyID, int $SiteID) : array
| uses | \SiteHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
intretrieve details for the specified id
arrayRetrieveList(int $CompanyID, array $SiteIDs) : array
| used_by | \CustomerHandler::SiteRetrieveList() |
|---|---|
| used_by | \SiteHandler::Search() |
| used_by | \SiteHandler::SearchFields() |
| used_by | \SiteHandler::Retrieve() |
intthe Company ID. In single company builds, this is 0.
arraylist of Site ID's to retrieve details for
arraySearch(int $CompanyID, string $Search = '', int $Limit = 500, int $Offset = 0) : array
This function retrieve's a list of sites who's name matches the search term.
| uses | \SiteHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
stringThe search text for the location name. Can use % for wildcards.
intthe total number of sites to return (0 - 500)
inthow many results to skip, before returning {@link $Limit}
arraySearchFields(int $CompanyID, array $SearchTerms) : array
This function retrieve's a list of sites who's set of fields match their associated values
Implemented Search Terms are: Address,Suburb,State,Postcode,Zone,ZoneName
| uses | \SiteHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
arrayAn associative array of Search Fields[key] and their search terms [value]
arrayUpdate(int $CompanyID, int $SiteID, array $SiteDetails) : bool
<?php
array_keys($SiteDetails) == array (
'SiteName',
'Address',
'Suburb',
'State',
'Postcode',
'Country',
'MailAddress',
'MailSuburb',
'MailState',
'MailPostcode',
'ContactFirstName',
'ContactLastName',
'ContactPosition',
'Phone',
'Mobile',
'Fax',
'Email',
'Notes',
'ZoneName',
'ZoneID',
'CertificationDay',
'CertificationMonth',
'MailContact',
'MailCompanyInclude',
'CustomFields'
);
?>
intthe company id
intThe site to update.
arrayan associative array of site information.
boolValueForecast(int $CompanyID, int $SiteID, string $StartDate, string $EndDate) : array
Performs a value forecast on a site.
intthe company id
intthe site to perform the Value Forcast for
stringDate start (inclusive) to search. {@link http://php.net/manual/en/function.strtotime.php}
stringDate end (inclusive) to search. {@link http://php.net/manual/en/function.strtotime.php}
array