Back to top  

CatalogSubGroupHandler

api
package simPROAPI
subpackage Materials
author Nathan Muir
version 2011-07-18

 Methods

CatalogSubGroupInsert

Insert(int $CompanyID, int $CatalogGroupID, string $SubGroupName) : int
Static

Parameters

$CompanyID

int

the company id

$CatalogGroupID

int

the catalog group to add the sub-group to

$SubGroupName

string

the sub-group to add

Returns

int

CatalogSubGroupRetrieve

Retrieve(int $CompanyID, int $CatalogSubGroupID) : array
Static

This function retrieves details for a specific details id

uses \CatalogSubGroupHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$CatalogSubGroupID

int

the Catalog Sub-Group id to retrieve details for

Returns

array

CatalogSubGroupRetrieveList

RetrieveList(int $CompanyID, array $CatalogSubGroupIDs = array(), array $CatalogGroupIDs = array()) : array
Static

This function retrieves details on the provided list of Catalog Sub-Group ids

used_by \CatalogSubGroupHandler::Search()
used_by \CatalogSubGroupHandler::Retrieve()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$CatalogSubGroupIDs = array()

array

the Catalog Sub-Group ids to retrieve details for

$CatalogGroupIDs = array()

array

the Catalog Group ids to retrieve details for -- parameter will be removed.

Returns

array

CatalogSubGroupSearch

Search(int $CompanyID, string $Search = '', int $CatalogGroupID = null) : array
Static

This function searches for a catalog sub-group with a name. Use % for wildcards

uses \CatalogSubGroupHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$Search = ''

string

The Catalog Sub-Group Name to search for

$CatalogGroupID = null

int

the Catalog Group id to search for sub groups, null to search all groups

Returns

array

CatalogSubGroupUpdate

Update(int $CompanyID, int $CatalogSubGroupID, string $SubGroupName, int $CatalogGroupID = null) : bool
Static

Parameters

$CompanyID

int

the company id

$CatalogSubGroupID

int

the Sub-Group to update.

$SubGroupName

string

the new sub-group name

$CatalogGroupID = null

int

the catalog group to move the sub-group to. Null/Zero keeps the current value.

Returns

bool