From db01bf2f2759491b7ee782f5be906deb357eeac8 Mon Sep 17 00:00:00 2001 From: eileen Date: Wed, 27 Jan 2016 15:22:53 +1300 Subject: [PATCH] some random comment fixes --- CRM/ACL/BAO/ACL.php | 3 ++ CRM/Badge/BAO/Badge.php | 6 ++++ CRM/Contact/BAO/ContactType.php | 9 ++--- CRM/Core/BAO/SchemaHandler.php | 42 ++++++++++-------------- CRM/Cxn/CiviCxnStore.php | 3 ++ CRM/Event/Cart/Page/AddToCart.php | 5 +++ CRM/Event/Cart/Page/RemoveFromCart.php | 5 +++ CRM/Mailing/BAO/Mailing.php | 2 +- Civi/ActionSchedule/MappingInterface.php | 4 +++ api/v3/System.php | 6 ++++ 10 files changed, 56 insertions(+), 29 deletions(-) diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index 1277fe4c9e..9fd37f5ba0 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -35,6 +35,9 @@ * Access Control List */ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { + /** + * @var string + */ static $_entityTable = NULL; static $_objectTable = NULL; static $_operation = NULL; diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index 6c2da90afd..ccd7167508 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -36,8 +36,14 @@ */ class CRM_Badge_BAO_Badge { + /** + * @var bool + */ public $debug = FALSE; + /** + * @var int + */ public $border = 0; /** diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index eaec754c70..90f470cfff 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -54,7 +54,9 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { } /** - * @param $contactType + * Is this contact type active. + * + * @param string $contactType * * @return bool */ @@ -266,8 +268,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} } /** - * - * retrieve info array about all types i.e basic + subtypes. + * Retrieve info array about all types i.e basic + subtypes. * * @param bool $all * @param bool $reset @@ -326,7 +327,7 @@ WHERE type.name IS NOT NULL } /** - * Retrieve basic type pairs with name as 'built-in name' and 'label' as value + * Retrieve basic type pairs with name as 'built-in name' and 'label' as value. * * @param bool $all * @param null $typeName diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php index 8b1a16d5d3..f27648762a 100644 --- a/CRM/Core/BAO/SchemaHandler.php +++ b/CRM/Core/BAO/SchemaHandler.php @@ -29,35 +29,29 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * This file contains functions for creating and altering CiviCRM-tables. */ /** - * structure, similar to what is used in GenCode.php + * This file contains functions for creating and altering CiviCRM-tables structure. * * $table = array( - * 'name' => TABLE_NAME, - * 'attributes' => ATTRIBUTES, - * 'fields' => array( - * array( - * 'name' => FIELD_NAME, - * 'type' => FIELD_SQL_TYPE, - * // can be field, index, constraint - * 'class' => FIELD_CLASS_TYPE, - * 'primary' => BOOLEAN, - * 'required' => BOOLEAN, - * 'searchable' => TRUE, - * 'fk_table_name' => FOREIGN_KEY_TABLE_NAME, - * 'fk_field_name' => FOREIGN_KEY_FIELD_NAME, - * 'comment' => COMMENT, - * 'default' => DEFAULT, ) - * ... - * ) ); + * 'name' => TABLE_NAME, + * 'attributes' => ATTRIBUTES, + * 'fields' => array( + * array( + * 'name' => FIELD_NAME, + * // can be field, index, constraint + * 'type' => FIELD_SQL_TYPE, + * 'class' => FIELD_CLASS_TYPE, + * 'primary' => BOOLEAN, + * 'required' => BOOLEAN, + * 'searchable' => TRUE, + * 'fk_table_name' => FOREIGN_KEY_TABLE_NAME, + * 'fk_field_name' => FOREIGN_KEY_FIELD_NAME, + * 'comment' => COMMENT, + * 'default' => DEFAULT, ) + * ... + * )); */ class CRM_Core_BAO_SchemaHandler { diff --git a/CRM/Cxn/CiviCxnStore.php b/CRM/Cxn/CiviCxnStore.php index eb05f86119..dc25dc8c51 100644 --- a/CRM/Cxn/CiviCxnStore.php +++ b/CRM/Cxn/CiviCxnStore.php @@ -1,5 +1,8 @@ _id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE); diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 7c3eff86f5..4fcf26f6e1 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -1403,7 +1403,7 @@ ORDER BY civicrm_email.is_bulkmail DESC * * Get mailing object and replaces subscribeInvite, domain and mailing tokens. * - * @param array $mailing + * @param CRM_Mailing_BAO_Mailing $mailing */ public static function tokenReplace(&$mailing) { $domain = CRM_Core_BAO_Domain::getDomain(); diff --git a/Civi/ActionSchedule/MappingInterface.php b/Civi/ActionSchedule/MappingInterface.php index cbee54781c..4e4403efb4 100644 --- a/Civi/ActionSchedule/MappingInterface.php +++ b/Civi/ActionSchedule/MappingInterface.php @@ -27,6 +27,10 @@ namespace Civi\ActionSchedule; +/** + * Interface MappingInterface + * @package Civi\ActionSchedule + */ interface MappingInterface { /** diff --git a/api/v3/System.php b/api/v3/System.php index 712d80e231..b7514c5a06 100644 --- a/api/v3/System.php +++ b/api/v3/System.php @@ -348,6 +348,12 @@ function _civicrm_api3_system_get_redacted_mysql() { return $result; } +/** + * Get redacted settings. + * + * @return array + * @throws CiviCRM_API3_Exception + */ function _civicrm_api3_system_get_redacted_settings() { static $whitelist = NULL; if ($whitelist === NULL) { -- 2.25.1