Skip to content

ReportCustomColumnListFactory

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

ReportCustomColumnListFactory

  • Class name: ReportCustomColumnListFactory
  • Namespace:
  • Parent class: ReportCustomColumnFactory
  • This class implements: IteratorAggregate

Properties

$table

protected mixed $table = 'report_custom_column'
  • Visibility: protected

$pk_sequence_name

protected mixed $pk_sequence_name = 'report_custom_column_id_seq'
  • Visibility: protected

$report_obj

protected mixed $report_obj = NULL
  • 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

\ReportCustomColumnListFactory ReportCustomColumnListFactory::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|\ReportCustomColumnListFactory ReportCustomColumnListFactory::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', ... )

getByCompanyId

boolean|\ReportCustomColumnListFactory ReportCustomColumnListFactory::getByCompanyId(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', ... )

getByIdAndCompanyId

boolean|\ReportCustomColumnListFactory ReportCustomColumnListFactory::getByIdAndCompanyId(string $id, string $company_id, array $where, array $order)
  • Visibility: public

Arguments

  • $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', ... )

getByCompanyIdAndName

boolean|\ReportCustomColumnListFactory ReportCustomColumnListFactory::getByCompanyIdAndName(string $company_id, $name, array $where, array $order)
  • Visibility: public

Arguments

  • $company_id string - UUID
  • $name 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', ... )

getByTypeId

boolean|\ReportCustomColumnListFactory ReportCustomColumnListFactory::getByTypeId(integer $type_id, array $where, array $order)
  • Visibility: public

Arguments

  • $type_id integer
  • $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', ... )

getByCompanyIdAndTypeId

boolean|\ReportCustomColumnListFactory ReportCustomColumnListFactory::getByCompanyIdAndTypeId(string $company_id, integer $type_id, array $where, array $order)
  • Visibility: public

Arguments

  • $company_id string - UUID
  • $type_id integer
  • $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', ... )

getByCompanyIdAndTypeIdAndFormatIdAndScript

boolean|\ReportCustomColumnListFactory ReportCustomColumnListFactory::getByCompanyIdAndTypeIdAndFormatIdAndScript(string $company_id, integer $type_id, integer $format_id, $script, array $where, array $order)
  • Visibility: public

Arguments

  • $company_id string - UUID
  • $type_id integer
  • $format_id integer
  • $script 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', ... )

getAPISearchByCompanyIdAndArrayCriteria

boolean|\ReportCustomColumnListFactory ReportCustomColumnListFactory::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', ... )

getArrayByListFactory

array|boolean ReportCustomColumnListFactory::getArrayByListFactory($lf, boolean $include_blank)
  • Visibility: public

Arguments

  • $lf mixed
  • $include_blank boolean

getByCompanyIdAndTypeIdAndFormatIdAndScriptArray

array|boolean ReportCustomColumnListFactory::getByCompanyIdAndTypeIdAndFormatIdAndScriptArray(string $company_id, integer $type_id, integer $format_id, $script, null $key_prefix, null $name_prefix)
  • Visibility: public

Arguments

  • $company_id string - UUID
  • $type_id integer
  • $format_id integer
  • $script mixed
  • $key_prefix null
  • $name_prefix null

_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

getReportObject

boolean|null ReportCustomColumnFactory::getReportObject(string $class_prefix)

Arguments

  • $class_prefix string

getCompany

boolean|mixed ReportCustomColumnFactory::getCompany()

setCompany

boolean ReportCustomColumnFactory::setCompany(string $value)

Arguments

  • $value string - UUID

getType

boolean|integer ReportCustomColumnFactory::getType()

setType

boolean ReportCustomColumnFactory::setType($value)

Arguments

  • $value mixed

getFormat

integer ReportCustomColumnFactory::getFormat()

setFormat

boolean ReportCustomColumnFactory::setFormat($value)

Arguments

  • $value mixed

getScript

boolean|mixed ReportCustomColumnFactory::getScript()

setScript

boolean ReportCustomColumnFactory::setScript($value)

Arguments

  • $value mixed

isUniqueName

boolean ReportCustomColumnFactory::isUniqueName($name)

Arguments

  • $name mixed

getName

boolean|mixed ReportCustomColumnFactory::getName()

setName

boolean ReportCustomColumnFactory::setName($value)

Arguments

  • $value mixed

getDescription

boolean|mixed ReportCustomColumnFactory::getDescription()

setDescription

boolean ReportCustomColumnFactory::setDescription($value)

Arguments

  • $value mixed

getFormula

boolean|mixed ReportCustomColumnFactory::getFormula()

setFormula

boolean ReportCustomColumnFactory::setFormula($value)

Arguments

  • $value mixed

getIncludeColumns

mixed ReportCustomColumnFactory::getIncludeColumns()

setIncludeColumns

boolean ReportCustomColumnFactory::setIncludeColumns($value)

Arguments

  • $value mixed

getExcludeColumns

mixed ReportCustomColumnFactory::getExcludeColumns()

setExcludeColumns

boolean ReportCustomColumnFactory::setExcludeColumns($value)

Arguments

  • $value mixed

Validate

boolean ReportCustomColumnFactory::Validate(boolean $ignore_warning)

Arguments

  • $ignore_warning boolean

preSave

boolean ReportCustomColumnFactory::preSave()

handleScriptName

mixed ReportCustomColumnFactory::handleScriptName($script_name)

Arguments

  • $script_name mixed

setObjectFromArray

boolean ReportCustomColumnFactory::setObjectFromArray($data)

Arguments

  • $data mixed

getObjectAsArray

array ReportCustomColumnFactory::getObjectAsArray(null $include_columns, boolean $permission_children_ids)

Arguments

  • $include_columns null
  • $permission_children_ids boolean

addLog

boolean ReportCustomColumnFactory::addLog($log_action)

Arguments

  • $log_action mixed

calculateCustomColumns

boolean ReportCustomColumnFactory::calculateCustomColumns(object $obj, integer $type_id)

Arguments

  • $obj object
  • $type_id integer

calculateCustomColumnFilters

boolean ReportCustomColumnFactory::calculateCustomColumnFilters(object $obj, integer $type_id)

Arguments

  • $obj object
  • $type_id integer

__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

Clone this wiki locally