CatalogItemHandler
This class contains the functions to perform the following:
- Retrieve Catalog Items
- Insert Catalog Items
| api | |
|---|---|
| package | simPROAPI |
| subpackage | Materials |
| author | Nathan Muir |
| version | 2011-07-18 |
AddSupplier(int $CompanyID, int $CatalogItemID, int $SupplierID, double $NettPrice = null, bool $Default = false) : bool
intthe Company ID. In single company builds, this is 0.
intThe catalog item id to update
intThe supplier id to attach to the catalog item
doubleNett price for this part and supplier (Optional)
boolSet this supplier as the item's default supplier (Default: false)
boolDeleteLink(int $CompanyID, int $CatalogItemID, int $LinkCatalogItemID) : bool
intthe Company ID. In single company builds, this is 0.
intThe catalog item id to update by unlinking the supplied item
intThe catalog item id to unlink
boolDeleteSupplier(int $CompanyID, int $CatalogItemID, int $SupplierID) : bool
intthe Company ID. In single company builds, this is 0.
intThe catalog item id to update
intThe supplier id to remove from the catalog item
boolInsert(int $CompanyID, array $CatalogItemDetails) : int
<?php
$CatalogItemDetails = array(
"ItemName"=>"",
"GroupID"=>0,
"SubGroupID"=>0,
"PartNo"=>"",
"TradePrice"=>0.00,
"Manufacturer"=>"",
"Notes"=>"",
"Time"=>0.00,
"SearchTerms"=>array("",""),
"Favourite"=>true
);
?>
intthe company id
arrayan associative array of task information.
intLink(int $CompanyID, int $CatalogItemID, int $LinkCatalogItemID) : bool
intthe Company ID. In single company builds, this is 0.
intThe catalog item id to update with the supplied linked item
intThe catalog item id to link
boolRetrieve(int $CompanyID, int $CatalogItemID) : array
This function retrieves details for a specific details id
| uses | \CatalogItemHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
intthe Catalog Group id to retrieve details for
arrayRetrieveList(int $CompanyID, array $CatalogItemIDs) : array
This function retrieves details on the provided list of Catalog Item ids
| used_by | \CatalogItemHandler::Search() |
|---|---|
| used_by | \CatalogItemHandler::SearchExact() |
| used_by | \CatalogItemHandler::Retrieve() |
intthe Company ID. In single company builds, this is 0.
arraythe Catalog Item ids to retrieve details for
arraySearch(int $CompanyID, string $SearchText = null, int $CatalogGroupID = null, int $CatalogSubGroupID = null, int $Limit = 1000, int $Offset = 0, bool $Favorite = null) : array
This function searches the catalog for item with a name. Use % for wildcards
| uses | \CatalogItemHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
stringthe text to search the name, catalog no, or search terms for
intthe catalog group to search in
intthe sub group to search in
inthow many results to return
inthow many results to skip, before returning {@link $Limit}
boolreturn favorite items
arraySearchExact(int $CompanyID, string $Search, int $CatalogGroupID = null, int $CatalogSubGroupID = null) : array
This function searches the catalog for item which matches exactly the name, catalog no, or search terms
| uses | \CatalogItemHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
stringthe text to match the name, catalog no, or search terms for
intthe catalog group to search in
intthe sub group to search in
arrayUpdate(int $CompanyID, int $CatalogItemID, array $CatalogItemDetails) : bool
<?php
$CatalogItemDetails = array(
"ItemName"=>"",
"GroupID"=>0,
"SubGroupID"=>0,
"PartNo"=>"",
"TradePrice"=>0.00,
"Manufacturer"=>"",
"Notes"=>"",
"Time"=>0.00,
"SearchTerms"=>array("",""),
"Favourite"=>true
);
?>
intthe company id
intThe item id to update with the supplied information
arrayan associative array of task information.
bool