bp-xprofile-relationship-field.php

<?php

/**
 * The BuddyPress XProfile Relationship Field Plugin
 *
 * @package BP XProfile Relationship Field
 * @subpackage Main
 */

/**
 * Plugin Name:       BP XProfile Relationship Field
 * Description:       Add a relationship profile field type to BuddyPress to connect members with other objects
 * Plugin URI:        https://github.com/lmoffereins/bp-xprofile-relationship-field
 * Version:           1.2.0
 * Author:            Laurens Offereins
 * Author URI:        https://github.com/lmoffereins
 * Text Domain:       bp-xprofile-relationship-field
 * Domain Path:       /languages/
 * GitHub Plugin URI: lmoffereins/bp-xprofile-relationship-field
 */

// Exit if accessed directly
defined( 'ABSPATH' ) || exit;

if ( ! class_exists( 'BP_XProfile_Relationship_Field' ) ) :
/**
 * Main Plugin Class
 *
 * @since 1.0.0
 */
final class BP_XProfile_Relationship_Field {

	/**
	 * The profile field type
	 *
	 * @since 1.0.0
	 * @var string
	 */
	public $type = 'relationship';

	/**
	 * Setup singleton pattern and return the instance
	 *
	 * @since 1.0.0
	 *
	 * @return BP_XProfile_Relationship_Field
	 */
	public static function instance() {
		static $instance = null;

		if ( null === $instance ) {
			$instance = new BP_XProfile_Relationship_Field;
			$instance->setup_globals();
			$instance->includes();
			$instance->setup_actions();
		}

		return $instance;
	}

	/**
	 * Prevent object from created more than once
	 *
	 * @since 1.0.0
	 */
	private function __construct() { /* Do nothin' */ }

	/** Private Methods *******************************************************/

	/**
	 * Setup class defaults
	 *
	 * @since 1.0.0
	 */
	private function setup_globals() {

		/** Version **************************************************/

		$this->version      = '1.2.0';

		/** Plugin ***************************************************/

		$this->file         = __FILE__;
		$this->basename     = plugin_basename( $this->file );
		$this->plugin_dir   = plugin_dir_path( $this->file );
		$this->plugin_url   = plugin_dir_url(  $this->file );

		// Includes
		$this->includes_dir = trailingslashit( $this->plugin_dir . 'includes' );
		$this->includes_url = trailingslashit( $this->plugin_url . 'includes' );

		// Assets
		$this->assets_dir   = trailingslashit( $this->plugin_dir . 'assets' );
		$this->assets_url   = trailingslashit( $this->plugin_url . 'assets' );

		// Languages
		$this->lang_dir     = trailingslashit( $this->plugin_dir . 'languages' );

		/** Plugin ***************************************************/

		$this->domain       = 'bp-xprofile-relationship-field';
	}

	/**
	 * Include the required files
	 *
	 * @since 1.1.0
	 */
	private function includes() {
		require( $this->includes_dir . 'functions.php' );
	}

	/**
	 * Setup the default hooks and actions
	 *
	 * @since 1.0.0
	 */
	private function setup_actions() {

		// Plugin
		add_action( 'init', array( $this, 'load_textdomain' ) );

		// Main
		add_filter( 'bp_xprofile_get_field_types',    array( $this, 'add_field_type'     )        );
		add_filter( 'bp_field_css_classes',           array( $this, 'field_css_classes'  )        );
		add_filter( 'bp_xprofile_field_get_children', array( $this, 'field_get_children' ), 10, 3 );

		// Admin
		add_action( 'xprofile_field_after_save', array( $this, 'save_field'            ) );
		add_action( 'admin_enqueue_scripts',     array( $this, 'admin_enqueue_scripts' ) );

		// Parse data
		add_filter( 'bp_get_profile_field_data', array( $this, 'display_data' ),  1, 2 );
		add_filter( 'bp_xprofile_get_groups',    array( $this, 'get_groups'   ), 50, 2 );
	}

	/** Plugin ****************************************************************/

	/**
	 * Load the translation file for current language
	 *
	 * Note that custom translation files inside the Plugin folder will
	 * be removed on Plugin updates. If you're creating custom translation
	 * files, please use the global language folder.
	 *
	 * @since 1.0.0
	 *
	 * @uses apply_filters() Calls 'plugin_locale' with {@link get_locale()} value
	 * @uses load_textdomain() To load the textdomain
	 * @uses load_plugin_textdomain() To load the plugin textdomain
	 */
	public function load_textdomain() {

		// Traditional WordPress plugin locale filter
		$locale        = apply_filters( 'plugin_locale', get_locale(), $this->domain );
		$mofile        = sprintf( '%1$s-%2$s.mo', $this->domain, $locale );

		// Setup paths to current locale file
		$mofile_local  = $this->lang_dir . $mofile;
		$mofile_global = WP_LANG_DIR . '/bp-xprofile-relationship-field/' . $mofile;

		// Look in global /wp-content/languages/bp-xprofile-relationship-field folder
		load_textdomain( $this->domain, $mofile_global );

		// Look in local /wp-content/plugins/bp-xprofile-relationship-field/languages/ folder
		load_textdomain( $this->domain, $mofile_local );

		// Look in global /wp-content/languages/plugins/
		load_plugin_textdomain( $this->domain );
	}

	/** Public Methods ********************************************************/

	/**
	 * Register the relationship field type
	 *
	 * @since 1.0.0
	 *
	 * @param array $fields Fields
	 * @return array Fields
	 */
	public function add_field_type( $fields ) {

		// Declare field type
		require_once( $this->includes_dir . 'class-bp-xprofile-field-type-relationship.php' );

		// Add field type
		if ( class_exists( 'BP_XProfile_Field_Type_Relationship' ) ) {
			$fields[ bp_xprofile_relationship_field_type() ] = 'BP_XProfile_Field_Type_Relationship';
		}

		return $fields;
	}

	/**
	 * Modify the field css classes
	 *
	 * @since 1.2.0
	 *
	 * @param  array $classes Field classes
	 * @return array Field classes
	 */
	public function field_css_classes( $classes ) {
		global $profile_template;

		// Relationship field
		if ( bp_xprofile_is_relationship_field() ) {

			// Add selection method class to benefit native type styling
			$classes[] = 'field_type_' . sanitize_title( $profile_template->field->selection_method );
		}

		return $classes;
	}

	/**
	 * Modify the field's children
	 *
	 * @since 1.2.0
	 *
	 * @param  array             $children    Field children
	 * @param  bool              $for_editing Whether the field is for editing
	 * @param  BP_XProfile_Field $field       Field data
	 * @return array Field children
	 */
	public function field_get_children( $children, $for_editing, $field ) {

		// Relationship field
		if ( bp_xprofile_is_relationship_field( $field ) ) {
			$children = array();

			// Get field options
			foreach ( bp_xprofile_relationship_field_options( $field ) as $key => $option ) {

				// Append default option details
				$children[] = (object) array(
					'id'                => "{$option->id}",
					'group_id'          => '0',
					'parent_id'         => "{$field->id}",
					'type'              => 'option',
					'name'              => $option->name,
					'description'       => '',
					'is_required'       => '0',
					'is_default_option' => '0',
					'field_order'       => '0',
					'option_order'      => "{$key}",
					'order_by'          => '',
					'can_delete'        => '0'
				);
			}
		}

		return $children;
	}

	/** Admin *****************************************************************/

	/**
	 * Enqueue styles and scripts for the admin pages
	 *
	 * @since 1.0.0
	 */
	public function admin_enqueue_scripts() {

		// Bail when not on profile fields or edit page
		if ( empty( $_GET['page'] ) || ! in_array( $_GET['page'], array( 'bp-profile-setup', 'bp-profile-edit' ) ) )
			return;

		wp_enqueue_style( 'bp-xprofile-relationship-field-admin', $this->assets_url . 'admin.css', array( 'xprofile-admin-css' ), $this->version );
	}

	/** BP_XProfile_Field *****************************************************/

	/**
	 * Return the field type meta keys
	 *
	 * @since 1.0.0
	 *
	 * @uses apply_filters() Calls 'bp_xprofile_relationship_field_meta_keys'
	 * @return array Meta keys
	 */
	public function get_meta_keys() {

		/**
		 * Filter the available field meta keys for the relationship field type
		 *
		 * @since 1.0.0
		 *
		 * @param array $meta_keys The relationship field meta keys
		 */
		return (array) apply_filters( 'bp_xprofile_relationship_field_meta_keys', array(
			'related_to',
			'selection_method',
			'order_type', // For order_by value
		) );
	}

	/**
	 * Setup field meta on field object population
	 *
	 * @since 1.0.0
	 *
	 * @param BP_XProfile_Field $field Field object
	 * @return BP_XProfile_Field Field object
	 */
	public function populate_field( $field ) {

		// Populate field meta
		foreach ( $this->get_meta_keys() as $meta ) {
			$field->$meta = bp_xprofile_get_meta( $field->id, 'field', $meta );
		}

		return $field;
	}

	/**
	 * Modify the display value for the current field
	 *
	 * @since 1.0.0
	 *
	 * @global BP_XProfile_Field $field
	 *
	 * @uses apply_filters() Calls 'bp_xprofile_relationship_field_display_value'
	 *
	 * @param string $field_value Field value
	 * @param string $field_type Field type
	 * @param int $field_id Field id
	 * @return string Field display value
	 */
	public function display_field( $field_value, $field_type, $field_id = 0 ) {

		// Bail when this is not a relationship field
		if ( bp_xprofile_relationship_field_type() !== $field_type ) {
			return $field_value;
		}

		// Get field. Default to the global field
		if ( ! empty( $field_id ) ) {
			$field = xprofile_get_field( $field_id );
		} elseif ( isset( $GLOBALS['field'] ) ) {
			$field = $GLOBALS['field'];
		} else {
			return $field_value;
		}

		// Get possible field values
		$options = bp_xprofile_relationship_field_options( $field );
		$options_id_by_name = array_combine( wp_list_pluck( $options, 'id' ), wp_list_pluck( $options, 'name' ) );

		// Work with the provided value
		$values     = explode( ',', $field_value );
		$new_values = array();

		// Walk all values
		foreach ( (array) $values as $value ) {

			// Sanitize
			$value = trim( $value );

			// Find option by id value
			if ( $option_by_value = wp_list_filter( $options, array( 'id' => (int) $value ) ) ) {

				// Use option_by_value name if item was found
				$new_values[] = bp_xprofile_relationship_field_option_value( reset( $option_by_value ) );

			// Find option by name value. Compare sanitized titles
			} elseif ( $id_by_name = array_search( sanitize_title( $value ), array_map( 'sanitize_title', $options_id_by_name ) ) ) {

				// Get the option by value
				$option_by_value = wp_list_filter( $options, array( 'id' => (int) $id_by_name ) );

				// Use option_by_value name if item was found
				$new_values[] = bp_xprofile_relationship_field_option_value( reset( $option_by_value ) );

			// Option was not found, display stored value
			} else {
				$new_values[] = $value;
			}
		}

		$values = implode( ', ', $new_values );

		/**
		 * Filter the total display value of the relationship field
		 *
		 * @since 1.0.0
		 *
		 * @param string $values Field display value
		 * @param BP_XProfile_Field $field The current field object
		 * @param string $field_value The original unfiltered value
		 */
		return apply_filters( 'bp_xprofile_relationship_field_display_value', $values, $field, $field_value );
	}

	/**
	 * Modify the display data for the current field
	 *
	 * This is only relevant for displaying data. Queried relationship data
	 * is always unfiltered.
	 *
	 * @since 1.0.3
	 *
	 * @global BP_XProfile_Field $field
	 *
	 * @param mixed $data Field data
	 * @param array $args Field data arguments
	 * @return mixed Field data
	 */
	public function display_data( $data, $args = array() ) {

		// Get the field's ID
		if ( ! empty( $args['field'] ) ) {
			$field_id = is_numeric( $args['field'] ) ? $args['field'] : xprofile_get_field_id_from_name( $args['field'] );

		// Bail when the field is unknown
		} else {
			return $data;
		}

		// Get the field
		$field = xprofile_get_field( $field_id );

		// Get possible field values
		$options = bp_xprofile_relationship_field_options( $field );
		$options_id_by_name = array_combine( wp_list_pluck( $options, 'id' ), wp_list_pluck( $options, 'name' ) );

		// Work with the provided value
		$new_values = array();

		// Walk all values
		foreach ( (array) $data as $value ) {

			// Sanitize
			$value = trim( $value );

			// Find option by id value
			if ( $option_by_value = wp_list_filter( $options, array( 'id' => (int) $value ) ) ) {
				$option = reset( $option_by_value );

				// Use option_by_value name if item was found
				if ( $option && isset( $option->name ) ) {
					$new_values[] = $option->name;
				}

			// Find option by name value. Compare sanitized titles
			} elseif ( $id_by_name = array_search( sanitize_title( $value ), array_map( 'sanitize_title', $options_id_by_name ) ) ) {

				// Get the option by value
				$option_by_value = wp_list_filter( $options, array( 'id' => (int) $id_by_name ) );
				$option = reset( $option_by_value );

				// Use option_by_value name if item was found
				if ( $option && isset( $option->name ) ) {
					$new_values[] = $option->name;
				}

			// Option was not found, display stored value
			} else {
				$new_values[] = $value;
			}
		}

		$data = $new_values;

		return $data;
	}

	/**
	 * Modify the queried profile groups
	 *
	 * Ensures that item keys are parsed when groups are fetched with
	 * raw field data.
	 * 
	 * @since 1.1.3
	 *
	 * @param array $groups Profile groups
	 * @param array $args Query arguments
	 * @return array Profile groups
	 */
	public function get_groups( $groups, $args ) {
		$fetch_fields     = isset( $args['fetch_fields'] ) && $args['fetch_fields'];
		$fetch_field_data = isset( $args['fetch_field_data'] ) && $args['fetch_field_data'];
		
		// When fetching fields with raw field data
		if ( $fetch_fields && $fetch_field_data ) {

			// Walk fields in their groups
			foreach ( $groups as $gk => $group ) {
				foreach ( $group->fields as $fk => $field ) {

					// Skip when the field is not of relationship type
					if ( bp_xprofile_relationship_field_type() !== $field->type )
						continue;

					// Get field's relationship option
					$options   = bp_xprofile_relationship_field_options( $field );
					$option_id = (int) $field->data->value;
					$option    = wp_list_filter( $options, array( 'id' => $option_id ) );

					// Skip when the option does not exist
					if ( ! $option )
						continue;

					// Set the option ID
					$field->data->option_id = $option_id;

					// Define value as the related item's title
					$option = reset( $option );
					$field->data->value = $option->name;

					// Overwrite field object
					$groups[ $gk ]->fields[ $fk ] = $field;
				}
			}
		}

		return $groups;
	}

	/**
	 * Save field object
	 *
	 * @since 1.0.0
	 *
	 * @param BP_XProfile_Field $field Field object
	 */
	public function save_field( $field ) {

		// Type is posted escaped
		$type = esc_attr( bp_xprofile_relationship_field_type() );

		// Save field meta
		foreach ( $this->get_meta_keys() as $meta ) {

			// Skip when the option was not posted
			if ( ! isset( $_POST[ "{$meta}_{$type}" ] ) )
				continue;

			// Update
			bp_xprofile_update_meta( $field->id, 'field', $meta, $_POST[ "{$meta}_{$type}" ] );
		}
	}
}

/**
 * Instantiate plugin class
 *
 * @since 1.0.0
 *
 * @uses BP_XProfile_Relationship_Field
 */
function bp_xprofile_relationship_field() {
	return BP_XProfile_Relationship_Field::instance();
}

// Initiate when BP has loaded
add_action( 'bp_xprofile_setup_actions', 'bp_xprofile_relationship_field' );

endif; // class_exists