package | API\Client |
---|---|
inherited_from | \APIFactory |
__construct()
inherited_from | \APIFactory::__construct() |
---|
__construct()
convertAPIReturnHandlerToValidatorObject($api_retarr, $validator_obj = FALSE
)
convertToMultipleRecords($data)
convertToSingleRecord($data)
deleteClientGroup(array $data) : array
array
ClientGroup data
array
dragNdropClientGroup(array $src_id, integer $dst_id) : array
array
source Group ID
integer
destination Group ID
array
exportRecords($format, $file_name, $result, $filter_columns) : array | boolean
array
boolean
getAMFMessageID()
getClientGroup(array $data= NULL
, $disable_paging= FALSE
, $mode= 'flat'
) : array
array
filter data
array
getClientGroupDefaultData() : array
array
getCommonClientGroupData(array $data) : array
array
filter data
array
getCurrentCompanyObject()
getCurrentUserObject()
getCurrentUserPreferenceObject()
getMainClassObject()
getNextInsertID()
getOptions(string $name= FALSE
, mixed $parent= NULL
) : array
inherited_from | \APIFactory::getOptions() |
---|
string
Name of options to return, ie: 'columns', 'type', 'status'
mixed
Parent name/ID of options to return if data is in hierarchical format. (ie: Province)
array
getOptions($name= FALSE
, $parent= NULL
)
getPagerData()
getPermissionChildren()
getPermissionObject()
getProgressBarObject()
getProtocolVersion()
getVariableToFunctionMap($name, $parent = NULL
)
handlePermissionFilterColumns($filter_columns, $allowed_columns)
handleRecordValidationResults($validator, $validator_stats, $key, $save_result)
initializeFilterAndPager($data, $disable_paging = FALSE
)
returnHandler($retval= TRUE
, $code= FALSE
, $description= FALSE
, $details= FALSE
, $validator_stats= FALSE
, $user_generic_status_batch_id= FALSE
, $request_data= FALSE
)
setAMFMessageID($id)
setClientGroup(array $data, $validate_only= FALSE
, $ignore_warning= TRUE
) : array
array
ClientGroup data
array
setMainClassObject($obj)
setPagerObject($lf)
setValidationArray($primary_validator, $secondary_validator, $tertiary_validator = FALSE
)
stripReturnHandler($retarr)
validateClientGroup(array $data) : array
array
ClientGroup data
array
$data
array()
$current_company
NULL
$current_user
NULL
$current_user_prefs
NULL
$main_class
'ClientGroupFactory'
$main_class_obj
NULL
$pager_obj
NULL