*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This is class to handle address related functions
+ * This is class to handle address related functions.
*/
class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
- *
- * @return void
*/
public static function fixAddress(&$params) {
if (!empty($params['billing_street_address'])) {
}
/**
- * Add the formatted address to $this-> display
+ * Add the formatted address to $this-> display.
*
* @param bool $microformat
- *
- * @return void
+ * Unexplained parameter that I've always wondered about.
*/
public function addDisplay($microformat = FALSE) {
$fields = array(
* Address id.
* @param array $params
* Associated array of address params.
- *
- * @return void
*/
public static function processSharedAddress($addressId, $params) {
$query = 'SELECT id FROM civicrm_address WHERE master_id = %1';
* Master address id.
* @param array $params
* Associated array of submitted values.
- *
- * @return void
*/
public static function processSharedAddressRelationship($masterAddressId, $params) {
// get the contact type of contact being edited / created
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- * add static functions to include some common functionality
- * used across location sub object BAO classes
*
+ * Add static functions to include some common functionality used across location sub object BAO classes.
*/
class CRM_Core_BAO_Block {
* Block name.
* @param int $params
* Associates array.
- *
- * @return void
*/
public static function blockDelete($blockName, $params) {
$name = ucfirst($blockName);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * this file contains functions for synchronizing cms users with CiviCRM contacts
+ * This file contains functions for synchronizing cms users with CiviCRM contacts.
*/
require_once 'DB.php';
* This behavior is misplaced in the BAO layer, but we'll preserve it to avoid
* contract changes in the middle of the support cycle. In the next major
* release, we should remove & document it.
- *
- * @return void
- *
*/
public static function synchronize($is_interactive = TRUE) {
- //start of schronization code
$config = CRM_Core_Config::singleton();
// Build an array of rows from UF users table.
*/
/**
- * BAO object for civicrm_cache table. This is a database cache and is persisted across sessions. Typically we use
+ * BAO object for civicrm_cache table.
+ *
+ * This is a database cache and is persisted across sessions. Typically we use
* this to store meta data (like profile fields, custom fields etc).
*
* The group_name column is used for grouping together all cache elements that logically belong to the same set.
* Array of session values that should be persisted.
* This is either a form name + qfKey or just a form name
* (in the case of profile)
- *
- * @return void
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * file contains functions used in civicrm configuration
- *
+ * File contains functions used in civicrm configuration.
*/
class CRM_Core_BAO_ConfigSetting {
*
* @param array $params
* Associated array of civicrm variables.
- *
- * @return void
*/
public static function create($params) {
self::add($params);
*
* @param array $params
* Associated array of civicrm variables.
- *
- * @return void
*/
public static function add(&$params) {
self::fixParams($params);
*
* @param array $params
* Associated array of civicrm variables.
- *
- * @return void
*/
public static function fixParams(&$params) {
// in our old civicrm.settings.php we were using ISO code for country and
* Associated array of civicrm variables(submitted).
* @param array $values
* Associated array of civicrm variables stored in db.
- *
- * @return void
*/
public static function formatParams(&$params, &$values) {
if (empty($params) ||
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Core_BAO_CustomQuery {
const PREFIX = 'custom_value_';
/**
* Generate the select clause and the associated tables.
- * for the from clause
- *
- * @return void
*/
public function select() {
if (empty($this->_fields)) {
}
/**
- * Generate the where clause and also the english language.
- * equivalent
- *
- * @return void
+ * Generate the where clause and also the english language equivalent.
*/
public function where() {
foreach ($this->_ids as $id => $values) {
- // Fixed for Isuue CRM 607
+ // Fixed for Issue CRM 607
if (CRM_Utils_Array::value($id, $this->_fields) === NULL ||
!$values
) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* Business objects for managing custom data values.
- *
*/
class CRM_Core_BAO_CustomValue extends CRM_Core_DAO {
* Custom value ID.
* @param int $customGroupID
* Custom group ID.
- *
- * @return void
*/
public static function deleteCustomValue($customValueID, $customGroupID) {
// first we need to find custom value table, from custom group ID
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Class contains Contact dashboard related functions
+ * Class contains Contact dashboard related functions.
*/
class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
/**
* @param int $contactID
*
* @throws RuntimeException
- * @return void
*/
public static function saveDashletChanges($columns, $contactID = NULL) {
$session = CRM_Core_Session::singleton();
/**
* Update contact dashboard with new dashlet.
*
- * @param object : $dashlet
- *
- * @return void
+ * @param object $dashlet
*/
public static function addContactDashlet($dashlet) {
$admin = CRM_Core_Permission::check('administer CiviCRM');
*
* @param int $contactID
* Reset cache only for specific contact.
- *
- * @return void
*/
public static function resetDashletCache($contactID = NULL) {
$whereClause = NULL;
*
* @param int $dashletID
*
- * @return void
+ * @return bool
*/
public static function deleteDashlet($dashletID) {
$dashlet = new CRM_Core_DAO_Dashboard();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class contains functions for email handling
+ * This class contains functions for email handling.
*/
class CRM_Core_BAO_Email extends CRM_Core_DAO_Email {
/**
- * Create email address - note that the create function calls 'add' but
- * has more business logic
+ * Create email address.
+ *
+ * Note that the create function calls 'add' but has more business logic.
*
* @param array $params
* Input parameters.
*
* @param object $email
* Email object.
- *
- * @return void
*/
public static function holdEmail(&$email) {
//check for update mode
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag {
/**
- *
- * Given a contact id, it returns an array of tag id's the
- * contact belongs to.
+ * Given a contact id, it returns an array of tag id's the contact belongs to.
*
* @param int $entityID
* Id of the entity usually the contactID.
*
* @return array
* reference $tag array of category id's the contact belongs to.
- *
*/
public static function &getTag($entityID, $entityTable = 'civicrm_contact') {
$tags = array();
*
* @param array $params
* (reference) an assoc array of name/value pairs.
- * @param $entityTable
+ * @param string $entityTable
* @param int $entityID
- *
- * @return void
*/
public static function create(&$params, $entityTable, $entityID) {
// get categories for the entity id
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* @param int $id
* Id of the extension to be deleted.
*
- * @return void
- *
+ * @return mixed
*/
public static function del($id) {
$extension = new CRM_Core_DAO_Extension();
* @param string $fullName
* the fully-qualified name (eg "com.example.myextension").
* @param string $schemaVersion
- * @return void
+ *
+ * @return \CRM_Core_DAO|object
*/
public static function setSchemaVersion($fullName, $schemaVersion) {
$sql = 'UPDATE civicrm_extension SET schema_version = %1 WHERE full_name = %2';
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class contains functions for managing Label Formats
+ * This class contains functions for managing Label Formats.
*/
class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
/**
* Return the name of the group for customized labels.
- *
- * @return void
*/
public static function customGroupName() {
return ts('Custom');
* Id of the database record (null = new record).
* @param string $groupName
* Group name of the label format.
- *
- * @return void
*/
public function saveLabelFormat(&$values, $id = NULL, $groupName = 'label_format') {
// get the Option Group ID for Label Formats (create one if it doesn't exist)
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class handle creation of location block elements
+ * This class handle creation of location block elements.
*/
class CRM_Core_BAO_Location extends CRM_Core_DAO {
*
* @param int $locBlockId
* Id of the Location Block.
- *
- * @return void
*/
public static function deleteLocBlock($locBlockId) {
if (!$locBlockId) {
* Contact id.
* @param int $locationTypeId
* Id of the location to delete.
- *
- * @return void
*/
public static function deleteLocationBlocks($contactId, $locationTypeId) {
// ensure that contactId has a value
projects / civicrm-core.git / commitdiff