• Class name: ReportScheduleFactory
• Namespace:
• Parent class: Factory

protected mixed $table = 'report_schedule'

• Visibility: protected

protected mixed $pk_sequence_name = 'report_schedule_id_seq'

• Visibility: protected

protected mixed $temp_time = NULL

• Visibility: protected

protected mixed $execute_flag = FALSE

• Visibility: protected

protected mixed $user_report_data_obj = NULL

• Visibility: protected

public mixed $data = array()

• Visibility: public

public mixed $old_data = array()

• Visibility: public

public mixed $tmp_data = array()

• Visibility: public

protected mixed $enable_system_log_detail = TRUE

• Visibility: protected

protected mixed $progress_bar_obj = NULL

• Visibility: protected

protected mixed $AMF_message_id = NULL

• Visibility: protected

public mixed $Validator = NULL

• Visibility: public

public mixed $validate_only = FALSE

• Visibility: public

private mixed $is_valid = FALSE

• Visibility: private

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

• Visibility: protected
• This method is defined by Factory

• $name string
• $parent string|integer

boolean Factory::_getVariableToFunctionMap(array $data)

• Visibility: protected
• This method is defined by Factory

• $data array

boolean ReportScheduleFactory::getUserObject()

• Visibility: public

boolean ReportScheduleFactory::getUserPreferenceObject()

• Visibility: public

boolean ReportScheduleFactory::getUserReportDataObject()

• Visibility: public

boolean|mixed ReportScheduleFactory::getUserReportData()

• Visibility: public

boolean ReportScheduleFactory::setUserReportData(string $value)

• Visibility: public

• $value string - UUID

boolean|integer ReportScheduleFactory::getState()

• Visibility: public

boolean ReportScheduleFactory::setState($value)

• Visibility: public

• $value mixed

boolean|integer ReportScheduleFactory::getStatus()

• Visibility: public

boolean ReportScheduleFactory::setStatus($value)

• Visibility: public

• $value mixed

boolean|integer ReportScheduleFactory::getPriority()

• Visibility: public

boolean ReportScheduleFactory::setPriority($value)

• Visibility: public

• $value mixed

boolean|mixed ReportScheduleFactory::getName()

• Visibility: public

boolean ReportScheduleFactory::setName($value)

• Visibility: public

• $value mixed

boolean|mixed ReportScheduleFactory::getDescription()

• Visibility: public

boolean ReportScheduleFactory::setDescription($value)

• Visibility: public

• $value mixed

boolean|mixed ReportScheduleFactory::getOutputFormat()

• Visibility: public

boolean ReportScheduleFactory::setOutputFormat($value)

• Visibility: public

• $value mixed

boolean|integer ReportScheduleFactory::getStartDate(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setStartDate(integer $value)

• Visibility: public

• $value integer - EPOCH

boolean|integer ReportScheduleFactory::getEndDate(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setEndDate(integer $value)

• Visibility: public

• $value integer - EPOCH

array|boolean ReportScheduleFactory::getCustomFrequencyDateArray(integer $last_run_date)

Custom frequencies simply overwrite existing cron strings with their own.

For example, if we have PP start date selected, we grab the last PP start date from now, and split out the day, month, year from it and replace the day, month, year columns in the cron string, while leaving the minute/hour strings.

• Visibility: public

• $last_run_date integer - EPOCH

boolean|mixed ReportScheduleFactory::getCustomFrequency()

• Visibility: public

boolean ReportScheduleFactory::setCustomFrequency($value)

• Visibility: public

• $value mixed

boolean|mixed ReportScheduleFactory::getCustomFrequencyData()

• Visibility: public

boolean ReportScheduleFactory::setCustomFrequencyData($value)

• Visibility: public

• $value mixed

array|boolean ReportScheduleFactory::getMinute(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setMinute($value)

• Visibility: public

• $value mixed

array|boolean ReportScheduleFactory::getHour(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setHour($value)

• Visibility: public

• $value mixed

array|boolean ReportScheduleFactory::getDayOfMonth(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setDayOfMonth($value)

• Visibility: public

• $value mixed

array|boolean ReportScheduleFactory::getMonth(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setMonth($value)

• Visibility: public

• $value mixed

array|boolean ReportScheduleFactory::getDayOfWeek(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setDayOfWeek($value)

• Visibility: public

• $value mixed

boolean ReportScheduleFactory::getEnableEmailBlankReport()

• Visibility: public

boolean ReportScheduleFactory::setEnableEmailBlankReport($value)

• Visibility: public

• $value mixed

boolean ReportScheduleFactory::getEnableHomeEmail()

• Visibility: public

boolean ReportScheduleFactory::setEnableHomeEmail($value)

• Visibility: public

• $value mixed

array|boolean ReportScheduleFactory::parseOtherEmailAddresses($value)

• Visibility: public
• This method is static.

• $value mixed

boolean|mixed ReportScheduleFactory::getOtherEmail()

• Visibility: public

boolean ReportScheduleFactory::setOtherEmail($value)

• Visibility: public

• $value mixed

boolean|integer ReportScheduleFactory::getLastRunDate(boolean $raw)

• Visibility: public

• $raw boolean

boolean ReportScheduleFactory::setLastRunDate(integer $value)

• Visibility: public

• $value integer - EPOCH

boolean|mixed ReportScheduleFactory::getLastRunProcessingTime()

• Visibility: public

boolean ReportScheduleFactory::setLastRunProcessingTime($value)

• Visibility: public

• $value mixed

boolean|mixed ReportScheduleFactory::getAverageProcessingTime()

• Visibility: public

boolean ReportScheduleFactory::setAverageProcessingTime($value)

• Visibility: public

• $value mixed

boolean|mixed ReportScheduleFactory::getTotalProcessingTime()

• Visibility: public

boolean ReportScheduleFactory::setTotalProcessingTime($value)

• Visibility: public

• $value mixed

boolean|mixed ReportScheduleFactory::getTotalRuns()

• Visibility: public

boolean ReportScheduleFactory::setTotalRuns($value)

• Visibility: public

• $value mixed

mixed ReportScheduleFactory::setExecuteFlag($bool)

• Visibility: private

• $bool mixed

boolean ReportScheduleFactory::getExecuteFlag()

• Visibility: private

boolean ReportScheduleFactory::isActiveDate(integer $epoch)

• Visibility: public

• $epoch integer - EPOCH

array ReportScheduleFactory::getCronData(integer $last_run_date)

• Visibility: public

• $last_run_date integer - EPOCH

boolean|false|integer|null ReportScheduleFactory::getNextScheduleDate(integer $last_run_date)

• Visibility: public

• $last_run_date integer - EPOCH

boolean ReportScheduleFactory::isScheduledToRun(integer $epoch, integer $last_run_date)

• Visibility: public

• $epoch integer - EPOCH
• $last_run_date integer - EPOCH

boolean ReportScheduleFactory::Execute()

• Visibility: public

boolean ReportScheduleFactory::checkUserEmail()

• Visibility: public

boolean ReportScheduleFactory::UnsubscribeEmail($email)

• Visibility: public
• This method is static.

• $email mixed

boolean ReportScheduleFactory::Validate(boolean $ignore_warning)

• Visibility: public

• $ignore_warning boolean

boolean ReportScheduleFactory::preSave()

• Visibility: public

boolean ReportScheduleFactory::postSave()

• Visibility: public

boolean ReportScheduleFactory::setObjectFromArray($data)

• Visibility: public

• $data mixed

array ReportScheduleFactory::getObjectAsArray(null $include_columns)

• Visibility: public

• $include_columns null

boolean ReportScheduleFactory::addLog($log_action)

• Visibility: public

• $log_action mixed

mixed Factory::__construct()

Factory constructor.

• Visibility: public
• This method is defined by Factory

boolean|null Factory::getAMFMessageID()

Used for updating progress bar for API calls.

• Visibility: public
• This method is defined by Factory

boolean Factory::setAMFMessageID(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::setProgressBarObject(object $obj)

• Visibility: public
• This method is defined by Factory

• $obj object

null|\ProgressBar Factory::getProgressBarObject()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

• $obj object
• $variable string

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

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

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

• Visibility: public
• This method is defined by Factory

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

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

• Visibility: public
• This method is defined by Factory

• $name string
• $cast mixed

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

• Visibility: public
• This method is defined by Factory

• $name string
• $data mixed
• $cast mixed

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

• $value mixed - mixed
• $cast mixed - string

boolean Factory::getGenericTempDataValue(string $name)

• Visibility: public
• This method is defined by Factory

• $name string

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

• Visibility: public
• This method is defined by Factory

• $name string
• $data mixed

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

• Visibility: public
• This method is defined by Factory

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

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

• Visibility: public
• This method is defined by Factory

• $cache_id string
• $group_id string

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

• Visibility: public
• This method is defined by Factory

• $data mixed
• $cache_id string
• $group_id string

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

• Visibility: public
• This method is defined by Factory

• $cache_id string
• $group_id string

boolean Factory::setCacheLifeTime(integer $secs)

• Visibility: public
• This method is defined by Factory

• $secs integer

string Factory::serializeRS(object $rs)

• Visibility: public
• This method is defined by Factory

• $rs object

mixed Factory::unserializeRS(string $rs)

• Visibility: public
• This method is defined by Factory

• $rs string

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

• Visibility: public
• This method is defined by Factory

• $strip_quotes boolean

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

• Visibility: public
• This method is defined by Factory

• $column string

boolean|string Factory::__toString()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

• $value string|integer|boolean

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

• Visibility: public
• This method is defined by Factory

• $value string|integer|boolean

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

• $force_lookup boolean
• $id string - UUID

boolean|mixed|string Factory::getLabelId()

• Visibility: public
• This method is defined by Factory

boolean|mixed Factory::getId()

• Visibility: public
• This method is defined by Factory

boolean Factory::setId(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::getEnableSystemLogDetail()

• Visibility: public
• This method is defined by Factory

boolean Factory::setEnableSystemLogDetail($bool)

• Visibility: public
• This method is defined by Factory

• $bool mixed

boolean Factory::getDeleted()

• Visibility: public
• This method is defined by Factory

boolean Factory::setDeleted(boolean $bool)

• Visibility: public
• This method is defined by Factory

• $bool boolean

integer Factory::getCreatedDate()

• Visibility: public
• This method is defined by Factory

boolean Factory::setCreatedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getCreatedBy()

• Visibility: public
• This method is defined by Factory

boolean Factory::setCreatedBy(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

integer Factory::getUpdatedDate()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getUpdatedBy()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean|mixed Factory::getDeletedDate()

• Visibility: public
• This method is defined by Factory

boolean Factory::setDeletedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getDeletedBy()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

• $id string - UUID

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

• $is_valid boolean

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

• Visibility: public
• This method is defined by Factory

• $data array
• $variable_to_function_map array

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

• Visibility: public
• This method is defined by Factory

• $data array
• $include_columns null

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

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

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

• Visibility: public
• This method is defined by Factory

• $name string
• $parent string|integer

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

• Visibility: public
• This method is defined by Factory

• $data array

integer|boolean Factory::getRecordCount()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

• $offset integer

boolean Factory::setQueryStatementTimeout(null $milliseconds)

• Visibility: public
• This method is defined by Factory

• $milliseconds null

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

• Visibility: private
• This method is defined by Factory

• $rs object

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

• Visibility: protected
• This method is defined by Factory

• $int integer|string
• $type string

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

• Visibility: protected
• This method is defined by Factory

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

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

• Visibility: public
• This method is defined by Factory

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

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

• $arg string

mixed Factory::stripSQLSyntax(string $arg)

• Visibility: protected
• This method is defined by Factory

• $arg string

string Factory::getSQLToTimeStampFunction()

• Visibility: protected
• This method is defined by Factory

string Factory::getDatabaseType()

• Visibility: protected
• This method is defined by Factory

string Factory::getGEOMAsTextFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLToEpochFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLToTimeFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

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

• Visibility: protected
• This method is defined by Factory

• $sql string
• $glue string

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

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

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

• Visibility: private
• This method is defined by Factory

• $column string

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

• Visibility: protected
• This method is defined by Factory

• $array array
• $append_where boolean

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

• Visibility: protected
• This method is defined by Factory

• $columns array
• $aliases array

array Factory::convertFlexArray(array $array)

• Visibility: public
• This method is defined by Factory

• $array array

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

• Visibility: public
• This method is defined by Factory

• $array array
• $strict boolean
• $additional_fields array

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

• Visibility: protected
• This method is defined by Factory

• $array array
• $strict boolean
• $additional_fields array

array|boolean Factory::getColumnList()

• Visibility: public
• This method is defined by Factory

mixed Factory::getEmptyRecordSet(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::getUpdateQuery()

• Visibility: private
• This method is defined by Factory

mixed Factory::getInsertQuery()

• Visibility: private
• This method is defined by Factory

mixed Factory::StartTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::FailTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::CommitTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::setTransactionMode(string $mode)

• Visibility: public
• This method is defined by Factory

• $mode string

string Factory::getTransactionMode()

• Visibility: public
• This method is defined by Factory

boolean Factory::isValid(boolean $ignore_warning)

• Visibility: public
• This method is defined by Factory

• $ignore_warning boolean

boolean Factory::isWarning()

• Visibility: public
• This method is defined by Factory

boolean Factory::getSequenceName()

• Visibility: public
• This method is defined by Factory

boolean|string Factory::getNextInsertId()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

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

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

• Visibility: public
• This method is defined by Factory

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

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

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

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

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

• Visibility: public
• This method is defined by Factory

• $reset_data boolean
• $force_lookup boolean

boolean Factory::Delete()

• Visibility: public
• This method is defined by Factory

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

• Visibility: public
• This method is defined by Factory

• $lf object

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

• Visibility: public
• This method is defined by Factory

• $ids string|array - UUID

boolean Factory::clearGeoCode(array $data_diff)

• Visibility: public
• This method is defined by Factory

• $data_diff array

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

• $data array|null

boolean Factory::clearData()

• Visibility: public
• This method is defined by Factory

boolean Factory::clearOldData()

• Visibility: public
• This method is defined by Factory

\FactoryListIterator Factory::getIterator()

• Visibility: public
• This method is defined by Factory

mixed Factory::getCurrent()

• Visibility: public
• This method is defined by Factory