From b67daa72ccf6cddb2d026f23ce58cea295c05254 Mon Sep 17 00:00:00 2001 From: eileen Date: Wed, 22 May 2019 15:22:19 +1200 Subject: [PATCH] [NFC] fix docblock types from boolean to bool This is the correct type name we should be using --- CRM/Admin/Page/Options.php | 2 +- CRM/Case/Form/Search.php | 6 +++--- CRM/Case/Form/Task/Delete.php | 4 ++-- CRM/Case/Form/Task/Restore.php | 2 +- CRM/Case/Selector/Search.php | 4 ++-- CRM/Case/XMLProcessor/Report.php | 2 +- CRM/Contact/BAO/Query.php | 21 +++++++++++---------- CRM/Contribute/Form/AbstractEditPayment.php | 2 +- CRM/Contribute/Form/Contribution.php | 2 +- CRM/Contribute/Form/ContributionBase.php | 2 +- CRM/Contribute/Form/Search.php | 4 ++-- CRM/Contribute/Form/Task.php | 2 +- CRM/Contribute/Form/Task/Delete.php | 2 +- CRM/Contribute/Form/Task/Email.php | 2 +- CRM/Contribute/Form/Task/Invoice.php | 2 +- CRM/Contribute/Form/Task/PDF.php | 2 +- CRM/Contribute/Form/Task/Status.php | 2 +- CRM/Contribute/Import/Field.php | 5 +++-- CRM/Contribute/Import/Parser.php | 2 +- CRM/Contribute/Selector/Search.php | 4 ++-- CRM/Core/Form/Search.php | 2 +- CRM/Core/Page.php | 4 ++-- CRM/Core/Permission/Backdrop.php | 5 +++-- CRM/Core/Permission/Drupal.php | 4 ++-- CRM/Core/Permission/Drupal6.php | 4 ++-- CRM/Core/Permission/DrupalBase.php | 5 +++-- CRM/Core/Region.php | 2 +- CRM/Mailing/Page/Browse.php | 2 +- CRM/PCP/Form/PCPAccount.php | 2 +- CRM/Pledge/Form/Search.php | 4 ++-- CRM/Pledge/Form/Task/Delete.php | 2 +- CRM/Pledge/Selector/Search.php | 4 ++-- CRM/Price/Page/Field.php | 2 +- CRM/Price/Page/Option.php | 2 +- CRM/Profile/Selector/Listings.php | 6 +++--- CRM/Report/Form.php | 6 +++--- CRM/UF/Form/Field.php | 2 +- CRM/Upgrade/Form.php | 2 +- 38 files changed, 69 insertions(+), 65 deletions(-) diff --git a/CRM/Admin/Page/Options.php b/CRM/Admin/Page/Options.php index 7ba567c047..8a54c7426c 100644 --- a/CRM/Admin/Page/Options.php +++ b/CRM/Admin/Page/Options.php @@ -69,7 +69,7 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic { /** * A boolean determining if you can add options to this group in the GUI. * - * @var boolean + * @var bool */ public static $_isLocked = FALSE; diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index 7aabdfe489..1391393294 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -46,20 +46,20 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_single = FALSE; /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_limit = NULL; /** * Prefix for the controller - * @var sting + * @var string */ protected $_prefix = 'case_'; diff --git a/CRM/Case/Form/Task/Delete.php b/CRM/Case/Form/Task/Delete.php index d32a9300ea..b963126ccf 100644 --- a/CRM/Case/Form/Task/Delete.php +++ b/CRM/Case/Form/Task/Delete.php @@ -40,14 +40,14 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { * Are we operating in "single mode", i.e. deleting one * specific case? * - * @var boolean + * @var bool */ protected $_single = FALSE; /** * Are we moving case to Trash. * - * @var boolean + * @var bool */ public $_moveToTrash = TRUE; diff --git a/CRM/Case/Form/Task/Restore.php b/CRM/Case/Form/Task/Restore.php index db78e81b73..8257943097 100644 --- a/CRM/Case/Form/Task/Restore.php +++ b/CRM/Case/Form/Task/Restore.php @@ -40,7 +40,7 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { * Are we operating in "single mode", i.e. deleting one * specific case? * - * @var boolean + * @var bool */ protected $_single = FALSE; diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php index 8d63a8ea29..5a4ab88c8e 100644 --- a/CRM/Case/Selector/Search.php +++ b/CRM/Case/Selector/Search.php @@ -72,14 +72,14 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base { /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_single = FALSE; /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_limit = NULL; diff --git a/CRM/Case/XMLProcessor/Report.php b/CRM/Case/XMLProcessor/Report.php index 8224e22c1d..98534dc95e 100644 --- a/CRM/Case/XMLProcessor/Report.php +++ b/CRM/Case/XMLProcessor/Report.php @@ -35,7 +35,7 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor { /** * The default variable defined. * - * @var boolean + * @var bool */ protected $_isRedact; diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 0e08cb5ed9..82dab92b61 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -213,28 +213,28 @@ class CRM_Contact_BAO_Query { /** * Are we in search mode. * - * @var boolean + * @var bool */ public $_search = TRUE; /** * Should we skip permission checking. * - * @var boolean + * @var bool */ public $_skipPermission = FALSE; /** * Should we skip adding of delete clause. * - * @var boolean + * @var bool */ public $_skipDeleteClause = FALSE; /** * Are we in strict mode (use equality over LIKE) * - * @var boolean + * @var bool */ public $_strict = FALSE; @@ -250,21 +250,21 @@ class CRM_Contact_BAO_Query { /** * Should we only search on primary location. * - * @var boolean + * @var bool */ public $_primaryLocation = TRUE; /** * Are contact ids part of the query. * - * @var boolean + * @var bool */ public $_includeContactIds = FALSE; /** * Should we use the smart group cache. * - * @var boolean + * @var bool */ public $_smartGroupCache = TRUE; @@ -286,7 +286,7 @@ class CRM_Contact_BAO_Query { * Should we enable the distinct clause, used if we are including * more than one group * - * @var boolean + * @var bool */ public $_useDistinct = FALSE; @@ -402,8 +402,9 @@ class CRM_Contact_BAO_Query { */ protected $_rangeCache = []; /** - * Set to true when $this->relationship is run to avoid adding twice - * @var Boolean + * Set to true when $this->relationship is run to avoid adding twice. + * + * @var bool */ protected $_relationshipValuesAdded = FALSE; diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index f410a2bf71..62f1fe7a0b 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -151,7 +151,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task { * Is this contribution associated with an online * financial transaction * - * @var boolean + * @var bool */ public $_online = FALSE; diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index ab46198a0b..ea84119689 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -75,7 +75,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP * Is this contribution associated with an online. * financial transaction * - * @var boolean + * @var bool */ public $_online = FALSE; diff --git a/CRM/Contribute/Form/ContributionBase.php b/CRM/Contribute/Form/ContributionBase.php index 971479e633..28ff5f2aaf 100644 --- a/CRM/Contribute/Form/ContributionBase.php +++ b/CRM/Contribute/Form/ContributionBase.php @@ -176,7 +176,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { /** * Contribution page supports memberships - * @var boolean + * @var bool */ public $_useForMember; diff --git a/CRM/Contribute/Form/Search.php b/CRM/Contribute/Form/Search.php index 8351b6d9ad..c4281faffe 100644 --- a/CRM/Contribute/Form/Search.php +++ b/CRM/Contribute/Form/Search.php @@ -46,14 +46,14 @@ class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { /** * Are we restricting ourselves to a single contact. * - * @var boolean + * @var bool */ protected $_single = FALSE; /** * Are we restricting ourselves to a single contact. * - * @var boolean + * @var bool */ protected $_limit = NULL; diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php index fac10e2ac6..bd50979923 100644 --- a/CRM/Contribute/Form/Task.php +++ b/CRM/Contribute/Form/Task.php @@ -54,7 +54,7 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form_Task { /** * The flag to tell if there are soft credits included. * - * @var boolean + * @var bool */ public $_includesSoftCredits = FALSE; diff --git a/CRM/Contribute/Form/Task/Delete.php b/CRM/Contribute/Form/Task/Delete.php index 8601ee564c..0722cd9541 100644 --- a/CRM/Contribute/Form/Task/Delete.php +++ b/CRM/Contribute/Form/Task/Delete.php @@ -42,7 +42,7 @@ class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task { * Are we operating in "single mode", i.e. deleting one * specific contribution? * - * @var boolean + * @var bool */ protected $_single = FALSE; diff --git a/CRM/Contribute/Form/Task/Email.php b/CRM/Contribute/Form/Task/Email.php index 1300c85d5e..56cb5d471b 100644 --- a/CRM/Contribute/Form/Task/Email.php +++ b/CRM/Contribute/Form/Task/Email.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task { * Are we operating in "single mode", i.e. sending email to one * specific contact? * - * @var boolean + * @var bool */ public $_single = FALSE; diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index f2742ee109..a38c5e9327 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -43,7 +43,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { * Are we operating in "single mode", i.e. updating the task of only * one specific contribution? * - * @var boolean + * @var bool */ public $_single = FALSE; diff --git a/CRM/Contribute/Form/Task/PDF.php b/CRM/Contribute/Form/Task/PDF.php index c27b4fd176..96d9985e9a 100644 --- a/CRM/Contribute/Form/Task/PDF.php +++ b/CRM/Contribute/Form/Task/PDF.php @@ -41,7 +41,7 @@ class CRM_Contribute_Form_Task_PDF extends CRM_Contribute_Form_Task { * Are we operating in "single mode", i.e. updating the task of only * one specific contribution? * - * @var boolean + * @var bool */ public $_single = FALSE; diff --git a/CRM/Contribute/Form/Task/Status.php b/CRM/Contribute/Form/Task/Status.php index 348ed22387..bc291dc167 100644 --- a/CRM/Contribute/Form/Task/Status.php +++ b/CRM/Contribute/Form/Task/Status.php @@ -40,7 +40,7 @@ class CRM_Contribute_Form_Task_Status extends CRM_Contribute_Form_Task { * Are we operating in "single mode", i.e. updating the task of only * one specific contribution? * - * @var boolean + * @var bool */ public $_single = FALSE; diff --git a/CRM/Contribute/Import/Field.php b/CRM/Contribute/Import/Field.php index 969441ef83..83943e405a 100644 --- a/CRM/Contribute/Import/Field.php +++ b/CRM/Contribute/Import/Field.php @@ -56,8 +56,9 @@ class CRM_Contribute_Import_Field { public $_type; /** - * Is this field required - * @var boolean + * Is this field required. + * + * @var bool */ public $_required; diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index 939eef3d80..9ceac6a63d 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -114,7 +114,7 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser { /** * Whether the file has a column header or not * - * @var boolean + * @var bool */ protected $_haveColumnHeader; diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php index f2250641c6..1c2d23a3bc 100644 --- a/CRM/Contribute/Selector/Search.php +++ b/CRM/Contribute/Selector/Search.php @@ -83,14 +83,14 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_single = FALSE; /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_limit = NULL; diff --git a/CRM/Core/Form/Search.php b/CRM/Core/Form/Search.php index 07b1a85489..ede46d09d6 100644 --- a/CRM/Core/Form/Search.php +++ b/CRM/Core/Form/Search.php @@ -61,7 +61,7 @@ class CRM_Core_Form_Search extends CRM_Core_Form { /** * Have we already done this search * - * @var boolean + * @var bool */ protected $_done; diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index e8908fea50..145c91af53 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -67,7 +67,7 @@ class CRM_Core_Page { * so the display routine needs to not do any work. (The * parent object takes care of the display) * - * @var boolean + * @var bool */ protected $_embedded = FALSE; @@ -75,7 +75,7 @@ class CRM_Core_Page { * Are we in print mode? if so we need to modify the display * functionality to do a minimal display :) * - * @var boolean + * @var bool */ protected $_print = FALSE; diff --git a/CRM/Core/Permission/Backdrop.php b/CRM/Core/Permission/Backdrop.php index e2277df2f1..915b95f614 100644 --- a/CRM/Core/Permission/Backdrop.php +++ b/CRM/Core/Permission/Backdrop.php @@ -41,14 +41,15 @@ class CRM_Core_Permission_Backdrop extends CRM_Core_Permission_DrupalBase { /** * Is this user someone with access for the entire system. * - * @var boolean + * @var bool */ protected $_viewAdminUser = FALSE; protected $_editAdminUser = FALSE; /** * Am in in view permission or edit permission? - * @var boolean + * + * @var bool */ protected $_viewPermission = FALSE; protected $_editPermission = FALSE; diff --git a/CRM/Core/Permission/Drupal.php b/CRM/Core/Permission/Drupal.php index 9c0bbdee78..f49c0dd52e 100644 --- a/CRM/Core/Permission/Drupal.php +++ b/CRM/Core/Permission/Drupal.php @@ -41,14 +41,14 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { /** * Is this user someone with access for the entire system. * - * @var boolean + * @var bool */ protected $_viewAdminUser = FALSE; protected $_editAdminUser = FALSE; /** * Am in in view permission or edit permission? - * @var boolean + * @var bool */ protected $_viewPermission = FALSE; protected $_editPermission = FALSE; diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index d969ed4237..eb1a8801fe 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -41,14 +41,14 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { /** * Is this user someone with access for the entire system. * - * @var boolean + * @var bool */ protected $_viewAdminUser = FALSE; protected $_editAdminUser = FALSE; /** * Am in in view permission or edit permission? - * @var boolean + * @var bool */ protected $_viewPermission = FALSE; protected $_editPermission = FALSE; diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index b691211be2..74baeac71c 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -41,14 +41,15 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { /** * Is this user someone with access for the entire system. * - * @var boolean + * @var bool */ protected $_viewAdminUser = FALSE; protected $_editAdminUser = FALSE; /** * Am in in view permission or edit permission? - * @var boolean + * + * @var bool */ protected $_viewPermission = FALSE; protected $_editPermission = FALSE; diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php index a9f9e13b71..6ece48f889 100644 --- a/CRM/Core/Region.php +++ b/CRM/Core/Region.php @@ -38,7 +38,7 @@ class CRM_Core_Region { /** * Whether the snippets array has been sorted * - * @var boolean + * @var bool */ public $_isSorted; diff --git a/CRM/Mailing/Page/Browse.php b/CRM/Mailing/Page/Browse.php index 65bf2de542..abb1428e2a 100644 --- a/CRM/Mailing/Page/Browse.php +++ b/CRM/Mailing/Page/Browse.php @@ -67,7 +67,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page { /** * Scheduled mailing. * - * @var boolean + * @var bool */ public $_scheduled; diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index ccac09cf54..624b873b4c 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -49,7 +49,7 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { /** * Are we in single form mode or wizard mode? * - * @var boolean + * @var bool */ public $_single; diff --git a/CRM/Pledge/Form/Search.php b/CRM/Pledge/Form/Search.php index e4a0354e01..c101d33a6d 100644 --- a/CRM/Pledge/Form/Search.php +++ b/CRM/Pledge/Form/Search.php @@ -46,14 +46,14 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { /** * Are we restricting ourselves to a single contact. * - * @var boolean + * @var bool */ protected $_single = FALSE; /** * Are we restricting ourselves to a single contact. * - * @var boolean + * @var bool */ protected $_limit = NULL; diff --git a/CRM/Pledge/Form/Task/Delete.php b/CRM/Pledge/Form/Task/Delete.php index deb28e3e39..ace7d94717 100644 --- a/CRM/Pledge/Form/Task/Delete.php +++ b/CRM/Pledge/Form/Task/Delete.php @@ -42,7 +42,7 @@ class CRM_Pledge_Form_Task_Delete extends CRM_Pledge_Form_Task { * Are we operating in "single mode", i.e. deleting one * specific pledge? * - * @var boolean + * @var bool */ protected $_single = FALSE; diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php index 94551d9544..b2d39ad3b7 100644 --- a/CRM/Pledge/Selector/Search.php +++ b/CRM/Pledge/Selector/Search.php @@ -80,14 +80,14 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_single = FALSE; /** * Are we restricting ourselves to a single contact * - * @var boolean + * @var bool */ protected $_limit = NULL; diff --git a/CRM/Price/Page/Field.php b/CRM/Price/Page/Field.php index 47e1cb1c93..d32d22d2e4 100644 --- a/CRM/Price/Page/Field.php +++ b/CRM/Price/Page/Field.php @@ -62,7 +62,7 @@ class CRM_Price_Page_Field extends CRM_Core_Page { /** * The price set is reserved or not. * - * @var boolean + * @var bool */ protected $_isSetReserved = FALSE; diff --git a/CRM/Price/Page/Option.php b/CRM/Price/Page/Option.php index bdf06ffc36..fd610f35c9 100644 --- a/CRM/Price/Page/Option.php +++ b/CRM/Price/Page/Option.php @@ -62,7 +62,7 @@ class CRM_Price_Page_Option extends CRM_Core_Page { /** * The price set is reserved or not. * - * @var boolean + * @var bool */ protected $_isSetReserved = FALSE; diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index ac36108f2a..e92eb6641f 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -98,21 +98,21 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR /** * Do we enable mapping of users. * - * @var boolean + * @var bool */ protected $_map; /** * Do we enable edit link. * - * @var boolean + * @var bool */ protected $_editLink; /** * Should we link to the UF Profile. * - * @var boolean + * @var bool */ protected $_linkToUF; diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index 76ade8a729..babcd5793d 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -300,14 +300,14 @@ class CRM_Report_Form extends CRM_Core_Form { /** * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method. * - * @var boolean + * @var bool */ protected $_storeResultSet = FALSE; /** * When _storeResultSet Flag is set use this var to store result set in form of array * - * @var boolean + * @var bool */ protected $_resultSet = []; @@ -388,7 +388,7 @@ class CRM_Report_Form extends CRM_Core_Form { /** * Is this being called without a form controller (ie. the report is being render outside the normal form * - e.g the api is retrieving the rows - * @var boolean + * @var bool */ public $noController = FALSE; diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php index 8640d593f0..d8bd4c9232 100644 --- a/CRM/UF/Form/Field.php +++ b/CRM/UF/Form/Field.php @@ -82,7 +82,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { * Is this profile has searchable field. * or is any field having in selector true. * - * @var boolean. + * @var bool. */ protected $_hasSearchableORInSelector; diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php index 483125451f..a8f62440b3 100644 --- a/CRM/Upgrade/Form.php +++ b/CRM/Upgrade/Form.php @@ -60,7 +60,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form { /** * Upgrade for multilingual. * - * @var boolean + * @var bool */ public $multilingual = FALSE; -- 2.25.1