Commit 192d36c5 authored by eileenmcnaugton's avatar eileenmcnaugton

comment fixes

parent 347e061b
......@@ -29,12 +29,10 @@
*
* @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 {
......@@ -200,8 +198,6 @@ 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'])) {
......@@ -559,11 +555,10 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_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(
......@@ -1005,8 +1000,6 @@ SELECT is_primary,
* 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';
......@@ -1110,8 +1103,6 @@ SELECT is_primary,
* 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
......
......@@ -29,11 +29,8 @@
*
* @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 {
......@@ -398,8 +395,6 @@ class CRM_Core_BAO_Block {
* Block name.
* @param int $params
* Associates array.
*
* @return void
*/
public static function blockDelete($blockName, $params) {
$name = ucfirst($blockName);
......
......@@ -29,12 +29,10 @@
*
* @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';
......@@ -52,12 +50,8 @@ class CRM_Core_BAO_CMSUser {
* 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.
......
......@@ -26,7 +26,9 @@
*/
/**
* 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.
......@@ -262,8 +264,6 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
* 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
*/
/**
......
......@@ -30,13 +30,10 @@
*
* @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 {
......@@ -46,8 +43,6 @@ class CRM_Core_BAO_ConfigSetting {
*
* @param array $params
* Associated array of civicrm variables.
*
* @return void
*/
public static function create($params) {
self::add($params);
......@@ -62,8 +57,6 @@ class CRM_Core_BAO_ConfigSetting {
*
* @param array $params
* Associated array of civicrm variables.
*
* @return void
*/
public static function add(&$params) {
self::fixParams($params);
......@@ -130,8 +123,6 @@ class CRM_Core_BAO_ConfigSetting {
*
* @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
......@@ -164,8 +155,6 @@ class CRM_Core_BAO_ConfigSetting {
* 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) ||
......
......@@ -30,8 +30,6 @@
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
class CRM_Core_BAO_CustomQuery {
const PREFIX = 'custom_value_';
......@@ -254,9 +252,6 @@ SELECT label, value
/**
* Generate the select clause and the associated tables.
* for the from clause
*
* @return void
*/
public function select() {
if (empty($this->_fields)) {
......@@ -318,15 +313,12 @@ SELECT label, value
}
/**
* 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
) {
......
......@@ -29,13 +29,10 @@
*
* @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 {
......@@ -208,8 +205,6 @@ 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
......
......@@ -29,12 +29,10 @@
*
* @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 {
/**
......@@ -356,7 +354,6 @@ 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();
......@@ -486,9 +483,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
/**
* 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');
......@@ -555,8 +550,6 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
*
* @param int $contactID
* Reset cache only for specific contact.
*
* @return void
*/
public static function resetDashletCache($contactID = NULL) {
$whereClause = NULL;
......@@ -574,7 +567,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
*
* @param int $dashletID
*
* @return void
* @return bool
*/
public static function deleteDashlet($dashletID) {
$dashlet = new CRM_Core_DAO_Dashboard();
......
......@@ -29,18 +29,17 @@
*
* @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.
......@@ -235,8 +234,6 @@ ORDER BY e.is_primary DESC, email_id ASC ";
*
* @param object $email
* Email object.
*
* @return void
*/
public static function holdEmail(&$email) {
//check for update mode
......
......@@ -30,15 +30,11 @@
*
* @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.
......@@ -47,7 +43,6 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag {
*
* @return array
* reference $tag array of category id's the contact belongs to.
*
*/
public static function &getTag($entityID, $entityTable = 'civicrm_contact') {
$tags = array();
......@@ -220,10 +215,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag {
*
* @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
......
......@@ -29,8 +29,6 @@
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
/**
......@@ -65,8 +63,7 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension {
* @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();
......@@ -80,7 +77,8 @@ class CRM_Core_BAO_Extension extends 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';
......
......@@ -30,12 +30,10 @@
*
* @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 {
......@@ -452,8 +450,6 @@ 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');
......@@ -467,8 +463,6 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
* 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)
......
......@@ -29,12 +29,10 @@
*
* @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 {
......@@ -193,8 +191,6 @@ WHERE e.id = %1";
*
* @param int $locBlockId
* Id of the Location Block.
*
* @return void
*/
public static function deleteLocBlock($locBlockId) {
if (!$locBlockId) {
......@@ -289,8 +285,6 @@ WHERE e.id = %1";
* 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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment