InvoiceListFactory

Class InvoiceFactory

Class name: InvoiceListFactory
Namespace:
Parent class: InvoiceFactory
This class implements: IteratorAggregate

Properties

$table

protected mixed $table = 'invoice'

Visibility: protected

$pk_sequence_name

protected mixed $pk_sequence_name = 'invoice_id_seq'

Visibility: protected

$client_obj

protected mixed $client_obj = NULL

Visibility: protected

$invoice_config_obj

protected mixed $invoice_config_obj = NULL

Visibility: protected

$client_contact_obj

protected mixed $client_contact_obj = NULL

Visibility: protected

$currency_obj

protected mixed $currency_obj = NULL

Visibility: protected

$sales_contact_user_obj

protected mixed $sales_contact_user_obj = NULL

Visibility: protected

$shipping_policy_obj

protected mixed $shipping_policy_obj = NULL

Visibility: protected

$calc_shipping

protected mixed $calc_shipping = FALSE

Visibility: protected

$data

public mixed $data = array()

Visibility: public

$old_data

public mixed $old_data = array()

Visibility: public

$tmp_data

public mixed $tmp_data = array()

Visibility: public

$enable_system_log_detail

protected mixed $enable_system_log_detail = TRUE

Visibility: protected

$progress_bar_obj

protected mixed $progress_bar_obj = NULL

Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL

Visibility: protected

$Validator

public mixed $Validator = NULL

Visibility: public

$validate_only

public mixed $validate_only = FALSE

Visibility: public

$is_valid

private mixed $is_valid = FALSE

Visibility: private

Methods

getAll

\InvoiceListFactory InvoiceListFactory::getAll(integer $limit, integer $page, array $where, array $order)

Visibility: public

Arguments

$limit integer - Limit the number of records returned
$page integer - Page number of records to return for pagination
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getById

boolean|\InvoiceListFactory InvoiceListFactory::getById(string $id, array $where, array $order)

Visibility: public

Arguments

$id string - UUID
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByInvoiceNumber

boolean|\InvoiceListFactory InvoiceListFactory::getByInvoiceNumber($invoice_number, array $where, array $order)

Visibility: public

Arguments

$invoice_number mixed
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByInvoiceNumberAndClientID

boolean|\InvoiceListFactory InvoiceListFactory::getByInvoiceNumberAndClientID($invoice_number, $client_id, array $where, array $order)

Visibility: public

Arguments

$invoice_number mixed
$client_id mixed
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByCompanyId

boolean|\InvoiceListFactory InvoiceListFactory::getByCompanyId(string $id, integer $limit, integer $page, array $where, array $order)

Visibility: public

Arguments

$id string - UUID
$limit integer - Limit the number of records returned
$page integer - Page number of records to return for pagination
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByIdAndCompanyId

boolean|\InvoiceListFactory InvoiceListFactory::getByIdAndCompanyId(string $id, string $company_id, integer $limit, integer $page, array $where, array $order)

Visibility: public

Arguments

$id string - UUID
$company_id string - UUID
$limit integer - Limit the number of records returned
$page integer - Page number of records to return for pagination
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByIdAndClientId

boolean|\InvoiceListFactory InvoiceListFactory::getByIdAndClientId(string $id, string $client_id, array $where, array $order)

Visibility: public

Arguments

$id string - UUID
$client_id string - UUID
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByClientIdAndClientContactID

boolean|\InvoiceListFactory InvoiceListFactory::getByClientIdAndClientContactID(string $client_id, string $client_contact_id, array $where, array $order)

Visibility: public

Arguments

$client_id string - UUID
$client_contact_id string - UUID
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByIdAndClientIdAndCompanyId

boolean|\InvoiceListFactory InvoiceListFactory::getByIdAndClientIdAndCompanyId(string $id, string $client_id, string $company_id, array $where, array $order)

Visibility: public

Arguments

$id string - UUID
$client_id string - UUID
$company_id string - UUID
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByClientIdAndCompanyId

boolean|\InvoiceListFactory InvoiceListFactory::getByClientIdAndCompanyId(string $client_id, string $company_id, integer $limit, integer $page, array $where, array $order)

Visibility: public

Arguments

$client_id string - UUID
$company_id string - UUID
$limit integer - Limit the number of records returned
$page integer - Page number of records to return for pagination
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

getByCompanyIDArray

array InvoiceListFactory::getByCompanyIDArray(string $id, boolean $include_blank)

Visibility: public

Arguments

$id string - UUID
$include_blank boolean

getAPISearchByCompanyIdAndArrayCriteria

boolean|\InvoiceListFactory InvoiceListFactory::getAPISearchByCompanyIdAndArrayCriteria(string $company_id, $filter_data, integer $limit, integer $page, array $where, array $order)

Visibility: public

Arguments

$company_id string - UUID
$filter_data mixed
$limit integer - Limit the number of records returned
$page integer - Page number of records to return for pagination
$where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
$order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

_getFactoryOptions

boolean Factory::_getFactoryOptions(string $name, string|integer $parent)

Visibility: protected
This method is defined by Factory

Arguments

$name string
$parent string|integer

_getVariableToFunctionMap

boolean Factory::_getVariableToFunctionMap(array $data)

Visibility: protected
This method is defined by Factory

Arguments

$data array

getClientObject

boolean InvoiceFactory::getClientObject()

Visibility: public
This method is defined by InvoiceFactory

getInvoiceConfigObject

boolean InvoiceFactory::getInvoiceConfigObject()

Visibility: public
This method is defined by InvoiceFactory

getCurrencyObject

boolean InvoiceFactory::getCurrencyObject()

Visibility: public
This method is defined by InvoiceFactory

getSalesContactUserObject

boolean InvoiceFactory::getSalesContactUserObject()

Visibility: public
This method is defined by InvoiceFactory

getShippingPolicyObject

boolean InvoiceFactory::getShippingPolicyObject(string $shipping_policy_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$shipping_policy_id string - UUID

getClientContactObject

boolean InvoiceFactory::getClientContactObject(string $client_contact_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$client_contact_id string - UUID

getCompany

boolean InvoiceFactory::getCompany()

Visibility: public
This method is defined by InvoiceFactory

generateInvoiceNumber

string InvoiceFactory::generateInvoiceNumber()

Visibility: public
This method is defined by InvoiceFactory

isUniqueInvoiceNumber

boolean InvoiceFactory::isUniqueInvoiceNumber($invoice_number)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$invoice_number mixed

getInvoiceNumber

string InvoiceFactory::getInvoiceNumber()

Visibility: public
This method is defined by InvoiceFactory

setInvoiceNumber

boolean InvoiceFactory::setInvoiceNumber($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getClient

boolean|mixed InvoiceFactory::getClient()

Visibility: public
This method is defined by InvoiceFactory

setClient

boolean InvoiceFactory::setClient(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - UUID

determineStatus

boolean|integer InvoiceFactory::determineStatus()

Visibility: public
This method is defined by InvoiceFactory

getTypeLabel

string InvoiceFactory::getTypeLabel()

Visibility: public
This method is defined by InvoiceFactory

getOldStatus

boolean InvoiceFactory::getOldStatus()

Visibility: public
This method is defined by InvoiceFactory

getStatus

boolean|integer InvoiceFactory::getStatus()

Visibility: public
This method is defined by InvoiceFactory

setStatus

boolean InvoiceFactory::setStatus($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getBillingContact

boolean|mixed InvoiceFactory::getBillingContact()

Visibility: public
This method is defined by InvoiceFactory

setBillingContact

boolean InvoiceFactory::setBillingContact(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - UUID

getShippingContact

boolean|mixed InvoiceFactory::getShippingContact()

Visibility: public
This method is defined by InvoiceFactory

setShippingContact

boolean InvoiceFactory::setShippingContact(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - UUID

getOtherContact

boolean|mixed InvoiceFactory::getOtherContact()

Visibility: public
This method is defined by InvoiceFactory

setOtherContact

boolean InvoiceFactory::setOtherContact(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - UUID

getSalesContact

boolean|mixed InvoiceFactory::getSalesContact()

Visibility: public
This method is defined by InvoiceFactory

setSalesContact

boolean InvoiceFactory::setSalesContact(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - UUID

getCurrency

boolean|mixed InvoiceFactory::getCurrency()

Visibility: public
This method is defined by InvoiceFactory

setCurrency

boolean InvoiceFactory::setCurrency(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - UUID

getInvoiceDate

boolean|integer InvoiceFactory::getInvoiceDate()

Visibility: public
This method is defined by InvoiceFactory

setInvoiceDate

boolean InvoiceFactory::setInvoiceDate(integer $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value integer - EPOCH

getOrderDate

boolean|integer InvoiceFactory::getOrderDate()

Visibility: public
This method is defined by InvoiceFactory

setOrderDate

boolean InvoiceFactory::setOrderDate(integer $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value integer - EPOCH

getPaymentRequiredDate

boolean|integer InvoiceFactory::getPaymentRequiredDate()

Visibility: public
This method is defined by InvoiceFactory

setPaymentRequiredDate

boolean InvoiceFactory::setPaymentRequiredDate(integer $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value integer - EPOCH

getShippedDate

boolean|integer InvoiceFactory::getShippedDate()

Visibility: public
This method is defined by InvoiceFactory

setShippedDate

boolean InvoiceFactory::setShippedDate(integer $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value integer - EPOCH

getPurchaseOrderNumber

mixed InvoiceFactory::getPurchaseOrderNumber()

Visibility: public
This method is defined by InvoiceFactory

setPurchaseOrderNumber

boolean InvoiceFactory::setPurchaseOrderNumber($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getTrackingNumberURL

boolean|string InvoiceFactory::getTrackingNumberURL()

Visibility: public
This method is defined by InvoiceFactory

getTrackingNumber

mixed InvoiceFactory::getTrackingNumber()

Visibility: public
This method is defined by InvoiceFactory

setTrackingNumber

boolean InvoiceFactory::setTrackingNumber($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getShippingPolicy

boolean|mixed InvoiceFactory::getShippingPolicy()

Visibility: public
This method is defined by InvoiceFactory

setShippingPolicy

boolean InvoiceFactory::setShippingPolicy(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - UUID

getShippingPolicyService

boolean|mixed InvoiceFactory::getShippingPolicyService()

Visibility: public
This method is defined by InvoiceFactory

setShippingPolicyService

boolean InvoiceFactory::setShippingPolicyService(string $value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value string - int This should not be a UUID, as it can be set from a carrier such as UPS/Fedex.

getPrivateNote

boolean|mixed InvoiceFactory::getPrivateNote()

Visibility: public
This method is defined by InvoiceFactory

setPrivateNote

boolean InvoiceFactory::setPrivateNote($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getPublicNote

boolean|mixed InvoiceFactory::getPublicNote()

Visibility: public
This method is defined by InvoiceFactory

setPublicNote

boolean InvoiceFactory::setPublicNote($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getTag

boolean|string InvoiceFactory::getTag()

Visibility: public
This method is defined by InvoiceFactory

setTag

boolean InvoiceFactory::setTag($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getOtherID1

boolean InvoiceFactory::getOtherID1()

Visibility: public
This method is defined by InvoiceFactory

setOtherID1

boolean InvoiceFactory::setOtherID1($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getOtherID2

boolean InvoiceFactory::getOtherID2()

Visibility: public
This method is defined by InvoiceFactory

setOtherID2

boolean InvoiceFactory::setOtherID2($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getOtherID3

boolean InvoiceFactory::getOtherID3()

Visibility: public
This method is defined by InvoiceFactory

setOtherID3

boolean InvoiceFactory::setOtherID3($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getOtherID4

boolean InvoiceFactory::getOtherID4()

Visibility: public
This method is defined by InvoiceFactory

setOtherID4

boolean InvoiceFactory::setOtherID4($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getOtherID5

boolean InvoiceFactory::getOtherID5()

Visibility: public
This method is defined by InvoiceFactory

setOtherID5

boolean InvoiceFactory::setOtherID5($value)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$value mixed

getTransactionArray

array|boolean InvoiceFactory::getTransactionArray()

Get all transactions mapped to this invoice.

Visibility: public
This method is defined by InvoiceFactory

setTransaction

boolean InvoiceFactory::setTransaction($data)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$data mixed

getProductTransactionArray

array|boolean InvoiceFactory::getProductTransactionArray()

Visibility: public
This method is defined by InvoiceFactory

getTaxPolicyCodesByTaxPolicyIDs

boolean|string InvoiceFactory::getTaxPolicyCodesByTaxPolicyIDs(string $tax_policy_ids)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$tax_policy_ids string - UUID

getTotalOwing

boolean InvoiceFactory::getTotalOwing(null $transactions, boolean $include_unconfirmed_transactions)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$transactions null
$include_unconfirmed_transactions boolean

getTotalArray

array InvoiceFactory::getTotalArray(null $transactions, boolean $include_unconfirmed_transactions, boolean $previous_total_array)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$transactions null
$include_unconfirmed_transactions boolean
$previous_total_array boolean

getTaxPolicyIDsByBillToIDAndShipToID

array|boolean InvoiceFactory::getTaxPolicyIDsByBillToIDAndShipToID(string $bill_to_client_contact_id, string $ship_to_client_contact_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$bill_to_client_contact_id string - UUID
$ship_to_client_contact_id string - UUID

getTaxPolicyIDsByProductId

array InvoiceFactory::getTaxPolicyIDsByProductId(string $product_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$product_id string - UUID

mergeIncludeAndExcludePolicyIDs

array|boolean InvoiceFactory::mergeIncludeAndExcludePolicyIDs($policy_ids_a, $policy_ids_b)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$policy_ids_a mixed
$policy_ids_b mixed

calcTaxes

array|boolean InvoiceFactory::calcTaxes(null $transactions, string $bill_to_contact_id, string $ship_to_contact_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$transactions null
$bill_to_contact_id string - UUID
$ship_to_contact_id string - UUID

deleteTaxTransactions

boolean InvoiceFactory::deleteTaxTransactions()

Visibility: public
This method is defined by InvoiceFactory

insertTaxTransactions

boolean InvoiceFactory::insertTaxTransactions($tax_arr)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$tax_arr mixed

getCustomsData

array InvoiceFactory::getCustomsData(null $transactions)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$transactions null

getShipmentPackages

array InvoiceFactory::getShipmentPackages(null $transactions)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$transactions null

getShippingPolicyIDsByShipToID

array|boolean InvoiceFactory::getShippingPolicyIDsByShipToID(string $client_contact_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$client_contact_id string - UUID

getShippingOptionData

array|boolean|mixed InvoiceFactory::getShippingOptionData(string $ship_to_contact_id, null $shipment_packages_arr, null $customs_data, string $currency_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$ship_to_contact_id string - UUID
$shipment_packages_arr null
$customs_data null
$currency_id string - UUID

getShippingOptions

array|boolean InvoiceFactory::getShippingOptions(null $shipping_option_arr, string $currency_id, boolean $include_prices)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$shipping_option_arr null
$currency_id string - UUID
$include_prices boolean

getEnableCalcShipping

boolean InvoiceFactory::getEnableCalcShipping()

Visibility: public
This method is defined by InvoiceFactory

setEnableCalcShipping

boolean InvoiceFactory::setEnableCalcShipping($bool)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$bool mixed

calcShipping

boolean|mixed InvoiceFactory::calcShipping(null $transactions, string $ship_to_contact_id, string $shipping_policy_id, string $currency_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$transactions null
$ship_to_contact_id string - UUID
$shipping_policy_id string - UUID
$currency_id string - UUID

deleteShippingTransactions

boolean InvoiceFactory::deleteShippingTransactions()

Visibility: public
This method is defined by InvoiceFactory

insertShippingTransactions

boolean InvoiceFactory::insertShippingTransactions($data)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$data mixed

isShipableProducts

boolean InvoiceFactory::isShipableProducts(null $transactions)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$transactions null

isShippingLabelExists

boolean InvoiceFactory::isShippingLabelExists(integer $label_number)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$label_number integer

clearShippingLabel

boolean InvoiceFactory::clearShippingLabel()

Visibility: public
This method is defined by InvoiceFactory

getShippingLabelFileName

string InvoiceFactory::getShippingLabelFileName(integer $label_number, string $company_id, string $client_id, string $invoice_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$label_number integer
$company_id string - UUID
$client_id string - UUID
$invoice_id string - UUID

getShippingLabelStoragePath

boolean|string InvoiceFactory::getShippingLabelStoragePath(string $company_id, string $client_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$company_id string - UUID
$client_id string - UUID

cancelShippingLabel

boolean InvoiceFactory::cancelShippingLabel()

Visibility: public
This method is defined by InvoiceFactory

getShippingLabel

boolean InvoiceFactory::getShippingLabel()

Visibility: public
This method is defined by InvoiceFactory

unassignAllTransactions

boolean InvoiceFactory::unassignAllTransactions(integer $type_id, string $ignore_ids, integer $ignore_product_type_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$type_id integer - ID
$ignore_ids string - UUID
$ignore_product_type_id integer - ID

deleteAllTransactions

boolean InvoiceFactory::deleteAllTransactions(integer $type_id, string $ignore_ids, integer $ignore_product_type_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$type_id integer - ID
$ignore_ids string - UUID
$ignore_product_type_id integer - ID

getInvoice

boolean|string InvoiceFactory::getInvoice(null $ilf, string $company_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$ilf null
$company_id string - UUID

emailInvoice

boolean InvoiceFactory::emailInvoice(boolean $ship_to, null $other_address)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$ship_to boolean
$other_address null

getPackingSlip

boolean|string InvoiceFactory::getPackingSlip(null $ilf, string $company_id)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$ilf null
$company_id string - UUID

handleDefaultPayment

boolean InvoiceFactory::handleDefaultPayment()

Visibility: public
This method is defined by InvoiceFactory

Validate

boolean InvoiceFactory::Validate()

Visibility: public
This method is defined by InvoiceFactory

preSave

boolean InvoiceFactory::preSave()

Visibility: public
This method is defined by InvoiceFactory

postSave

boolean InvoiceFactory::postSave()

Visibility: public
This method is defined by InvoiceFactory

setObjectFromArray

boolean InvoiceFactory::setObjectFromArray($data)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$data mixed

getObjectAsArray

array InvoiceFactory::getObjectAsArray(null $include_columns)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$include_columns null

addLog

boolean InvoiceFactory::addLog($log_action)

Visibility: public
This method is defined by InvoiceFactory

Arguments

$log_action mixed

__construct

mixed Factory::__construct()

Factory constructor.

Visibility: public
This method is defined by Factory

getAMFMessageID

boolean|null Factory::getAMFMessageID()

Used for updating progress bar for API calls.

Visibility: public
This method is defined by Factory

setAMFMessageID

boolean Factory::setAMFMessageID(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

setProgressBarObject

boolean Factory::setProgressBarObject(object $obj)

Visibility: public
This method is defined by Factory

Arguments

$obj object

getProgressBarObject

null|\ProgressBar Factory::getProgressBarObject()

Visibility: public
This method is defined by Factory

setGenericObject

boolean Factory::setGenericObject(object $obj, string $variable)

Visibility: public
This method is defined by Factory

Arguments

$obj object
$variable string

getGenericObject

boolean Factory::getGenericObject(string $list_factory, string|integer $id, string $variable, string $list_factory_method, string $id_method)

Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod

Visibility: public
This method is defined by Factory

Arguments

$list_factory string
$id string|integer - UUID
$variable string
$list_factory_method string
$id_method string

getCompanyGenericMapData

mixed Factory::getCompanyGenericMapData(string $company_id, integer $object_type_id, string $id, string $variable)

Visibility: public
This method is defined by Factory

Arguments

$company_id string - UUID
$object_type_id integer
$id string - UUID
$variable string

getGenericDataValue

boolean|mixed Factory::getGenericDataValue(string $name, $cast)

Visibility: public
This method is defined by Factory

Arguments

$name string
$cast mixed

setGenericDataValue

boolean Factory::setGenericDataValue(string $name, mixed $data, $cast)

Visibility: public
This method is defined by Factory

Arguments

$name string
$data mixed
$cast mixed

castGenericDataValue

mixed Factory::castGenericDataValue($value, $cast)

Generic casting function that all set/get*() functions should pass through.

However for now lets wait until we have meta data from SQL schema so we can pass those datatypes directly into this.

Visibility: public
This method is defined by Factory

Arguments

$value mixed - mixed
$cast mixed - string

getGenericTempDataValue

boolean Factory::getGenericTempDataValue(string $name)

Visibility: public
This method is defined by Factory

Arguments

$name string

setGenericTempDataValue

boolean Factory::setGenericTempDataValue(string $name, mixed $data)

Visibility: public
This method is defined by Factory

Arguments

$name string
$data mixed

getGenericOldDataValue

boolean|mixed Factory::getGenericOldDataValue(string $name)

Visibility: public
This method is defined by Factory

Arguments

$name string - Gets data value from old_data array, or the original value in the database, prior to any changes currently in memory.

getCache

boolean|mixed Factory::getCache(string $cache_id, string $group_id)

Visibility: public
This method is defined by Factory

Arguments

$cache_id string
$group_id string

saveCache

boolean Factory::saveCache(mixed $data, string $cache_id, string $group_id)

Visibility: public
This method is defined by Factory

Arguments

$data mixed
$cache_id string
$group_id string

removeCache

boolean Factory::removeCache(string $cache_id, string $group_id)

Visibility: public
This method is defined by Factory

Arguments

$cache_id string
$group_id string

setCacheLifeTime

boolean Factory::setCacheLifeTime(integer $secs)

Visibility: public
This method is defined by Factory

Arguments

$secs integer

serializeRS

string Factory::serializeRS(object $rs)

Visibility: public
This method is defined by Factory

Arguments

$rs object

unserializeRS

mixed Factory::unserializeRS(string $rs)

Visibility: public
This method is defined by Factory

Arguments

$rs string

getTable

boolean|string Factory::getTable(boolean $strip_quotes)

Visibility: public
This method is defined by Factory

Arguments

$strip_quotes boolean

getColumn

boolean|mixed Factory::getColumn(string $column)

Visibility: public
This method is defined by Factory

Arguments

$column string

__toString

boolean|string Factory::__toString()

Visibility: public
This method is defined by Factory

toBool

integer Factory::toBool(string|integer|boolean $value)

Visibility: public
This method is defined by Factory

Arguments

$value string|integer|boolean

fromBool

boolean Factory::fromBool(string|integer|boolean $value)

Visibility: public
This method is defined by Factory

Arguments

$value string|integer|boolean

isNew

boolean Factory::isNew(boolean $force_lookup, string $id)

Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.

Visibility: public
This method is defined by Factory

Arguments

$force_lookup boolean
$id string - UUID

getLabelId

boolean|mixed|string Factory::getLabelId()

Visibility: public
This method is defined by Factory

getId

boolean|mixed Factory::getId()

Visibility: public
This method is defined by Factory

setId

boolean Factory::setId(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getEnableSystemLogDetail

boolean Factory::getEnableSystemLogDetail()

Visibility: public
This method is defined by Factory

setEnableSystemLogDetail

boolean Factory::setEnableSystemLogDetail($bool)

Visibility: public
This method is defined by Factory

Arguments

$bool mixed

getDeleted

boolean Factory::getDeleted()

Visibility: public
This method is defined by Factory

setDeleted

boolean Factory::setDeleted(boolean $bool)

Visibility: public
This method is defined by Factory

Arguments

$bool boolean

getCreatedDate

integer Factory::getCreatedDate()

Visibility: public
This method is defined by Factory

setCreatedDate

boolean Factory::setCreatedDate(integer $epoch)

Visibility: public
This method is defined by Factory

Arguments

$epoch integer - EPOCH

getCreatedBy

boolean|mixed Factory::getCreatedBy()

Visibility: public
This method is defined by Factory

setCreatedBy

boolean Factory::setCreatedBy(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getUpdatedDate

integer Factory::getUpdatedDate()

Visibility: public
This method is defined by Factory

setUpdatedDate

boolean|integer|null|string Factory::setUpdatedDate(integer $epoch)

Visibility: public
This method is defined by Factory

Arguments

$epoch integer - EPOCH

getUpdatedBy

boolean|mixed Factory::getUpdatedBy()

Visibility: public
This method is defined by Factory

setUpdatedBy

boolean|null Factory::setUpdatedBy(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getDeletedDate

boolean|mixed Factory::getDeletedDate()

Visibility: public
This method is defined by Factory

setDeletedDate

boolean Factory::setDeletedDate(integer $epoch)

Visibility: public
This method is defined by Factory

Arguments

$epoch integer - EPOCH

getDeletedBy

boolean|mixed Factory::getDeletedBy()

Visibility: public
This method is defined by Factory

setDeletedBy

boolean|null Factory::setDeletedBy(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

setIsValid

boolean Factory::setIsValid(boolean $is_valid)

Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.

Required because $this->is_valid is a private variable and should stay that way.

Visibility: public
This method is defined by Factory

Arguments

$is_valid boolean

setCreatedAndUpdatedColumns

boolean Factory::setCreatedAndUpdatedColumns(array $data, array $variable_to_function_map)

Visibility: public
This method is defined by Factory

Arguments

$data array
$variable_to_function_map array

getCreatedAndUpdatedColumns

boolean Factory::getCreatedAndUpdatedColumns(array $data, null $include_columns)

Visibility: public
This method is defined by Factory

Arguments

$data array
$include_columns null

getPermissionColumns

boolean Factory::getPermissionColumns(array $data, string $object_user_id, string $created_by_id, string $permission_children_ids, array $include_columns)

Visibility: public
This method is defined by Factory

Arguments

$data array
$object_user_id string - UUID
$created_by_id string - UUID
$permission_children_ids string - UUID
$include_columns array

getOptions

array|boolean Factory::getOptions(string $name, string|integer $parent)

Visibility: public
This method is defined by Factory

Arguments

$name string
$parent string|integer

getVariableToFunctionMap

array|boolean Factory::getVariableToFunctionMap(array $data)

Visibility: public
This method is defined by Factory

Arguments

$data array

getRecordCount

integer|boolean Factory::getRecordCount()

Visibility: public
This method is defined by Factory

getCurrentRow

integer|boolean Factory::getCurrentRow(integer $offset)

Visibility: public
This method is defined by Factory

Arguments

$offset integer

setQueryStatementTimeout

boolean Factory::setQueryStatementTimeout(null $milliseconds)

Visibility: public
This method is defined by Factory

Arguments

$milliseconds null

getRecordSetColumnList

array|boolean Factory::getRecordSetColumnList(object $rs)

Visibility: private
This method is defined by Factory

Arguments

$rs object

castInteger

boolean|integer|string Factory::castInteger(integer|string $int, string $type)

Visibility: protected
This method is defined by Factory

Arguments

$int integer|string
$type string

getListSQL

boolean|integer|string|array Factory::getListSQL(array|string|integer $array, array $ph, string|boolean $cast)

Visibility: protected
This method is defined by Factory

Arguments

$array array|string|integer
$ph array
$cast string|boolean

getDateRangeSQL

boolean|string Factory::getDateRangeSQL(string $str, string $column, string $format, boolean $include_blank_dates)

Visibility: public
This method is defined by Factory

Arguments

$str string
$column string
$format string
$include_blank_dates boolean

handleSQLSyntax

string Factory::handleSQLSyntax(string $arg)

SQL where clause Syntax: or % as wildcard.

"" as exact match, no default wildcard and no metaphone

Handles '*' and '%' as wildcards, defaults to wildcard on the end always. If no wildcard is to be added, the last character should be |

Visibility: protected
This method is defined by Factory

Arguments

$arg string

stripSQLSyntax

mixed Factory::stripSQLSyntax(string $arg)

Visibility: protected
This method is defined by Factory

Arguments

$arg string

getSQLToTimeStampFunction

string Factory::getSQLToTimeStampFunction()

Visibility: protected
This method is defined by Factory

getDatabaseType

string Factory::getDatabaseType()

Visibility: protected
This method is defined by Factory

getGEOMAsTextFunction

string Factory::getGEOMAsTextFunction(string $sql)

Visibility: protected
This method is defined by Factory

Arguments

$sql string

getSQLToEpochFunction

string Factory::getSQLToEpochFunction(string $sql)

Visibility: protected
This method is defined by Factory

Arguments

$sql string

getSQLToTimeFunction

string Factory::getSQLToTimeFunction(string $sql)

Visibility: protected
This method is defined by Factory

Arguments

$sql string

getSQLStringAggregate

string Factory::getSQLStringAggregate(string $sql, string $glue)

Visibility: protected
This method is defined by Factory

Arguments

$sql string
$glue string

getWhereClauseSQL

null|string Factory::getWhereClauseSQL(array|string $columns, array|string $args, string $type, array $ph, string $query_stub, boolean $and)

Visibility: protected
This method is defined by Factory

Arguments

$columns array|string
$args array|string
$type string
$ph array
$query_stub string
$and boolean

parseColumnName

boolean|string Factory::parseColumnName(string $column)

Visibility: private
This method is defined by Factory

Arguments

$column string

getWhereSQL

boolean|string Factory::getWhereSQL(array $array, boolean $append_where)

Visibility: protected
This method is defined by Factory

Arguments

$array array
$append_where boolean

getColumnsFromAliases

array Factory::getColumnsFromAliases(array $columns, array $aliases)

Visibility: protected
This method is defined by Factory

Arguments

$columns array
$aliases array

convertFlexArray

array Factory::convertFlexArray(array $array)

Visibility: public
This method is defined by Factory

Arguments

$array array

getValidSQLColumns

array Factory::getValidSQLColumns(array $array, boolean $strict, array $additional_fields)

Visibility: public
This method is defined by Factory

Arguments

$array array
$strict boolean
$additional_fields array

getSortSQL

boolean|string Factory::getSortSQL(array $array, boolean $strict, array $additional_fields)

Visibility: protected
This method is defined by Factory

Arguments

$array array
$strict boolean
$additional_fields array

getColumnList

array|boolean Factory::getColumnList()

Visibility: public
This method is defined by Factory

getEmptyRecordSet

mixed Factory::getEmptyRecordSet(string $id)

Visibility: public
This method is defined by Factory

Arguments

$id string - UUID

getUpdateQuery

boolean Factory::getUpdateQuery()

Visibility: private
This method is defined by Factory

getInsertQuery

mixed Factory::getInsertQuery()

Visibility: private
This method is defined by Factory

StartTransaction

mixed Factory::StartTransaction()

Visibility: public
This method is defined by Factory

FailTransaction

mixed Factory::FailTransaction()

Visibility: public
This method is defined by Factory

CommitTransaction

mixed Factory::CommitTransaction()

Visibility: public
This method is defined by Factory

setTransactionMode

mixed Factory::setTransactionMode(string $mode)

Visibility: public
This method is defined by Factory

Arguments

$mode string

getTransactionMode

string Factory::getTransactionMode()

Visibility: public
This method is defined by Factory

isValid

boolean Factory::isValid(boolean $ignore_warning)

Visibility: public
This method is defined by Factory

Arguments

$ignore_warning boolean

isWarning

boolean Factory::isWarning()

Visibility: public
This method is defined by Factory

getSequenceName

boolean Factory::getSequenceName()

Visibility: public
This method is defined by Factory

getNextInsertId

boolean|string Factory::getNextInsertId()

Visibility: public
This method is defined by Factory

ExecuteSQL

boolean Factory::ExecuteSQL(string $query, array $ph, integer $limit, integer $page)

Visibility: public
This method is defined by Factory

Arguments

$query string
$ph array
$limit integer - Limit the number of records returned
$page integer - Page number of records to return for pagination

RetryExecuteSQL

boolean Factory::RetryExecuteSQL(string $query, array $ph, integer $retry_max_attempts, integer $sleep)

Visibility: public
This method is defined by Factory

Arguments

$query string
$ph array
$retry_max_attempts integer
$sleep integer

getDataDifferences

array Factory::getDataDifferences()

Returns the differences in data from the DB vs the in-memory object, so the data will be the OLD data. Used in Validation/postSave() functions to determine if a field has changed or not.

Visibility: public
This method is defined by Factory

isDataDifferent

boolean Factory::isDataDifferent($key, $data_diff, null $type_id, null $new_data)

Used to check the differences between a single key in the $old_data vs. $data arrays.

This is especially important to use when trying to see if a date or timestamp field in the DB has changed, as they need to be handled in special ways.

Visibility: public
This method is defined by Factory

Arguments

$key mixed - string
$data_diff mixed - array
$type_id null - string
$new_data null - mixed

Save

boolean|integer|string Factory::Save(boolean $reset_data, boolean $force_lookup)

Visibility: public
This method is defined by Factory

Arguments

$reset_data boolean
$force_lookup boolean

Delete

boolean Factory::Delete()

Visibility: public
This method is defined by Factory

getIDSByListFactory

array|boolean Factory::getIDSByListFactory(object $lf)

Visibility: public
This method is defined by Factory

Arguments

$lf object

bulkDelete

boolean Factory::bulkDelete(string|array $ids)

Visibility: public
This method is defined by Factory

Arguments

$ids string|array - UUID

clearGeoCode

boolean Factory::clearGeoCode(array $data_diff)

Visibility: public
This method is defined by Factory

Arguments

$data_diff array

clearNonMappedData

array|null Factory::clearNonMappedData(array|null $data)

Removes array elements from $data that are not in the function map.

Visibility: public
This method is defined by Factory

Arguments

$data array|null

clearData

boolean Factory::clearData()

Visibility: public
This method is defined by Factory

clearOldData

boolean Factory::clearOldData()

Visibility: public
This method is defined by Factory

getIterator

\FactoryListIterator Factory::getIterator()

Visibility: public
This method is defined by Factory

getCurrent

mixed Factory::getCurrent()

Visibility: public
This method is defined by Factory

InvoiceListFactory - staffcheck/api GitHub Wiki

InvoiceListFactory

Properties

$table

$pk_sequence_name

$client_obj

$invoice_config_obj

$client_contact_obj

$currency_obj

$sales_contact_user_obj

$shipping_policy_obj

$calc_shipping

$data

$old_data

$tmp_data

$enable_system_log_detail

$progress_bar_obj

$AMF_message_id

$Validator

$validate_only

$is_valid

Methods

getAll

Arguments

getById

Arguments

getByInvoiceNumber

Arguments

getByInvoiceNumberAndClientID

Arguments

getByCompanyId

Arguments

getByIdAndCompanyId

Arguments

getByIdAndClientId

Arguments

getByClientIdAndClientContactID

Arguments

getByIdAndClientIdAndCompanyId

Arguments

getByClientIdAndCompanyId

Arguments

getByCompanyIDArray

Arguments

getAPISearchByCompanyIdAndArrayCriteria

Arguments

_getFactoryOptions

Arguments

_getVariableToFunctionMap

Arguments

getClientObject

getInvoiceConfigObject

getCurrencyObject

getSalesContactUserObject

getShippingPolicyObject

Arguments

getClientContactObject

Arguments

getCompany

generateInvoiceNumber

isUniqueInvoiceNumber

Arguments

getInvoiceNumber

setInvoiceNumber

Arguments

getClient

setClient

Arguments

determineStatus

getTypeLabel

getOldStatus

getStatus

setStatus

Arguments

getBillingContact

setBillingContact

Arguments

getShippingContact

setShippingContact

Arguments