Back to top  

PrebuildGroupHandler

This class contains the functions to manage Prebuild Groups

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

 Methods

PrebuildGroupInsert

Insert(int $CompanyID, string $GroupName) : int
Static

Parameters

$CompanyID

int

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

$GroupName

string

the group to add

Returns

int

PrebuildGroupRetrieve

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

This function retrieves details for a specific details id

uses \PrebuildGroupHandler::RetrieveList()

Parameters

$CompanyID

int

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

$PrebuildGroupID

int

the Prebuild Group id to retrieve details for

Returns

array

PrebuildGroupRetrieveList

RetrieveList(int $CompanyID, array $PrebuildGroupIDs) : array
Static

This function retrieves details on the provided list of Prebuild Group ids

used_by \PrebuildGroupHandler::Search()
used_by \PrebuildGroupHandler::Retrieve()

Parameters

$CompanyID

int

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

$PrebuildGroupIDs

array

the Prebuild Group ids to retrieve details for

Returns

array

PrebuildGroupSearch

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

This function searches for a prebuild group with a name. Use % for wildcards

uses \PrebuildGroupHandler::RetrieveList()

Parameters

$CompanyID

int

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

$Search = ''

string

The Prebuild Group Name to search for

Returns

array

PrebuildGroupUpdate

Update(int $CompanyID, int $PrebuildGroupID, string $GroupName) : bool
Static

Parameters

$CompanyID

int

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

$PrebuildGroupID

int

the prebuild group id to update

$GroupName

string

the new group name

Returns

bool