Reputation()

Description #

Reputation hooks.

Source #

File: addons/reputation/reputation.php

class Reputation extends \AnsPress\Singleton {

	/**
	 * Instance of this class.
	 *
	 * @var     object
	 * @since 4.1.8
	 */
	protected static $instance = null;

	/**
	 * Init class.
	 *
	 * @since unknown
	 * @since 4.2.0 Added hook `ap_settings_menu_features_groups`.
	 * @since 4.2.0 Renamed hook `ap_form_addon-reputation` to `ap_form_options_features_tag`.
	 */
	protected function __construct() {
		$this->register_default_events();

		ap_add_default_options(
			array(
				'user_page_title_reputations' => __( 'Reputations', 'anspress-question-answer' ),
				'user_page_slug_reputations'  => 'reputations',
			)
		);

		anspress()->add_action( 'ap_settings_menu_features_groups', $this, 'add_to_settings_page' );
		anspress()->add_action( 'ap_form_options_features_reputation', $this, 'load_options', 20 );
		anspress()->add_action( 'wp_ajax_ap_save_events', $this, 'ap_save_events' );
		anspress()->add_action( 'ap_after_new_question', $this, 'new_question', 10, 2 );
		anspress()->add_action( 'ap_after_new_answer', $this, 'new_answer', 10, 2 );
		anspress()->add_action( 'ap_untrash_question', $this, 'new_question', 10, 2 );
		anspress()->add_action( 'ap_trash_question', $this, 'trash_question', 10, 2 );
		anspress()->add_action( 'ap_before_delete_question', $this, 'trash_question', 10, 2 );
		anspress()->add_action( 'ap_untrash_answer', $this, 'new_answer', 10, 2 );
		anspress()->add_action( 'ap_trash_answer', $this, 'trash_answer', 10, 2 );
		anspress()->add_action( 'ap_before_delete_answer', $this, 'trash_answer', 10, 2 );
		anspress()->add_action( 'ap_select_answer', $this, 'select_answer' );
		anspress()->add_action( 'ap_unselect_answer', $this, 'unselect_answer' );
		anspress()->add_action( 'ap_vote_up', $this, 'vote_up' );
		anspress()->add_action( 'ap_vote_down', $this, 'vote_down' );
		anspress()->add_action( 'ap_undo_vote_up', $this, 'undo_vote_up' );
		anspress()->add_action( 'ap_undo_vote_down', $this, 'undo_vote_down' );
		anspress()->add_action( 'ap_publish_comment', $this, 'new_comment' );
		anspress()->add_action( 'ap_unpublish_comment', $this, 'delete_comment' );
		anspress()->add_filter( 'user_register', $this, 'user_register' );
		anspress()->add_action( 'delete_user', $this, 'delete_user' );
		anspress()->add_filter( 'ap_user_display_name', $this, 'display_name', 10, 2 );
		anspress()->add_filter( 'ap_pre_fetch_question_data', $this, 'pre_fetch_post' );
		anspress()->add_filter( 'ap_pre_fetch_answer_data', $this, 'pre_fetch_post' );
		anspress()->add_filter( 'bp_before_member_header_meta', $this, 'bp_profile_header_meta' );
		anspress()->add_filter( 'ap_user_pages', $this, 'ap_user_pages' );
		anspress()->add_filter( 'ap_ajax_load_more_reputation', $this, 'load_more_reputation' );
		anspress()->add_filter( 'ap_bp_nav', $this, 'ap_bp_nav' );
		anspress()->add_filter( 'ap_bp_page', $this, 'ap_bp_page', 10, 2 );
		anspress()->add_filter( 'ap_all_options', $this, 'ap_all_options', 10, 2 );
	}

	/**
	 * Add tags settings to features settings page.
	 *
	 * @param array $groups Features settings group.
	 * @return array
	 * @since 4.2.0
	 */
	public function add_to_settings_page( $groups ) {
		$groups['reputation'] = array(
			'label' => __( 'Reputation', 'anspress-question-answer' ),
			'info'  => __( 'Reputation event points can be adjusted here :', 'anspress-question-answer' ) . ' <a href="' . esc_url( admin_url( 'admin.php?page=anspress_options&active_tab=reputations' ) ) . '">' . __( 'Reputation Points', 'anspress-question-answer' ) . '</a>',
		);

		return $groups;
	}

	/**
	 * Register reputation options
	 */
	public function load_options() {
		$opt  = ap_opt();
		$form = array(
			'fields' => array(
				'user_page_title_reputations' => array(
					'label' => __( 'Reputations page title', 'anspress-question-answer' ),
					'desc'  => __( 'Custom title for user profile reputations page', 'anspress-question-answer' ),
					'value' => $opt['user_page_title_reputations'],
				),
				'user_page_slug_reputations'  => array(
					'label' => __( 'Reputations page slug', 'anspress-question-answer' ),
					'desc'  => __( 'Custom slug for user profile reputations page', 'anspress-question-answer' ),
					'value' => $opt['user_page_slug_reputations'],
				),
			),
		);

		return $form;
	}

	/**
	 * Register default reputation events.
	 */
	public function register_default_events() {
		$events_db = wp_cache_get( 'all', 'ap_get_all_reputation_events' );

		if ( false === $events_db ) {
			$events_db = ap_get_all_reputation_events();
		}

		// If already in DB return from here.
		if ( ! $events_db ) {
			$events = array(
				array(
					'slug'        => 'register',
					'label'       => __( 'Registration', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user account is created', 'anspress-question-answer' ),
					'icon'        => 'apicon-question',
					'activity'    => __( 'Registered', 'anspress-question-answer' ),
					'parent'      => 'question',
					'points'      => 10,
				),
				array(
					'slug'        => 'ask',
					'points'      => 2,
					'label'       => __( 'Asking', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user asks a question', 'anspress-question-answer' ),
					'icon'        => 'apicon-question',
					'activity'    => __( 'Asked a question', 'anspress-question-answer' ),
					'parent'      => 'question',
				),
				array(
					'slug'        => 'answer',
					'points'      => 5,
					'label'       => __( 'Answering', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user answers a question', 'anspress-question-answer' ),
					'icon'        => 'apicon-answer',
					'activity'    => __( 'Posted an answer', 'anspress-question-answer' ),
					'parent'      => 'answer',
				),
				array(
					'slug'        => 'comment',
					'points'      => 2,
					'label'       => __( 'Commenting', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user comments on question or answer', 'anspress-question-answer' ),
					'icon'        => 'apicon-comments',
					'activity'    => __( 'Commented on a post', 'anspress-question-answer' ),
					'parent'      => 'comment',
				),
				array(
					'slug'        => 'select_answer',
					'points'      => 2,
					'label'       => __( 'Selecting an Answer', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user selects an answer for their question', 'anspress-question-answer' ),
					'icon'        => 'apicon-check',
					'activity'    => __( 'Selected an answer as best', 'anspress-question-answer' ),
					'parent'      => 'question',
				),
				array(
					'slug'        => 'best_answer',
					'points'      => 10,
					'label'       => __( 'Answer selected as best', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user\'s answer is selected as best', 'anspress-question-answer' ),
					'icon'        => 'apicon-check',
					'activity'    => __( 'Answer was selected as best', 'anspress-question-answer' ),
					'parent'      => 'answer',
				),
				array(
					'slug'        => 'received_vote_up',
					'points'      => 10,
					'label'       => __( 'Received up vote', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user receives an upvote', 'anspress-question-answer' ),
					'icon'        => 'apicon-thumb-up',
					'activity'    => __( 'Received an upvote', 'anspress-question-answer' ),
				),
				array(
					'slug'        => 'received_vote_down',
					'points'      => -2,
					'label'       => __( 'Received down vote', 'anspress-question-answer' ),
					'description' => __( 'Points awarded when user receives a down vote', 'anspress-question-answer' ),
					'icon'        => 'apicon-thumb-down',
					'activity'    => __( 'Received a down vote', 'anspress-question-answer' ),
				),
				array(
					'slug'        => 'given_vote_up',
					'points'      => 0,
					'label'       => __( 'Gives an up vote', 'anspress-question-answer' ),
					'description' => __( 'Points taken from user when they give an up vote', 'anspress-question-answer' ),
					'icon'        => 'apicon-thumb-up',
					'activity'    => __( 'Given an up vote', 'anspress-question-answer' ),
				),
				array(
					'slug'        => 'given_vote_down',
					'points'      => 0,
					'label'       => __( 'Gives down vote', 'anspress-question-answer' ),
					'description' => __( 'Points taken from user when they give a down vote', 'anspress-question-answer' ),
					'icon'        => 'apicon-thumb-down',
					'activity'    => __( 'Given a down vote', 'anspress-question-answer' ),
				),
			);

			$custom_points = get_option( 'anspress_reputation_events', array() );

			foreach ( $events as $event ) {
				$points = isset( $custom_points[ $event['slug'] ] ) ? (int) $custom_points[ $event['slug'] ] : (int) $event['points'];

				ap_insert_reputation_event(
					$event['slug'],
					$event['label'],
					$event['description'],
					$points,
					! empty( $event['activity'] ) ? $event['activity'] : '',
					! empty( $event['parent'] ) ? $event['parent'] : ''
				);
			}

			$events_db = ap_get_all_reputation_events();

			wp_cache_set( 'all', $events_db, 'ap_get_all_reputation_events' );
		}

		if ( empty( $events_db ) ) {
			return;
		}

		// Fallback for register events.
		foreach ( $events_db as $event ) {
			$args = (array) $event;

			unset( $args['slug'] );

			ap_register_reputation_event( $event->slug, $args );
		}
	}

	/**
	 * Save reputation events.
	 */
	public function ap_save_events() {
		check_ajax_referer( 'ap-save-events', '__nonce' );

		if ( ! current_user_can( 'manage_options' ) ) {
			wp_die();
		}

		$events_point = ap_isset_post_value( 'events', 'r' );
		$points       = array();

		foreach ( ap_get_reputation_events() as $slug => $event ) {
			if ( isset( $events_point[ $slug ] ) ) {
				$points[ sanitize_text_field( $slug ) ] = (int) $events_point[ $slug ];
			}
		}

		if ( ! empty( $points ) ) {
			update_option( 'anspress_reputation_events', $points );
		}

		echo '<div class="notice notice-success is-dismissible"><p>' . esc_attr__( 'Successfully updated reputation points!', 'anspress-question-answer' ) . '</p></div>';

		wp_die();
	}

	/**
	 * Add reputation for user for new question.
	 *
	 * @param integer  $post_id Post ID.
	 * @param \WP_Post $_post Post object.
	 */
	public function new_question( $post_id, $_post ) {
		ap_insert_reputation( 'ask', $post_id, $_post->post_author );
	}

	/**
	 * Add reputation for new answer.
	 *
	 * @param integer  $post_id Post ID.
	 * @param \WP_Post $_post Post object.
	 */
	public function new_answer( $post_id, $_post ) {
		ap_insert_reputation( 'answer', $post_id, $_post->post_author );
	}

	/**
	 * Update reputation when a question is deleted.
	 *
	 * @param integer $post_id Post ID.
	 * @param object  $_post Post object.
	 */
	public function trash_question( $post_id, $_post ) {
		ap_delete_reputation( 'ask', $post_id, $_post->post_author );
	}

	/**
	 * Update reputation when a answer is deleted.
	 *
	 * @param integer $post_id Post ID.
	 * @param object  $_post   Post object.
	 */
	public function trash_answer( $post_id, $_post ) {
		ap_delete_reputation( 'answer', $post_id, $_post->post_author );
	}

	/**
	 * Award reputation when best answer selected.
	 *
	 * @param object $_post Post object.
	 */
	public function select_answer( $_post ) {
		ap_insert_reputation( 'best_answer', $_post->ID, $_post->post_author );
		$question = get_post( $_post->post_parent );

		// Award select answer points to question author only.
		if ( get_current_user_id() === (int) $_post->post_author ) {
			ap_insert_reputation( 'select_answer', $_post->ID );
		}
	}

	/**
	 * Award reputation when user get an upvote.
	 *
	 * @param object $_post Post object.
	 */
	public function unselect_answer( $_post ) {
		ap_delete_reputation( 'best_answer', $_post->ID, $_post->post_author );
		$question = get_post( $_post->post_parent );
		ap_delete_reputation( 'select_answer', $_post->ID, $question->post_author );
	}

	/**
	 * Award reputation when user receive an up vote.
	 *
	 * @param integer $post_id Post ID.
	 */
	public function vote_up( $post_id ) {
		$_post = get_post( $post_id );
		ap_insert_reputation( 'received_vote_up', $_post->ID, $_post->post_author );
		ap_insert_reputation( 'given_vote_up', $_post->ID );
	}

	/**
	 * Award reputation when user receive an down vote.
	 *
	 * @param integer $post_id Post ID.
	 */
	public function vote_down( $post_id ) {
		$_post = get_post( $post_id );
		ap_insert_reputation( 'received_vote_down', $_post->ID, $_post->post_author );
		ap_insert_reputation( 'given_vote_down', $_post->ID );
	}

	/**
	 * Award reputation when user recive an up vote.
	 *
	 * @param integer $post_id Post ID.
	 */
	public function undo_vote_up( $post_id ) {
		$_post = get_post( $post_id );
		ap_delete_reputation( 'received_vote_up', $_post->ID, $_post->post_author );
		ap_delete_reputation( 'given_vote_up', $_post->ID );
	}

	/**
	 * Award reputation when user recive an down vote.
	 *
	 * @param integer $post_id Post ID.
	 */
	public function undo_vote_down( $post_id ) {
		$_post = get_post( $post_id );
		ap_delete_reputation( 'received_vote_down', $_post->ID, $_post->post_author );
		ap_delete_reputation( 'given_vote_down', $_post->ID );
	}

	/**
	 * Award reputation on new comment.
	 *
	 * @param  object $comment WordPress comment object.
	 */
	public function new_comment( $comment ) {
		ap_insert_reputation( 'comment', $comment->comment_ID, $comment->user_id );
	}

	/**
	 * Undo reputation on deleting comment.
	 *
	 * @param  object $comment Comment object.
	 */
	public function delete_comment( $comment ) {
		ap_delete_reputation( 'comment', $comment->comment_ID, $comment->user_id );
	}

	/**
	 * Award reputation when user register.
	 *
	 * @param integer $user_id User Id.
	 */
	public function user_register( $user_id ) {
		ap_insert_reputation( 'register', $user_id, $user_id );
	}

	/**
	 * Delete all reputation of user when user get deleted.
	 *
	 * @param integer $user_id User ID.
	 */
	public function delete_user( $user_id ) {
		global $wpdb;
		$delete = $wpdb->delete( $wpdb->ap_reputations, array( 'repu_user_id' => $user_id ), array( '%d' ) ); // WPCS: db call okay, db cache okay.

		if ( false !== $delete ) {
			do_action( 'ap_bulk_delete_reputations_of_user', $user_id );
		}
	}

	/**
	 * Append user reputations in display name.
	 *
	 * @param string $name User display name.
	 * @param array  $args Arguments.
	 * @return string
	 */
	public function display_name( $name, $args ) {
		if ( $args['user_id'] > 0 ) {
			if ( $args['html'] ) {
				$reputation = ap_get_user_reputation_meta( $args['user_id'] );

				if ( ap_is_addon_active( 'buddypress.php' ) && function_exists( 'bp_core_get_userlink' ) ) {
					return $name . '<a href="' . ap_user_link( $args['user_id'] ) . 'qa/reputations/" class="ap-user-reputation" title="' . __( 'Reputation', 'anspress-question-answer' ) . '">' . $reputation . '</a>';
				} else {
					return $name . '<a href="' . ap_user_link( $args['user_id'] ) . 'reputations/" class="ap-user-reputation" title="' . __( 'Reputation', 'anspress-question-answer' ) . '">' . $reputation . '</a>';
				}
			}
		}

		return $name;
	}

	/**
	 * Pre fetch user reputations.
	 *
	 * @param array $ids Pre fetching ids.
	 */
	public function pre_fetch_post( $ids ) {
		if ( ! empty( $ids['user_ids'] ) ) {
			ap_get_users_reputation( $ids['user_ids'] );
		}
	}

	/**
	 * Show reputation points of user in BuddyPress profile meta.
	 */
	public function bp_profile_header_meta() {
		echo wp_kses_post(
			'<span class="ap-user-meta ap-user-meta-reputation">' .
			sprintf(
				// translators: Placeholder contains reputation points.
				__( '%s Reputation', 'anspress-question-answer' ),
				ap_get_user_reputation_meta( bp_displayed_user_id() )
			) .
			'</span>'
		);
	}

	/**
	 * Adds reputations tab in AnsPress authors page.
	 */
	public function ap_user_pages() {
		anspress()->user_pages[] = array(
			'slug'  => 'reputations',
			'label' => __( 'Reputations', 'anspress-question-answer' ),
			'icon'  => 'apicon-reputation',
			'cb'    => array( $this, 'reputation_page' ),
			'order' => 5,
		);
	}

	/**
	 * Display reputation tab content in AnsPress author page.
	 */
	public function reputation_page() {
		$user_id = get_queried_object_id();

		$reputations = new \AnsPress_Reputation_Query( array( 'user_id' => $user_id ) );
		include ap_get_theme_location( 'addons/reputation/index.php' );
	}

	/**
	 * Ajax callback for loading more reputations.
	 */
	public function load_more_reputation() {
		check_admin_referer( 'load_more_reputation', '__nonce' );

		$user_id = ap_sanitize_unslash( 'user_id', 'r' );
		$paged   = ap_sanitize_unslash( 'current', 'r', 1 ) + 1;

		ob_start();
		$reputations = new \AnsPress_Reputation_Query(
			array(
				'user_id' => $user_id,
				'paged'   => $paged,
			)
		);
		while ( $reputations->have() ) :
			$reputations->the_reputation();
			include ap_get_theme_location( 'addons/reputation/item.php' );
		endwhile;
		$html = ob_get_clean();

		$paged = $reputations->total_pages > $paged ? $paged : 0;

		ap_ajax_json(
			array(
				'success' => true,
				'args'    => array(
					'ap_ajax_action' => 'load_more_reputation',
					'__nonce'        => wp_create_nonce( 'load_more_reputation' ),
					'current'        => (int) $paged,
					'user_id'        => $user_id,
				),
				'html'    => $html,
				'element' => '.ap-reputations tbody',
			)
		);
	}

	/**
	 * Add reputations nav link in BuddyPress profile.
	 *
	 * @param array $nav Nav menu.
	 * @return array
	 */
	public function ap_bp_nav( $nav ) {
		$nav[] = array(
			'name' => __( 'Reputations', 'anspress-question-answer' ),
			'slug' => 'reputations',
		);
		return $nav;
	}

	/**
	 * Add BuddyPress reputation page callback.
	 *
	 * @param array  $cb       Callback function.
	 * @param string $template Template.
	 * @return array
	 */
	public function ap_bp_page( $cb, $template ) {
		if ( 'reputations' === $template ) {
			return array( $this, 'bp_reputation_page' );
		}
		return $cb;
	}

	/**
	 * Display reputation on buddypress page.
	 *
	 * @since unknown
	 */
	public function bp_reputation_page() {
		$user_id = bp_displayed_user_id();

		$reputations = new \AnsPress_Reputation_Query( array( 'user_id' => $user_id ) );
		include ap_get_theme_location( 'addons/reputation/index.php' );
	}

	/**
	 * Add reputation events option in AnsPress options.
	 *
	 * @param array $all_options Options.
	 * @return array
	 * @since 4.1.0
	 */
	public function ap_all_options( $all_options ) {
		$all_options['reputations'] = array(
			'label'    => __( '⚙ Reputations', 'anspress-question-answer' ),
			'template' => 'reputation-events.php',
		);

		return $all_options;
	}
}

Leave a Reply

Your email address will not be published.

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Add your comment