GovernmentForms_US_RETURN1040
extends GovernmentForms_US
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
- $records : mixed
- $records_total : mixed
- $show_background : mixed
- $temp_page_offsets : mixed
- $template_index : mixed
- $template_offsets : mixed
- $xml_object : mixed
- $xml_schema : mixed
- $messages : 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
- formatEIN() : mixed
- formatSSN() : mixed
- getAfterDecimal() : mixed
- getBeforeDecimal() : mixed
- getClassDirectory() : mixed
- getCurrentPage() : mixed
- getDebug() : mixed
- getMessages() : mixed
- getPageMargins() : mixed
- getPageOffsets() : mixed
- getPDFObject() : mixed
- getRecords() : mixed
- getRecordsTotal() : mixed
- getSchemaSpecificCoordinates() : mixed
- getShowBackground() : mixed
- getStatus() : mixed
- getTemplateDirectory() : mixed
- getTemplateOffsets() : mixed
- getTemplateSchema() : mixed
- getTempPageOffsets() : mixed
- getXMLObject() : mixed
- getYear() : mixed
- initPage() : mixed
- isNumeric() : mixed
- MoneyFormat() : mixed
- MoneyFormatPretty() : mixed
- Output() : mixed
- padLine() : mixed
- padRecord() : 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
- setStatus() : mixed
- setTemplateOffsets() : mixed
- setTempPageOffsets() : mixed
- setXMLObject() : mixed
- stripNonAlphaNumeric() : mixed
- stripNonFloat() : mixed
- stripNonNumeric() : mixed
- stripSpaces() : mixed
- sumRecords() : mixed
- unserialize() : false|string
- Unserializes a array into the form itself.
Properties
$class_directory
public
mixed
$class_directory
= \null
$current_template_index
public
mixed
$current_template_index
= \null
$data
public
mixed
$data
= \null
$debug
public
mixed
$debug
= \false
$default_font
public
mixed
$default_font
= 'helvetica'
$metadata
public
mixed
$metadata
= \null
$original_data
public
mixed
$original_data
= \null
$page_margins
public
mixed
$page_margins
= [0, 0]
$page_offsets
public
mixed
$page_offsets
= [0, 0]
$pdf_object
public
mixed
$pdf_object
= \null
$records
public
mixed
$records
= []
$records_total
public
mixed
$records_total
= []
$show_background
public
mixed
$show_background
= \true
$temp_page_offsets
public
mixed
$temp_page_offsets
= [0, 0]
$template_index
public
mixed
$template_index
= []
$template_offsets
public
mixed
$template_offsets
= [0, 0]
$xml_object
public
mixed
$xml_object
= \null
$xml_schema
public
mixed
$xml_schema
= '1040/IndividualIncomeTax/Ind1040/Return1040.xsd'
$messages
private
mixed
$messages
= []
Methods
__construct()
public
__construct() : mixed
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —__isset()
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —__set()
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
Return values
mixed —__unset()
public
__unset(mixed $name) : mixed
Parameters
- $name : 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 —addRecord()
public
addRecord(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —arraySum()
Need to use bcmath for large numbers, especially on 32bit PHP installs.
public
static arraySum( $array) : int|string
Parameters
Return values
int|string —arrayToObject()
public
arrayToObject(mixed $array) : mixed
Parameters
- $array : mixed
Return values
mixed —calculate()
public
calculate() : mixed
Return values
mixed —clearMessages()
public
clearMessages() : mixed
Return values
mixed —clearRecords()
public
clearRecords() : mixed
Return values
mixed —countRecords()
public
countRecords() : mixed
Return values
mixed —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 —drawMessages()
public
drawMessages() : 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 —formatEIN()
public
formatEIN(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —formatSSN()
public
formatSSN(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 —getClassDirectory()
public
getClassDirectory() : mixed
Return values
mixed —getCurrentPage()
public
getCurrentPage() : mixed
Return values
mixed —getDebug()
public
getDebug() : mixed
Return values
mixed —getMessages()
public
getMessages() : 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 —getPDFObject()
public
getPDFObject() : mixed
Return values
mixed —getRecords()
public
getRecords() : mixed
Return values
mixed —getRecordsTotal()
public
getRecordsTotal() : 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 —getShowBackground()
public
getShowBackground() : mixed
Return values
mixed —getStatus()
public
getStatus() : mixed
Return values
mixed —getTemplateDirectory()
public
getTemplateDirectory() : 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 —getXMLObject()
public
getXMLObject() : mixed
Return values
mixed —getYear()
public
getYear([mixed $epoch = null ]) : mixed
Parameters
- $epoch : mixed = null
Return values
mixed —initPage()
public
initPage(mixed $template_schema) : mixed
Parameters
- $template_schema : mixed
Return values
mixed —isNumeric()
public
isNumeric(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —MoneyFormat()
public
MoneyFormat(mixed $value) : mixed
Parameters
- $value : 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 —removeDecimal()
public
removeDecimal(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —resetTemplatePage()
public
resetTemplatePage() : mixed
Return values
mixed —revertToOriginalDataState()
public
revertToOriginalDataState() : mixed
Return values
mixed —saveOriginDataState()
public
saveOriginDataState() : 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 —setDebug()
public
setDebug(mixed $bool) : mixed
Parameters
- $bool : 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 —setPDFObject()
public
setPDFObject(mixed &$obj) : mixed
Parameters
- $obj : mixed
Return values
mixed —setRecords()
public
setRecords(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —setShowBackground()
public
setShowBackground(mixed $bool) : mixed
Parameters
- $bool : 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 —setXMLObject()
public
setXMLObject(mixed &$obj) : mixed
Parameters
- $obj : mixed
Return values
mixed —stripNonAlphaNumeric()
public
stripNonAlphaNumeric(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —stripNonFloat()
public
stripNonFloat(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —stripNonNumeric()
public
stripNonNumeric(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —stripSpaces()
public
stripSpaces(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —sumRecords()
public
sumRecords() : mixed
Return values
mixed —unserialize()
Unserializes a array into the form itself.
public
unserialize(mixed $data) : false|string
Parameters
- $data : mixed