Commit d09edf64 authored by Eileen McNaughton's avatar Eileen McNaughton

INFRA-132 add full stops

parent 0880a9d0
......@@ -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(
......
......@@ -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
......
......@@ -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;
*/
......
......@@ -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
......
......@@ -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;
......
......@@ -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
*/
......
......@@ -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
......
......@@ -34,7 +34,7 @@ class CRM_Core_ManagedEntities {
protected $declarations;
/**
* Get an instance
* Get an instance.
* @param bool $fresh
* @return \CRM_Core_ManagedEntities
*/
......
......@@ -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;
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
*/
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.