Merge pull request #610 from colemanw/cleanup

NFC - Docblock cleanup
civicrm · Jul 29, 2020 · d5d78a2 · d5d78a2
2 parents 1bf6c8e + 9070aa4
commit d5d78a2
Show file tree

Hide file tree

Showing 107 changed files with 383 additions and 1,614 deletions.
diff --git a/civicrm.install b/civicrm.install
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_engage/Engage/Report/Form/CallList.php b/modules/civicrm_engage/Engage/Report/Form/CallList.php
@@ -14,7 +14,6 @@
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
  * @copyright DharmaTech  (c) 2009
- * $Id$
  *
  */
 

diff --git a/modules/civicrm_engage/Engage/Report/Form/List.php b/modules/civicrm_engage/Engage/Report/Form/List.php
@@ -14,7 +14,6 @@
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
  * @copyright DharmaTech  (c) 2009
- * $Id$
  *
  */
 
@@ -215,8 +214,8 @@ class Engage_Report_Form_List extends CRM_Report_Form {
     $this->_demoTable = $dao->table_name;
 
     $query = "
-SELECT column_name 
-FROM   civicrm_custom_field 
+SELECT column_name
+FROM   civicrm_custom_field
 WHERE custom_group_id={$demoTableID} AND column_name = '" . $this->_languageName . "' LIMIT 1";
     $dao = CRM_Core_DAO::executeQuery($query);
     $dao->fetch();
@@ -230,16 +229,16 @@ class Engage_Report_Form_List extends CRM_Report_Form {
     $this->_coreInfoTable = $dao->table_name;
 
     $query = "
-SELECT column_name 
-FROM   civicrm_custom_field 
+SELECT column_name
+FROM   civicrm_custom_field
 WHERE custom_group_id={$coreInfoTableID} AND column_name='" . self::CF_OTHER_NAME_NAME . "' LIMIT 1";
     $dao = CRM_Core_DAO::executeQuery($query);
     $dao->fetch();
     $this->_coreOtherCol = $dao->column_name;
 
     $query = "
-SELECT column_name 
-FROM   civicrm_custom_field 
+SELECT column_name
+FROM   civicrm_custom_field
 WHERE custom_group_id={$coreInfoTableID} AND column_name='" . self::CF_CONSTITUENT_TYPE_NAME . "' LIMIT 1";
     $dao = CRM_Core_DAO::executeQuery($query);
     $dao->fetch();
@@ -364,29 +363,29 @@ public function engageWhereGroupClause($clause) {
 
     if (!empty($smartGroups)) {
       $smartGroups = implode(',', $smartGroups);
-      $smartGroupQuery = " UNION DISTINCT 
-                  SELECT DISTINCT smartgroup_contact.contact_id                                    
-                  FROM civicrm_group_contact_cache smartgroup_contact        
+      $smartGroupQuery = " UNION DISTINCT
+                  SELECT DISTINCT smartgroup_contact.contact_id
+                  FROM civicrm_group_contact_cache smartgroup_contact
                   WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
     }
 
     if ($this->_params['gid_op'] == 'in') {
-      return " {$this->_aliases['civicrm_contact']}.id IN ( 
-                          SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id 
+      return " {$this->_aliases['civicrm_contact']}.id IN (
+                          SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
                           FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
-                          WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added' 
+                          WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
                           {$smartGroupQuery} ) ";
     }
     elseif ($this->_params['gid_op'] == 'mand') {
-      $query = " {$this->_aliases['civicrm_contact']}.id IN ( 
-                          SELECT DISTINCT {$this->_aliases['civicrm_group']}1.contact_id 
+      $query = " {$this->_aliases['civicrm_contact']}.id IN (
+                          SELECT DISTINCT {$this->_aliases['civicrm_group']}1.contact_id
                           FROM civicrm_group_contact {$this->_aliases['civicrm_group']}1
 ";
 
       for ($i = 2; $i <= count($this->_params['gid_value']); $i++) {
         $j = $i - 1;
         $status[] = "{$this->_aliases['civicrm_group']}{$i}.group_id != {$this->_aliases['civicrm_group']}{$j}.group_id";
-        $query .= " INNER JOIN civicrm_group_contact {$this->_aliases['civicrm_group']}{$i} 
+        $query .= " INNER JOIN civicrm_group_contact {$this->_aliases['civicrm_group']}{$i}
                               ON {$this->_aliases['civicrm_group']}{$i}.contact_id = {$this->_aliases['civicrm_group']}{$j}.contact_id AND " . implode(" AND ", $status) . "
 ";
       }

diff --git a/modules/civicrm_engage/Engage/Report/Form/WalkList.php b/modules/civicrm_engage/Engage/Report/Form/WalkList.php
@@ -14,7 +14,6 @@
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
  * @copyright DharmaTech  (c) 2009
- * $Id$
  *
  */
 

diff --git a/modules/civicrm_engage/civicrm_engage.install b/modules/civicrm_engage/civicrm_engage.install
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_engage/civicrm_engage.module b/modules/civicrm_engage/civicrm_engage.module
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 define('CIVICRM_ENGAGE_CG_DEMOGRAPHICS_NAME', 'Demographics');

diff --git a/modules/civicrm_group_roles/civicrm_group_roles.install b/modules/civicrm_group_roles/civicrm_group_roles.install
@@ -1,25 +1,11 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM.                                    |
- |                                                                    |
- | CiviCRM is free software; you can copy, modify, and distribute it  |
- | under the terms of the GNU Affero General Public License           |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
- |                                                                    |
- | CiviCRM is distributed in the hope that it will be useful, but     |
- | WITHOUT ANY WARRANTY; without even the implied warranty of         |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
- | See the GNU Affero General Public License for more details.        |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | You should have received a copy of the GNU Affero General Public   |
- | License and the CiviCRM Licensing Exception along                  |
- | with this program; if not, contact CiviCRM LLC                     |
- | at info[AT]civicrm[DOT]org. If you have questions about the        |
- | GNU Affero General Public License or the licensing of CiviCRM,     |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
 

diff --git a/modules/civicrm_group_roles/civicrm_group_roles.module b/modules/civicrm_group_roles/civicrm_group_roles.module
@@ -1,26 +1,12 @@
 <?php
 /*
-  +--------------------------------------------------------------------+
-  | CiviCRM version 5                                                  |
-  +--------------------------------------------------------------------+
-  | This file is a part of CiviCRM.                                    |
-  |                                                                    |
-  | CiviCRM is free software; you can copy, modify, and distribute it  |
-  | under the terms of the GNU Affero General Public License           |
-  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
-  |                                                                    |
-  | CiviCRM is distributed in the hope that it will be useful, but     |
-  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
-  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
-  | See the GNU Affero General Public License for more details.        |
-  |                                                                    |
-  | You should have received a copy of the GNU Affero General Public   |
-  | License and the CiviCRM Licensing Exception along                  |
-  | with this program; if not, contact CiviCRM LLC                     |
-  | at info[AT]civicrm[DOT]org. If you have questions about the        |
-  | GNU Affero General Public License or the licensing of CiviCRM,     |
-  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
-  +--------------------------------------------------------------------+
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
  */
 
 /**

diff --git a/modules/civicrm_og_sync/civicrm_og_sync.install b/modules/civicrm_og_sync/civicrm_og_sync.install
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_og_sync/civicrm_og_sync.module b/modules/civicrm_og_sync/civicrm_og_sync.module
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_rules/civicrm_rules.contact-eval.inc b/modules/civicrm_rules/civicrm_rules.contact-eval.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_rules/civicrm_rules.event-eval.inc b/modules/civicrm_rules/civicrm_rules.event-eval.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 require_once 'civicrm_rules_utils.inc';

diff --git a/modules/civicrm_rules/civicrm_rules.install b/modules/civicrm_rules/civicrm_rules.install
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_rules/civicrm_rules.mailing-eval.inc b/modules/civicrm_rules/civicrm_rules.mailing-eval.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 require_once 'civicrm_rules_utils.inc';

diff --git a/modules/civicrm_rules/civicrm_rules.module b/modules/civicrm_rules/civicrm_rules.module
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_rules/civicrm_rules.participant-eval.inc b/modules/civicrm_rules/civicrm_rules.participant-eval.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 require_once 'civicrm_rules_utils.inc';

diff --git a/modules/civicrm_rules/civicrm_rules.rules.inc b/modules/civicrm_rules/civicrm_rules.rules.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 require_once 'civicrm_rules_utils.inc';
 require_once 'civicrm_rules.contact-eval.inc';

diff --git a/modules/civicrm_rules/civicrm_rules_action.inc b/modules/civicrm_rules/civicrm_rules_action.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrm_rules/civicrm_rules_condition.inc b/modules/civicrm_rules/civicrm_rules_condition.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 function civicrm_rules_get_condition() {
   return array(

diff --git a/modules/civicrm_rules/civicrm_rules_entity.inc b/modules/civicrm_rules/civicrm_rules_entity.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 function civicrm_rules_get_entity() {
 

diff --git a/modules/civicrm_rules/civicrm_rules_event.inc b/modules/civicrm_rules/civicrm_rules_event.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 function civicrm_rules_get_event() {
   $defaults = array(

diff --git a/modules/civicrm_rules/civicrm_rules_utils.inc b/modules/civicrm_rules/civicrm_rules_utils.inc
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrmtheme/civicrmtheme.install b/modules/civicrmtheme/civicrmtheme.install
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/civicrmtheme/civicrmtheme.module b/modules/civicrmtheme/civicrmtheme.module
@@ -13,8 +13,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 /**

diff --git a/modules/views/civicrm.views.inc b/modules/views/civicrm.views.inc
@@ -1,25 +1,11 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM.                                    |
- |                                                                    |
- | CiviCRM is free software; you can copy, modify, and distribute it  |
- | under the terms of the GNU Affero General Public License           |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
- |                                                                    |
- | CiviCRM is distributed in the hope that it will be useful, but     |
- | WITHOUT ANY WARRANTY; without even the implied warranty of         |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
- | See the GNU Affero General Public License for more details.        |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | You should have received a copy of the GNU Affero General Public   |
- | License and the CiviCRM Licensing Exception along                  |
- | with this program; if not, contact CiviCRM LLC                     |
- | at info[AT]civicrm[DOT]org. If you have questions about the        |
- | GNU Affero General Public License or the licensing of CiviCRM,     |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
 

diff --git a/modules/views/civicrm.views_default.inc b/modules/views/civicrm.views_default.inc
@@ -1,25 +1,11 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM.                                    |
- |                                                                    |
- | CiviCRM is free software; you can copy, modify, and distribute it  |
- | under the terms of the GNU Affero General Public License           |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
- |                                                                    |
- | CiviCRM is distributed in the hope that it will be useful, but     |
- | WITHOUT ANY WARRANTY; without even the implied warranty of         |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
- | See the GNU Affero General Public License for more details.        |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | You should have received a copy of the GNU Affero General Public   |
- | License and the CiviCRM Licensing Exception along                  |
- | with this program; if not, contact CiviCRM LLC                     |
- | at info[AT]civicrm[DOT]org. If you have questions about the        |
- | GNU Affero General Public License or the licensing of CiviCRM,     |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,8 +13,6 @@ @@
      *
      * @package CRM
      * @copyright CiviCRM LLC https://civicrm.org/licensing
-     * $Id$
-     *
      */
     /**
@@ Expand Down @@