From d09edf64e678a73669cff34014a55a06604de75a Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Wed, 4 Feb 2015 13:39:30 +1300 Subject: [PATCH] INFRA-132 add full stops --- CRM/Core/BAO/WordReplacement.php | 41 ++++++++++++--------- CRM/Core/Config.php | 12 +++--- CRM/Core/Controller.php | 18 ++++----- CRM/Core/DAO.php | 4 +- CRM/Core/Error.php | 2 +- CRM/Core/Invoke.php | 6 +-- CRM/Core/JobManager.php | 6 +-- CRM/Core/ManagedEntities.php | 2 +- CRM/Core/Module.php | 2 +- CRM/Core/OptionGroup.php | 4 +- CRM/Core/OptionValue.php | 10 ++--- CRM/Core/Payment.php | 28 +++++++------- CRM/Core/Payment/AuthorizeNet.php | 2 +- CRM/Core/Permission.php | 24 ++++++------ CRM/Core/Permission/Base.php | 14 +++---- CRM/Core/Permission/Drupal.php | 6 +-- CRM/Core/Permission/Drupal6.php | 8 ++-- CRM/Core/Permission/DrupalBase.php | 8 ++-- CRM/Core/Permission/UnitTests.php | 2 +- CRM/Core/PseudoConstant.php | 34 ++++++++--------- CRM/Core/QuickForm/Action.php | 4 +- CRM/Core/QuickForm/Action/Back.php | 2 +- CRM/Core/QuickForm/Action/Cancel.php | 2 +- CRM/Core/QuickForm/Action/Display.php | 10 ++--- CRM/Core/QuickForm/Action/Done.php | 2 +- CRM/Core/QuickForm/Action/Jump.php | 2 +- CRM/Core/QuickForm/Action/Next.php | 2 +- CRM/Core/QuickForm/Action/Process.php | 2 +- CRM/Core/QuickForm/Action/Refresh.php | 2 +- CRM/Core/QuickForm/Action/Reload.php | 2 +- CRM/Core/QuickForm/Action/Submit.php | 2 +- CRM/Core/QuickForm/Action/Upload.php | 4 +- CRM/Core/QuickForm/GroupMultiSelect.php | 2 +- CRM/Core/QuickForm/NestedAdvMultiSelect.php | 2 +- CRM/Core/Reference/Dynamic.php | 2 +- CRM/Core/Reference/Interface.php | 4 +- CRM/Core/Region.php | 12 +++--- CRM/Core/Resources.php | 14 +++---- 38 files changed, 156 insertions(+), 149 deletions(-) diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index 5cd85e83dd..06c5759018 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -30,26 +30,23 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2014 * $Id$ - * */ /** - * + * Class CRM_Core_BAO_WordReplacement. */ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** - * Class constructor - * - * @return \CRM_Core_DAO_WordReplacement - */ - /** + * Class constructor. */ public function __construct() { parent::__construct(); } /** + * Function that must have never worked & should be removed. + * * Takes a bunch of params that are needed to match certain criteria and * retrieves the relevant objects. * @@ -65,11 +62,11 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { } /** - * Get the domain BAO + * Get the domain BAO. * * @param null $reset * - * @return null|CRM_Core_BAO_WordRepalcement + * @return null|CRM_Core_BAO_WordReplacement */ public static function getWordReplacement($reset = NULL) { static $wordReplacement = NULL; @@ -85,7 +82,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** - * Save the values of a WordReplacement + * Save the values of a WordReplacement. * * @param array $params * @param int $id @@ -104,7 +101,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { } /** - * Create a new WordReplacement + * Create a new WordReplacement. * * @param array $params * @@ -124,7 +121,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { } /** - * Delete website + * Delete website. * * @param int $id * WordReplacement id. @@ -142,10 +139,11 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { } /** - * Get all word-replacements in the form of an array + * Get all word-replacements in the form of an array. * * @param int $id * Domain ID. + * * @return array * @see civicrm_domain.locale_custom_strings */ @@ -188,7 +186,11 @@ WHERE domain_id = %1 } /** - * Rebuild + * Rebuild. + * + * @param bool $clearCaches + * + * @return bool */ public static function rebuild($clearCaches = TRUE) { $id = CRM_Core_Config::domainID(); @@ -213,6 +215,8 @@ WHERE domain_id = %1 } /** + * Get word replacements for the api. + * * Get all the word-replacements stored in config-arrays * and convert them to params for the WordReplacement.create API. * @@ -220,10 +224,11 @@ WHERE domain_id = %1 * CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade * step behaves consistently even as the BAO evolves in future versions. * However, if there's a bug in here prior to 4.4.0, we should apply the - * bugfix in both places. + * bug-fix in both places. * * @param bool $rebuildEach * Whether to perform rebuild after each individual API call. + * * @return array * Each item is $params for WordReplacement.create * @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams @@ -239,7 +244,7 @@ WHERE domain_id = %1 $params = array(); $params["domain_id"] = $value["id"]; $params["options"] = array('wp-rebuild' => $rebuildEach); - // unserialize word match string + // Unserialize word match string. $localeCustomArray = unserialize($value["locale_custom_strings"]); if (!empty($localeCustomArray)) { $wordMatchArray = array(); @@ -266,6 +271,8 @@ WHERE domain_id = %1 } /** + * Rebuild word replacements. + * * Get all the word-replacements stored in config-arrays * and write them out as records in civicrm_word_replacement. * @@ -273,7 +280,7 @@ WHERE domain_id = %1 * CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade * step behaves consistently even as the BAO evolves in future versions. * However, if there's a bug in here prior to 4.4.0, we should apply the - * bugfix in both places. + * bug-fix in both places. */ public static function rebuildWordReplacementTable() { civicrm_api3('word_replacement', 'replace', array( diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index f4f909e450..b03664e68a 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -402,7 +402,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Initialize the DataObject framework + * Initialize the DataObject framework. * * @return void */ @@ -418,7 +418,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Returns the singleton logger for the application + * Returns the singleton logger for the application. * * @param * @@ -433,7 +433,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Initialize the config variables + * Initialize the config variables. * * @return void */ @@ -533,7 +533,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Retrieve a mailer to send any mail from the application + * Retrieve a mailer to send any mail from the application. * * @param bool $persist * Open a persistent smtp connection, should speed up mailings. @@ -612,7 +612,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Create a new instance of a PEAR Mail driver + * Create a new instance of a PEAR Mail driver. * * @param string $driver * 'CRM_Mailing_BAO_Spool' or a name suitable for Mail::factory(). @@ -632,7 +632,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Deletes the web server writable directories + * Deletes the web server writable directories. * * @param int $value * 1: clean templates_c, 2: clean upload, 3: clean both diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 7276ab5bd5..34ca7eca91 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -52,28 +52,28 @@ require_once 'HTML/QuickForm/Action/Direct.php'; class CRM_Core_Controller extends HTML_QuickForm_Controller { /** - * The title associated with this controller + * The title associated with this controller. * * @var string */ protected $_title; /** - * The key associated with this controller + * The key associated with this controller. * * @var string */ public $_key; /** - * The name of the session scope where values are stored + * The name of the session scope where values are stored. * * @var object */ protected $_scope; /** - * The state machine associated with this controller + * The state machine associated with this controller. * * @var object */ @@ -116,35 +116,35 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { public $_generateQFKey = TRUE; /** - * QF response type + * QF response type. * * @var string */ public $_QFResponseType = 'html'; /** - * Cache the smarty template for efficiency reasons + * Cache the smarty template for efficiency reasons. * * @var CRM_Core_Smarty */ static protected $_template; /** - * Cache the session for efficiency reasons + * Cache the session for efficiency reasons. * * @var CRM_Core_Session */ static protected $_session; /** - * The parent of this form if embedded + * The parent of this form if embedded. * * @var object */ protected $_parent = NULL; /** - * The destination if set will override the destination the code wants to send it to + * The destination if set will override the destination the code wants to send it to. * * @var string; */ diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 5a96a775d1..54f85cc25f 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -637,7 +637,7 @@ class CRM_Core_DAO extends DB_DataObject { } /** - * Get the size and maxLength attributes for this text field + * Get the size and maxLength attributes for this text field. * (or for all text fields) in the DAO object. * * @param string $class @@ -1314,7 +1314,7 @@ FROM civicrm_domain } /** - * make a shallow copy of an object + * make a shallow copy of an object. * and all the fields in the object * * @param string $daoName diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index d3147a8e0f..c82568b745 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -88,7 +88,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { private static $_singleton = NULL; /** - * The logger object for this application + * The logger object for this application. * @var object */ private static $_log = NULL; diff --git a/CRM/Core/Invoke.php b/CRM/Core/Invoke.php index 48d71a52c2..90332ed622 100644 --- a/CRM/Core/Invoke.php +++ b/CRM/Core/Invoke.php @@ -125,7 +125,7 @@ class CRM_Core_Invoke { } /** - * Perform general setup + * Perform general setup. * * @param array $args * List of path parts. @@ -327,7 +327,7 @@ class CRM_Core_Invoke { } /** - * This function contains the default action + * This function contains the default action. * * @param $action * @@ -349,7 +349,7 @@ class CRM_Core_Invoke { } /** - * Show the message about CiviCRM versions + * Show the message about CiviCRM versions. * * @param CRM_Core_Smarty $template */ diff --git a/CRM/Core/JobManager.php b/CRM/Core/JobManager.php index 5d77cc3df9..6798a12f83 100644 --- a/CRM/Core/JobManager.php +++ b/CRM/Core/JobManager.php @@ -52,7 +52,7 @@ class CRM_Core_JobManager { /** - * Class constructor + * Class constructor. * * @return void */ @@ -88,7 +88,7 @@ class CRM_Core_JobManager { } /** - * Class destructor + * Class destructor. */ public function __destruct() { } @@ -159,7 +159,7 @@ class CRM_Core_JobManager { } /** - * Retrieves specific job from the database by id + * Retrieves specific job from the database by id. * and creates ScheduledJob object. * * @param int $id diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index 66db51e959..4de184a28c 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -34,7 +34,7 @@ class CRM_Core_ManagedEntities { protected $declarations; /** - * Get an instance + * Get an instance. * @param bool $fresh * @return \CRM_Core_ManagedEntities */ diff --git a/CRM/Core/Module.php b/CRM/Core/Module.php index 7ec8c94a5c..19d7bc18be 100644 --- a/CRM/Core/Module.php +++ b/CRM/Core/Module.php @@ -57,7 +57,7 @@ class CRM_Core_Module { } /** - * Get a list of all known modules + * Get a list of all known modules. */ public static function getAll($fresh = FALSE) { static $result; diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index b43c2fe6a2..ca23899ccc 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -442,7 +442,7 @@ WHERE v.option_group_id = g.id } /** - * Creates a new option group with the passed in values + * Creates a new option group with the passed in values. * @TODO: Should update the group if it already exists intelligently, so multi-lingual is * not messed up. Currently deletes the old group * @@ -635,7 +635,7 @@ WHERE v.option_group_id = g.id } /** - * Wrapper for calling values with fresh set to true to empty the given value + * Wrapper for calling values with fresh set to true to empty the given value. * * Since there appears to be some inconsistency * (@todo remove inconsistency) around the pseudoconstant operations diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index c7d695510c..2edf837dbe 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -35,21 +35,21 @@ class CRM_Core_OptionValue { /** - * Static field for all the option value information that we can potentially export + * Static field for all the option value information that we can potentially export. * * @var array */ static $_exportableFields = NULL; /** - * Static field for all the option value information that we can potentially export + * Static field for all the option value information that we can potentially export. * * @var array */ static $_importableFields = NULL; /** - * Static field for all the option value information that we can potentially export + * Static field for all the option value information that we can potentially export. * * @var array */ @@ -237,7 +237,7 @@ class CRM_Core_OptionValue { } /** - * Check if there is a record with the same name in the db + * Check if there is a record with the same name in the db. * * @param string $value * The value of the field we are checking. @@ -267,7 +267,7 @@ class CRM_Core_OptionValue { } /** - * Check if there is a record with the same name in the db + * Check if there is a record with the same name in the db. * * @param string $mode * @param string $contactType diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php index 899c837097..74dbac2dc7 100644 --- a/CRM/Core/Payment.php +++ b/CRM/Core/Payment.php @@ -70,7 +70,7 @@ abstract class CRM_Core_Payment { protected $_paymentProcessor; /** - * Singleton function used to manage this object + * Singleton function used to manage this object. * We will migrate to calling Civi\Payment\System::singleton()->getByProcessor($paymentProcessor) * & Civi\Payment\System::singleton()->getById($paymentProcessor) directly as the main access methods & work * to remove this function all together @@ -118,7 +118,7 @@ abstract class CRM_Core_Payment { } /** - * Check if capability is supported + * Check if capability is supported. * @param string $capability * E.g BackOffice, LiveMode, FutureRecurStartDate. * @@ -155,7 +155,7 @@ abstract class CRM_Core_Payment { } /** - * Are test payments supported + * Are test payments supported. * @return bool */ protected function supportsTestMode() { @@ -163,7 +163,7 @@ abstract class CRM_Core_Payment { } /** - * Should the first payment date be configurable when setting up back office recurring payments + * Should the first payment date be configurable when setting up back office recurring payments. * We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this * @return bool */ @@ -172,7 +172,7 @@ abstract class CRM_Core_Payment { } /** - * Setter for the payment form that wants to use the processor + * Setter for the payment form that wants to use the processor. * @deprecated * @param CRM_Core_Form $paymentForm */ @@ -181,7 +181,7 @@ abstract class CRM_Core_Payment { } /** - * Getter for payment form that is using the processor + * Getter for payment form that is using the processor. * @deprecated * @return CRM_Core_Form * A form object @@ -191,7 +191,7 @@ abstract class CRM_Core_Payment { } /** - * Getter for accessing member vars + * Getter for accessing member vars. * @todo believe this is unused * @param string $name * @@ -202,7 +202,7 @@ abstract class CRM_Core_Payment { } /** - * Get name for the payment information type + * Get name for the payment information type. * @todo - use option group + name field (like Omnipay does) * @return string */ @@ -211,7 +211,7 @@ abstract class CRM_Core_Payment { } /** - * Get label for the payment information type + * Get label for the payment information type. * @todo - use option group + labels (like Omnipay does) * @return string */ @@ -220,7 +220,7 @@ abstract class CRM_Core_Payment { } /** - * Get array of fields that should be displayed on the payment form + * Get array of fields that should be displayed on the payment form. * @todo make payment type an option value & use it in the function name - currently on debit & credit card work * @return array * @throws CiviCRM_API3_Exception @@ -233,7 +233,7 @@ abstract class CRM_Core_Payment { } /** - * Get array of fields that should be displayed on the payment form for credit cards + * Get array of fields that should be displayed on the payment form for credit cards. * * @return array */ @@ -247,7 +247,7 @@ abstract class CRM_Core_Payment { } /** - * Get array of fields that should be displayed on the payment form for direct debits + * Get array of fields that should be displayed on the payment form for direct debits. * * @return array */ @@ -261,7 +261,7 @@ abstract class CRM_Core_Payment { } /** - * Return an array of all the details about the fields potentially required for payment fields + * Return an array of all the details about the fields potentially required for payment fields. * Only those determined by getPaymentFormFields will actually be assigned to the form * * @return array @@ -440,7 +440,7 @@ abstract class CRM_Core_Payment { } /** - * This function checks to see if we have the right config values + * This function checks to see if we have the right config values. * * @return string * the error message if any diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index efbaa0d149..da4d90f51c 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -65,7 +65,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { } /** - * Should the first payment date be configurable when setting up back office recurring payments + * Should the first payment date be configurable when setting up back office recurring payments. * In the case of Authorize.net this is an option * @return bool */ diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index 88d3628547..86ee19f6b2 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -39,7 +39,7 @@ class CRM_Core_Permission { /** - * Static strings used to compose permissions + * Static strings used to compose permissions. * * @const * @var string @@ -47,31 +47,31 @@ class CRM_Core_Permission { const EDIT_GROUPS = 'edit contacts in ', VIEW_GROUPS = 'view contacts in '; /** - * The various type of permissions + * The various type of permissions. * * @var int */ const EDIT = 1, VIEW = 2, DELETE = 3, CREATE = 4, SEARCH = 5, ALL = 6, ADMIN = 7; /** - * A placeholder permission which always fails + * A placeholder permission which always fails. */ const ALWAYS_DENY_PERMISSION = "*always deny*"; /** - * A placeholder permission which always fails + * A placeholder permission which always fails. */ const ALWAYS_ALLOW_PERMISSION = "*always allow*"; /** - * Various authentication sources + * Various authentication sources. * * @var int */ const AUTH_SRC_UNKNOWN = 0, AUTH_SRC_CHECKSUM = 1, AUTH_SRC_SITEKEY = 2, AUTH_SRC_LOGIN = 4; /** - * Get the current permission of this user + * Get the current permission of this user. * * @return string * the permission of the user (edit or view or null) @@ -142,7 +142,7 @@ class CRM_Core_Permission { } /** - * Determine if any one of the permissions strings applies to current user + * Determine if any one of the permissions strings applies to current user. * * @param array $perms * @return bool @@ -171,7 +171,7 @@ class CRM_Core_Permission { } /** - * Get the permissioned where clause for the user + * Get the permissioned where clause for the user. * * @param int $type * The type of permission needed. @@ -431,7 +431,7 @@ class CRM_Core_Permission { } /** - * Check permissions for delete and edit actions + * Check permissions for delete and edit actions. * * @param string $module * Component name. @@ -671,7 +671,7 @@ class CRM_Core_Permission { } /** - * Validate user permission across + * Validate user permission across. * edit or view or with supportable acls. * * @return bool @@ -745,7 +745,7 @@ class CRM_Core_Permission { } /** - * Get all the contact emails for users that have a specific permission + * Get all the contact emails for users that have a specific permission. * * @param string $permissionName * Name of the permission we are interested in. @@ -759,7 +759,7 @@ class CRM_Core_Permission { } /** - * Get all the contact emails for users that have a specific role + * Get all the contact emails for users that have a specific role. * * @param string $roleName * Name of the role we are interested in. diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index 4a750d9fc3..0fabdc8a12 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -42,7 +42,7 @@ class CRM_Core_Permission_Base { public $permissions = NULL; /** - * Translate permission + * Translate permission. * * @param string $perm * Permission string e.g "administer CiviCRM", "cms:access user record", "Drupal:administer content", @@ -74,7 +74,7 @@ class CRM_Core_Permission_Base { } /** - * Get the current permission of this user + * Get the current permission of this user. * * @return string * the permission of the user (edit or view or null) @@ -84,7 +84,7 @@ class CRM_Core_Permission_Base { } /** - * Get the permissioned where clause for the user + * Get the permissioned where clause for the user. * * @param int $type * The type of permission needed. @@ -101,7 +101,7 @@ class CRM_Core_Permission_Base { } /** - * Get the permissioned where clause for the user when trying to see groups + * Get the permissioned where clause for the user when trying to see groups. * * @param int $type * The type of permission needed. @@ -136,7 +136,7 @@ class CRM_Core_Permission_Base { } /** - * Get group clause for this user + * Get group clause for this user. * * @param int $type * The type of permission needed. @@ -177,7 +177,7 @@ class CRM_Core_Permission_Base { } /** - * Get all the contact emails for users that have a specific permission + * Get all the contact emails for users that have a specific permission. * * @param string $permissionName * Name of the permission we are interested in. @@ -188,7 +188,7 @@ class CRM_Core_Permission_Base { } /** - * Get all the contact emails for users that have a specific role + * Get all the contact emails for users that have a specific role. * * @param string $roleName * Name of the role we are interested in. diff --git a/CRM/Core/Permission/Drupal.php b/CRM/Core/Permission/Drupal.php index 18f8e5ecef..db6e041663 100644 --- a/CRM/Core/Permission/Drupal.php +++ b/CRM/Core/Permission/Drupal.php @@ -39,7 +39,7 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { /** - * Is this user someone with access for the entire system + * Is this user someone with access for the entire system. * * @var boolean */ @@ -54,7 +54,7 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { protected $_editPermission = FALSE; /** - * The current set of permissioned groups for the user + * The current set of permissioned groups for the user. * * @var array */ @@ -133,7 +133,7 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { } /** - * Get all the contact emails for users that have a specific permission + * Get all the contact emails for users that have a specific permission. * * @param string $permissionName * Name of the permission we are interested in. diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index dd59e137e2..03ddc61a02 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -39,7 +39,7 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { /** - * Is this user someone with access for the entire system + * Is this user someone with access for the entire system. * * @var boolean */ @@ -54,7 +54,7 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { protected $_editPermission = FALSE; /** - * The current set of permissioned groups for the user + * The current set of permissioned groups for the user. * * @var array */ @@ -112,7 +112,7 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { } /** - * Get all the contact emails for users that have a specific role + * Get all the contact emails for users that have a specific role. * * @param string $roleName * Name of the role we are interested in. @@ -147,7 +147,7 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { } /** - * Get all the contact emails for users that have a specific permission + * Get all the contact emails for users that have a specific permission. * * @param string $permissionName * Name of the permission we are interested in. diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index 8bd540c6b9..e3aaf80398 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -39,7 +39,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { /** - * Is this user someone with access for the entire system + * Is this user someone with access for the entire system. * * @var boolean */ @@ -54,7 +54,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { protected $_editPermission = FALSE; /** - * The current set of permissioned groups for the user + * The current set of permissioned groups for the user. * * @var array */ @@ -206,7 +206,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { } /** - * Get the current permission of this user + * Get the current permission of this user. * * @return string * the permission of the user (edit or view or null) @@ -283,7 +283,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { } /** - * Get all the contact emails for users that have a specific permission + * Get all the contact emails for users that have a specific permission. * * @param string $permissionName * Name of the permission we are interested in. diff --git a/CRM/Core/Permission/UnitTests.php b/CRM/Core/Permission/UnitTests.php index d96c268e29..7a3aef7bee 100644 --- a/CRM/Core/Permission/UnitTests.php +++ b/CRM/Core/Permission/UnitTests.php @@ -63,7 +63,7 @@ class CRM_Core_Permission_UnitTests extends CRM_Core_Permission_Base { } /** - * Get the permissioned where clause for the user + * Get the permissioned where clause for the user. * * @param int $type * The type of permission needed. diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index aa6dec652f..127c2bf68c 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -50,7 +50,7 @@ class CRM_Core_PseudoConstant { /** - * Static cache for pseudoconstant arrays + * Static cache for pseudoconstant arrays. * @var array */ private static $cache; @@ -70,7 +70,7 @@ class CRM_Core_PseudoConstant { private static $stateProvince; /** - * Counties + * Counties. * @var array */ private static $county; @@ -82,13 +82,13 @@ class CRM_Core_PseudoConstant { private static $stateProvinceAbbreviation; /** - * Country + * Country. * @var array */ private static $country; /** - * CountryIsoCode + * CountryIsoCode. * @var array */ private static $countryIsoCode; @@ -419,7 +419,7 @@ class CRM_Core_PseudoConstant { } /** - * Fetch the translated label for a field given its key + * Fetch the translated label for a field given its key. * * @param string $baoName * @param string $fieldName @@ -441,7 +441,7 @@ class CRM_Core_PseudoConstant { } /** - * Fetch the machine name for a field given its key + * Fetch the machine name for a field given its key. * * @param string $baoName * @param string $fieldName @@ -461,7 +461,7 @@ class CRM_Core_PseudoConstant { } /** - * Fetch the key for a field option given its name + * Fetch the key for a field option given its name. * * @param string $baoName * @param string $fieldName @@ -508,7 +508,7 @@ class CRM_Core_PseudoConstant { } /** - * DEPRECATED generic populate method + * DEPRECATED generic populate method. * All pseudoconstant functions that use this method are also @deprecated * * The static array $var is populated from the db @@ -582,7 +582,7 @@ class CRM_Core_PseudoConstant { } /** - * Flush given pseudoconstant so it can be reread from db + * Flush given pseudoconstant so it can be reread from db. * nex time it's requested. * * @@ -957,7 +957,7 @@ WHERE id = %1"; } /** - * Get all permissioned groups from database + * Get all permissioned groups from database. * * The static array group is returned, and if it's * called the first time, the Group DAO is used @@ -979,7 +979,7 @@ WHERE id = %1"; } /** - * Fetch groups in a nested format suitable for use in select form element + * Fetch groups in a nested format suitable for use in select form element. * @param bool $checkPermissions * @param string|null $groupType * @param bool $excludeHidden @@ -991,7 +991,7 @@ WHERE id = %1"; } /** - * Get all permissioned groups from database + * Get all permissioned groups from database. * * The static array group is returned, and if it's * called the first time, the Group DAO is used @@ -1457,7 +1457,7 @@ WHERE id = %1"; } /** - * Get all the World Regions from Database + * Get all the World Regions from Database. * * * @param bool $id @@ -1724,7 +1724,7 @@ WHERE id = %1 } /** - * Construct array of default greeting values for contact type + * Construct array of default greeting values for contact type. * * * @return array @@ -1754,7 +1754,7 @@ WHERE id = %1 } /** - * Get all extensions + * Get all extensions. * * The static array extensions * @@ -1783,7 +1783,7 @@ WHERE id = %1 } /** - * Get all options values + * Get all options values. * * The static array option values is returned * @@ -1824,7 +1824,7 @@ WHERE id = %1 /** - * Get all tax rates + * Get all tax rates. * * The static array tax rates is returned * diff --git a/CRM/Core/QuickForm/Action.php b/CRM/Core/QuickForm/Action.php index 8d3d265882..24f85d2b14 100644 --- a/CRM/Core/QuickForm/Action.php +++ b/CRM/Core/QuickForm/Action.php @@ -42,13 +42,13 @@ require_once 'HTML/QuickForm/Action.php'; class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action { /** - * Reference to the state machine i belong to + * Reference to the state machine i belong to. * @var object */ protected $_stateMachine; /** - * Constructor + * Constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Back.php b/CRM/Core/QuickForm/Action/Back.php index 0b9c147dee..e702080ed4 100644 --- a/CRM/Core/QuickForm/Action/Back.php +++ b/CRM/Core/QuickForm/Action/Back.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Cancel.php b/CRM/Core/QuickForm/Action/Cancel.php index 5fd6b70200..0600c8f2dd 100644 --- a/CRM/Core/QuickForm/Action/Cancel.php +++ b/CRM/Core/QuickForm/Action/Cancel.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index 8c3b2a4246..2bb6da1149 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -42,13 +42,13 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { static $_requiredTemplate = NULL; /** - * The template to display error messages inline with the form element + * The template to display error messages inline with the form element. * @var string */ static $_errorTemplate = NULL; /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. @@ -102,7 +102,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { } /** - * Render the page using a custom templating system + * Render the page using a custom templating system. * * @param CRM_Core_Form $page * The CRM_Core_Form page. @@ -187,7 +187,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { } /** - * Set the various rendering templates + * Set the various rendering templates. * * @param CRM_Core_Form $page * The CRM_Core_Form page. @@ -206,7 +206,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { } /** - * Initialize the various templates + * Initialize the various templates. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php index e0fb11bdeb..a2d83e3c0d 100644 --- a/CRM/Core/QuickForm/Action/Done.php +++ b/CRM/Core/QuickForm/Action/Done.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Jump.php b/CRM/Core/QuickForm/Action/Jump.php index ee7f8b4f0c..9603ad57c8 100644 --- a/CRM/Core/QuickForm/Action/Jump.php +++ b/CRM/Core/QuickForm/Action/Jump.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Next.php b/CRM/Core/QuickForm/Action/Next.php index 964d0f319c..02c6635e9c 100644 --- a/CRM/Core/QuickForm/Action/Next.php +++ b/CRM/Core/QuickForm/Action/Next.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Process.php b/CRM/Core/QuickForm/Action/Process.php index 7459101152..95ca8fdb9a 100644 --- a/CRM/Core/QuickForm/Action/Process.php +++ b/CRM/Core/QuickForm/Action/Process.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Refresh.php b/CRM/Core/QuickForm/Action/Refresh.php index 8854235929..616dce661d 100644 --- a/CRM/Core/QuickForm/Action/Refresh.php +++ b/CRM/Core/QuickForm/Action/Refresh.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Reload.php b/CRM/Core/QuickForm/Action/Reload.php index 46ec4bed69..0325504dfa 100644 --- a/CRM/Core/QuickForm/Action/Reload.php +++ b/CRM/Core/QuickForm/Action/Reload.php @@ -39,7 +39,7 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Submit.php b/CRM/Core/QuickForm/Action/Submit.php index 0bb57f60fd..c3d48a2397 100644 --- a/CRM/Core/QuickForm/Action/Submit.php +++ b/CRM/Core/QuickForm/Action/Submit.php @@ -36,7 +36,7 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action { /** - * Class constructor + * Class constructor. * * @param object $stateMachine * Reference to state machine object. diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php index 136a07c477..63fd54335d 100644 --- a/CRM/Core/QuickForm/Action/Upload.php +++ b/CRM/Core/QuickForm/Action/Upload.php @@ -35,13 +35,13 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** - * The array of uploaded file names + * The array of uploaded file names. * @var array */ protected $_uploadNames; /** - * The directory to store the uploaded files + * The directory to store the uploaded files. * @var string */ protected $_uploadDir; diff --git a/CRM/Core/QuickForm/GroupMultiSelect.php b/CRM/Core/QuickForm/GroupMultiSelect.php index 8bc800e59d..c37f08d218 100644 --- a/CRM/Core/QuickForm/GroupMultiSelect.php +++ b/CRM/Core/QuickForm/GroupMultiSelect.php @@ -35,7 +35,7 @@ */ class CRM_Core_QuickForm_GroupMultiSelect extends CRM_Core_QuickForm_NestedAdvMultiSelect { /** - * Returns the HTML generated for the advanced multiple select component + * Returns the HTML generated for the advanced multiple select component. * * @return string * @since version 0.4.0 (2005-06-25) diff --git a/CRM/Core/QuickForm/NestedAdvMultiSelect.php b/CRM/Core/QuickForm/NestedAdvMultiSelect.php index 9e236c82db..b346d11ec7 100644 --- a/CRM/Core/QuickForm/NestedAdvMultiSelect.php +++ b/CRM/Core/QuickForm/NestedAdvMultiSelect.php @@ -41,7 +41,7 @@ require_once 'HTML/QuickForm/advmultiselect.php'; */ class CRM_Core_QuickForm_NestedAdvMultiSelect extends HTML_QuickForm_advmultiselect { /** - * Loads options from different types of data sources + * Loads options from different types of data sources. * * This method overloaded parent method of select element, to allow * loading options with fancy attributes. diff --git a/CRM/Core/Reference/Dynamic.php b/CRM/Core/Reference/Dynamic.php index 3f8f6d6c1b..64fc790ebc 100644 --- a/CRM/Core/Reference/Dynamic.php +++ b/CRM/Core/Reference/Dynamic.php @@ -17,7 +17,7 @@ class CRM_Core_Reference_Dynamic extends CRM_Core_Reference_Basic { } /** - * Create a query to find references to a particular record + * Create a query to find references to a particular record. * * @param CRM_Core_DAO $targetDao * The instance for which we want references. diff --git a/CRM/Core/Reference/Interface.php b/CRM/Core/Reference/Interface.php index 6eb7193dc2..09e0a0ba6d 100644 --- a/CRM/Core/Reference/Interface.php +++ b/CRM/Core/Reference/Interface.php @@ -17,7 +17,7 @@ interface CRM_Core_Reference_Interface { public function matchesTargetTable($tableName); /** - * Create a query to find references to a particular record + * Create a query to find references to a particular record. * * @param CRM_Core_DAO $targetDao * The instance for which we want references. @@ -26,7 +26,7 @@ interface CRM_Core_Reference_Interface { public function findReferences($targetDao); /** - * Create a query to find references to a particular record + * Create a query to find references to a particular record. * * @param CRM_Core_DAO $targetDao * The instance for which we want references. diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php index 9db08aa172..7868cee238 100644 --- a/CRM/Core/Region.php +++ b/CRM/Core/Region.php @@ -7,7 +7,7 @@ class CRM_Core_Region { static private $_instances = NULL; /** - * Obtain the content for a given region + * Obtain the content for a given region. * * @param string $name * @param bool $autocreate @@ -64,7 +64,7 @@ class CRM_Core_Region { } /** - * Add a snippet of content to a region + * Add a snippet of content to a region. * * @code * CRM_Core_Region::instance('page-header')->add(array( @@ -146,7 +146,7 @@ class CRM_Core_Region { } /** - * Render all the snippets in a region + * Render all the snippets in a region. * * @param string $default * HTML, the initial content of the region. @@ -250,7 +250,7 @@ class CRM_Core_Region { } /** - * Add block of static HTML to a region + * Add block of static HTML to a region. * * @param string $markup * HTML. @@ -263,7 +263,7 @@ class CRM_Core_Region { * } * * /** - * Add a Smarty template file to a region + * Add a Smarty template file to a region. * * Note: File is not evaluated until the page is rendered * @@ -278,7 +278,7 @@ class CRM_Core_Region { * } * * /** - * Use a callback function to extend a region + * Use a callback function to extend a region. * * @param mixed $callback * @param array $arguments diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index d5b40a8897..744e5be721 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -125,7 +125,7 @@ class CRM_Core_Resources { } /** - * Construct a resource manager + * Construct a resource manager. * * @param CRM_Extension_Mapper $extMapper * Map extension names to their base path or URLs. @@ -286,7 +286,7 @@ class CRM_Core_Resources { } /** - * Helper fn for addSettingsFactory + * Helper fn for addSettingsFactory. */ public function getSettings() { $result = $this->settings; @@ -313,7 +313,7 @@ class CRM_Core_Resources { } /** - * Helper fn for addSetting + * Helper fn for addSetting. * Render JavaScript variables for the global CRM object. * * @return string @@ -439,7 +439,7 @@ class CRM_Core_Resources { } /** - * Determine file path of a resource provided by an extension + * Determine file path of a resource provided by an extension. * * @param string $ext * extension name; use 'civicrm' for core. @@ -462,7 +462,7 @@ class CRM_Core_Resources { } /** - * Determine public URL of a resource provided by an extension + * Determine public URL of a resource provided by an extension. * * @param string $ext * extension name; use 'civicrm' for core. @@ -624,7 +624,7 @@ class CRM_Core_Resources { } /** - * Flushes cached translated strings + * Flushes cached translated strings. * @return CRM_Core_Resources */ public function flushStrings() { @@ -659,7 +659,7 @@ class CRM_Core_Resources { } /** - * List of core resources we add to every CiviCRM page + * List of core resources we add to every CiviCRM page. * * @return array */ -- 2.25.1