Changeset 11027

Timestamp:

08/22/2016 10:11:20 PM (10 years ago)

Author:

r-a-y

Message:

Groups: Cast properties as integers where appropriate.

See #6977.

Location:

trunk/src/bp-groups

Files:

• bp-groups-functions.php (modified) (2 diffs)
• classes/class-bp-groups-group.php (modified) (6 diffs)
• classes/class-bp-groups-member.php (modified) (13 diffs)

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

@@ -115 +115 @@
         // Pass an existing group ID.
         if ( ! empty( $group_id ) ) {
-                $group = groups_get_group( array( 'group_id' => (int) $group_id ) );
+                $group = groups_get_group( array( 'group_id' => $group_id ) );
                 $name  = ! empty( $name ) ? $name : $group->name;
                 $slug  = ! empty( $slug ) ? $slug : $group->slug;
@@ -416 +416 @@
  *
  * @param string $group_slug The group's slug.
- * @return int The ID.
+ * @return int|null The group ID on success; null on failure.
  */
 function groups_get_id( $group_slug ) {
-        return (int)BP_Groups_Group::group_exists( $group_slug );
+        return BP_Groups_Group::group_exists( $group_slug );
 }
 

trunk/src/bp-groups/classes/class-bp-groups-group.php

@@ -176 +176 @@
 
                 if ( !empty( $id ) ) {
-                        $this->id = $id;
+                        $this->id = (int) $id;
                         $this->populate();
                 }
@@ -209 +209 @@
 
                 // Group found so setup the object variables.
-                $this->id           = $group->id;
-                $this->creator_id   = $group->creator_id;
+                $this->id           = (int) $group->id;
+                $this->creator_id   = (int) $group->creator_id;
                 $this->name         = stripslashes( $group->name );
                 $this->slug         = $group->slug;
                 $this->description  = stripslashes( $group->description );
                 $this->status       = $group->status;
-                $this->enable_forum = $group->enable_forum;
+                $this->enable_forum = (int) $group->enable_forum;
                 $this->date_created = $group->date_created;
 
@@ -232 +232 @@
                         // Add admins and moderators to their respective arrays.
                         foreach ( (array) $admin_mods as $user ) {
+                                $user->user_id  = (int) $user->user_id;
+                                $user->is_admin = (int) $user->is_admin;
+                                $user->is_mod   = (int) $user->is_mod;
+
                                 if ( !empty( $user->is_admin ) ) {
                                         $this->admins[] = $user;
@@ -242 +246 @@
                         // from the bp_groups cache because it's cached independently.
                         $this->last_activity      = groups_get_groupmeta( $this->id, 'last_activity' );
-                        $this->total_member_count = groups_get_groupmeta( $this->id, 'total_member_count' );
+                        $this->total_member_count = (int) groups_get_groupmeta( $this->id, 'total_member_count' );
 
                         // Set user-specific data.
@@ -436 +440 @@
          * @param string|bool $table_name Optional. Name of the table to check
          *                                against. Default: $bp->groups->table_name.
-         * @return string|null ID of the group, if one is found, else null.
+         * @return int|null Group ID if found; null if not.
          */
         public static function group_exists( $slug, $table_name = false ) {
@@ -447 +451 @@
                         return false;
 
-                return $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$table_name} WHERE slug = %s", strtolower( $slug ) ) );
+                $query = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$table_name} WHERE slug = %s", strtolower( $slug ) ) );
+
+                return is_numeric( $query ) ? (int) $query : $query;
         }
 

trunk/src/bp-groups/classes/class-bp-groups-member.php

@@ -186 +186 @@
 
                 if ( !empty( $member ) ) {
-                        $this->id            = $member->id;
-                        $this->group_id      = $member->group_id;
-                        $this->user_id       = $member->user_id;
-                        $this->inviter_id    = $member->inviter_id;
-                        $this->is_admin      = $member->is_admin;
-                        $this->is_mod        = $member->is_mod;
-                        $this->is_banned     = $member->is_banned;
+                        $this->id            = (int) $member->id;
+                        $this->group_id      = (int) $member->group_id;
+                        $this->user_id       = (int) $member->user_id;
+                        $this->inviter_id    = (int) $member->inviter_id;
+                        $this->is_admin      = (int) $member->is_admin;
+                        $this->is_mod        = (int) $member->is_mod;
+                        $this->is_banned     = (int) $member->is_banned;
                         $this->user_title    = $member->user_title;
                         $this->date_modified = $member->date_modified;
-                        $this->is_confirmed  = $member->is_confirmed;
+                        $this->is_confirmed  = (int) $member->is_confirmed;
                         $this->comments      = $member->comments;
-                        $this->invite_sent   = $member->invite_sent;
+                        $this->invite_sent   = (int) $member->invite_sent;
 
                         $this->user = new BP_Core_User( $this->user_id );
@@ -787 +787 @@
          * @param string $type     If 'sent', results are limited to those invitations
          *                         that have actually been sent (non-draft). Default: 'sent'.
-         * @return int|null The ID of the invitation if found, otherwise null.
+         * @return int|null The ID of the invitation if found; null if not found.
          */
         public static function check_has_invite( $user_id, $group_id, $type = 'sent' ) {
@@ -801 +801 @@
                         $sql .= " AND invite_sent = 1";
 
-                return $wpdb->get_var( $wpdb->prepare( $sql, $user_id, $group_id ) );
+                $query = $wpdb->get_var( $wpdb->prepare( $sql, $user_id, $group_id ) );
+
+                return is_numeric( $query ) ? (int) $query : $query;
         }
 
@@ -932 +934 @@
          * @param int $user_id  ID of the user.
          * @param int $group_id ID of the group.
-         * @return mixed
+         * @return int|null int 1 if user is banned; int 0 if user is not banned;
+         *                  null if user is not part of the group or if group doesn't exist.
          */
         public static function check_is_banned( $user_id, $group_id ) {
@@ -942 +945 @@
                 $bp = buddypress();
 
-                return $wpdb->get_var( $wpdb->prepare( "SELECT is_banned FROM {$bp->groups->table_name_members} WHERE user_id = %d AND group_id = %d", $user_id, $group_id ) );
+                $query = $wpdb->get_var( $wpdb->prepare( "SELECT is_banned FROM {$bp->groups->table_name_members} WHERE user_id = %d AND group_id = %d", $user_id, $group_id ) );
+
+                return is_numeric( $query ) ? (int) $query : $query;
         }
 
@@ -952 +957 @@
          * @param int $user_id  ID of the user.
          * @param int $group_id ID of the group.
-         * @return int|null ID of the group if the user is the creator,
-         *                  otherwise false.
+         * @return int|null int of group ID if user is the creator; null on failure.
          */
         public static function check_is_creator( $user_id, $group_id ) {
@@ -963 +967 @@
                 $bp = buddypress();
 
-                return $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$bp->groups->table_name} WHERE creator_id = %d AND id = %d", $user_id, $group_id ) );
+                $query = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$bp->groups->table_name} WHERE creator_id = %d AND id = %d", $user_id, $group_id ) );
+
+                return is_numeric( $query ) ? (int) $query : $query;
         }
 
@@ -973 +979 @@
          * @param int $user_id  ID of the user.
          * @param int $group_id ID of the group.
-         * @return int|null ID of the membership if found, otherwise false.
+         * @return int Database ID of the membership if found; int 0 on failure.
          */
         public static function check_for_membership_request( $user_id, $group_id ) {
@@ -1002 +1008 @@
                 // If the user is logged in and viewing their random groups, we can show hidden and private groups.
                 if ( bp_is_my_profile() ) {
-                        return $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT group_id FROM {$bp->groups->table_name_members} WHERE user_id = %d AND is_confirmed = 1 AND is_banned = 0 ORDER BY rand() LIMIT %d", $user_id, $total_groups ) );
+                        return array_map( 'intval', $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT group_id FROM {$bp->groups->table_name_members} WHERE user_id = %d AND is_confirmed = 1 AND is_banned = 0 ORDER BY rand() LIMIT %d", $user_id, $total_groups ) ) );
                 } else {
-                        return $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT m.group_id FROM {$bp->groups->table_name_members} m, {$bp->groups->table_name} g WHERE m.group_id = g.id AND g.status != 'hidden' AND m.user_id = %d AND m.is_confirmed = 1 AND m.is_banned = 0 ORDER BY rand() LIMIT %d", $user_id, $total_groups ) );
+                        return array_map( 'intval', $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT m.group_id FROM {$bp->groups->table_name_members} m, {$bp->groups->table_name} g WHERE m.group_id = g.id AND g.status != 'hidden' AND m.user_id = %d AND m.is_confirmed = 1 AND m.is_banned = 0 ORDER BY rand() LIMIT %d", $user_id, $total_groups ) ) );
                 }
         }
@@ -1021 +1027 @@
                 $bp = buddypress();
 
-                return $wpdb->get_col( $wpdb->prepare( "SELECT user_id FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_confirmed = 1 AND is_banned = 0", $group_id ) );
+                return array_map( 'intval', $wpdb->get_col( $wpdb->prepare( "SELECT user_id FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_confirmed = 1 AND is_banned = 0", $group_id ) ) );
         }
 
@@ -1044 +1050 @@
                 }
 
+                // Integer casting.
+                foreach ( (array) $group_admins as $key => $data ) {
+                        $group_admins[ $key ]->user_id = (int) $group_admins[ $key ]->user_id;
+                }
+
                 return $group_admins;
         }
@@ -1060 +1071 @@
                 $bp = buddypress();
 
-                return $wpdb->get_results( $wpdb->prepare( "SELECT user_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_mod = 1 AND is_banned = 0", $group_id ) );
+                $group_mods = $wpdb->get_results( $wpdb->prepare( "SELECT user_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_mod = 1 AND is_banned = 0", $group_id ) );
+
+                // Integer casting.
+                foreach ( (array) $group_mods as $key => $data ) {
+                        $group_mods[ $key ]->user_id = (int) $group_mods[ $key ]->user_id;
+                }
+
+                return $group_mods;
         }
 
@@ -1093 +1111 @@
                 $bp = buddypress();
 
-                return $wpdb->get_col( $wpdb->prepare( "SELECT user_id FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_confirmed = 0 AND inviter_id = 0", $group_id ) );
+                return array_map( 'intval', $wpdb->get_col( $wpdb->prepare( "SELECT user_id FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_confirmed = 0 AND inviter_id = 0", $group_id ) ) );
         }