Back to top  

CostCentreHandler

This class contains the functions to perform the following:

- Retrieve Cost Centre(s)
api
package simPROAPI
subpackage Configuration
author Nathan Muir
version 2011-07-18

 Methods

CostCentreRetrieve

Retrieve(int $CompanyID, int $CostCentreID, bool $ReturnRemoved = false) : array
Static

This function retrieves details for a specific details id

uses \CostCentreHandler::RetrieveList()

Parameters

$CompanyID

int

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

$CostCentreID

int

the Cost Centre id to retrieve details for

$ReturnRemoved = false

bool

if true, it will return removed departments

Returns

array

CostCentreRetrieveList

RetrieveList(int $CompanyID, array $CostCentreIDs, bool $ReturnRemoved) : array
Static

This function retrieves details on the provided list of cost centre ids

used_by \CostCentreHandler::Search()
used_by \CostCentreHandler::Retrieve()

Parameters

$CompanyID

int

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

$CostCentreIDs

array

the cost centre ids to retrieve details for

$ReturnRemoved

bool

if true, it will return removed departments

Returns

array

CostCentreSearch

Search(int $CompanyID, string $Name = '%', bool $ReturnRemoved = false) : array
Static

This function searches for a cost centre with a name. Use % for wildcards

uses \CostCentreHandler::RetrieveList()

Parameters

$CompanyID

int

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

$Name = '%'

string

The Cost Centre Name to search for

$ReturnRemoved = false

bool

if true, it will return removed departments

Returns

array