protected $_preserveDefault = TRUE;
/**
- * Contact fields
+ * Contact fields.
*/
protected $_contactFields = array();
/**
- * Fields array of fields in the batch profile
+ * Fields array of fields in the batch profile.
* (based on the uf_field table data)
* (this can't be protected as it is passed into the CRM_Contact_Form_Task_Batch::parseStreetAddress function
* (although a future refactoring might hopefully change that so it uses the api & the function is not
class CRM_Core_BAO_Note extends CRM_Core_DAO_Note {
/**
- * Const the max number of notes we display at any given time
+ * Const the max number of notes we display at any given time.
* @var int
*/
const MAX_NOTES = 3;
}
/**
- * Get next available value
+ * Get next available value.
* We will take the highest numeric value (or 0 if no numeric values exist)
* and add one. The calling function is responsible for any
* more complex decision making
class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent {
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Look for any missing settings and convert them from config or load default as appropriate
+ * Look for any missing settings and convert them from config or load default as appropriate.
* This should be run from GenCode & also from upgrades to add any new defaults.
*
* Multisites have often been overlooked in upgrade scripts so can be expected to be missing
}
/**
- * Clear the smarty cache and assign default values
+ * Clear the smarty cache and assign default values.
* FIXME: unused cos we no longer do evil singleton magick
*/
protected function reset() {
const DEFAULT_PERMISSION = 'administer CiviCRM';
/**
- * Default time to wait before retrying
+ * Default time to wait before retrying.
*/
const DEFAULT_RETRY = 7200; // 2 hours
protected $messagesUrl;
/**
- * Create default instance
+ * Create default instance.
*
* @return CRM_Core_CommunityMessages
*/
}
/**
- * Download document from URL and parse as JSON
+ * Download document from URL and parse as JSON.
*
* @return NULL|array
* parsed JSON
}
/**
- * Pick a message to display
+ * Pick a message to display.
*
* @return NULL|array
*/
}
/**
- * Handle table dependencies of components
+ * Handle table dependencies of components.
*
* @param array $tables
* Array of tables.
}
/**
- * Get components info from info file
+ * Get components info from info file.
*/
public static function getComponentsFromFile($crmFolderDir) {
$components = array();
}
/**
- * Provides information about user dashboard element
+ * Provides information about user dashboard element.
* offered by this component.
*
* @return array|null
abstract public function getUserDashboardElement();
/**
- * Provides information about user dashboard element
+ * Provides information about user dashboard element.
* offered by this component.
*
* @return array|null
public $userPermissionClass;
/**
- * The root directory where Smarty should store compiled files
+ * The root directory where Smarty should store compiled files.
*
* @var string
*/
}
/**
- * Verify that the needed parameters are not null in the config
+ * Verify that the needed parameters are not null in the config.
*
* @param CRM_Core_Config $config (reference) the system config object
* @param array $required (reference) the parameters that need a value
}
/**
- * Reset the serialized array and recompute
+ * Reset the serialized array and recompute.
* use with care
*/
public function reset() {
}
/**
- * This method should initialize auth sources
+ * This method should initialize auth sources.
*/
public function initAuthSrc() {
$session = CRM_Core_Session::singleton();
}
/**
- * One function to get domain ID
+ * One function to get domain ID.
*/
public static function domainID($domainID = NULL, $reset = FALSE) {
static $domain;
}
/**
- * Flush information about loaded modules
+ * Flush information about loaded modules.
*/
public function clearModuleList() {
CRM_Extension_System::singleton()->getCache()->flush();
}
/**
- * Clear db cache
+ * Clear db cache.
*/
public static function clearDBCache() {
$queries = array(
}
/**
- * Clear leftover temporary tables
+ * Clear leftover temporary tables.
*/
public static function clearTempTables() {
// CRM-5645
}
/**
- * Check if running in upgrade mode
+ * Check if running in upgrade mode.
*/
public static function isUpgradeMode($path = NULL) {
if (defined('CIVICRM_UPGRADE_ACTIVE')) {
}
/**
- * Wrapper function to allow unit tests to switch user framework on the fly
+ * Wrapper function to allow unit tests to switch user framework on the fly.
*/
public function setUserFramework($userFramework = NULL) {
$this->userFramework = $userFramework;
}
/**
- * Getter method for stateMachine
+ * Getter method for stateMachine.
*
* @return CRM_Core_StateMachine
*/
}
/**
- * Setter method for stateMachine
+ * Setter method for stateMachine.
*
* @param CRM_Core_StateMachine $stateMachine
*
}
/**
- * Store the variable with the value in the form scope
+ * Store the variable with the value in the form scope.
*
* @param string|array $name name of the variable or an assoc array of name/value pairs
* @param mixed $value
}
/**
- * Get the variable from the form scope
+ * Get the variable from the form scope.
*
* @param string $name
* name of the variable.
}
/**
- * Create the header for the wizard from the list of pages
+ * Create the header for the wizard from the list of pages.
* Store the created header in smarty
*
* @param string $currentPageName
}
/**
- * Assign value to name in template
+ * Assign value to name in template.
*
* @param string $var
* @param mixed $value
}
/**
- * Assign value to name in template by reference
+ * Assign value to name in template by reference.
*
* @param string $var
* @param mixed $value
}
/**
- * Appends values to template variables
+ * Appends values to template variables.
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value
}
/**
- * Returns an array containing template variables
+ * Returns an array containing template variables.
*
* @param string $name
*
}
/**
- * Setter for embedded
+ * Setter for embedded.
*
* @param bool $embedded
*
}
/**
- * Getter for embedded
+ * Getter for embedded.
*
* @return bool
* return the embedded value
}
/**
- * Setter for skipRedirection
+ * Setter for skipRedirection.
*
* @param bool $skipRedirection
*
}
/**
- * Getter for skipRedirection
+ * Getter for skipRedirection.
*
* @return bool
* return the skipRedirection value
}
/**
- * Setter for print
+ * Setter for print.
*
* @param bool $print
*
}
/**
- * Getter for print
+ * Getter for print.
*
* @return bool
* return the print value
class CRM_Core_Error extends PEAR_ErrorStack {
/**
- * Status code of various types of errors
+ * Status code of various types of errors.
*/
const FATAL_ERROR = 2;
const DUPLICATE_CONTACT = 8001;
}
/**
- * Constructor
+ * Constructor.
*/
public function __construct() {
parent::__construct('CiviCRM');
}
/**
- * Status display function specific to payment processor errors
+ * Status display function specific to payment processor errors.
* @param $error
* @param string $separator
*/
}
/**
- * Display an error page with an error message describing what happened
+ * Display an error page with an error message describing what happened.
*
* @param string $message
* The error message.
}
/**
- * Display an error page with an error message describing what happened
+ * Display an error page with an error message describing what happened.
*
* This function is evil -- it largely replicates fatal(). Hopefully the
* entire CRM_Core_Error system can be hollowed out and replaced with
}
/**
- * Display the error message on terminal
+ * Display the error message on terminal.
*
* @param $message
* @param bool $out
}
/**
- * Obtain a reference to the error log
+ * Obtain a reference to the error log.
*
* @param string $comp
*
}
/**
- * Render a backtrace array as a string
+ * Render a backtrace array as a string.
*
* @param array $backTrace
* Array of stack frames.
}
/**
- * Render a backtrace array as an array
+ * Render a backtrace array as an array.
*
* @param array $backTrace
* Array of stack frames.
}
/**
- * Render an exception as HTML string
+ * Render an exception as HTML string.
*
* @param Exception $e
* @return string
}
/**
- * Write details of an exception to the log
+ * Write details of an exception to the log.
*
* @param Exception $e
* @return string
}
/**
- * Reset the error stack
+ * Reset the error stack.
*
*/
public static function reset() {
}
/**
- * Terminate execution abnormally
+ * Terminate execution abnormally.
*/
protected static function abend($code) {
// do a hard rollback of any pending transactions
}
/**
- * custom string representation of object
+ * custom string representation of object.
* @return string
*/
public function __toString() {
projects / civicrm-core.git / commitdiff