CRM_Core_DAO_Job
class CRM_Core_DAO_Job extends CRM_Core_DAO
Database access object for the Job entity.
Constants
NOT_NULL |
|
IS_NULL |
|
DB_DAO_NOTNULL |
|
VALUE_SEPARATOR |
|
BULK_INSERT_COUNT |
|
BULK_INSERT_HIGH_COUNT |
|
QUERY_FORMAT_WILDCARD |
|
QUERY_FORMAT_NO_QUOTES |
|
SERIALIZE_SEPARATOR_BOOKEND |
|
SERIALIZE_SEPARATOR_TRIMMED |
|
SERIALIZE_JSON |
|
SERIALIZE_PHP |
|
SERIALIZE_COMMA |
|
Properties
protected int | $resultCopies | How many times has this instance been cloned. | from CRM_Core_DAO |
static null | $_nullObject | from CRM_Core_DAO | |
static array | $_nullArray | from CRM_Core_DAO | |
static | $_dbColumnValueCache | from CRM_Core_DAO | |
static array | $_testEntitiesToSkip | Define entities that shouldn't be created or deleted when creating/ deleting test objects - this prevents world regions, countries etc from being added / deleted | from CRM_Core_DAO |
static object | $_factory | The factory class for this application. | from CRM_Core_DAO |
static | $_checkedSqlFunctionsExist | from CRM_Core_DAO | |
protected array | $_options | https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings | from CRM_Core_DAO |
static string | $_tableName | Static instance to hold the table name. | |
static bool | $_log | Should CiviCRM log any modifications to this table in the civicrm_log table. | |
int | $id | Job Id | |
int | $domain_id | Which Domain is this scheduled job for | |
string | $run_frequency | Scheduled job run frequency. | |
timestamp | $last_run | When was this cron entry last run | |
timestamp | $scheduled_run_date | When is this cron entry scheduled to run | |
string | $name | Title of the job | |
string | $description | Description of the job | |
string | $api_entity | Entity of the job api call | |
string | $api_action | Action of the job api call | |
text | $parameters | List of parameters to the command. | |
bool | $is_active | Is this job active? |
Methods
Class constructor.
Returns the names of this table
Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.
Generate and assign an arbitrary value to a field of a test object.
Execute a query by the current DAO, localizing it along the way (if needed).
Static function to set the factory instance for this class.
Factory method to instantiate a new object from a table name.
Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
Returns foreign keys and entity references.
Returns all the column names of this table
Deletes items from table which match current objects variables.
Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
Store all the values from this object in an associative array this is a destructive store, calling function is responsible for keeping sanity of id's.
Create an attribute for this specific field. We only do this for strings and text
Get the size and maxLength attributes for this text field.
Check if there is a record with the same name in the db.
Check if there is a given column in a specific table.
Scans all the tables using a slow query and table name.
Checks if a constraint exists for a specified table.
Checks if CONSTRAINT keyword exists for a specified table.
Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
Check whether a specific column in a specific table has always the same value.
Check whether a specific column in a specific table is always NULL.
Check if there is a given table in the database.
Find a DAO object for the given ID and return it.
Get all the result records as mapping between columns.
Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
Get sort string.
Fetch object based on array of properties.
Delete the object records that are associated with this contact.
Execute an unbuffered query.
Execute a query.
Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
Execute a query and get the single result.
Compose the query by merging the parameters into it.
Make a shallow copy of an object and all the fields in the object.
Method that copies custom fields values from an old entity to a new one.
Cascade update through related entities.
Given the component id, compute the contact id since its used for things like send email
Fetch object based on array of properties.
Escape a list of strings for use with "WHERE X IN (.
Creates a test object, including any required objects it needs via recursion createOnly: only create in database, do not store or return the objects (useful for perf testing) ONLY USE FOR TESTING
Deletes the this object plus any dependent objects that are associated with it.
Set defaults when creating new entity.
No description
No description
Build a list of triggers via hook and add them to (err, reconcile them with) the database.
Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
Given a list of fields, create a list of references.
List all tables which have hard foreign keys to this table.
Add custom tables that extend contacts to the list of contact references.
Add custom ContactReference fields to the list of contact references
Lookup the value of a MySQL global configuration variable.
Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
Get options for the called BAO object's field.
Provides documentation and validation for the buildOptions $context param
Get SQL where clause for SQL filter syntax input parameters.
SQL has a limit of 64 characters on various names: table name, trigger name, column name .
https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
This returns the final permissioned query string for this entity
ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insenstive.
Transform an array to a serialized string for database storage.
Transform a serialized string from the database into an array.
Get exportable fields with pseudoconstants rendered as an extra field.
Return a mapping from field-name to the corresponding key (as used in fields()).
Returns if this table needs to be logged
Returns the list of fields that can be imported
Returns the list of fields that can be exported
Returns the list of indices
Details
at line 111
CRM_Core_DAO
__construct()
Class constructor.
in CRM_Core_DAO at line 130
__clone()
in CRM_Core_DAO at line 139
__destruct()
Class destructor.
at line 318
static
getTableName()
Returns the names of this table
in CRM_Core_DAO at line 159
static
init(string $dsn)
Initialize the DAO object.
in CRM_Core_DAO at line 185
static DB_common
getConnection()
in CRM_Core_DAO at line 194
static
disableFullGroupByMode()
Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
in CRM_Core_DAO at line 206
static
reenableFullGroupByMode()
Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.
.
in CRM_Core_DAO at line 219
protected
assignTestFK(string $fieldName, $fieldDef, array $params)
in CRM_Core_DAO at line 264
protected
assignTestValue(string $fieldName, array $fieldDef, int $counter)
Generate and assign an arbitrary value to a field of a test object.
in CRM_Core_DAO at line 376
reset()
Reset the DAO object.
DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
in CRM_Core_DAO at line 396
static string
getLocaleTableName(string $tableName)
in CRM_Core_DAO at line 418
object
query(string $query, bool $i18nRewrite = TRUE)
Execute a query by the current DAO, localizing it along the way (if needed).
in CRM_Core_DAO at line 447
static
setFactory(object $factory)
Static function to set the factory instance for this class.
in CRM_Core_DAO at line 457
DataObject|PEAR_Error
factory(string $table = '')
Factory method to instantiate a new object from a table name.
in CRM_Core_DAO at line 469
initialize()
Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
in CRM_Core_DAO at line 484
array
keys()
Defines the default key as 'id'.
in CRM_Core_DAO at line 499
array
sequenceKey()
Tells DB_DataObject which keys use autoincrement.
'id' is autoincrementing by default.
at line 122
static array
getReferenceColumns()
Returns foreign keys and entity references.
at line 136
static array
fields()
Returns all the column names of this table
in CRM_Core_DAO at line 535
array
table()
Get/set an associative array of table columns
in CRM_Core_DAO at line 558
CRM_Core_DAO
save(bool $hook = TRUE)
Save DAO object.
in CRM_Core_DAO at line 610
delete(bool $useWhere = FALSE)
Deletes items from table which match current objects variables.
Returns the true on success
for example
Designed to be extended
$object = new mytable(); $object->ID=123; echo $object->delete(); // builds a conditon
$object = new mytable(); $object->whereAdd('age > 12'); $object->limit(1); $object->orderBy('age DESC'); $object->delete(true); // dont use object vars, use the conditions, limit and order.
in CRM_Core_DAO at line 628
log(bool $created = FALSE)
in CRM_Core_DAO at line 669
bool
copyValues(array $params, bool $serializeArrays = FALSE)
Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
in CRM_Core_DAO at line 725
static
storeValues(object $object, array $values)
Store all the values from this object in an associative array this is a destructive store, calling function is responsible for keeping sanity of id's.
in CRM_Core_DAO at line 747
static array|null
makeAttribute(array $field)
Create an attribute for this specific field. We only do this for strings and text
in CRM_Core_DAO at line 800
static array
getAttribute(string $class, string $fieldName = NULL)
Get the size and maxLength attributes for this text field.
(or for all text fields) in the DAO object.
in CRM_Core_DAO at line 842
static bool
objectExists(string $value, string $daoName, string $daoID, string $fieldName = 'name', string $domainID = NULL)
Check if there is a record with the same name in the db.
in CRM_Core_DAO at line 871
static bool
checkFieldExists(string $tableName, string $columnName, bool $i18nRewrite = TRUE)
deprecated
deprecated
Check if there is a given column in a specific table.
in CRM_Core_DAO at line 880
static array
getTableNames()
Scans all the tables using a slow query and table name.
in CRM_Core_DAO at line 901
static bool
isDBMyISAM(int $maxTablesToCheck = 10)
in CRM_Core_DAO at line 919
static string
getDatabaseName()
Get the name of the CiviCRM database.
in CRM_Core_DAO at line 933
static bool
checkConstraintExists(string $tableName, string $constraint)
Checks if a constraint exists for a specified table.
in CRM_Core_DAO at line 960
static bool
schemaRequiresRebuilding(array $tables = ["civicrm_contact"])
Checks if CONSTRAINT keyword exists for a specified table.
in CRM_Core_DAO at line 995
static bool
checkFKConstraintInFormat(string $tableName, string $columnName)
Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
in CRM_Core_DAO at line 1023
static bool
checkFieldHasAlwaysValue(string $tableName, string $columnName, string $columnValue)
Check whether a specific column in a specific table has always the same value.
in CRM_Core_DAO at line 1039
static bool
checkFieldIsAlwaysNull(string $tableName, string $columnName)
Check whether a specific column in a specific table is always NULL.
in CRM_Core_DAO at line 1054
static bool
checkTableExists(string $tableName)
Check if there is a given table in the database.
in CRM_Core_DAO at line 1073
static bool
checkTableHasData(string $tableName)
Check if a given table has data.
in CRM_Core_DAO at line 1083
bool
checkVersion($version)
in CRM_Core_DAO at line 1103
static CRM_Core_DAO
findById(int $id)
Find a DAO object for the given ID and return it.
in CRM_Core_DAO at line 1117
array
fetchAll()
Returns all results as array-encoded records.
in CRM_Core_DAO at line 1131
fetchGenerator(string $type = 'dao')
Return the results as PHP generator.
in CRM_Core_DAO at line 1153
mixed|NULL
fetchValue()
Returns a singular value.
in CRM_Core_DAO at line 1174
array
fetchMap(string $keyColumn, string $valueColumn)
Get all the result records as mapping between columns.
in CRM_Core_DAO at line 1199
static string|null
getFieldValue(string $daoName, int $searchValue, string $returnColumn = 'name', string $searchColumn = 'id', bool $force = FALSE)
Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
in CRM_Core_DAO at line 1252
static bool
setFieldValue(string $daoName, int $searchValue, string $setColumn, string $setValue, string $searchColumn = 'id')
Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
in CRM_Core_DAO at line 1277
static string
getSortString(array|object $sort, string $default = NULL)
Get sort string.
in CRM_Core_DAO at line 1310
static object
commonRetrieve(string $daoName, array $params, array $defaults, array $returnProperities = NULL)
Fetch object based on array of properties.
in CRM_Core_DAO at line 1335
static
deleteEntityContact(string $daoName, int $contactId)
Delete the object records that are associated with this contact.
in CRM_Core_DAO at line 1360
static CRM_Core_DAO
executeUnbufferedQuery(string $query, array $params = [], bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)
Execute an unbuffered query.
This is a wrapper around new functionality exposed with CRM-17748.
in CRM_Core_DAO at line 1401
static CRM_Core_DAO|object
executeQuery(string $query, array $params = [], bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE, array $options = [])
Execute a query.
in CRM_Core_DAO at line 1456
bool
isValidOption(array $options)
Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
in CRM_Core_DAO at line 1491
static string|null
singleValueQuery(string $query, array $params = [], bool $abort = TRUE, bool $i18nRewrite = TRUE)
Execute a query and get the single result.
in CRM_Core_DAO at line 1529
static string
composeQuery(string $query, array $params = [], bool $abort = TRUE)
Compose the query by merging the parameters into it.
in CRM_Core_DAO at line 1576
static
freeResult(null $ids = NULL)
in CRM_Core_DAO at line 1623
static CRM_Core_DAO|bool
copyGeneric(string $daoName, array $criteria, array $newData = NULL, string $fieldsFix = NULL, string $blockCopyOfDependencies = NULL, bool $blockCopyofCustomValues = FALSE)
Make a shallow copy of an object and all the fields in the object.
in CRM_Core_DAO at line 1713
copyCustomFields(int $entityID, int $newEntityID)
Method that copies custom fields values from an old entity to a new one.
Fixes bug CRM-19302, where if a custom field of File type was present, left both events using the same file, breaking download URL's for the old event.
in CRM_Core_DAO at line 1768
static CRM_Core_DAO|null
cascadeUpdate(string $daoName, $fromId, $toId, array $newData = [])
Cascade update through related entities.
in CRM_Core_DAO at line 1813
static array
getContactIDsFromComponent($componentIDs, string $tableName, string $idField = 'id')
Given the component id, compute the contact id since its used for things like send email
in CRM_Core_DAO at line 1848
static object
commonRetrieveAll(string $daoName, string $fieldIdName = 'id', int $fieldId, $details, array $returnProperities = NULL)
Fetch object based on array of properties.
in CRM_Core_DAO at line 1875
static
dropAllTables()
Drop all CiviCRM tables.
in CRM_Core_DAO at line 1897
static string
escapeString($string)
in CRM_Core_DAO at line 1926
static string
escapeStrings(array $strings, string $default = NULL)
Escape a list of strings for use with "WHERE X IN (.
..)" queries.
in CRM_Core_DAO at line 1945
static string
escapeWildCardString($string)
in CRM_Core_DAO at line 1973
static object|array|NULL
createTestObject(string $daoName, array $params = [], int $numObjects = 1, bool $createOnly = FALSE)
Creates a test object, including any required objects it needs via recursion createOnly: only create in database, do not store or return the objects (useful for perf testing) ONLY USE FOR TESTING
in CRM_Core_DAO at line 2062
static
deleteTestObjects(string $daoName, array $params = [])
Deletes the this object plus any dependent objects that are associated with it.
ONLY USE FOR TESTING
in CRM_Core_DAO at line 2110
static
setCreateDefaults(array $params, $defaults)
Set defaults when creating new entity.
(don't call this set defaults as already in use with different signature in some places)
in CRM_Core_DAO at line 2130
static string
createTempTableName(string $prefix = 'civicrm', bool $addRandomString = TRUE, null $string = NULL)
deprecated
deprecated
in CRM_Core_DAO at line 2150
static bool
checkTriggerViewPermission(bool $view = TRUE, bool $trigger = TRUE)
in CRM_Core_DAO at line 2198
static
debugPrint(null $message = NULL, bool $printDAO = TRUE)
in CRM_Core_DAO at line 2222
static
triggerRebuild(string $tableName = NULL, bool $force = FALSE)
deprecated
deprecated
Build a list of triggers via hook and add them to (err, reconcile them with) the database.
in CRM_Core_DAO at line 2233
static
checkSqlFunctionsExist()
Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
in CRM_Core_DAO at line 2250
static
dropTriggers(string $tableName = NULL)
deprecated
deprecated
Wrapper function to drop triggers.
in CRM_Core_DAO at line 2261
static
createTriggers(array $info, string $onlyTableName = NULL)
deprecated
deprecated
in CRM_Core_DAO at line 2272
static array
createReferenceColumns(string $className)
Given a list of fields, create a list of references.
in CRM_Core_DAO at line 2295
array
findReferences()
Find all records which refer to this entity.
in CRM_Core_DAO at line 2324
array
getReferenceCounts()
in CRM_Core_DAO at line 2361
static array
getReferencesToTable(string $tableName)
List all tables which have hard foreign keys to this table.
For now, this returns a description of every entity_id/entity_table reference. TODO: filter dynamic entity references on the $tableName, based on schema metadata in dynamicForeignKey which enumerates a restricted set of possible entity_table's.
in CRM_Core_DAO at line 2386
static
getReferencesToContactTable()
Get all references to contact table.
This includes core tables, custom group tables, tables added by the merge hook and the entity_tag table.
Refer to CRM-17454 for information on the danger of querying the information schema to derive this.
in CRM_Core_DAO at line 2418
static
appendCustomTablesExtendingContacts(array $cidRefs)
Add custom tables that extend contacts to the list of contact references.
CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish function to be sure all are retrieved & we don't miss subtypes or inactive or multiples - the down side is it is not cached.
Further changes should be include tests in the CRM_Core_MergerTest class to ensure that disabled, subtype, multiple etc groups are still captured.
in CRM_Core_DAO at line 2435
static
appendCustomContactReferenceFields(array $cidRefs)
Add custom ContactReference fields to the list of contact references
This includes active and inactive fields/groups
in CRM_Core_DAO at line 2453
static mixed
getGlobalSetting(string $name, mixed $default = NULL)
Lookup the value of a MySQL global configuration variable.
in CRM_Core_DAO at line 2477
static
appendPseudoConstantsToFields(array $fields)
Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
This is relevant where we want to offer both the ID field and the label field as an option, e.g. search builder.
It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the change small, but is appropriate for other sorts of pseudoconstants.
in CRM_Core_DAO at line 2531
static array|bool
buildOptions(string $fieldName, string $context = NULL, array $props = [])
Get options for the called BAO object's field.
This function can be overridden by each BAO to add more logic related to context. The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
in CRM_Core_DAO at line 2542
getOptionLabels()
Populate option labels for this object's fields.
in CRM_Core_DAO at line 2568
static array
buildOptionsContext(string $context = NULL)
Provides documentation and validation for the buildOptions $context param
in CRM_Core_DAO at line 2588
bool|array
getFieldSpec(string $fieldName)
in CRM_Core_DAO at line 2631
static NULL|string|array
createSQLFilter(string $fieldName, array $filter, string $type = NULL, string $alias = NULL, bool $returnSanitisedArray = FALSE)
Get SQL where clause for SQL filter syntax input parameters.
SQL version of api function to assign filters to the DAO based on the syntax $field => array('IN' => array(4,6,9)) OR $field => array('LIKE' => array('%me%)) etc
in CRM_Core_DAO at line 2696
static array
acceptedSQLOperators()
in CRM_Core_DAO at line 2733
static string
shortenSQLName(string $string, int $length = 60, bool $makeRandom = FALSE)
SQL has a limit of 64 characters on various names: table name, trigger name, column name .
..
For custom groups and fields we generated names from user entered input which can be longer than this length, this function helps with creating strings that meet various criteria.
in CRM_Core_DAO at line 2759
setOptions(array $options)
https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
in CRM_Core_DAO at line 2772
protected
_setDBOptions(array $options)
https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
in CRM_Core_DAO at line 2787
setApiFilter(array $params)
deprecated
deprecated
in CRM_Core_DAO at line 2804
array
addSelectWhereClause()
Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
Return format is in the form of fieldname => clauses starting with an operator. e.g.:
in CRM_Core_DAO at line 2845
static array
getSelectWhereClause(string $tableAlias = NULL)
This returns the final permissioned query string for this entity
With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
in CRM_Core_DAO at line 2868
static bool
requireSafeDBName($database)
ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insenstive.
in CRM_Core_DAO at line 2890
static string|null
serializeField(array|null $value, int $serializationType)
Transform an array to a serialized string for database storage.
in CRM_Core_DAO at line 2924
static array|null
unSerializeField(string|null $value, $serializationType)
Transform a serialized string from the database into an array.
in CRM_Core_DAO at line 2955
static array
getEntityRefFilters()
in CRM_Core_DAO at line 2966
static array
getExportableFieldsWithPseudoConstants(string $baoClass)
Get exportable fields with pseudoconstants rendered as an extra field.
at line 306
static array
fieldKeys()
Return a mapping from field-name to the corresponding key (as used in fields()).
at line 327
bool
getLog()
Returns if this table needs to be logged
at line 338
static array
import(bool $prefix = FALSE)
Returns the list of fields that can be imported
at line 350
static array
export(bool $prefix = FALSE)
Returns the list of fields that can be exported
at line 362
static array
indices(bool $localize = TRUE)
Returns the list of indices