Changeset 10424 for trunk/src/bp-friends/classes/class-bp-friends-friendship.php

Timestamp:

12/22/2015 05:40:21 AM (9 years ago)

Author:

tw2113

Message:

Scrutinizr feedback cleanup.

See #6400.

File:

• trunk/src/bp-friends/classes/class-bp-friends-friendship.php (modified) (3 diffs)

trunk/src/bp-friends/classes/class-bp-friends-friendship.php

@@ -86 +86 @@
      * Constructor method.
      *
-     * @param int  $id                      Optional. The ID of an existing friendship.
-     * @param bool $is_request              Deprecated.
-     * @param bool $populate_friend_details True if friend details should be queried.
+     * @param int|null $id                      Optional. The ID of an existing friendship.
+     * @param bool     $is_request              Deprecated.
+     * @param bool     $populate_friend_details True if friend details should be queried.
      */
     public function __construct( $id = null, $is_request = false, $populate_friend_details = true ) {
@@ -297 +297 @@
      * Search the friends of a user by a search string.
      *
-     * @param string $filter  The search string, matched against xprofile
+     * @param string   $filter  The search string, matched against xprofile
      *                        fields (if available), or usermeta 'nickname' field.
-     * @param int    $user_id ID of the user whose friends are being searched.
-     * @param int    $limit   Optional. Max number of friends to return.
-     * @param int    $page    Optional. The page of results to return. Default:
-     *                        null (no pagination - return all results).
+     * @param int      $user_id ID of the user whose friends are being searched.
+     * @param int|null $limit   Optional. Max number of friends to return.
+     * @param int|null $page    Optional. The page of results to return. Default:
+     *                          null (no pagination - return all results).
      *
      * @return array|bool On success, an array: {
@@ -478 +478 @@
      * @todo Why does this exist, and why is it in bp-friends?
      *
-     * @param string $filter  String to search by.
-     * @param int    $user_id A user ID param that is unused.
-     * @param int    $limit   Optional. Max number of records to return.
-     * @param int    $page    Optional. Number of the page to return. Default:
-     *                        false (no pagination - return all results).
+     * @param string   $filter  String to search by.
+     * @param int      $user_id A user ID param that is unused.
+     * @param int|null $limit   Optional. Max number of records to return.
+     * @param int|null $page    Optional. Number of the page to return. Default:
+     *                          false (no pagination - return all results).
      * @return array $filtered_ids IDs of users who match the query.
      */