package API\Document
inherited_from \APIFactory

 Methods

__construct()

__construct() 
inherited_from \APIFactory::__construct()

__construct()

__construct() 
Inherited

Set attachment data for attachment.

addAttachment(string $name, integer $object_type_id, integer $object_id, $description = '', $group = 0, $private = FALSE, $template = FALSE) : integer

Parameters

$name

string

document name

$object_type_id

integer

attachment object type

$object_id

integer

attachment object

$description

$group

$private

$template

Returns

integer

convertAPIReturnHandlerToValidatorObject()

convertAPIReturnHandlerToValidatorObject($api_retarr, $validator_obj = FALSE
Inherited

Parameters

$api_retarr

$validator_obj

convertToMultipleRecords()

convertToMultipleRecords($data) 
Inherited

Parameters

$data

convertToSingleRecord()

convertToSingleRecord($data) 
Inherited

Parameters

$data

Copy one or more documentes.

copyDocument(array $data) : array

Parameters

$data

array

document IDs

Returns

array

Delete one or more documents.

deleteDocument(array $data, $object_type_id = NULL) : array

Parameters

$data

array

document data

$object_type_id

Returns

array

Export data to csv

exportDocument(string $format = 'csv', array $data = NULL, $disable_paging = TRUE) : array

Parameters

$format

string

file format (csv)

$data

array

filter data

$disable_paging

Returns

array

downloaded a result_set as a csv.

exportRecords($format, $file_name, $result, $filter_columns) : array | boolean
Inherited

Parameters

$format

$file_name

$result

$filter_columns

Returns

arrayboolean

getAMFMessageID()

getAMFMessageID() 
Inherited

Get only the fields that are common across all records in the search criteria. Used for Mass Editing of records.

getCommonDocumentData(array $data) : array

Parameters

$data

array

filter data

Returns

array

getCurrentCompanyObject()

getCurrentCompanyObject() 
Inherited

getCurrentUserObject()

getCurrentUserObject() 
Inherited

getCurrentUserPreferenceObject()

getCurrentUserPreferenceObject() 
Inherited

Get document data for one or more documentes.

getDocument(array $data = NULL, $disable_paging = FALSE) : array

Parameters

$data

array

filter data

$disable_paging

Returns

array

Get default document data for creating new documentes.

getDocumentDefaultData() : array

Returns

array

getMainClassObject()

getMainClassObject() 
Inherited

getNextInsertID()

getNextInsertID() 
Inherited

getOptions()

getOptions($name = FALSE, $parent = NULL
Inherited

Parameters

$name

$parent

getPagerData()

getPagerData() 
Inherited

getPermissionChildren()

getPermissionChildren() 
Inherited

getPermissionObject()

getPermissionObject() 
Inherited

getProgressBarObject()

getProgressBarObject() 
Inherited

getProtocolVersion()

getProtocolVersion() 
Inherited

getVariableToFunctionMap()

getVariableToFunctionMap($name, $parent = NULL
Inherited

Parameters

$name

$parent

handlePermissionFilterColumns()

handlePermissionFilterColumns($filter_columns, $allowed_columns) 
Inherited

Parameters

$filter_columns

$allowed_columns

handleRecordValidationResults()

handleRecordValidationResults($validator, $validator_stats, $key, $save_result) 
Inherited

Parameters

$validator

$validator_stats

$key

$save_result

initializeFilterAndPager()

initializeFilterAndPager($data, $disable_paging = FALSE
Inherited

Parameters

$data

$disable_paging

returnHandler()

returnHandler($retval = TRUE, $code = FALSE, $description = FALSE, $details = FALSE, $validator_stats = FALSE, $user_generic_status_batch_id = FALSE, $request_data = FALSE
Inherited

Parameters

$retval

$code

$description

$details

$validator_stats

$user_generic_status_batch_id

$request_data

setAMFMessageID()

setAMFMessageID($id) 
Inherited

Parameters

$id

Set document data for one or more documentes.

setDocument(array $data, $validate_only = FALSE, $ignore_warning = TRUE) : array

Parameters

$data

array

document data

$validate_only

$ignore_warning

Returns

array

setMainClassObject()

setMainClassObject($obj) 
Inherited

Parameters

$obj

setPagerObject()

setPagerObject($lf) 
Inherited

Parameters

$lf

setValidationArray()

setValidationArray($primary_validator, $secondary_validator, $tertiary_validator = FALSE
Inherited

Parameters

$primary_validator

$secondary_validator

$tertiary_validator

stripReturnHandler()

stripReturnHandler($retarr) 
Inherited

Parameters

$retarr

Validate document data for one or more documentes.

validateDocument(array $data) : array

Parameters

$data

array

document data

Returns

array

 Properties

 

$data

$data 

Default

array()
 

$AMF_message_id

$AMF_message_id 

Default

NULL
 

$current_company

$current_company 

Default

NULL
 

$current_user

$current_user 

Default

NULL
 

$current_user_prefs

$current_user_prefs 

Default

NULL
 

$main_class

$main_class 

Default

'DocumentFactory'
 

$main_class_obj

$main_class_obj 

Default

NULL
 

$pager_obj

$pager_obj 

Default

NULL
 

$permission

$permission 

Default

NULL
 

$progress_bar_obj

$progress_bar_obj 

Default

NULL