Commit a6c01b45 authored by colemanw's avatar colemanw

INFRA-132 - Fix spacing of @return tag in comments

parent 79c0e11e
......@@ -54,7 +54,8 @@ class CRM_ACL_API {
* @param int $contactID
* The contactID for whom the check is made.
*
* @return boolean true if yes, else false
* @return boolean
* true if yes, else false
* @static
*/
public static function check($str, $contactID = NULL) {
......@@ -88,7 +89,8 @@ class CRM_ACL_API {
* Don't add delete clause if this is true,.
* this means it is handled by generating query
*
* @return string the group where clause for this user
* @return string
* the group where clause for this user
*/
public static function whereClause(
$type,
......@@ -153,7 +155,8 @@ class CRM_ACL_API {
* @param null $allGroups
* @param null $includedGroups
*
* @return array the ids of the groups for which the user has permissions
* @return array
* the ids of the groups for which the user has permissions
*/
public static function group(
$type,
......@@ -189,7 +192,8 @@ class CRM_ACL_API {
* @param null $includedGroups
* @param bool $flush
*
* @return array the ids of the groups for which the user has permissions
* @return array
* the ids of the groups for which the user has permissions
*/
public static function groupPermission(
$type,
......
......@@ -105,7 +105,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
* @param bool $acl_role
* For grant operations, this flag determines if we're granting a single acl (false) or an entire group.
*
* @return string - The WHERE clause, or 0 on failure
* @return string
* The WHERE clause, or 0 on failure
* @static
*/
public static function permissionClause(
......@@ -359,7 +360,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
* @param bool $hideEmpty
* Only return elements that have a value set.
*
* @return array - Assoc. array of the ACL rule's properties
* @return array
* Assoc. array of the ACL rule's properties
*/
public function toArray($format = '%s', $hideEmpty = FALSE) {
$result = array();
......@@ -388,7 +390,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
* @param bool $aclRoles
* Should we include ACL Roles.
*
* @return array - Array of assoc. arrays of ACL rules
* @return array
* Array of assoc. arrays of ACL rules
* @static
*/
public static function &getACLs($contact_id = NULL, $group_id = NULL, $aclRoles = FALSE) {
......@@ -453,7 +456,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
* @param int $group_id
* ID of a group to search for.
*
* @return array - Array of assoc. arrays of ACL rules
* @return array
* Array of assoc. arrays of ACL rules
* @static
*/
public static function &getACLRoles($contact_id = NULL, $group_id = NULL) {
......@@ -519,7 +523,8 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
* @param bool $aclRoles
* Include ACL Roles?.
*
* @return array - Assoc array of ACL rules
* @return array
* Assoc array of ACL rules
* @static
*/
public static function &getGroupACLs($contact_id, $aclRoles = FALSE) {
......@@ -563,7 +568,8 @@ SELECT $acl.*
* @param int $contact_id
* ID of a contact to search for.
*
* @return array - Array of assoc. arrays of ACL rules
* @return array
* Array of assoc. arrays of ACL rules
* @static
*/
public static function &getGroupACLRoles($contact_id) {
......@@ -635,7 +641,8 @@ SELECT $acl.*
* @param int $contact_id
* The contact ID.
*
* @return array - Assoc array of ACL rules
* @return array
* Assoc array of ACL rules
* @static
*/
public static function &getAllByContact($contact_id) {
......@@ -678,7 +685,8 @@ SELECT $acl.*
* @param bool $is_active
* Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @return Object
* DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
......
......@@ -80,7 +80,8 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
* @param bool $is_active
* Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @return Object
* DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
......
......@@ -170,7 +170,8 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form {
* This function should be shared from a similar one in
* distmaker/utils/joomlaxml.php
*
* @return array civicrm permissions
* @return array
* civicrm permissions
*/
public static function getPermissionArray() {
global $civicrm_root;
......
......@@ -55,7 +55,8 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic {
/**
* Get BAO Name
*
* @return string Classname of BAO.
* @return string
* Classname of BAO.
*/
public function getBAOName() {
return 'CRM_ACL_BAO_ACL';
......@@ -64,7 +65,8 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic {
/**
* Get action Links
*
* @return array (reference) of action links
* @return array
* (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
......@@ -255,7 +257,8 @@ ORDER BY entity_id
/**
* Get name of edit form
*
* @return string Classname of edit form.
* @return string
* Classname of edit form.
*/
public function editForm() {
return 'CRM_ACL_Form_ACL';
......@@ -264,7 +267,8 @@ ORDER BY entity_id
/**
* Get edit form name
*
* @return string name of this page.
* @return string
* name of this page.
*/
public function editName() {
return 'ACL';
......@@ -275,7 +279,8 @@ ORDER BY entity_id
*
* @param null $mode
*
* @return string user context.
* @return string
* user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/acl';
......
......@@ -53,7 +53,8 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic {
/**
* Get BAO Name
*
* @return string Classname of BAO.
* @return string
* Classname of BAO.
*/
public function getBAOName() {
return 'CRM_ACL_BAO_ACL';
......@@ -62,7 +63,8 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic {
/**
* Get action Links
*
* @return array (reference) of action links
* @return array
* (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
......@@ -189,7 +191,8 @@ ORDER BY entity_id
/**
* Get name of edit form
*
* @return string Classname of edit form.
* @return string
* Classname of edit form.
*/
public function editForm() {
return 'CRM_ACL_Form_ACLBasic';
......@@ -198,7 +201,8 @@ ORDER BY entity_id
/**
* Get edit form name
*
* @return string name of this page.
* @return string
* name of this page.
*/
public function editName() {
return 'Core ACLs';
......@@ -209,7 +213,8 @@ ORDER BY entity_id
*
* @param null $mode
*
* @return string user context.
* @return string
* user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/acl/basic';
......
......@@ -55,7 +55,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
/**
* Get BAO Name
*
* @return string Classname of BAO.
* @return string
* Classname of BAO.
*/
public function getBAOName() {
return 'CRM_ACL_BAO_EntityRole';
......@@ -64,7 +65,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
/**
* Get action Links
*
* @return array (reference) of action links
* @return array
* (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
......@@ -196,7 +198,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
/**
* Get name of edit form
*
* @return string Classname of edit form.
* @return string
* Classname of edit form.
*/
public function editForm() {
return 'CRM_ACL_Form_EntityRole';
......@@ -205,7 +208,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
/**
* Get edit form name
*
* @return string name of this page.
* @return string
* name of this page.
*/
public function editName() {
return 'ACL EntityRole';
......@@ -216,7 +220,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
*
* @param null $mode
*
* @return string user context.
* @return string
* user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/acl/entityrole';
......
......@@ -657,7 +657,8 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
* - context string page on which selector is build
* - activity_type_id int|string the activitiy types we want to restrict by
*
* @return array (reference) $values the relevant data object values of open activities
* @return array
* (reference) $values the relevant data object values of open activities
*
* @static
*/
......@@ -906,7 +907,8 @@ ORDER BY fixed_sort_order
* user has permission. To decide whether we are going to include
* component related activities w/ core activity retrieve process.
*
* @return array of component id and name.
* @return array
* of component id and name.
* @static
**/
public static function activityComponents() {
......@@ -946,7 +948,8 @@ ORDER BY fixed_sort_order
* - context string page on which selector is build
* - activity_type_id int|string the activity types we want to restrict by
*
* @return int count of activities
* @return int
* count of activities
*
* @static
*/
......@@ -983,7 +986,8 @@ LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.a
* - count boolean are we interested in the count clause only?
* - activity_type_id int|string the activity types we want to restrict by
*
* @return int count of activities
* @return int
* count of activities
*
* @static
*/
......@@ -1176,7 +1180,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
* @param string $additionalDetails
* The additional information of CC and BCC appended to the activity Details.
*
* @return array ( sent, activityId) if any email is sent and activityId
* @return array
* ( sent, activityId) if any email is sent and activityId
* @static
*/
static function sendEmail(
......@@ -1591,7 +1596,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
* @param null $cc
* @param null $bcc
*
* @return boolean true if successfull else false.
* @return boolean
* true if successfull else false.
* @static
*/
static function sendMessage(
......@@ -1663,7 +1669,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
*
* @param bool $status
*
* @return array array of importable Fields
* @return array
* array of importable Fields
* @static
*/
public static function &importableFields($status = FALSE) {
......@@ -1717,7 +1724,8 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
* @param int $contactId
* Id of the contact whose activities need to find.
*
* @return array array of activity fields
* @return array
* array of activity fields
*/
public static function getContactActivity($contactId) {
$activities = array();
......@@ -1910,7 +1918,8 @@ SELECT display_name
* @param int $activityId
* Current activity id.
*
* @return int $parentId Id of parent activity otherwise false.
* @return int
* $parentId Id of parent activity otherwise false.
*/
public static function getParentActivity($activityId) {
static $parentActivities = array();
......@@ -1937,7 +1946,8 @@ SELECT display_name
* @param $activityID
* Current activity id.
*
* @return int $params count of prior activities otherwise false.
* @return int
* $params count of prior activities otherwise false.
*/
public static function getPriorCount($activityID) {
static $priorCounts = array();
......@@ -1975,7 +1985,8 @@ AND id < {$activityID}
* Current activity id.
* @param bool $onlyPriorRevisions
*
* @return array $result prior activities info.
* @return array
* prior activities info.
*/
public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {