Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
11/02/2015 01:58:52 AM (9 years ago)
Author:
tw2113
Message:

More documentation cleanup for the Members component.

See #6402.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-members/classes/class-bp-signup.php

    r10149 r10322  
    99 */
    1010
     11/**
     12 * Class used to handle Signups.
     13 */
    1114class BP_Signup {
    1215
    … …  
    112115     *
    113116     * @param array $args the argument to retrieve desired signups.
    114      *
    115117     * @return array {
    116118     *     @type array $signups Located signups.
    … …  
    150152        if ( empty( $r['include'] ) ) {
    151153
    152             // Search terms
     154            // Search terms.
    153155            if ( ! empty( $r['usersearch'] ) ) {
    154156                $search_terms_like = '%' . bp_esc_like( $r['usersearch'] ) . '%';
    … …  
    156158            }
    157159
    158             // Activation key
     160            // Activation key.
    159161            if ( ! empty( $r['activation_key'] ) ) {
    160162                $sql['where'][] = $wpdb->prepare( "activation_key = %s", $r['activation_key'] );
    161163            }
    162164
    163             // User login
     165            // User login.
    164166            if ( ! empty( $r['user_login'] ) ) {
    165167                $sql['where'][] = $wpdb->prepare( "user_login = %s", $r['user_login'] );
    … …  
    174176        }
    175177
    176         // Implode WHERE clauses
     178        // Implode WHERE clauses.
    177179        $sql['where'] = 'WHERE ' . implode( ' AND ', $sql['where'] );
    178180
    … …  
    194196
    195197        // Used to calculate a diff between now & last
    196         // time an activation link has been resent
     198        // time an activation link has been resent.
    197199        $now = current_time( 'timestamp', true );
    198200
    … …  
    208210            }
    209211
    210             // Sent date defaults to date of registration
     212            // Sent date defaults to date of registration.
    211213            if ( ! empty( $signup->meta['sent_date'] ) ) {
    212214                $signup->date_sent = $signup->meta['sent_date'];
    … …  
    219221
    220222            /**
    221              * add a boolean in case the last time an activation link
    222              * has been sent happened less than a day ago
     223             * Add a boolean in case the last time an activation link
     224             * has been sent happened less than a day ago.
    223225             */
    224226            if ( $diff < 1 * DAY_IN_SECONDS ) {
    … …  
    258260     * @since 2.0.0
    259261     *
    260      * @param array $args
    261      *
     262     * @param array $args Array of arguments for signup addition.
    262263     * @return int|bool ID of newly created signup on success, false on
    263264     *                  failure.
    … …  
    320321     * @param string $user_email    User email address.
    321322     * @param array  $usermeta      Metadata associated with the signup.
    322      *
    323323     * @return int User id.
    324324     */
    … …  
    338338
    339339        // Update the user status to '2', ie "not activated"
    340         // (0 = active, 1 = spam, 2 = not active)
     340        // (0 = active, 1 = spam, 2 = not active).
    341341        $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->users} SET user_status = 2 WHERE ID = %d", $user_id ) );
    342342
    … …  
    347347        delete_user_option( $user_id, 'user_level'   );
    348348
    349         // Set any profile data
     349        // Set any profile data.
    350350        if ( bp_is_active( 'xprofile' ) ) {
    351351            if ( ! empty( $usermeta['profile_field_ids'] ) ) {
    … …  
    360360                    xprofile_set_field_data( $field_id, $user_id, $current_field );
    361361
    362                     // Save the visibility level
     362                    // Save the visibility level.
    363363                    $visibility_level = ! empty( $usermeta['field_' . $field_id . '_visibility'] ) ? $usermeta['field_' . $field_id . '_visibility'] : 'public';
    364364                    xprofile_set_field_visibility_level( $field_id, $user_id, $visibility_level );
    … …  
    383383     *
    384384     * @param int $user_id ID of the user being checked.
    385      *
    386385     * @return int|bool The status if found, otherwise false.
    387386     */
    … …  
    411410     *
    412411     * @param string $key Activation key.
    413      *
    414412     * @return bool True on success, false on failure.
    415413     */
    … …  
    422420
    423421        $activated = $wpdb->update(
    424             // Signups table
     422            // Signups table.
    425423            buddypress()->members->table_name_signups,
    426424            array(
    … …  
    431429                'activation_key' => $key,
    432430            ),
    433             // Data sanitization format
     431            // Data sanitization format.
    434432            array(
    435433                '%d',
    436434                '%s',
    437435            ),
    438             // WHERE sanitization format
     436            // WHERE sanitization format.
    439437            array(
    440438                '%s',
    … …  
    483481     * @since 2.0.0
    484482     *
    485      * @param array $args
    486      *
    487      * @return int The signup id
     483     * @param array $args Array of arguments for the signup update.
     484     * @return int The signup id.
    488485     */
    489486    public static function update( $args = array() ) {
    … …  
    503500
    504501        $wpdb->update(
    505             // Signups table
     502            // Signups table.
    506503            buddypress()->members->table_name_signups,
    507             // Data to update
     504            // Data to update.
    508505            array(
    509506                'meta' => serialize( $r['meta'] ),
    510507            ),
    511             // WHERE
     508            // WHERE.
    512509            array(
    513510                'signup_id' => $r['signup_id'],
    514511            ),
    515             // Data sanitization format
     512            // Data sanitization format.
    516513            array(
    517514                '%s',
    518515            ),
    519             // WHERE sanitization format
     516            // WHERE sanitization format.
    520517            array(
    521518                '%d',
    … …  
    539536     *
    540537     * @param array $signup_ids Single ID or list of IDs to resend.
    541      *
    542538     * @return array
    543539     */
    … …  
    572568            $meta['count_sent'] = $signup->count_sent + 1;
    573569
    574             // Send activation email
     570            // Send activation email.
    575571            if ( is_multisite() ) {
    576572                wpmu_signup_user_notification( $signup->user_login, $signup->user_email, $signup->activation_key, serialize( $meta ) );
    577573            } else {
    578574
    579                 // Check user status before sending email
     575                // Check user status before sending email.
    580576                $user_id = email_exists( $signup->user_email );
    581577
    582578                if ( ! empty( $user_id ) && 2 != self::check_user_status( $user_id ) ) {
    583579
    584                     // Status is not 2, so user's account has been activated
     580                    // Status is not 2, so user's account has been activated.
    585581                    $result['errors'][ $signup->signup_id ] = array( $signup->user_login, esc_html__( 'the sign-up has already been activated.', 'buddypress' ) );
    586582
    587                     // repair signups table
     583                    // Repair signups table.
    588584                    self::validate( $signup->activation_key );
    589585
    590586                    continue;
    591587
    592                 // Send the validation email
     588                // Send the validation email.
    593589                } else {
    594590                    bp_core_signup_send_validation_email( false, $signup->user_email, $signup->activation_key );
    … …  
    596592            }
    597593
    598             // Update metas
     594            // Update metas.
    599595            $result['resent'][] = self::update( array(
    600596                'signup_id' => $signup->signup_id,
    … …  
    629625     *
    630626     * @param array $signup_ids Single ID or list of IDs to activate.
    631      *
    632627     * @return array
    633628     */
    … …  
    670665                if ( empty( $user_id ) ) {
    671666
    672                     // Status is not 2, so user's account has been activated
     667                    // Status is not 2, so user's account has been activated.
    673668                    $result['errors'][ $signup->signup_id ] = array( $signup->user_login, esc_html__( 'the sign-up has already been activated.', 'buddypress' ) );
    674669
    675                     // repair signups table
     670                    // Repair signups table.
    676671                    self::validate( $signup->activation_key );
    677672
    678                 // we have a user id, account is not active, let's delete it
     673                // We have a user id, account is not active, let's delete it.
    679674                } else {
    680675                    $result['errors'][ $signup->signup_id ] = array( $signup->user_login, $user->get_error_message() );
    … …  
    712707     *
    713708     * @param array $signup_ids Single ID or list of IDs to delete.
    714      *
    715709     * @return array
    716710     */
    … …  
    748742                if ( 2 != self::check_user_status( $user_id ) ) {
    749743
    750                     // Status is not 2, so user's account has been activated
     744                    // Status is not 2, so user's account has been activated.
    751745                    $result['errors'][ $signup->signup_id ] = array( $signup->user_login, esc_html__( 'the sign-up has already been activated.', 'buddypress' ) );
    752746
    753                     // repair signups table
     747                    // Repair signups table.
    754748                    self::validate( $signup->activation_key );
    755749
    756                 // we have a user id, account is not active, let's delete it
     750                // We have a user id, account is not active, let's delete it.
    757751                } else {
    758752                    bp_core_delete_account( $user_id );
    … …  
    762756            if ( empty( $result['errors'][ $signup->signup_id ] ) ) {
    763757                $wpdb->delete(
    764                     // Signups table
     758                    // Signups table.
    765759                    buddypress()->members->table_name_signups,
    766                     // Where
     760                    // Where.
    767761                    array( 'signup_id' => $signup->signup_id, ),
    768                     // WHERE sanitization format
     762                    // WHERE sanitization format.
    769763                    array( '%d', )
    770764                );
Note: See TracChangeset for help on using the changeset viewer.