bulk comment fix
[civicrm-core.git] / CRM / Core / BAO / UFGroup.php
index 83c7fdbda60ec7f69adf6eaf0f73e02f63311a7c..7395d7366b12083e4afac106ed9e0515f2f25a9f 100644 (file)
@@ -128,8 +128,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
   /**
    * get all the registration fields
    *
-   * @param int $action   what action are we doing
-   * @param int $mode     mode
+   * @param int $action what action are we doing
+   * @param int $mode mode
+   *
+   * @param null $ctype
    *
    * @return array the fields that are needed for registration
    * @static
@@ -181,12 +183,15 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
   /**
    * get all the listing fields
    *
-   * @param int     $action            what action are we doing
-   * @param int     $visibility        visibility of fields we are interested in
-   * @param bool    $considerSelector  whether to consider the in_selector parameter
-   * @param array   $ufGroupIds
+   * @param int $action what action are we doing
+   * @param int $visibility visibility of fields we are interested in
+   * @param bool $considerSelector whether to consider the in_selector parameter
+   * @param array $ufGroupIds
    * @param boolean $searchable
    *
+   * @param null $restrict
+   * @param bool $skipPermission
+   * @param int $permissionType
    * @return array   the fields that are listings related
    * @static
    * @access public
@@ -248,14 +253,21 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
    * and format for use with buildProfile. This is the SQL analog of
    * formatUFFields().
    *
-   * @param mix      $id           the id of the UF group or ids of ufgroup
-   * @param int      $register     are we interested in registration fields
-   * @param int      $action       what action are we doing
-   * @param int      $visibility   visibility of fields we are interested in
+   * @param mix $id the id of the UF group or ids of ufgroup
+   * @param bool|int $register are we interested in registration fields
+   * @param int $action what action are we doing
+   * @param int $visibility visibility of fields we are interested in
    * @param          $searchable
-   * @param boolean  $showall
-   * @param string   $restrict     should we restrict based on a specified profile type
+   * @param bool $showAll
+   * @param string $restrict should we restrict based on a specified profile type
+   *
+   * @param bool $skipPermission
+   * @param null $ctype
+   * @param int $permissionType
+   * @param string $orderBy
+   * @param null $orderProfiles
    *
+   * @internal param bool $showall
    * @return array   the fields that belong to this ufgroup(s)
    * @static
    * @access public
@@ -350,9 +362,13 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
    *
    * @param array $groupArr (mimic CRM_UF_DAO_UFGroup)
    * @param array $fieldArrs list of fields (each mimics CRM_UF_DAO_UFField)
-   * @param bool $visibility   visibility of fields we are interested in
+   * @param bool $visibility visibility of fields we are interested in
    * @param bool $searchable
-   * @param bool $showall
+   * @param bool $showAll
+   * @param null $ctype
+   * @param int $permissionType
+   *
+   * @internal param bool $showall
    * @return array
    * @see getFields
    */
@@ -1470,6 +1486,10 @@ AND    ( entity_id IS NULL OR entity_id <= 0 )
    * @params int $displayName if set return display name in array
    * @params int $status if set return module other than default modules (User Account/User registration/Profile)
    *
+   * @param null $ufGroupId
+   * @param null $displayName
+   * @param null $status
+   *
    * @return array $ufGroupJoinRecords
    *
    * @access public
@@ -1576,11 +1596,12 @@ AND    ( entity_id IS NULL OR entity_id <= 0 )
    * Function to get the uf group for a module
    *
    * @param string $moduleName module name
-   * @param int    $count no to increment the weight
-   * @param bool   $skipPermision - whether to add permission clause
-   * @param int    $op - which operation (view, edit, create, etc) to check permission for
+   * @param int $count no to increment the weight
+   * @param bool $skipPermission
+   * @param int $op - which operation (view, edit, create, etc) to check permission for
    * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
    *
+   * @internal param bool $skipPermision - whether to add permission clause
    * @return array $ufGroups array of ufgroups for a module
    * @access public
    * @static
@@ -1653,6 +1674,9 @@ AND    ( entity_id IS NULL OR entity_id <= 0 )
    *
    * @params int $ufGroupId uf group id (profile id)
    *
+   * @param $ufGroupId
+   * @param null $contactID
+   *
    * @return boolean true or false
    * @static
    * @access public
@@ -1698,6 +1722,15 @@ AND    ( entity_id IS NULL OR entity_id <= 0 )
    * @params int     $contactID  contact id
    * @params string  $usedFor    for building up prefixed fieldname for special cases (e.g. onBehalf, Honor)
    *
+   * @param $form
+   * @param $field
+   * @param $mode
+   * @param null $contactId
+   * @param bool $online
+   * @param null $usedFor
+   * @param null $rowNumber
+   * @param string $prefix
+   *
    * @return null
    * @static
    * @access public
@@ -2211,6 +2244,13 @@ AND    ( entity_id IS NULL OR entity_id <= 0 )
    * @params boolean $singleProfile  true for single profile else false(batch update)
    * @params int     $componentId    id for specific components like contribute, event etc
    *
+   * @param $contactId
+   * @param $fields
+   * @param $defaults
+   * @param bool $singleProfile
+   * @param null $componentId
+   * @param null $component
+   *
    * @return null
    * @static
    * @access public
@@ -2557,8 +2597,10 @@ AND    ( entity_id IS NULL OR entity_id <= 0 )
   /**
    * Function to get default value for Register.
    *
-   * @return $defaults
-   * @static
+   * @param $fields
+   * @param $defaults
+   *
+   * @return mixed $defaults@static
    * @access public
    */
   static function setRegisterDefaults(&$fields, &$defaults) {