INFRA-132 - CRM/ACL - Convert single-line @param to multi-line

diff --git a/CRM/ACL/API.php b/CRM/ACL/API.php
index 4f3bef607269213b1b473bc98823fd8f1f7cee1e..7ada9d6f609d5cd3517ef7feefebae37a0aabfbf 100644 (file)
--- a/CRM/ACL/API.php
+++ b/CRM/ACL/API.php
@@ -49,8 +49,10 @@ class CRM_ACL_API {
   /**
    * Given a permission string, check for access requirements
    *
-   * @param string $str       the permission to check
-   * @param int    $contactID the contactID for whom the check is made
+   * @param string $str
+   *   The permission to check.
+   * @param int $contactID
+   *   The contactID for whom the check is made.
    *
    * @return boolean true if yes, else false
    * @static
@@ -72,12 +74,18 @@ class CRM_ACL_API {
   /**
    * Get the permissioned where clause for the user
    *
-   * @param int $type the type of permission needed
-   * @param  array $tables (reference ) add the tables that are needed for the select clause
-   * @param  array $whereTables (reference ) add the tables that are needed for the where clause
-   * @param int    $contactID the contactID for whom the check is made
-   * @param bool   $onlyDeleted  whether to include only deleted contacts
-   * @param bool   $skipDeleteClause don't add delete clause if this is true,
+   * @param int $type
+   *   The type of permission needed.
+   * @param array $tables
+   *   (reference ) add the tables that are needed for the select clause.
+   * @param array $whereTables
+   *   (reference ) add the tables that are needed for the where clause.
+   * @param int $contactID
+   *   The contactID for whom the check is made.
+   * @param bool $onlyDeleted
+   *   Whether to include only deleted contacts.
+   * @param bool $skipDeleteClause
+   *   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
@@ -135,8 +143,10 @@ class CRM_ACL_API {
   /**
    * Get all the groups the user has access to for the given operation
    *
-   * @param int $type the type of permission needed
-   * @param int $contactID the contactID for whom the check is made
+   * @param int $type
+   *   The type of permission needed.
+   * @param int $contactID
+   *   The contactID for whom the check is made.
    *
    * @param string $tableName
    * @param null $allGroups
@@ -167,9 +177,11 @@ class CRM_ACL_API {
   /**
    * Check if the user has access to this group for operation $type
    *
-   * @param int $type the type of permission needed
+   * @param int $type
+   *   The type of permission needed.
    * @param int $groupID
-   * @param int $contactID the contactID for whom the check is made
+   * @param int $contactID
+   *   The contactID for whom the check is made.
    *
    * @param string $tableName
    * @param null $allGroups

diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php
index d2e84a985b28162cec47cdf31ae6858d00a2b8df..3c6c05298c57446d6c6ac78427892039c07bb9d1 100644 (file)
--- a/CRM/ACL/BAO/ACL.php
+++ b/CRM/ACL/BAO/ACL.php
@@ -92,12 +92,18 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
   /**
    * Construct a WHERE clause to handle permissions to $object_*
    *
-   * @param array $tables -   Any tables that may be needed in the FROM
-   * @param string $operation -   The operation being attempted
-   * @param string $object_table -    The table of the object in question
-   * @param int $object_id -   The ID of the object in question
-   * @param int $acl_id -       If it's a grant/revoke operation, the ACL ID
-   * @param boolean $acl_role -  For grant operations, this flag determines if we're granting a single acl (false) or an entire group.
+   * @param array $tables
+   *   Any tables that may be needed in the FROM.
+   * @param string $operation
+   *   The operation being attempted.
+   * @param string $object_table
+   *   The table of the object in question.
+   * @param int $object_id
+   *   The ID of the object in question.
+   * @param int $acl_id
+   *   If it's a grant/revoke operation, the ACL ID.
+   * @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
    * @static
@@ -326,9 +332,12 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
   /**
    * Given a table and id pair, return the filter clause
    *
-   * @param string $table -   The table owning the object
-   * @param int $id -       The ID of the object
-   * @param array $tables - Tables that will be needed in the FROM
+   * @param string $table
+   *   The table owning the object.
+   * @param int $id
+   *   The ID of the object.
+   * @param array $tables
+   *   Tables that will be needed in the FROM.
    *
    * @return string|null  -   WHERE-style clause to filter results,
    * or null if $table or $id is null
@@ -357,8 +366,10 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
   /**
    * Construct an associative array of an ACL rule's properties
    *
-   * @param   string $format sprintf format for array
-   * @param   bool $hideEmpty only return elements that have a value set.
+   * @param string $format
+   *   Sprintf format for array.
+   * @param bool $hideEmpty
+   *   Only return elements that have a value set.
    *
    * @return array    - Assoc. array of the ACL rule's properties
    */
@@ -382,9 +393,12 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
    * directly to the contact, but not those granted to the contact through
    * any/all of his group memberships.
    *
-   * @param int $contact_id       -   ID of a contact to search for
-   * @param int $group_id         -   ID of a group to search for
-   * @param boolean $aclRoles    -   Should we include ACL Roles
+   * @param int $contact_id
+   *   ID of a contact to search for.
+   * @param int $group_id
+   *   ID of a group to search for.
+   * @param bool $aclRoles
+   *   Should we include ACL Roles.
    *
    * @return array                -   Array of assoc. arrays of ACL rules
    * @static
@@ -447,8 +461,10 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
   /**
    * Get all of the ACLs through ACL groups
    *
-   * @param int $contact_id   -   ID of a contact to search for
-   * @param int $group_id     -   ID of a group to search for
+   * @param int $contact_id
+   *   ID of a contact to search for.
+   * @param int $group_id
+   *   ID of a group to search for.
    *
    * @return array            -   Array of assoc. arrays of ACL rules
    * @static
@@ -511,8 +527,10 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
   /**
    * Get all ACLs granted to a contact through all group memberships
    *
-   * @param int $contact_id       -   The contact's ID
-   * @param boolean $aclRoles     -   Include ACL Roles?
+   * @param int $contact_id
+   *   The contact's ID.
+   * @param bool $aclRoles
+   *   Include ACL Roles?.
    *
    * @return array                -   Assoc array of ACL rules
    * @static
@@ -556,7 +574,8 @@ SELECT      $acl.*
    * Get all of the ACLs for a contact through ACL groups owned by Contact
    * groups.
    *
-   * @param int $contact_id   -   ID of a contact to search for
+   * @param int $contact_id
+   *   ID of a contact to search for.
    *
    * @return array            -   Array of assoc. arrays of ACL rules
    * @static
@@ -628,7 +647,8 @@ SELECT $acl.*
   /**
    * Get all ACLs owned by a given contact, including domain and group-level.
    *
-   * @param int $contact_id   -   The contact ID
+   * @param int $contact_id
+   *   The contact ID.
    *
    * @return array            -   Assoc array of ACL rules
    * @static
@@ -668,8 +688,10 @@ SELECT $acl.*
   /**
    * Update the is_active flag in the db
    *
-   * @param int      $id        id of the database record
-   * @param boolean  $is_active value we want to set the is_active field
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $is_active
+   *   Value we want to set the is_active field.
    *
    * @return Object             DAO object on sucess, null otherwise
    * @static
@@ -957,7 +979,8 @@ ORDER BY a.object_id
   /**
    * Delete ACL records
    *
-   * @param  int  $aclId     ID of the ACL record to be deleted.
+   * @param int $aclId
+   *   ID of the ACL record to be deleted.
    *
    * @static
    */

diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php
index 7eafbdef4050c3330c8d017d798eab5e405f8cc8..ffc2c2116eb592d7f6da203443d5381650ba3239 100644 (file)
--- a/CRM/ACL/BAO/EntityRole.php
+++ b/CRM/ACL/BAO/EntityRole.php
@@ -75,8 +75,10 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
   /**
    * Update the is_active flag in the db
    *
-   * @param int      $id        id of the database record
-   * @param boolean  $is_active value we want to set the is_active field
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $is_active
+   *   Value we want to set the is_active field.
    *
    * @return Object             DAO object on sucess, null otherwise
    * @static
@@ -88,7 +90,8 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
   /**
    * Delete Entity Role records
    *
-   * @param  int  $entityRoleId ID of the EntityRole record to be deleted.
+   * @param int $entityRoleId
+   *   ID of the EntityRole record to be deleted.
    *
    * @static
    */