<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
class CRM_Core_DAO extends DB_DataObject {
/**
- * a null object so we can pass it as reference if / when needed
+ * A null object so we can pass it as reference if / when needed
*/
static $_nullObject = NULL;
static $_nullArray = array();
static $_dbColumnValueCache = NULL;
- CONST NOT_NULL = 1, IS_NULL = 2,
+ const NOT_NULL = 1, IS_NULL = 2,
DB_DAO_NOTNULL = 128,
VALUE_SEPARATOR = "\ 1",
BULK_INSERT_COUNT = 200,
*/
static $_testEntitiesToSkip = array();
/**
- * the factory class for this application
+ * The factory class for this application
* @var object
*/
static $_factory = NULL;
* @return \CRM_Core_DAO
@access public
*/
- function __construct() {
+ public function __construct() {
$this->initialize();
$this->__table = $this->getTableName();
}
/**
- * empty definition for virtual function
+ * Empty definition for virtual function
*/
- static function getTableName() {
+ public static function getTableName() {
return NULL;
}
/**
- * initialize the DAO object
+ * Initialize the DAO object
*
- * @param string $dsn the database connection string
+ * @param string $dsn
+ * The database connection string.
*
* @return void
- * @access private
* @static
*/
- static function init($dsn) {
+ public static function init($dsn) {
$options = &PEAR::getStaticProperty('DB_DataObject', 'options');
$options['database'] = $dsn;
if (defined('CIVICRM_DAO_DEBUG')) {
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $fieldDef
* @param array $params
*
*
* @param string $fieldName
* @param array $fieldDef
- * @param int $counter the globally-unique ID of the test object
+ * @param int $counter
+ * The globally-unique ID of the test object.
*/
protected function assignTestValue($fieldName, &$fieldDef, $counter) {
$dbName = $fieldDef['name'];
}
/**
- * reset the DAO object. DAO is kinda crappy in that there is an unwritten
+ * 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 restricrion
* by resetting some of DAO's internal fields. Use this with caution
*
* @return void
- * @access public
*
*/
- function reset() {
+ public function reset() {
foreach (array_keys($this->table()) as $field) {
unset($this->$field);
}
/**
- * @param $tableName
+ * @param string $tableName
*
* @return string
*/
- static function getLocaleTableName($tableName) {
+ public static function getLocaleTableName($tableName) {
global $dbLocale;
if ($dbLocale) {
$tables = CRM_Core_I18n_Schema::schemaStructureTables();
/**
* Execute a query by the current DAO, localizing it along the way (if needed).
*
- * @param string $query the SQL query for execution
- * @param bool $i18nRewrite whether to rewrite the query
+ * @param string $query
+ * The SQL query for execution.
+ * @param bool $i18nRewrite
+ * Whether to rewrite the query.
*
* @return object the current DAO object after the query execution
*/
- function query($query, $i18nRewrite = TRUE) {
+ public function query($query, $i18nRewrite = TRUE) {
// rewrite queries that should use $dbLocale-based views for multi-language installs
global $dbLocale;
if ($i18nRewrite and $dbLocale) {
/**
* Static function to set the factory instance for this class.
*
- * @param object $factory the factory application object
+ * @param object $factory
+ * The factory application object.
*
* @return void
- * @access public
* @static
*/
- static function setFactory(&$factory) {
+ public static function setFactory(&$factory) {
self::$_factory = &$factory;
}
* @param string $table
*
* @return void
- * @access public
*/
- function factory($table = '') {
+ public function factory($table = '') {
if (!isset(self::$_factory)) {
return parent::factory($table);
}
* we need to set the links manually.
*
* @return void
- * @access protected
*/
- function initialize() {
+ public function initialize() {
$this->_connect();
$this->query("SET NAMES utf8");
}
/**
* Defines the default key as 'id'.
*
- * @access protected
*
* @return array
*/
- function keys() {
+ public function keys() {
static $keys;
if (!isset($keys)) {
$keys = array('id');
* Tells DB_DataObject which keys use autoincrement.
* 'id' is autoincrementing by default.
*
- * @access protected
*
* @return array
*/
- function sequenceKey() {
+ public function sequenceKey() {
static $sequenceKeys;
if (!isset($sequenceKeys)) {
$sequenceKeys = array('id', TRUE);
}
/**
- * returns list of FK relationships
+ * Returns list of FK relationships
*
* @static
- * @access public
*
* @return array of CRM_Core_Reference_Interface
*/
- static function getReferenceColumns() {
+ public static function getReferenceColumns() {
return array();
}
/**
- * returns all the column names of this table
+ * Returns all the column names of this table
*
- * @access public
*
* @return array
*/
}
/**
- * get/set an associative array of table columns
+ * Get/set an associative array of table columns
*
- * @access public
- * @param array key=>type array
+ * @param array key=>type array
* @return array (associative)
*/
- function table() {
+ public function table() {
$fields = &$this->fields();
$table = array();
/**
* @return $this
*/
- function save() {
+ public function save() {
if (!empty($this->id)) {
$this->update();
return $this;
}
- function delete($useWhere = FALSE) {
+ public function delete($useWhere = FALSE) {
$result = parent::delete($useWhere);
$event = new \Civi\Core\DAO\Event\PostDelete($this, $result);
/**
* @param bool $created
*/
- function log($created = FALSE) {
+ public function log($created = FALSE) {
static $cid = NULL;
if (!$this->getLog()) {
* Given an associative array of name/value pairs, extract all the values
* that belong to this object and initialize the object with said values
*
- * @param array $params (reference ) associative array of name/value pairs
+ * @param array $params
+ * (reference ) associative array of name/value pairs.
*
* @return boolean did we copy all null values into the object
- * @access public
*/
- function copyValues(&$params) {
+ public function copyValues(&$params) {
$fields = &$this->fields();
$allNull = TRUE;
foreach ($fields as $name => $value) {
* this is a destructive store, calling function is responsible
* for keeping sanity of id's.
*
- * @param object $object the object that we are extracting data from
- * @param array $values (reference ) associative array of name/value pairs
+ * @param object $object
+ * The object that we are extracting data from.
+ * @param array $values
+ * (reference ) associative array of name/value pairs.
*
* @return void
- * @access public
* @static
*/
- static function storeValues(&$object, &$values) {
+ public static function storeValues(&$object, &$values) {
$fields = &$object->fields();
foreach ($fields as $name => $value) {
$dbName = $value['name'];
}
/**
- * create an attribute for this specific field. We only do this for strings and text
+ * Create an attribute for this specific field. We only do this for strings and text
*
- * @param array $field the field under task
+ * @param array $field
+ * The field under task.
*
* @return array|null the attributes for the object
- * @access public
* @static
*/
- static function makeAttribute($field) {
+ public static function makeAttribute($field) {
if ($field) {
if (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_STRING) {
$maxLength = CRM_Utils_Array::value('maxlength', $field);
* Get the size and maxLength attributes for this text field
* (or for all text fields) in the DAO object.
*
- * @param string $class name of DAO class
- * @param string $fieldName field that i'm interested in or null if
+ * @param string $class
+ * Name of DAO class.
+ * @param string $fieldName
+ * Field that i'm interested in or null if.
* you want the attributes for all DAO text fields
*
* @return array assoc array of name => attribute pairs
- * @access public
* @static
*/
- static function getAttribute($class, $fieldName = NULL) {
+ public static function getAttribute($class, $fieldName = NULL) {
$object = new $class( );
$fields = &$object->fields();
if ($fieldName != NULL) {
*
* @throws Exception
*/
- static function transaction($type) {
+ public static function transaction($type) {
CRM_Core_Error::fatal('This function is obsolete, please use CRM_Core_Transaction');
}
/**
* Check if there is a record with the same name in the db
*
- * @param string $value the value of the field we are checking
- * @param string $daoName the dao object name
- * @param string $daoID the id of the object being updated. u can change your name
+ * @param string $value
+ * The value of the field we are checking.
+ * @param string $daoName
+ * The dao object name.
+ * @param string $daoID
+ * The id of the object being updated. u can change your name.
* as long as there is no conflict
- * @param string $fieldName the name of the field in the DAO
+ * @param string $fieldName
+ * The name of the field in the DAO.
*
* @return boolean true if object exists
- * @access public
* @static
*/
- static function objectExists($value, $daoName, $daoID, $fieldName = 'name') {
+ public static function objectExists($value, $daoName, $daoID, $fieldName = 'name') {
$object = new $daoName( );
$object->$fieldName = $value;
*
* @param string $tableName
* @param string $columnName
- * @param bool $i18nRewrite whether to rewrite the query on multilingual setups
+ * @param bool $i18nRewrite
+ * Whether to rewrite the query on multilingual setups.
*
* @return boolean true if exists, else false
* @static
*/
- static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
+ public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
$query = "
SHOW COLUMNS
FROM $tableName
* @return array
* @static
*/
- static function getStorageValues($tableName = NULL, $maxTablesToCheck = 10, $fieldName = 'Engine') {
+ public static function getStorageValues($tableName = NULL, $maxTablesToCheck = 10, $fieldName = 'Engine') {
$values = array();
$query = "SHOW TABLE STATUS LIKE %1";
*
* @return bool
*/
- static function isDBMyISAM($maxTablesToCheck = 10) {
+ public static function isDBMyISAM($maxTablesToCheck = 10) {
// show error if any of the tables, use 'MyISAM' storage engine.
$engines = self::getStorageValues(NULL, $maxTablesToCheck);
if (array_key_exists('MyISAM', $engines)) {
* @return boolean true if constraint exists, false otherwise
* @static
*/
- static function checkConstraintExists($tableName, $constraint) {
+ public static function checkConstraintExists($tableName, $constraint) {
static $show = array();
if (!array_key_exists($tableName, $show)) {
*
* @return boolean true if CONSTRAINT keyword exists, false otherwise
*/
- static function schemaRequiresRebuilding($tables = array("civicrm_contact")) {
+ public static function schemaRequiresRebuilding($tables = array("civicrm_contact")) {
$show = array();
foreach($tables as $tableName){
if (!array_key_exists($tableName, $show)) {
* @return boolean true if in format, false otherwise
* @static
*/
- static function checkFKConstraintInFormat($tableName, $columnName) {
+ public static function checkFKConstraintInFormat($tableName, $columnName) {
static $show = array();
if (!array_key_exists($tableName, $show)) {
* @return boolean true if the value is always $columnValue, false otherwise
* @static
*/
- static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
+ public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
$query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
$dao = CRM_Core_DAO::executeQuery($query);
$result = $dao->fetch() ? FALSE : TRUE;
* @return boolean true if if the value is always NULL, false otherwise
* @static
*/
- static function checkFieldIsAlwaysNull($tableName, $columnName) {
+ public static function checkFieldIsAlwaysNull($tableName, $columnName) {
$query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
$dao = CRM_Core_DAO::executeQuery($query);
$result = $dao->fetch() ? FALSE : TRUE;
* @return boolean true if exists, else false
* @static
*/
- static function checkTableExists($tableName) {
+ public static function checkTableExists($tableName) {
$query = "
SHOW TABLES
LIKE %1
*
* @return bool
*/
- function checkVersion($version) {
+ public function checkVersion($version) {
$query = "
SELECT version
FROM civicrm_domain
return trim($version) == trim($dbVersion) ? TRUE : FALSE;
}
+ /**
+ * Find a DAO object for the given ID and return it.
+ *
+ * @param int $id
+ * Id of the DAO object being searched for.
+ *
+ * @return object Object of the type of the class that called this function.
+ */
+ public static function findById($id) {
+ $object = new static();
+ $object->id = $id;
+ if (!$object->find(TRUE)) {
+ throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
+ }
+ return $object;
+ }
+
/**
* Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
*
- * @param string $daoName Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact)
- * @param int $searchValue Value of the column you want to search by
- * @param string $returnColumn Name of the column you want to GET the value of
- * @param string $searchColumn Name of the column you want to search by
- * @param boolean $force Skip use of the cache
+ * @param string $daoName
+ * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
+ * @param int $searchValue
+ * Value of the column you want to search by.
+ * @param string $returnColumn
+ * Name of the column you want to GET the value of.
+ * @param string $searchColumn
+ * Name of the column you want to search by.
+ * @param bool $force
+ * Skip use of the cache.
*
* @return string|null Value of $returnColumn in the retrieved record
* @static
- * @access public
*/
- static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
+ public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
if (
empty($searchValue) ||
trim(strtolower($searchValue)) == 'null'
/**
* Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
*
- * @param string $daoName Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact)
- * @param int $searchValue Value of the column you want to search by
- * @param string $setColumn Name of the column you want to SET the value of
- * @param string $setValue SET the setColumn to this value
- * @param string $searchColumn Name of the column you want to search by
+ * @param string $daoName
+ * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
+ * @param int $searchValue
+ * Value of the column you want to search by.
+ * @param string $setColumn
+ * Name of the column you want to SET the value of.
+ * @param string $setValue
+ * SET the setColumn to this value.
+ * @param string $searchColumn
+ * Name of the column you want to search by.
*
* @return boolean true if we found and updated the object, else false
* @static
- * @access public
*/
- static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
+ public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
$object = new $daoName( );
$object->selectAdd();
$object->selectAdd("$searchColumn, $setColumn");
* Get sort string
*
* @param array|object $sort either array or CRM_Utils_Sort
- * @param string $default - default sort value
+ * @param string $default
+ * Default sort value.
*
* @return string - sortString
- * @access public
* @static
*/
- static function getSortString($sort, $default = NULL) {
+ public static function getSortString($sort, $default = NULL) {
// check if sort is of type CRM_Utils_Sort
if (is_a($sort, 'CRM_Utils_Sort')) {
return $sort->orderBy();
/**
* Fetch object based on array of properties
*
- * @param string $daoName name of the dao object
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
- * @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name')
+ * @param string $daoName
+ * Name of the dao object.
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
+ * @param array $returnProperities
+ * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
*
* @return object an object of type referenced by daoName
- * @access public
* @static
*/
- static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
+ public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
$object = new $daoName( );
$object->copyValues($params);
/**
* Delete the object records that are associated with this contact
*
- * @param string $daoName name of the dao object
- * @param int $contactId id of the contact to delete
+ * @param string $daoName
+ * Name of the dao object.
+ * @param int $contactId
+ * Id of the contact to delete.
*
* @return void
- * @access public
* @static
*/
- static function deleteEntityContact($daoName, $contactId) {
+ public static function deleteEntityContact($daoName, $contactId) {
$object = new $daoName( );
$object->entity_table = 'civicrm_contact';
}
/**
- * execute a query
+ * Execute a query
*
- * @param string $query query to be executed
+ * @param string $query
+ * Query to be executed.
*
* @param array $params
* @param bool $abort
*
* @return CRM_Core_DAO object that holds the results of the query
* @static
- * @access public
*/
static function &executeQuery(
$query,
}
/**
- * execute a query and get the single result
+ * Execute a query and get the single result
*
- * @param string $query query to be executed
+ * @param string $query
+ * Query to be executed.
* @param array $params
* @param bool $abort
* @param bool $i18nRewrite
* @return string|null the result of the query if any
*
* @static
- * @access public
*/
- static function &singleValueQuery($query,
+ static function &singleValueQuery(
+ $query,
$params = array(),
$abort = TRUE,
$i18nRewrite = TRUE
* @return string
* @throws Exception
*/
- static function composeQuery($query, &$params, $abort = TRUE) {
+ public static function composeQuery($query, &$params, $abort = TRUE) {
$tr = array();
foreach ($params as $key => $item) {
if (is_numeric($key)) {
/**
* @param null $ids
*/
- static function freeResult($ids = NULL) {
+ public static function freeResult($ids = NULL) {
global $_DB_DATAOBJECT;
if (!$ids) {
* This function is to make a shallow copy of an object
* and all the fields in the object
*
- * @param string $daoName name of the dao
- * @param array $criteria array of all the fields & values
+ * @param string $daoName
+ * Name of the dao.
+ * @param array $criteria
+ * Array of all the fields & values.
* on which basis to copy
- * @param array $newData array of all the fields & values
+ * @param array $newData
+ * Array of all the fields & values.
* to be copied besides the other fields
- * @param string $fieldsFix array of fields that you want to prefix/suffix/replace
- * @param string $blockCopyOfDependencies fields that you want to block from
+ * @param string $fieldsFix
+ * Array of fields that you want to prefix/suffix/replace.
+ * @param string $blockCopyOfDependencies
+ * Fields that you want to block from.
* getting copied
*
*
* @return (reference ) the newly created copy of the object
- * @access public
*/
static function ©Generic($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL) {
$object = new $daoName( );
return $newObject;
}
- static function cascadeUpdate($daoName, $fromId, $toId, $newData = array()) {
+ public static function cascadeUpdate($daoName, $fromId, $toId, $newData = array()) {
$object = new $daoName( );
$object->id = $fromId;
* since its used for things like send email
*
* @param $componentIDs
- * @param $tableName
+ * @param string $tableName
*
* @return array
*/
/**
* Fetch object based on array of properties
*
- * @param string $daoName name of the dao object
+ * @param string $daoName
+ * Name of the dao object.
* @param string $fieldIdName
- * @param $fieldId
+ * @param int $fieldId
* @param $details
- * @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name')
+ * @param array $returnProperities
+ * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
*
* @return object an object of type referenced by daoName
- * @access public
* @static
*/
- static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
+ public static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
require_once (str_replace('_', DIRECTORY_SEPARATOR, $daoName) . ".php");
$object = new $daoName( );
$object->$fieldIdName = $fieldId;
return $details;
}
- static function dropAllTables() {
+ public static function dropAllTables() {
// first drop all the custom tables we've created
CRM_Core_BAO_CustomGroup::dropAllTables();
*
* @return string
*/
- static function escapeString($string) {
+ public static function escapeString($string) {
static $_dao = NULL;
if (!$_dao) {
+ // If this is an atypical case (e.g. preparing .sql files
+ // before Civi has been installed), then we fallback to
+ // DB-less escaping helper (mysql_real_escape_string).
+ // Note: In typical usage, escapeString() will only
+ // check one conditional ("if !$_dao") rather than
+ // two conditionals ("if !defined(DSN)")
+ if (!defined('CIVICRM_DSN')) {
+ if (function_exists('mysql_real_escape_string')) {
+ return mysql_real_escape_string($string);
+ } else {
+ throw new CRM_Core_Exception("Cannot generate SQL. \"mysql_real_escape_string\" is missing. Have you installed PHP \"mysql\" extension?");
+ }
+ }
+
$_dao = new CRM_Core_DAO();
}
/**
* Escape a list of strings for use with "WHERE X IN (...)" queries.
*
- * @param $strings array
- * @param $default string the value to use if $strings has no elements
+ * @param $strings
+ * Array.
+ * @param $default
+ * String the value to use if $strings has no elements.
* @return string eg "abc","def","ghi"
*/
- static function escapeStrings($strings, $default = NULL) {
+ public static function escapeStrings($strings, $default = NULL) {
static $_dao = NULL;
if (!$_dao) {
$_dao = new CRM_Core_DAO();
*
* @return string
*/
- static function escapeWildCardString($string) {
+ public static function escapeWildCardString($string) {
// CRM-9155
// ensure we escape the single characters % and _ which are mysql wild
// card characters and could come in via sortByCharacter
}
/**
- * deletes the this object plus any dependent objects that are associated with it
+ * Deletes the this object plus any dependent objects that are associated with it
* ONLY USE FOR TESTING
*
* @param string $daoName
* @param array $params
*/
- static function deleteTestObjects($daoName, $params = array()) {
+ public static function deleteTestObjects($daoName, $params = array()) {
//this is a test function also backtrace is set for the test suite it sometimes unsets itself
// so we re-set here in case
$config = CRM_Core_Config::singleton();
* @param array $params
* @param $defaults
*/
- static function setCreateDefaults(&$params, $defaults) {
+ public static function setCreateDefaults(&$params, $defaults) {
if (isset($params['id'])) {
return;
}
*
* @return string
*/
- static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
+ public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
$tableName = $prefix . "_temp";
if ($addRandomString) {
*
* @return bool
*/
- static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
+ public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
// test for create view and trigger permissions and if allowed, add the option to go multilingual
// and logging
// I'm not sure why we use the getStaticProperty for an error, rather than checking for DB_Error
* @param null $message
* @param bool $printDAO
*/
- static function debugPrint($message = NULL, $printDAO = TRUE) {
+ public static function debugPrint($message = NULL, $printDAO = TRUE) {
CRM_Utils_System::xMemory("{$message}: ");
if ($printDAO) {
* Build a list of triggers via hook and add them to (err, reconcile them
* with) the database.
*
- * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables
+ * @param $tableName
+ * String the specific table requiring a rebuild; or NULL to rebuild all tables.
* @param bool $force
*
* @see CRM-9716
*/
- static function triggerRebuild($tableName = NULL, $force = FALSE) {
+ public static function triggerRebuild($tableName = NULL, $force = FALSE) {
$info = array();
$logging = new CRM_Logging_Schema;
* * Stop using functions and find another way to strip numeric characters from phones
* * Give better error messages (currently a missing fn fatals with "unknown error")
*/
- static function checkSqlFunctionsExist() {
+ public static function checkSqlFunctionsExist() {
if (!self::$_checkedSqlFunctionsExist) {
self::$_checkedSqlFunctionsExist = TRUE;
$dao = CRM_Core_DAO::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'");
/**
* Wrapper function to drop triggers
*
- * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables
+ * @param $tableName
+ * String the specific table requiring a rebuild; or NULL to rebuild all tables.
*/
- static function dropTriggers($tableName = NULL) {
+ public static function dropTriggers($tableName = NULL) {
$info = array();
$logging = new CRM_Logging_Schema;
}
/**
- * @param $info array per hook_civicrm_triggerInfo
- * @param $onlyTableName string the specific table requiring a rebuild; or NULL to rebuild all tables
+ * @param $info
+ * Array per hook_civicrm_triggerInfo.
+ * @param $onlyTableName
+ * String the specific table requiring a rebuild; or NULL to rebuild all tables.
*/
- static function createTriggers(&$info, $onlyTableName = NULL) {
+ public static function createTriggers(&$info, $onlyTableName = NULL) {
// Validate info array, should probably raise errors?
if (is_array($info) == FALSE) {
return;
/**
* Given a list of fields, create a list of references.
*
- * @param string $className BAO/DAO class name
+ * @param string $className
+ * BAO/DAO class name.
* @return array<CRM_Core_Reference_Interface>
*/
- static function createReferenceColumns($className) {
+ public static function createReferenceColumns($className) {
$result = array();
$fields = $className::fields();
foreach ($fields as $field) {
*
* @return array of objects referencing this
*/
- function findReferences() {
+ public function findReferences() {
$links = self::getReferencesToTable(static::getTableName());
$occurrences = array();
* - table: string|null SQL table name
* - key: string|null SQL column name
*/
- function getReferenceCounts() {
+ public function getReferenceCounts() {
$links = self::getReferencesToTable(static::getTableName());
$counts = array();
* schema metadata in dynamicForeignKey which enumerates a restricted
* set of possible entity_table's.
*
- * @param string $tableName table referred to
+ * @param string $tableName
+ * Table referred to.
*
* @return array structure of table and column, listing every table with a
* foreign key reference to $tableName, and the column where the key appears.
*/
- static function getReferencesToTable($tableName) {
+ public static function getReferencesToTable($tableName) {
$refsFound = array();
foreach (CRM_Core_DAO_AllCoreTables::getClasses() as $daoClassName) {
$links = $daoClassName::getReferenceColumns();
/**
* Lookup the value of a MySQL global configuration variable.
*
- * @param string $name e.g. "thread_stack"
+ * @param string $name
+ * E.g. "thread_stack".
* @param mixed $default
* @return mixed
*/
* The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
*
* @param string $fieldName
- * @param string $context : @see CRM_Core_DAO::buildOptionsContext
- * @param array $props : whatever is known about this bao object
+ * @param string $context
+ * : @see CRM_Core_DAO::buildOptionsContext.
+ * @param array $props
+ * : whatever is known about this bao object.
*
* @return Array|bool
*/
/**
* Provides documentation and validation for the buildOptions $context param
*
- * @param String $context
+ * @param string $context
*
* @throws Exception
* @return array
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @return bool|array
*/
- function getFieldSpec($fieldName) {
+ public function getFieldSpec($fieldName) {
$fields = $this->fields();
$fieldKeys = $this->fieldKeys();
* $field => array('LIKE' => array('%me%))
* etc
*
- * @param string $fieldName name of fields
- * @param $filter array filter to be applied indexed by operator
- * @param $type String type of field (not actually used - nor in api @todo )
- * @param $alias String alternative field name ('as') @todo- not actually used
- * @param bool $returnSanitisedArray return a sanitised array instead of a clause
+ * @param string $fieldName
+ * Name of fields.
+ * @param $filter
+ * Array filter to be applied indexed by operator.
+ * @param $type
+ * String type of field (not actually used - nor in api @todo ).
+ * @param $alias
+ * String alternative field name ('as') @todo- not actually used.
+ * @param bool $returnSanitisedArray
+ * Return a sanitised array instead of a clause.
* this is primarily so we can add filters @ the api level to the Query object based fields
*
* @throws Exception
* which can be longer than this length, this function helps with creating
* strings that meet various criteria.
*
- * @param string $string - the string to be shortened
- * @param int $length - the max length of the string
+ * @param string $string
+ * The string to be shortened.
+ * @param int $length
+ * The max length of the string.
*
* @param bool $makeRandom
*
/**
* @param array $params
*/
- function setApiFilter(&$params) {}
+ public function setApiFilter(&$params) {}
}
projects / civicrm-core.git / blobdiff