PlantHandler
This class contains the functions to perform the following:
| api | |
|---|---|
| package | simPROAPI |
| subpackage | Staff |
| author | Nathan Muir, Isaac Martin |
| version | 2014-06-23 |
| uses | \global\StaffHandler |
Retrieve(mixed $CompanyID, int $PlantID) : array
This function retrieves a plant with a specific Plant ID
| uses | \PlantHandler::RetrieveList() |
|---|
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
intplant id
arrayRetrieveList(mixed $CompanyID, array $PlantIDs, array $Detail = array()) : array
This function retrieves details on the provided list of plant ids
| uses | \StaffHandler::RetrieveList() |
|---|---|
| used_by | \PlantHandler::Search() |
| used_by | \PlantHandler::SearchFields() |
| used_by | \PlantHandler::Retrieve() |
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
arraylist of Plant ID's to retrieve.
arraythe specification of which details to return - ("Zones","Departments"). Null/Empty/Empty array will return none.
arraySearch(mixed $CompanyID, string $Search = '%', array $Detail = array(), bool $Schedulable = false) : array
This function retrieve's a list of plants who's name matches the search term.
| uses | \PlantHandler::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 plant. Can use % for wildcards.
arraythe specification of which details to return - ("Zones","Departments"). Null/Empty/Empty array will return none.
boolwether to return schedulable Plant items. Null/Empty will return all.
arraySearchFields(mixed $CompanyID, array $SearchTerms) : array
This function retrieve's a list of plants who's set of fields match their associated values
Implemented Search Terms are: ZoneID, ZoneName, PlantTypeID, PlantTypeName
| uses | \PlantHandler::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]
arrayTypesRetrieve(mixed $CompanyID) : array
This function retrieves plant types
mixedthe Company IDs. Can be a single Company ID or an array of Company IDs. In single company builds, this is 0.
array