Changeset 11035

Timestamp:

08/24/2016 12:22:22 PM (8 years ago)

Author:

djpaul

Message:

Activity, Groups, XProfile: fix some PHPDoc parameter types.

Props Scrutinizer-CI

See #5891

Location:

trunk/src

Files:

• bp-activity/bp-activity-template.php (modified) (1 diff)
• bp-groups/bp-groups-template.php (modified) (6 diffs)
• bp-xprofile/bp-xprofile-admin.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)
• bp-xprofile/classes/class-bp-xprofile-field.php (modified) (1 diff)

trunk/src/bp-activity/bp-activity-template.php

@@ -1541 +1541 @@
  * @global object $activities_template {@link BP_Activity_Template}
  *
- * @param object|bool $activity Optional. Falls back on the current item in the loop.
+ * @param BP_Activity_Activity $activity Optional. Falls back on the current item in the loop.
  * @return bool True if can delete, false otherwise.
  */

trunk/src/bp-groups/bp-groups-template.php

@@ -267 +267 @@
  * @since 1.0.0
  *
- * @param object|bool $group Optional. Group object. Default: current group in loop.
+ * @param BP_Groups_Group $group Optional. Group object. Default: current group in loop.
  * @return bool
  */
-function bp_group_is_visible( $group = false ) {
+function bp_group_is_visible( $group = null ) {
     global $groups_template;
 
@@ -752 +752 @@
  * @since 1.0.0
  *
- * @param object|bool $group Optional. Group object.
- *                           Default: current group in loop.
- */
-function bp_group_permalink( $group = false ) {
+ * @param BP_Groups_Group $group Optional. Group object. Default: current group in loop.
+ */
+function bp_group_permalink( $group = null ) {
     echo bp_get_group_permalink( $group );
 }
@@ -763 +762 @@
      * @since 1.0.0
      *
-     * @param object|bool $group Optional. Group object.
-     *                           Default: current group in loop.
+     * @param BP_Groups_Group $group Optional. Group object. Default: current group in loop.
      * @return string
      */
-    function bp_get_group_permalink( $group = false ) {
+    function bp_get_group_permalink( $group = null ) {
         global $groups_template;
 
@@ -1243 +1241 @@
  * @since 1.7.0
  *
- * @param object|bool $group   Optional. Group object.
- *                             Default: current group in loop.
- * @param int         $user_id ID of the user.
+ * @param BP_Groups_Group $group   Optional. Group object. Default: current group in loop.
+ * @param int             $user_id ID of the user.
  * @return bool
  */
-function bp_is_group_creator( $group = false, $user_id = 0 ) {
+function bp_is_group_creator( $group = null, $user_id = 0 ) {
     global $groups_template;
 
@@ -3226 +3223 @@
      *
      * @param object|bool $group Single group object.
-     * @return mixed
+     * @return false|string
      */
     function bp_get_group_join_button( $group = false ) {
@@ -4956 +4953 @@
      *
      * @param array $args Array of arguments for friends list output.
-     * @return mixed HTML list of checkboxes, or false
+     * @return false|string HTML list of checkboxes, or false
      */
     function bp_get_new_group_invite_friend_list( $args = array() ) {

trunk/src/bp-xprofile/bp-xprofile-admin.php

@@ -549 +549 @@
  * @since 1.5.0
  *
- * @param object $admin_field Admin field.
+ * @param BP_XProfile_Field   $admin_field Admin field.
  * @param object $admin_group Admin group object.
  * @param string $class       Classes to append to output.

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

@@ -965 +965 @@
  * @param string $object_type Type of object. 'group', 'field', or 'data'.
  * @param string $meta_key    Key of the metadata being updated.
- * @param mixed  $meta_value  Value of the metadata being updated.
+ * @param string $meta_value  Value of the metadata being updated.
  * @param mixed  $prev_value  Optional. If specified, only update existing
  *                            metadata entries with the specified value.

trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

@@ -505 +505 @@
      *
      * @param int $user_id ID of the user to get field data for.
-     * @return object
+     * @return BP_XProfile_ProfileData
      */
     public function get_field_data( $user_id = 0 ) {