Back to top  

CustomerIdentifierHandler

This class contains the functions to perform the following:

- Retrieve Customer Identifiers(s)
api
package simPROAPI
subpackage Customers
author Nathan Muir
version 2011-08-23

 Methods

CustomerIdentifierInsert

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

Parameters

$CompanyID

int

the company id

$TagName

string

the identifier name

Returns

int

CustomerIdentifierRetrieve

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

This function retrieves details for a specific details id

uses \CustomerIdentifierHandler::RetrieveList()

Parameters

$CompanyID

int

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

$CustomerIdentifierID

int

the Customer Identifier id to retrieve details for

Returns

array

CustomerIdentifierRetrieveList

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

This function retrieves details on the provided list of Customer Identifier ids

used_by \CustomerIdentifierHandler::Search()
used_by \CustomerIdentifierHandler::Retrieve()

Parameters

$CompanyID

int

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

$CustomerIdentifierIDs

array

the Customer Identifier ids to retrieve details for

Returns

array

CustomerIdentifierSearch

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

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

uses \CustomerIdentifierHandler::RetrieveList()

Parameters

$CompanyID

int

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

$Name = '%'

string

The Customer Identifier Name to search for

Returns

array

CustomerIdentifierUpdate

Update(int $CompanyID, int $TagID, string $TagName) : int
Static

Parameters

$CompanyID

int

$TagID

int

$TagName

string

Returns

int