TimeTrex API Manual

GovernmentForms_CA_T4 extends GovernmentForms_CA
in package

Table of Contents

$class_directory  : mixed
$current_template_index  : mixed
$data  : mixed
$debug  : mixed
$default_font  : mixed
$metadata  : mixed
$original_data  : mixed
$page_margins  : mixed
$page_offsets  : mixed
$pdf_object  : mixed
$pdf_template  : mixed
$records  : mixed
$records_total  : mixed
$show_background  : mixed
$temp_page_offsets  : mixed
$template_index  : mixed
$template_offsets  : mixed
$xml_object  : mixed
$messages  : mixed
$payroll_deduction_obj  : mixed
__construct()  : mixed
__get()  : mixed
__isset()  : mixed
__set()  : mixed
__unset()  : mixed
_outputPDF()  : mixed
_outputXML()  : mixed
addMessage()  : mixed
addPage()  : mixed
addRecord()  : mixed
arraySum()  : int|string
Need to use bcmath for large numbers, especially on 32bit PHP installs.
arrayToObject()  : mixed
calculate()  : mixed
clearMessages()  : mixed
clearRecords()  : mixed
countRecords()  : mixed
Draw()  : mixed
drawChars()  : mixed
drawCheckBox()  : mixed
drawGrid()  : mixed
drawMessageFieldNotice()  : mixed
drawMessages()  : mixed
drawNormal()  : mixed
drawNormalGrid()  : mixed
drawPiecemeal()  : mixed
drawSegments()  : mixed
drawSplitDecimalFloat()  : mixed
drawSplitDecimalFloatGrid()  : mixed
filterAddress()  : mixed
filterCompanyAddress()  : mixed
filterMiddleName()  : mixed
filterPayrollAccountNumber()  : mixed
formatAlpha3CountryCode()  : mixed
formatEIN()  : mixed
formatPayrollAccountNumber()  : mixed
formatSSN()  : mixed
getAfterDecimal()  : mixed
getBeforeDecimal()  : mixed
getClassDirectory()  : mixed
getCPPMaximumEarnings()  : mixed
getCurrentPage()  : mixed
getDebug()  : mixed
getEIMaximumEarnings()  : mixed
getMessages()  : mixed
getOptions()  : mixed
getPageMargins()  : mixed
getPageOffsets()  : mixed
getPayrollDeductionObject()  : mixed
getPDFObject()  : mixed
getRecords()  : mixed
getRecordsTotal()  : mixed
getSchemaSpecificCoordinates()  : mixed
getShowBackground()  : mixed
getShowInstructionPage()  : mixed
getStatus()  : mixed
getTemplateDirectory()  : mixed
getTemplateOffsets()  : mixed
getTemplateSchema()  : mixed
getTempPageOffsets()  : mixed
getType()  : mixed
getXMLObject()  : mixed
getYear()  : mixed
handleMultipleForms()  : mixed
handleSevenOrMoreOtherBoxData()  : mixed
initPage()  : mixed
isNumeric()  : mixed
MoneyFormat()  : mixed
MoneyFormatPretty()  : mixed
Output()  : mixed
padLine()  : mixed
padRecord()  : mixed
preCalcCPPExempt()  : mixed
preCalcEIExempt()  : mixed
preCalcL24()  : mixed
preCalcL26()  : mixed
preCalcPPIPExempt()  : mixed
removeDecimal()  : mixed
resetTemplatePage()  : mixed
revertToOriginalDataState()  : mixed
saveOriginDataState()  : mixed
serialize()  : false|string
Serializes the object to an array for storing in the DB and later retrieval. Especially important for handling correction reports like W2C.
setClassDirectory()  : mixed
setDebug()  : mixed
setPageMargins()  : mixed
setPageOffsets()  : mixed
setPDFObject()  : mixed
setRecords()  : mixed
setShowBackground()  : mixed
setShowInstructionPage()  : mixed
setStatus()  : mixed
setTemplateOffsets()  : mixed
setTempPageOffsets()  : mixed
setType()  : mixed
setXMLObject()  : mixed
stripNonAlphaNumeric()  : mixed
stripNonFloat()  : mixed
stripNonNumeric()  : mixed
stripSpaces()  : mixed
sumRecords()  : mixed
unserialize()  : false|string
Unserializes a array into the form itself.

Properties

$pdf_template

public mixed $pdf_template = 't4flat-10b.pdf'

$template_offsets

public mixed $template_offsets = [-10, 0]

$payroll_deduction_obj

private mixed $payroll_deduction_obj = \null

Methods

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed

_outputPDF()

public _outputPDF(mixed $type) : mixed
Parameters
$type : mixed
Return values
mixed

_outputXML()

public _outputXML([mixed $type = null ]) : mixed
Parameters
$type : mixed = null
Return values
mixed

addMessage()

public addMessage(int $type_id, string $message[, array<string|int, mixed> $field_notice_position = [] ]) : mixed
Parameters
$type_id : int

'note', 'warning', 'error'

$message : string
$field_notice_position : array<string|int, mixed> = []

[ 'page' => 1, 'x' => 0, 'y' => 0 ]

Return values
mixed

addPage()

public addPage([mixed $schema = null ]) : mixed
Parameters
$schema : mixed = null
Return values
mixed

arraySum()

Need to use bcmath for large numbers, especially on 32bit PHP installs.

public static arraySum( $array) : int|string
Parameters
$array :
Return values
int|string

Draw()

public Draw(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawChars()

public drawChars(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawCheckBox()

public drawCheckBox(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawGrid()

public drawGrid(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawMessageFieldNotice()

public drawMessageFieldNotice(mixed $pdf, mixed $i, mixed $messages_arr) : mixed
Parameters
$pdf : mixed
$i : mixed
$messages_arr : mixed
Return values
mixed

drawNormal()

public drawNormal(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawNormalGrid()

public drawNormalGrid(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawPiecemeal()

public drawPiecemeal(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawSegments()

public drawSegments(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawSplitDecimalFloat()

public drawSplitDecimalFloat(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

drawSplitDecimalFloatGrid()

public drawSplitDecimalFloatGrid(mixed $value, mixed $schema) : mixed
Parameters
$value : mixed
$schema : mixed
Return values
mixed

filterAddress()

public filterAddress(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

filterCompanyAddress()

public filterCompanyAddress(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

filterMiddleName()

public filterMiddleName(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

filterPayrollAccountNumber()

public filterPayrollAccountNumber(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

formatAlpha3CountryCode()

public formatAlpha3CountryCode(mixed $country_code) : mixed
Parameters
$country_code : mixed
Return values
mixed

formatPayrollAccountNumber()

public formatPayrollAccountNumber(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

getAfterDecimal()

public getAfterDecimal(mixed $float[, mixed $format_number = true ]) : mixed
Parameters
$float : mixed
$format_number : mixed = true
Return values
mixed

getBeforeDecimal()

public getBeforeDecimal(mixed $float) : mixed
Parameters
$float : mixed
Return values
mixed

getCPPMaximumEarnings()

public getCPPMaximumEarnings() : mixed
Return values
mixed

getEIMaximumEarnings()

public getEIMaximumEarnings() : mixed
Return values
mixed

getOptions()

public getOptions(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

getPageMargins()

public getPageMargins([mixed $type = null ]) : mixed
Parameters
$type : mixed = null
Return values
mixed

getPageOffsets()

public getPageOffsets([mixed $type = null ]) : mixed
Parameters
$type : mixed = null
Return values
mixed

getPayrollDeductionObject()

public getPayrollDeductionObject() : mixed
Return values
mixed

getSchemaSpecificCoordinates()

public getSchemaSpecificCoordinates(mixed $schema, mixed $key[, mixed $sub_key1 = null ]) : mixed
Parameters
$schema : mixed
$key : mixed
$sub_key1 : mixed = null
Return values
mixed

getShowInstructionPage()

public getShowInstructionPage() : mixed
Return values
mixed

getStatus()

public getStatus() : mixed
Return values
mixed

getTemplateOffsets()

public getTemplateOffsets([mixed $type = null ]) : mixed
Parameters
$type : mixed = null
Return values
mixed

getTemplateSchema()

public getTemplateSchema([mixed $name = null ]) : mixed
Parameters
$name : mixed = null
Return values
mixed

getTempPageOffsets()

public getTempPageOffsets([mixed $type = null ]) : mixed
Parameters
$type : mixed = null
Return values
mixed

getType()

public getType() : mixed
Return values
mixed

getYear()

public getYear([mixed $epoch = null ]) : mixed
Parameters
$epoch : mixed = null
Return values
mixed

handleMultipleForms()

public handleMultipleForms(mixed $records) : mixed
Parameters
$records : mixed
Return values
mixed

handleSevenOrMoreOtherBoxData()

public handleSevenOrMoreOtherBoxData(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

initPage()

public initPage(mixed $template_schema) : mixed
Parameters
$template_schema : mixed
Return values
mixed

MoneyFormatPretty()

public MoneyFormatPretty(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

Output()

public Output(mixed $type[, mixed $clear_records = true ]) : mixed
Parameters
$type : mixed
$clear_records : mixed = true
Return values
mixed

padLine()

public padLine(mixed $line[, mixed $length = false ]) : mixed
Parameters
$line : mixed
$length : mixed = false
Return values
mixed

padRecord()

public padRecord(mixed $value, mixed $length, mixed $type) : mixed
Parameters
$value : mixed
$length : mixed
$type : mixed
Return values
mixed

preCalcCPPExempt()

public preCalcCPPExempt(mixed $value, mixed $key, mixed &$array) : mixed
Parameters
$value : mixed
$key : mixed
$array : mixed
Return values
mixed

preCalcEIExempt()

public preCalcEIExempt(mixed $value, mixed $key, mixed &$array) : mixed
Parameters
$value : mixed
$key : mixed
$array : mixed
Return values
mixed

preCalcL24()

public preCalcL24(mixed $value, mixed $key, mixed &$array) : mixed
Parameters
$value : mixed
$key : mixed
$array : mixed
Return values
mixed

preCalcL26()

public preCalcL26(mixed $value, mixed $key, mixed &$array) : mixed
Parameters
$value : mixed
$key : mixed
$array : mixed
Return values
mixed

preCalcPPIPExempt()

public preCalcPPIPExempt(mixed $value, mixed $key, mixed &$array) : mixed
Parameters
$value : mixed
$key : mixed
$array : mixed
Return values
mixed

serialize()

Serializes the object to an array for storing in the DB and later retrieval. Especially important for handling correction reports like W2C.

public serialize([mixed $clear_records = true ]) : false|string
Parameters
$clear_records : mixed = true
Return values
false|string

setClassDirectory()

public setClassDirectory(mixed $dir) : mixed
Parameters
$dir : mixed
Return values
mixed

setPageMargins()

public setPageMargins(mixed $x, mixed $y) : mixed
Parameters
$x : mixed
$y : mixed
Return values
mixed

setPageOffsets()

public setPageOffsets(mixed $x, mixed $y) : mixed
Parameters
$x : mixed
$y : mixed
Return values
mixed

setShowBackground()

public setShowBackground(mixed $bool) : mixed
Parameters
$bool : mixed
Return values
mixed

setShowInstructionPage()

public setShowInstructionPage(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

setStatus()

public setStatus(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

setTemplateOffsets()

public setTemplateOffsets(mixed $x, mixed $y) : mixed
Parameters
$x : mixed
$y : mixed
Return values
mixed

setTempPageOffsets()

public setTempPageOffsets(mixed $x, mixed $y) : mixed
Parameters
$x : mixed
$y : mixed
Return values
mixed

setType()

public setType(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

stripNonAlphaNumeric()

public stripNonAlphaNumeric(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

stripNonNumeric()

public stripNonNumeric(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

unserialize()

Unserializes a array into the form itself.

public unserialize(mixed $data) : false|string
Parameters
$data : mixed
Return values
false|string

Search results