From: eileen Date: Thu, 23 May 2019 23:28:10 +0000 (+1200) Subject: Fix comment block for variable declarations X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=9f2660428580c431e8e750f5dc3cc656ae9244b6;hp=c55429dc01d68c84507728f9876a4c2482676856;p=civicrm-core.git Fix comment block for variable declarations Per https://github.com/civicrm/coder/pull/7 --- diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 82dab92b61..46840be319 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -409,8 +409,9 @@ class CRM_Contact_BAO_Query { protected $_relationshipValuesAdded = FALSE; /** - * Set to the name of the temp table if one has been created - * @var String + * Set to the name of the temp table if one has been created. + * + * @var string */ public static $_relationshipTempTable = NULL; diff --git a/CRM/Contact/Form/Search.php b/CRM/Contact/Form/Search.php index 297b0f3fac..9af7f55b17 100644 --- a/CRM/Contact/Form/Search.php +++ b/CRM/Contact/Form/Search.php @@ -120,7 +120,7 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { /** * The profile group id used for display. * - * @var integer + * @var int */ protected $_ufGroupID; @@ -132,13 +132,16 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { public static $csv = ['contact_type', 'group', 'tag']; /** - * @var string how to display the results. Should we display as - * contributons, members, cases etc + * How to display the results. Should we display as contributons, members, cases etc. + * + * @var string */ protected $_componentMode; /** - * @var string what operator should we use, AND or OR + * What operator should we use, AND or OR. + * + * @var string */ protected $_operator; diff --git a/CRM/Contact/Form/Search/Custom/FullText.php b/CRM/Contact/Form/Search/Custom/FullText.php index 28f61bbb19..46050f8781 100644 --- a/CRM/Contact/Form/Search/Custom/FullText.php +++ b/CRM/Contact/Form/Search/Custom/FullText.php @@ -35,7 +35,7 @@ class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Cu const LIMIT = 10; /** - * @var array CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery + * @var CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery[] */ protected $_partialQueries = NULL; @@ -54,23 +54,37 @@ class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Cu protected $_tableFields = NULL; /** - * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset) + * Limit clause. + * + * NULL if no limit; or array(0 => $limit, 1 => $offset). + * + * @var array|null */ protected $_limitClause = NULL; /** - * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset) + * Limit row clause. + * + * NULL if no limit; or array(0 => $limit, 1 => $offset) + * + * @var array|null */ protected $_limitRowClause = NULL; /** - * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset) + * Limit detail clause. + * + * NULL if no limit; or array(0 => $limit, 1 => $offset). + * + * @var array|null */ protected $_limitDetailClause = NULL; protected $_limitNumber = 10; + /** - * this should be one more than self::LIMIT + * This should be one more than self::LIMIT. + * * @var int */ protected $_limitNumberPlus1 = 11; diff --git a/CRM/Contact/Form/Search/Custom/Group.php b/CRM/Contact/Form/Search/Custom/Group.php index 76c7efbc36..92c4ddd71b 100644 --- a/CRM/Contact/Form/Search/Custom/Group.php +++ b/CRM/Contact/Form/Search/Custom/Group.php @@ -153,11 +153,12 @@ class CRM_Contact_Form_Search_Custom_Group extends CRM_Contact_Form_Search_Custo /** * @param int $offset * @param int $rowcount - * @param NULL $sort + * @param string $sort * @param bool $includeContactIDs * @param bool $justIDs * * @return string + * @throws \Exception */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, @@ -587,10 +588,11 @@ WHERE gcc.group_id = {$ssGroup->id} /** * @param int $offset * @param int $rowcount - * @param NULL $sort + * @param string $sort * @param bool $returnSQL * * @return string + * @throws \Exception */ public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) { return $this->all($offset, $rowcount, $sort, FALSE, TRUE); diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index c9d41c2cb1..827eeff9fa 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -37,18 +37,20 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { /** * Total number of lines in file * - * @var integer + * @var int */ protected $_rowCount; /** * Running total number of un-matched Contacts. + * * @var int */ protected $_unMatchCount; /** - * Array of unmatched lines + * Array of unmatched lines. + * * @var array */ protected $_unMatch; @@ -1354,7 +1356,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { 'return' => 'location_type_id', 'contact_id' => $contactID, 'is_primary' => 1, - 'sequential' => 1 + 'sequential' => 1, ]); } $defaultLocationType = CRM_Core_BAO_LocationType::getDefault(); diff --git a/CRM/Contact/Page/ImageFile.php b/CRM/Contact/Page/ImageFile.php index 9ea30c409b..a567356a53 100644 --- a/CRM/Contact/Page/ImageFile.php +++ b/CRM/Contact/Page/ImageFile.php @@ -32,7 +32,9 @@ */ class CRM_Contact_Page_ImageFile extends CRM_Core_Page { /** - * @var int Time to live (seconds). + * Time to live (seconds). + * + * @var int * * 12 hours: 12 * 60 * 60 = 43200 */ diff --git a/CRM/Contact/Page/View/ContactSmartGroup.php b/CRM/Contact/Page/View/ContactSmartGroup.php index d018f62402..0c323100a4 100644 --- a/CRM/Contact/Page/View/ContactSmartGroup.php +++ b/CRM/Contact/Page/View/ContactSmartGroup.php @@ -33,13 +33,14 @@ class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page { /** - * @var int contact id + * Contact id. + * + * @var int */ public $_contactId; /** - * called when action is browse. - * + * Called when action is browse. */ public function browse() { $in = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Added'); diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index f426a800e8..081c9a0315 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -132,8 +132,9 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_fromEmails; /** - * ID of from email - * @var integer + * ID of from email. + * + * @var int */ public $fromEmailId; @@ -171,8 +172,9 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $userEmail; /** - * Price set ID - * @var integer + * Price set ID. + * + * @var int */ public $_priceSetId; diff --git a/CRM/Contribute/Form/ContributionBase.php b/CRM/Contribute/Form/ContributionBase.php index 28ff5f2aaf..18fcdc93be 100644 --- a/CRM/Contribute/Form/ContributionBase.php +++ b/CRM/Contribute/Form/ContributionBase.php @@ -118,7 +118,7 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { /** * Pcp id * - * @var integer + * @var int */ public $_pcpId; diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index f93583590f..7ce505434d 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -41,7 +41,7 @@ class CRM_Core_Action { * Different possible actions are defined here. Keep in sync with the * constant from CRM_Core_Form for various modes. * - * @var integer const + * @var int */ const NONE = 0, diff --git a/CRM/Custom/Import/Parser.php b/CRM/Custom/Import/Parser.php index 7193515cf9..74e619b7fb 100644 --- a/CRM/Custom/Import/Parser.php +++ b/CRM/Custom/Import/Parser.php @@ -37,12 +37,8 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser { protected $_fileName; /** - * #@+ - * @var integer - */ - - /** - * Imported file size + * Imported file size. + * * @var int */ protected $_fileSize; diff --git a/CRM/Event/Form/ManageEvent.php b/CRM/Event/Form/ManageEvent.php index d432deadf4..9e065f4cc1 100644 --- a/CRM/Event/Form/ManageEvent.php +++ b/CRM/Event/Form/ManageEvent.php @@ -65,8 +65,9 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { protected $_isTemplate = FALSE; /** - * Pre-populate fields based on this template event_id - * @var integer + * Pre-populate fields based on this template event_id. + * + * @var int */ protected $_templateId; diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index 2684b39fd8..080ecb98c4 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -69,12 +69,14 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { /** * Show fee block or not. * - * @var bool determines if fee block should be shown or hidden + * @var bool */ public $_noFees; /** - * @var array Fee Block + * Fee Block. + * + * @var array */ public $_feeBlock; diff --git a/CRM/Event/Import/Parser.php b/CRM/Event/Import/Parser.php index 5276b02c1a..434f279614 100644 --- a/CRM/Event/Import/Parser.php +++ b/CRM/Event/Import/Parser.php @@ -37,24 +37,22 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { protected $_fileName; /** - * #@+ - * @var integer - */ - - /** - * Imported file size + * Imported file size. + * * @var int */ protected $_fileSize; /** - * Seperator being used + * Separator being used. + * * @var string */ protected $_seperator; /** - * Total number of lines in file + * Total number of lines in file. + * * @var int */ protected $_lineCount; diff --git a/CRM/Financial/Form/Payment.php b/CRM/Financial/Form/Payment.php index 9deb8ea265..f51cc0f2e2 100644 --- a/CRM/Financial/Form/Payment.php +++ b/CRM/Financial/Form/Payment.php @@ -51,7 +51,7 @@ class CRM_Financial_Form_Payment extends CRM_Core_Form { public $isBackOffice = FALSE; /** - * @var String + * @var string */ public $_formName = ''; diff --git a/CRM/Mailing/Page/View.php b/CRM/Mailing/Page/View.php index b06d61cf34..a6f03660f2 100644 --- a/CRM/Mailing/Page/View.php +++ b/CRM/Mailing/Page/View.php @@ -37,7 +37,9 @@ class CRM_Mailing_Page_View extends CRM_Core_Page { /** - * @var Signal to Flexmailer that this version of the class is usable. + * Signal to Flexmailer that this version of the class is usable. + * + * @var bool */ const USES_MAILING_PREVIEW_API = 1; diff --git a/CRM/Member/Import/Parser.php b/CRM/Member/Import/Parser.php index bf1cffec4d..3edd35bb54 100644 --- a/CRM/Member/Import/Parser.php +++ b/CRM/Member/Import/Parser.php @@ -36,11 +36,6 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { protected $_fileName; - /** - * #@+ - * @var integer - */ - /** * Imported file size * @var int diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index 532bd0e022..f12c915cf7 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -49,14 +49,14 @@ class CRM_Report_Form extends CRM_Core_Form { /** * The id of the report instance * - * @var integer + * @var int */ protected $_id; /** * The id of the report template * - * @var integer; + * @var int */ protected $_templateID; @@ -280,14 +280,15 @@ class CRM_Report_Form extends CRM_Core_Form { * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part * of the code (see limit() fn. * - * @var integer + * @var int */ protected $_limitValue = NULL; /** * This can be set to specify row offset * See notes on _limitValue - * @var integer + * + * @var int */ protected $_offsetValue = NULL; /** @@ -422,33 +423,43 @@ class CRM_Report_Form extends CRM_Core_Form { public $_section; /** - * @var string Report description. + * Report description. + * + * @var string */ public $_description; /** - * @var bool Is an address field selected. + * Is an address field selected. + * + * @var bool * This was intended to determine if the address table should be joined in * The isTableSelected function is now preferred for this purpose */ protected $_addressField; /** - * @var bool Is an email field selected. + * Is an email field selected. + * + * @var bool * This was intended to determine if the email table should be joined in * The isTableSelected function is now preferred for this purpose */ protected $_emailField; /** - * @var bool Is a phone field selected. + * Is a phone field selected. + * + * @var bool * This was intended to determine if the phone table should be joined in * The isTableSelected function is now preferred for this purpose */ protected $_phoneField; /** - * @var bool Create new report instance? (or update existing) on save. + * Create new report instance? (or update existing) on save. + * + * @var bool */ protected $_createNew; @@ -456,12 +467,15 @@ class CRM_Report_Form extends CRM_Core_Form { * When a grand total row has calculated the status we pop it off to here. * * This allows us to access it from the stats function and avoid recalculating. + * * @var array */ protected $rollupRow = []; /** - * @var string Database attributes - character set and collation + * Database attributes - character set and collation. + * + * @var string */ protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci'; diff --git a/CRM/SMS/Message.php b/CRM/SMS/Message.php index c6b1557ca1..d6188fc8f0 100644 --- a/CRM/SMS/Message.php +++ b/CRM/SMS/Message.php @@ -28,39 +28,45 @@ class CRM_SMS_Message { /** - * @var String * What address is this SMS message coming from. + * + * @var string */ public $from = ''; /** - * @var String * What address is this SMS message going to. + * + * @var string */ public $to = ''; /** - * @var Integer - * Contact ID that is matched to the From address + * Contact ID that is matched to the From address. + * + * @var int */ public $fromContactID = NULL; /** - * @var Integer - * Contact ID that is matched to the To address + * Contact ID that is matched to the To address. + * + * @var int */ public $toContactID = NULL; /** - * @var String - * Body content of the message + * Body content of the message. + * + * @var string */ public $body = ''; /** - * @var Integer - * Trackable ID in the system to match to + * Trackable ID in the system to match to. + * + * @var int */ public $trackID = NULL; diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php index d8bd4c9232..0f0eb5ecde 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 bool. + * @var bool */ protected $_hasSearchableORInSelector; diff --git a/CRM/Upgrade/Incremental/Base.php b/CRM/Upgrade/Incremental/Base.php index 5145be1072..48d8ed49ff 100644 --- a/CRM/Upgrade/Incremental/Base.php +++ b/CRM/Upgrade/Incremental/Base.php @@ -149,7 +149,8 @@ class CRM_Upgrade_Incremental_Base { * @param string $column * @param string $properties * @param bool $localizable is this a field that should be localized - * @param string|NULL $version CiviCRM version to use if rebuilding multilingual schema + * @param string|null $version CiviCRM version to use if rebuilding multilingual schema + * * @return bool */ public static function addColumn($ctx, $table, $column, $properties, $localizable = FALSE, $version = NULL) { @@ -281,7 +282,8 @@ class CRM_Upgrade_Incremental_Base { /** * Rebuild Multilingual Schema. * @param CRM_Queue_TaskContext $ctx - * @param string|NULL $version CiviCRM version to use if rebuilding multilingual schema + * @param string|null $version CiviCRM version to use if rebuilding multilingual schema + * * @return bool */ public static function rebuildMultilingalSchema($ctx, $version = NULL) { diff --git a/Civi/Angular/Page/Main.php b/Civi/Angular/Page/Main.php index 1c2a447a58..c844fd3cc0 100644 --- a/Civi/Angular/Page/Main.php +++ b/Civi/Angular/Page/Main.php @@ -37,7 +37,7 @@ class Main extends \CRM_Core_Page { /** * The region of the page into which JavaScript will be loaded. * - * @var String + * @var string * @deprecated */ public $region; diff --git a/tests/phpunit/CRM/Batch/Form/EntryTest.php b/tests/phpunit/CRM/Batch/Form/EntryTest.php index 726975dd69..1bd225198d 100644 --- a/tests/phpunit/CRM/Batch/Form/EntryTest.php +++ b/tests/phpunit/CRM/Batch/Form/EntryTest.php @@ -34,36 +34,42 @@ class CRM_Batch_Form_EntryTest extends CiviUnitTestCase { /** * Membership type name used in test function. - * @var String + * + * @var string */ protected $_membershipTypeName = NULL; /** * Membership type id used in test function. - * @var String + * + * @var string */ protected $_membershipTypeID = NULL; /** * Contact id used in test function. - * @var String + * + * @var string */ protected $_contactID = NULL; /** * Contact id used in test function. - * @var String + * + * @var string */ protected $_contactID2 = NULL; /** * Contact id used in test function. - * @var String + * + * @var string */ protected $_contactID3 = NULL; /** * Contact id used in test function. - * @var String + * + * @var string */ protected $_contactID4 = NULL; diff --git a/tests/phpunit/CRM/Contact/BAO/QueryTestDataProvider.php b/tests/phpunit/CRM/Contact/BAO/QueryTestDataProvider.php index 1d6104dd96..a25441ffba 100644 --- a/tests/phpunit/CRM/Contact/BAO/QueryTestDataProvider.php +++ b/tests/phpunit/CRM/Contact/BAO/QueryTestDataProvider.php @@ -38,7 +38,9 @@ class CRM_Contact_BAO_QueryTestDataProvider implements Iterator { /** - * @var integer + * Current count. + * + * @var int */ private $i = 0; diff --git a/tests/phpunit/CRM/Contact/Form/Search/Custom/GroupTestDataProvider.php b/tests/phpunit/CRM/Contact/Form/Search/Custom/GroupTestDataProvider.php index 2c8234d22d..8ce25c7a5c 100644 --- a/tests/phpunit/CRM/Contact/Form/Search/Custom/GroupTestDataProvider.php +++ b/tests/phpunit/CRM/Contact/Form/Search/Custom/GroupTestDataProvider.php @@ -37,7 +37,9 @@ class CRM_Contact_Form_Search_Custom_GroupTestDataProvider implements Iterator { /** - * @var integer + * Current count. + * + * @var int */ private $i = 0; diff --git a/tests/phpunit/CRM/Contact/Form/Search/Custom/SampleTestDataProvider.php b/tests/phpunit/CRM/Contact/Form/Search/Custom/SampleTestDataProvider.php index d9249d5fe5..d3fa7eecee 100644 --- a/tests/phpunit/CRM/Contact/Form/Search/Custom/SampleTestDataProvider.php +++ b/tests/phpunit/CRM/Contact/Form/Search/Custom/SampleTestDataProvider.php @@ -33,7 +33,9 @@ class CRM_Contact_Form_Search_Custom_SampleTestDataProvider implements Iterator { /** - * @var integer + * Current count. + * + * @var int */ private $i = 0; diff --git a/tests/phpunit/CRM/Group/Page/AjaxTest.php b/tests/phpunit/CRM/Group/Page/AjaxTest.php index fd69fd866e..d05371a6ed 100644 --- a/tests/phpunit/CRM/Group/Page/AjaxTest.php +++ b/tests/phpunit/CRM/Group/Page/AjaxTest.php @@ -7,8 +7,9 @@ class CRM_Group_Page_AjaxTest extends CiviUnitTestCase { /** * Permissioned group is used both as an active group the contact can see and as a group that allows - * logged in user to see contacts - * @var integer + * logged in user to see contacts. + * + * @var int */ protected $_permissionedGroup; /** diff --git a/tests/phpunit/CRM/Mailing/BAO/QueryTestDataProvider.php b/tests/phpunit/CRM/Mailing/BAO/QueryTestDataProvider.php index 37c47774e5..5a24b3c436 100644 --- a/tests/phpunit/CRM/Mailing/BAO/QueryTestDataProvider.php +++ b/tests/phpunit/CRM/Mailing/BAO/QueryTestDataProvider.php @@ -8,7 +8,7 @@ class CRM_Mailing_BAO_QueryTestDataProvider implements Iterator { /** - * @var integer + * @var int */ private $i = 0; diff --git a/tests/phpunit/CRM/Member/Import/Parser/MembershipTest.php b/tests/phpunit/CRM/Member/Import/Parser/MembershipTest.php index c39b1618d5..17b6ec9ef9 100644 --- a/tests/phpunit/CRM/Member/Import/Parser/MembershipTest.php +++ b/tests/phpunit/CRM/Member/Import/Parser/MembershipTest.php @@ -33,13 +33,15 @@ class CRM_Member_Import_Parser_MembershipTest extends CiviUnitTestCase { /** * Membership type name used in test function. - * @var String + * + * @var string */ protected $_membershipTypeName = NULL; /** * Membership type id used in test function. - * @var String + * + * @var string */ protected $_membershipTypeID = NULL; diff --git a/tests/phpunit/api/v3/RelationshipTest.php b/tests/phpunit/api/v3/RelationshipTest.php index 1fdc04b337..db08d268cb 100644 --- a/tests/phpunit/api/v3/RelationshipTest.php +++ b/tests/phpunit/api/v3/RelationshipTest.php @@ -37,7 +37,8 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { protected $_cId_a; /** * Second individual. - * @var integer + * + * @var int */ protected $_cId_a_2; protected $_cId_b; diff --git a/tests/phpunit/api/v3/TagTest.php b/tests/phpunit/api/v3/TagTest.php index c85d742719..e5dd292073 100644 --- a/tests/phpunit/api/v3/TagTest.php +++ b/tests/phpunit/api/v3/TagTest.php @@ -41,7 +41,8 @@ class api_v3_TagTest extends CiviUnitTestCase { protected $ids = array(); /** * Tag id. - * @var integer + * + * @var int */ protected $tag = array();