Changeset 10426

Timestamp:

12/22/2015 05:42:32 AM (11 years ago)

Author:

tw2113

Message:

Scrutinizr feedback cleanup.

See #6397.

Location:

trunk/src/bp-blogs

Files:

• bp-blogs-functions.php (modified) (2 diffs)
• classes/class-bp-blogs-blog.php (modified) (7 diffs)

trunk/src/bp-blogs/bp-blogs-functions.php

@@ -1278 +1278 @@
  * @see BP_Blogs_Blog::get_all() for a description of parameters and return values.
  *
- * @param int $limit See {@BP_Blogs_Blog::get_all()}.
- * @param int $page  See {@BP_Blogs_Blog::get_all()}.
+ * @param int|null $limit See {@BP_Blogs_Blog::get_all()}.
+ * @param int|null $page  See {@BP_Blogs_Blog::get_all()}.
  * @return array See {@BP_Blogs_Blog::get_all()}.
  */
@@ -1291 +1291 @@
  * @see BP_Blogs_Blog::get() for a description of parameters and return values.
  *
- * @param int $limit See {@BP_Blogs_Blog::get()}.
- * @param int $page  See {@BP_Blogs_Blog::get()}.
+ * @param int|null $limit See {@BP_Blogs_Blog::get()}.
+ * @param int|null $page  See {@BP_Blogs_Blog::get()}.
  * @return array See {@BP_Blogs_Blog::get()}.
  */

trunk/src/bp-blogs/classes/class-bp-blogs-blog.php

@@ -45 +45 @@
          * Constructor method.
          *
-         * @param int $id Optional. The ID of the blog.
+         * @param int|null $id Optional. The ID of the blog.
          */
         public function __construct( $id = null ) {
@@ -270 +270 @@
          * Delete the record of a given blog for a specific user.
          *
-         * @param int $blog_id The blog being removed.
-         * @param int $user_id Optional. The ID of the user from whom the blog is
-         *                     being removed. If absent, defaults to the logged-in user ID.
+         * @param int      $blog_id The blog being removed.
+         * @param int|null $user_id Optional. The ID of the user from whom the blog is
+         *                          being removed. If absent, defaults to the logged-in user ID.
          * @return int|bool Number of rows deleted on success, false on failure.
          */
@@ -289 +289 @@
          * Delete all of a user's blog associations in the BP tables.
          *
-         * @param int $user_id Optional. The ID of the user whose blog associations
-         *                     are being deleted. If absent, defaults to logged-in user ID.
+         * @param int|null $user_id Optional. The ID of the user whose blog associations
+         *                          are being deleted. If absent, defaults to logged-in user ID.
          * @return int|bool Number of rows deleted on success, false on failure.
          */
@@ -390 +390 @@
          * cap.
          *
-         * @param int $user_id Optional. ID of the user whose blogs are being
-         *                     queried. Defaults to logged-in user.
+         * @param int|null $user_id Optional. ID of the user whose blogs are being
+         *                          queried. Defaults to logged-in user.
          * @return int Blog count for the user.
          */
@@ -416 +416 @@
          * blogmeta table.
          *
-         * @param string $filter The search term.
-         * @param int    $limit  Optional. The maximum number of items to return.
-         *                       Default: null (no limit).
-         * @param int    $page   Optional. The page of results to return. Default:
-         *                       null (no limit).
+         * @param string   $filter The search term.
+         * @param int|null $limit  Optional. The maximum number of items to return.
+         *                         Default: null (no limit).
+         * @param int|null $page   Optional. The page of results to return. Default:
+         *                         null (no limit).
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects.
@@ -454 +454 @@
          * 'bp_moderate' cap.
          *
-         * @param int $limit Optional. The maximum number of items to return.
-         *                   Default: null (no limit).
-         * @param int $page  Optional. The page of results to return. Default:
-         *                   null (no limit).
+         * @param int|null $limit Optional. The maximum number of items to return.
+         *                        Default: null (no limit).
+         * @param int|null $page  Optional. The page of results to return. Default:
+         *                        null (no limit).
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects.
@@ -482 +482 @@
          * 'bp_moderate' cap.
          *
-         * @param string $letter The letter you're looking for.
-         * @param int    $limit  Optional. The maximum number of items to return.
-         *                       Default: null (no limit).
-         * @param int    $page   Optional. The page of results to return. Default:
-         *                       null (no limit).
+         * @param string   $letter The letter you're looking for.
+         * @param int|null $limit  Optional. The maximum number of items to return.
+         *                         Default: null (no limit).
+         * @param int|null $page   Optional. The page of results to return. Default:
+         *                         null (no limit).
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects.