Skip to content

APIPunch

Jump to bottom
Aydan Coskun edited this page Nov 29, 2019 · 1 revision

APIPunch

  • Class name: APIPunch
  • Namespace:
  • Parent class: APIFactory

Properties

$main_class

protected mixed $main_class = 'PunchFactory'
  • Visibility: protected

$is_import

public mixed $is_import = FALSE
  • Visibility: public

$data

public mixed $data = array()
  • Visibility: public

$main_class_obj

protected mixed $main_class_obj = NULL
  • Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL
  • Visibility: protected

$pager_obj

protected mixed $pager_obj = NULL
  • Visibility: protected

$current_company

protected mixed $current_company = NULL
  • Visibility: protected

$current_user

protected mixed $current_user = NULL
  • Visibility: protected

$current_user_prefs

protected mixed $current_user_prefs = NULL
  • Visibility: protected

$permission

protected mixed $permission = NULL
  • Visibility: protected

$progress_bar_obj

protected mixed $progress_bar_obj = NULL
  • Visibility: protected

Methods

__construct

mixed APIFactory::__construct()

APIFactory constructor.

  • Visibility: public
  • This method is defined by APIFactory

getUserPunch

array|boolean APIPunch::getUserPunch(string $user_id, integer $epoch, string $station_id)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $epoch integer - EPOCH
  • $station_id string - UUID

setUserPunch

array|boolean APIPunch::setUserPunch($data, boolean $validate_only, boolean $ignore_warning)
  • Visibility: public

Arguments

  • $data mixed
  • $validate_only boolean
  • $ignore_warning boolean

getPunchDefaultData

array APIPunch::getPunchDefaultData(string $user_id, integer $date, string $punch_control_id, string $previous_punch_id, integer $status_id, integer $type_id)

Get default punch data for creating new punches.

  • Visibility: public

Arguments

  • $user_id string - UUID
  • $date integer - EPOCH
  • $punch_control_id string - UUID
  • $previous_punch_id string - UUID
  • $status_id integer - ID
  • $type_id integer - ID

getRequestDefaultData

array APIPunch::getRequestDefaultData(string $user_id, integer $date, string $punch_control_id, string $previous_punch_id, integer $status_id, integer $type_id, string $current_punch_id)

Get default punch data for creating new punches.

  • Visibility: public

Arguments

  • $user_id string - UUID
  • $date integer - EPOCH
  • $punch_control_id string - UUID
  • $previous_punch_id string - UUID
  • $status_id integer
  • $type_id integer
  • $current_punch_id string - UUID

getPunch

array|boolean APIPunch::getPunch(array $data, boolean $disable_paging)

Get punch data for one or more punches.

  • Visibility: public

Arguments

  • $data array - filter data
  • $disable_paging boolean

getCommonPunchData

array APIPunch::getCommonPunchData(array $data)

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

  • Visibility: public

Arguments

  • $data array - filter data

validatePunch

array APIPunch::validatePunch(array $data)

Validate punch data for one or more punches.

  • Visibility: public

Arguments

  • $data array - punch data

setPunch

array|boolean APIPunch::setPunch(array $data, boolean $validate_only, boolean $ignore_warning)

Set punch data for one or more punches.

  • Visibility: public

Arguments

  • $data array - punch data
  • $validate_only boolean
  • $ignore_warning boolean

deletePunch

array|boolean APIPunch::deletePunch(array $data)

Delete one or more punchs.

  • Visibility: public

Arguments

  • $data array - punch data

getMealAndBreakTotalTime

array|boolean APIPunch::getMealAndBreakTotalTime($data, boolean $disable_paging)
  • Visibility: public

Arguments

  • $data mixed
  • $disable_paging boolean

exportPunch

array|boolean APIPunch::exportPunch(string $format, array $data, boolean $disable_paging)
  • Visibility: public

Arguments

  • $format string
  • $data array
  • $disable_paging boolean

getProtocolVersion

integer APIFactory::getProtocolVersion()
  • Visibility: public
  • This method is defined by APIFactory

getAMFMessageID

boolean|null APIFactory::getAMFMessageID()
  • Visibility: public
  • This method is defined by APIFactory

setAMFMessageID

boolean APIFactory::setAMFMessageID(string $id)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $id string - UUID

getCurrentCompanyObject

boolean|\CompanyFactory APIFactory::getCurrentCompanyObject()
  • Visibility: public
  • This method is defined by APIFactory

getCurrentUserObject

boolean|\UserFactory APIFactory::getCurrentUserObject()
  • Visibility: public
  • This method is defined by APIFactory

getCurrentUserPreferenceObject

boolean|\UserPreferenceFactory APIFactory::getCurrentUserPreferenceObject()
  • Visibility: public
  • This method is defined by APIFactory

getPermissionObject

boolean|null|\Permission APIFactory::getPermissionObject()
  • Visibility: public
  • This method is defined by APIFactory

getProgressBarObject

null|\ProgressBar APIFactory::getProgressBarObject()
  • Visibility: public
  • This method is defined by APIFactory

setPagerObject

boolean APIFactory::setPagerObject(object $lf)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $lf object

getPagerData

array|boolean APIFactory::getPagerData()
  • Visibility: public
  • This method is defined by APIFactory

setMainClassObject

boolean APIFactory::setMainClassObject(object $obj)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $obj object

getMainClassObject

string APIFactory::getMainClassObject()
  • Visibility: public
  • This method is defined by APIFactory

initializeFilterAndPager

array|boolean APIFactory::initializeFilterAndPager(array $data, boolean $disable_paging)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array
  • $disable_paging boolean

handlePermissionFilterColumns

array|null APIFactory::handlePermissionFilterColumns(array $filter_columns, array $allowed_columns)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $filter_columns array
  • $allowed_columns array

convertToSingleRecord

mixed APIFactory::convertToSingleRecord(array $data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array

convertToMultipleRecords

array APIFactory::convertToMultipleRecords(array $data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array

exportRecords

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

downloaded a result_set as a csv.

  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $format string
  • $file_name string
  • $result array
  • $filter_columns array

getNextInsertID

string APIFactory::getNextInsertID()
  • Visibility: public
  • This method is defined by APIFactory

getPermissionChildren

array APIFactory::getPermissionChildren()
  • Visibility: public
  • This method is defined by APIFactory

returnHandler

array|boolean APIFactory::returnHandler(boolean $retval, boolean $code, boolean $description, boolean $details, boolean $validator_stats, boolean $user_generic_status_batch_id, boolean $request_data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $retval boolean
  • $code boolean
  • $description boolean
  • $details boolean
  • $validator_stats boolean
  • $user_generic_status_batch_id boolean
  • $request_data boolean

stripReturnHandler

mixed APIFactory::stripReturnHandler(mixed $retarr)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $retarr mixed

getOptions

array|boolean APIFactory::getOptions(boolean $name, string|integer $parent)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $name boolean
  • $parent string|integer

getVariableToFunctionMap

array APIFactory::getVariableToFunctionMap(string $name, string|integer $parent)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $name string
  • $parent string|integer

convertAPIReturnHandlerToValidatorObject

boolean|\Validator APIFactory::convertAPIReturnHandlerToValidatorObject($api_retarr, boolean $validator_obj)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $api_retarr mixed
  • $validator_obj boolean

setValidationArray

array|boolean APIFactory::setValidationArray(string $primary_validator, string $secondary_validator, boolean $tertiary_validator)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $primary_validator string - UUID
  • $secondary_validator string - UUID
  • $tertiary_validator boolean

handleRecordValidationResults

array APIFactory::handleRecordValidationResults(object|boolean $validator, array $validator_stats, integer $key, array|boolean $save_result)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $validator object|boolean
  • $validator_stats array
  • $key integer
  • $save_result array|boolean

Clone this wiki locally