[NFC] fix docblock types from boolean to bool
authoreileen <emcnaughton@wikimedia.org>
Wed, 22 May 2019 03:22:19 +0000 (15:22 +1200)
committereileen <emcnaughton@wikimedia.org>
Wed, 22 May 2019 03:22:19 +0000 (15:22 +1200)
This is the correct type name we should be using

38 files changed:
CRM/Admin/Page/Options.php
CRM/Case/Form/Search.php
CRM/Case/Form/Task/Delete.php
CRM/Case/Form/Task/Restore.php
CRM/Case/Selector/Search.php
CRM/Case/XMLProcessor/Report.php
CRM/Contact/BAO/Query.php
CRM/Contribute/Form/AbstractEditPayment.php
CRM/Contribute/Form/Contribution.php
CRM/Contribute/Form/ContributionBase.php
CRM/Contribute/Form/Search.php
CRM/Contribute/Form/Task.php
CRM/Contribute/Form/Task/Delete.php
CRM/Contribute/Form/Task/Email.php
CRM/Contribute/Form/Task/Invoice.php
CRM/Contribute/Form/Task/PDF.php
CRM/Contribute/Form/Task/Status.php
CRM/Contribute/Import/Field.php
CRM/Contribute/Import/Parser.php
CRM/Contribute/Selector/Search.php
CRM/Core/Form/Search.php
CRM/Core/Page.php
CRM/Core/Permission/Backdrop.php
CRM/Core/Permission/Drupal.php
CRM/Core/Permission/Drupal6.php
CRM/Core/Permission/DrupalBase.php
CRM/Core/Region.php
CRM/Mailing/Page/Browse.php
CRM/PCP/Form/PCPAccount.php
CRM/Pledge/Form/Search.php
CRM/Pledge/Form/Task/Delete.php
CRM/Pledge/Selector/Search.php
CRM/Price/Page/Field.php
CRM/Price/Page/Option.php
CRM/Profile/Selector/Listings.php
CRM/Report/Form.php
CRM/UF/Form/Field.php
CRM/Upgrade/Form.php

index 7ba567c047e8519e01a50efd9d02b4516493a44b..8a54c7426cb06f79020180a41037a63a11d63f52 100644 (file)
@@ -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;
 
index 7aabdfe48958360e2eb5f874e41c99fae3f8cff8..1391393294c2b284160a9c5f473d581242a336f4 100644 (file)
@@ -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_';
 
index d32a9300ea13a65470a9cafe9e434365228e4b6c..b963126ccff1390fdcb7658cffcad287a2ad72fd 100644 (file)
@@ -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;
 
index db78e81b73cc19057cce73f10e124d3e50603c1e..8257943097c9bc838e05767fdc9e679ba7fa829a 100644 (file)
@@ -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;
 
index 8d63a8ea2923221bb55f0d399c4bdb65c2e1f959..5a4ab88c8e03b6ed742912e6969a6d8c254a68d2 100644 (file)
@@ -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;
 
index 8224e22c1d6b47fd829eb30e559016b6da744441..98534dc95ec8fe2e6aababc572f8c1334ab6def5 100644 (file)
@@ -35,7 +35,7 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor {
   /**
    * The default variable defined.
    *
-   * @var boolean
+   * @var bool
    */
   protected $_isRedact;
 
index 0e08cb5ed9216f1fea4e2b8b0af8a5d741bcbae6..82dab92b617580ca4fc418dfd0c4888f0777ab83 100644 (file)
@@ -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;
 
index f410a2bf7130f6d5fb9023ae01d05c22c5c78d1f..62f1fe7a0b301cd38b3c3dfc891da40982ff8e48 100644 (file)
@@ -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;
 
index ab46198a0b7aaf84a2e5be3730a4790a9cc0dbcc..ea84119689ac5c98f43ed1bdc6e53a32288efe1b 100644 (file)
@@ -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;
 
index 971479e6332d2b6c896d7208afd96a88fa06ee89..28ff5f2aaf90daba78155a6821eff13248d18d3f 100644 (file)
@@ -176,7 +176,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form {
 
   /**
    * Contribution page supports memberships
-   * @var boolean
+   * @var bool
    */
   public $_useForMember;
 
index 8351b6d9ad8bd399b8215354a4e2a53dcfa01087..c4281faffeda9d9fbd4583accc7358b59014b8c0 100644 (file)
@@ -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;
 
index fac10e2ac666ff28d362c845163ec9437f7c9d51..bd509799230a3e8a565d4b9ccc003c2cedd4d8bc 100644 (file)
@@ -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;
 
index 8601ee564c11fd73a8fbaf4159d980e237a065a1..0722cd9541a679845cc7951babaae2004c8ac2f1 100644 (file)
@@ -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;
 
index 1300c85d5e7e2ce5e90ff3540b3ef4bef635f8bf..56cb5d471b49344bfd258ca059dbd23d1d14f028 100644 (file)
@@ -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;
 
index f2742ee109e2dfb00e38dfad622818ce66593646..a38c5e93274c06302f615ff77a7f1893ed4566e4 100644 (file)
@@ -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;
 
index c27b4fd176ac0d65fb3ebfced6cd9212d79a04af..96d9985e9ae1e3608d44369575b122b198d238fa 100644 (file)
@@ -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;
 
index 348ed223870d9782034c74e6058f987448fedfd3..bc291dc167b35b69b858d193e7b3f584c14628f9 100644 (file)
@@ -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;
 
index 969441ef83e98aa614a594cbe88c32b795740a21..83943e405a39a8dcd13d7ded061eadfc0140d1ab 100644 (file)
@@ -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;
 
index 939eef3d8018cb4e131661452f038b37e5ffc3c9..9ceac6a63d6e137dc578b0475dce005a1ad4569e 100644 (file)
@@ -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;
 
index f2250641c62530a6f4aad5bb3119f8da0e397da3..1c2d23a3bc422c5019bf404320f8c0b8f9f3fa78 100644 (file)
@@ -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;
 
index 07b1a85489672ce9d60e2d58234af08a42b48a41..ede46d09d6fd7f98bb6fd25c97f5ee306a6ad0f4 100644 (file)
@@ -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;
 
index e8908fea50f1852ed4e70d1ad15e9859db3bc4e4..145c91af53352081c761e203fa89511e411f4e26 100644 (file)
@@ -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;
 
index e2277df2f173fa80f28a141340edcb6857637dee..915b95f614c7d2fd9079fe3edec926e72ad91257 100644 (file)
@@ -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;
index 9c0bbdee78c9da83c4917da2bfb1efe4964cdb64..f49c0dd52ec502d7149ac6bbfd3a8e4ee827df18 100644 (file)
@@ -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;
index d969ed42373fe3a501b2f20ed5889b55f016fdeb..eb1a8801fefee5d00207a614511b3b0a43a05e12 100644 (file)
@@ -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;
index b691211be25a0e5107d5b0ebe72fd1b4f5ba9929..74baeac71cb98684f4dd792ae66da8805c2a1ac8 100644 (file)
@@ -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;
index a9f9e13b71ae571c8a5247a10b637bbedc665767..6ece48f8893d79d04521385c11e522672afefc1b 100644 (file)
@@ -38,7 +38,7 @@ class CRM_Core_Region {
   /**
    * Whether the snippets array has been sorted
    *
-   * @var boolean
+   * @var bool
    */
   public $_isSorted;
 
index 65bf2de542df4a9cb0ef50650ae783d6afa0ff30..abb1428e2aae2b15a2be9c4f313cb97e2dee6191 100644 (file)
@@ -67,7 +67,7 @@ class CRM_Mailing_Page_Browse extends CRM_Core_Page {
   /**
    * Scheduled mailing.
    *
-   * @var boolean
+   * @var bool
    */
   public $_scheduled;
 
index ccac09cf549619e2545ed059ee46e8426cb60742..624b873b4ce582f827fb1b3d0886adb48e09b157 100644 (file)
@@ -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;
 
index e4a0354e01473bddc253f09675cef67580f57cdc..c101d33a6d9a0a22c4013492d0d849908113f0da 100644 (file)
@@ -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;
 
index deb28e3e3911996515f47962eef3333ada529de3..ace7d9471736168d6cf67ad0d34acd790f4d0f47 100644 (file)
@@ -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;
 
index 94551d9544aed0203cdae29e32cc923df113582d..b2d39ad3b71bcd53bc14f01f986db42b43f0de2a 100644 (file)
@@ -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;
 
index 47e1cb1c93dc542d1d9f5179f1b67062b9f0645b..d32d22d2e4d0d01b53a756fb9080a06dbfb48b1b 100644 (file)
@@ -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;
 
index bdf06ffc3631bd81d4930834d79758f7c6fbeb24..fd610f35c9e7d8a2718f51bd02e0b4240e8a0c0a 100644 (file)
@@ -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;
 
index ac36108f2a2bcb8d5caed82a4fdcf4be7ed16a8b..e92eb6641fe41972f18d5c84404c0d0e8802c573 100644 (file)
@@ -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;
 
index 76ade8a72987c29a382a3d3eec08b4bf68e6774b..babcd5793d97491e9880d3e491ff08732a700252 100644 (file)
@@ -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;
 
index 8640d593f07e0cb7ee0fd41d316b11b32cf04d16..d8bd4c92324b95e4c9eec2245a7157fa4e7dae76 100644 (file)
@@ -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;
 
index 483125451f1d7e7e6117121bd174a753297f77c6..a8f62440b39b221dfd7077074518326d6a06e1ad 100644 (file)
@@ -60,7 +60,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form {
   /**
    * Upgrade for multilingual.
    *
-   * @var boolean
+   * @var bool
    */
   public $multilingual = FALSE;