Commit 0d514755 authored by eileen's avatar eileen 🎱

Merge pull request #5077 from eileenmcnaughton/comment-full-stops

 INFRA-132 Function comment short description must end with a full stop 
parents 81feb942 d2e5d2ce
......@@ -35,7 +35,7 @@
class CRM_ACL_API {
/**
* The various type of permissions
* The various type of permissions.
*
* @var int
*/
......@@ -72,7 +72,7 @@ class CRM_ACL_API {
}
/**
* Get the permissioned where clause for the user
* Get the permissioned where clause for the user.
*
* @param int $type
* The type of permission needed.
......@@ -143,7 +143,7 @@ class CRM_ACL_API {
}
/**
* Get all the groups the user has access to for the given operation
* Get all the groups the user has access to for the given operation.
*
* @param int $type
* The type of permission needed.
......
......@@ -446,7 +446,7 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
}
/**
* Get all of the ACLs through ACL groups
* Get all of the ACLs through ACL groups.
*
* @param int $contact_id
* ID of a contact to search for.
......@@ -512,7 +512,7 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
}
/**
* Get all ACLs granted to a contact through all group memberships
* Get all ACLs granted to a contact through all group memberships.
*
* @param int $contact_id
* The contact's ID.
......@@ -557,7 +557,7 @@ SELECT $acl.*
}
/**
* Get all of the ACLs for a contact through ACL groups owned by Contact
* Get all of the ACLs for a contact through ACL groups owned by Contact.
* groups.
*
* @param int $contact_id
......@@ -963,7 +963,7 @@ ORDER BY a.object_id
}
/**
* Delete ACL records
* Delete ACL records.
*
* @param int $aclId
* ID of the ACL record to be deleted.
......
......@@ -88,7 +88,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
}
/**
* Delete Entity Role records
* Delete Entity Role records.
*
* @param int $entityRoleId
* ID of the EntityRole record to be deleted.
......
......@@ -112,7 +112,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form {
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -265,7 +265,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @return void
......
......@@ -74,7 +74,7 @@ SELECT object_table
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -123,7 +123,7 @@ SELECT object_table
}
/**
* Process the form submission
* Process the form submission.
*
*
* @return void
......
......@@ -43,7 +43,7 @@
class CRM_ACL_Form_EntityRole extends CRM_Admin_Form {
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -69,7 +69,7 @@ class CRM_ACL_Form_EntityRole extends CRM_Admin_Form {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @return void
......
......@@ -39,7 +39,7 @@
class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form {
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -98,7 +98,7 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form {
}
/**
* Process the form submission
* Process the form submission.
*
* @return void
*/
......
......@@ -45,14 +45,14 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic {
public $useLivePageJS = TRUE;
/**
* The action links that we need to display for the browse screen
* The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
* Get BAO Name
* Get BAO Name.
*
* @return string
* Classname of BAO.
......@@ -62,7 +62,7 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic {
}
/**
* Get action Links
* Get action Links.
*
* @return array
* (reference) of action links
......@@ -153,7 +153,7 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic {
}
/**
* Browse all acls
* Browse all acls.
*
* @return void
*/
......@@ -254,7 +254,7 @@ ORDER BY entity_id
}
/**
* Get name of edit form
* Get name of edit form.
*
* @return string
* Classname of edit form.
......@@ -264,7 +264,7 @@ ORDER BY entity_id
}
/**
* Get edit form name
* Get edit form name.
*
* @return string
* name of this page.
......
......@@ -43,14 +43,14 @@
class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic {
/**
* The action links that we need to display for the browse screen
* The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
* Get BAO Name
* Get BAO Name.
*
* @return string
* Classname of BAO.
......@@ -60,7 +60,7 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic {
}
/**
* Get action Links
* Get action Links.
*
* @return array
* (reference) of action links
......@@ -129,7 +129,7 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic {
}
/**
* Browse all acls
* Browse all acls.
*
* @return void
*/
......@@ -188,7 +188,7 @@ ORDER BY entity_id
}
/**
* Get name of edit form
* Get name of edit form.
*
* @return string
* Classname of edit form.
......@@ -198,7 +198,7 @@ ORDER BY entity_id
}
/**
* Get edit form name
* Get edit form name.
*
* @return string
* name of this page.
......
......@@ -45,14 +45,14 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
public $useLivePageJS = TRUE;
/**
* The action links that we need to display for the browse screen
* The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
* Get BAO Name
* Get BAO Name.
*
* @return string
* Classname of BAO.
......@@ -62,7 +62,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
}
/**
* Get action Links
* Get action Links.
*
* @return array
* (reference) of action links
......@@ -150,7 +150,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
}
/**
* Browse all acls
* Browse all acls.
*
* @return void
*/
......@@ -195,7 +195,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
}
/**
* Get name of edit form
* Get name of edit form.
*
* @return string
* Classname of edit form.
......@@ -205,7 +205,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
}
/**
* Get edit form name
* Get edit form name.
*
* @return string
* name of this page.
......
......@@ -325,7 +325,7 @@ WHERE civicrm_case.id = %1";
}
/**
* Delete the record that are associated with this case
* Delete the record that are associated with this case.
* record are deleted from case
*
* @param int $caseId
......@@ -468,7 +468,7 @@ WHERE civicrm_case.id = %1";
}
/**
* Retrieve contact names by caseId
* Retrieve contact names by caseId.
*
* @param int $caseId
* ID of the case.
......@@ -959,7 +959,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Get Case roles
* Get Case roles.
*
* @param int $contactID
* Contact id.
......@@ -1017,7 +1017,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Get Case Activities
* Get Case Activities.
*
* @param int $caseID
* Case id.
......@@ -1363,7 +1363,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Get Case Related Contacts
* Get Case Related Contacts.
*
* @param int $caseID
* Case id.
......@@ -1586,7 +1586,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Create an activity for a case via email
* Create an activity for a case via email.
*
* @param int $file
* Email sent.
......@@ -1676,7 +1676,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Retrieve the scheduled activity type and date
* Retrieve the scheduled activity type and date.
*
* @param array $cases
* Array of contact and case id.
......@@ -1720,7 +1720,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Combine all the exportable fields from the lower levels object
* Combine all the exportable fields from the lower levels object.
*
* @return array
* array of exportable Fields
......@@ -1748,7 +1748,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Restore the record that are associated with this case
* Restore the record that are associated with this case.
*
* @param int $caseId
* Id of the case to restore.
......@@ -1818,7 +1818,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
}
/**
* Convenience function to get both case contacts and global in one array
* Convenience function to get both case contacts and global in one array.
* @param int $caseId
*
* @return array
......@@ -3068,7 +3068,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
}
/**
* Verify user has permission to access a case
* Verify user has permission to access a case.
*
* @param int $caseId
* @param bool $denyClosed
......@@ -3117,7 +3117,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
}
/**
* Check whether activity is a case Activity
* Check whether activity is a case Activity.
*
* @param int $activityID
* Activity id.
......@@ -3138,7 +3138,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
}
/**
* Get all the case type ids currently in use
* Get all the case type ids currently in use.
*
* @return array
*/
......@@ -3162,7 +3162,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
}
/**
* Get all the case status ids currently in use
* Get all the case status ids currently in use.
*
* @return array
*/
......@@ -3183,7 +3183,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
}
/**
* Get all the encounter medium ids currently in use
* Get all the encounter medium ids currently in use.
*
* @return array
*/
......@@ -3254,7 +3254,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
}
/**
* Used during case component enablement and during ugprade
* Used during case component enablement and during ugprade.
*
* @return bool
*/
......@@ -3365,7 +3365,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
}
/**
* Get the list of clients for a case
* Get the list of clients for a case.
*
* @param int $caseId
*
......
......@@ -40,14 +40,14 @@
class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType {
/**
* Static field for all the case information that we can potentially export
* Static field for all the case information that we can potentially export.
*
* @var array
*/
static $_exportableFields = NULL;
/**
* Takes an associative array and creates a Case Type object
* Takes an associative array and creates a Case Type object.
*
* the function extract all the params it needs to initialize the create a
* case type object. the params array could contain additional unused name/value
......@@ -188,7 +188,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType {
}
/**
* Get the case definition either from db or read from xml file
* Get the case definition either from db or read from xml file.
*
* @param SimpleXmlElement $xml
* A single case-type record.
......@@ -272,7 +272,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType {
}
/**
* Takes an associative array and creates a case type object
* Takes an associative array and creates a case type object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
......
......@@ -40,35 +40,35 @@
class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity {
/**
* The default variable defined
* The default variable defined.
*
* @var int
*/
public $_caseId;
/**
* The default case type variable defined
* The default case type variable defined.
*
* @var int
*/
public $_caseType;
/**
* The default values of an activity
* The default values of an activity.
*
* @var array
*/
public $_defaults = array();
/**
* The array of releted contact info
* The array of releted contact info.
*
* @var array
*/
public $_relatedContacts;
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -351,7 +351,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity {
}
/**
* Global form rule
* Global form rule.
*
* @param array $fields
* The input form values.
......@@ -372,7 +372,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @param array $params
......
......@@ -101,7 +101,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate {
}
/**
* Global validation rules for the form
* Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
......@@ -117,7 +117,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @param CRM_Core_Form $form
......@@ -132,7 +132,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @param CRM_Core_Form $form
......
......@@ -101,7 +101,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus {
}
/**
* Global validation rules for the form
* Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
......@@ -117,7 +117,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @param CRM_Core_Form $form
......@@ -130,7 +130,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @param CRM_Core_Form $form
......
......@@ -98,7 +98,7 @@ class CRM_Case_Form_Activity_ChangeCaseType {
}
/**
* Global validation rules for the form
* Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
......@@ -114,7 +114,7 @@ class CRM_Case_Form_Activity_ChangeCaseType {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @param CRM_Core_Form $form
......@@ -137,7 +137,7 @@ class CRM_Case_Form_Activity_ChangeCaseType {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @param CRM_Core_Form $form
......
......@@ -37,21 +37,21 @@ class CRM_Core_BAO_CustomQuery {
const PREFIX = 'custom_value_';
/**
* The set of custom field ids
* The set of custom field ids.
*
* @var array
*/
protected $_ids;
/**
* The select clause
* The select clause.
*
* @var array
*/
public $_select;
/**
* The name of the elements that are in the select clause
* The name of the elements that are in the select clause.
* used to extract the values
*
* @var array
......@@ -59,7 +59,7 @@ class CRM_Core_BAO_CustomQuery {
public $_element;
/**
* The tables involved in the query
* The tables involved in the query.
*
* @var array
*/
......@@ -67,28 +67,28 @@ class CRM_Core_BAO_CustomQuery {
public $_whereTables;
/**
* The where clause
* The where clause.
*
* @var array
*/
public $_where;
/**
* The english language version of the query
* The english language version of the query.
*
* @var array
*/
public $_qill;
/**
* The cache to translate the option values into labels
* The cache to translate the option values into labels.
*
* @var array
*/
public $_options;
/**
* The custom fields information
* The custom fields information.
*
* @var array
*/
......@@ -104,7 +104,7 @@ class CRM_Core_BAO_CustomQuery {
protected $_locationSpecificCustomFields;
/**
* This stores custom data group types and tables that it extends
* This stores custom data group types and tables that it extends.
*
* @var array
*/
......@@ -129,7 +129,7 @@ class CRM_Core_BAO_CustomQuery {
);
/**
* Class constructor
* Class constructor.
*
* Takes in a set of custom field ids andsets up the data structures to
* generate a query
......@@ -253,7 +253,7 @@ SELECT label, value
}
/**
* Generate the select clause and the associated tables
* Generate the select clause and the associated tables.
* for the from clause
*
* @return void
......@@ -318,7 +318,7 @@ SELECT label, value
}
/**
* Generate the where clause and also the english language
* Generate the where clause and also the english language.
* equivalent
*
* @return void
......@@ -548,7 +548,7 @@ SELECT label, value
}
/**
* Function that does the actual query generation
* Function that does the actual query generation.
* basically ties all the above functions together
*
* @return array
......
<?php
// vim: set si ai expandtab tabstop=4 shiftwidth=4 softtabstop=4:
/**
* File to v3 APIs for Standards compliance
*
* (PHP 5)
*
* @copyright Copyright CiviCRM LLC (C) 2009
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
* GNU Affero General Public License version 3
* @version $Id:
* @package CiviCRM
*
* This file is part of CiviCRM
*
* CiviCRM is free software; you can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License
* as published by the Free Software Foundation; either version 3 of
* the License, or (at your option) any later version.
*
* CiviCRM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
*/
/**
* Include class definitions
*/
require_once 'CiviTest/CiviUnitTestCase.php';