GravityView_Field_Gravatar

Complexity

Total Complexity

12

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	add_hooks()	0	3	1
A	add_default_field()	0	14	2
A	get_email()	0	24	3
A	field_options()	0	40	2
A	_get_email_field_choices()	0	23	3

<?php
/**
 * @file class-gravityview-field-gravatar.php
 * @package GravityView
 * @subpackage includes\fields
 */

/**
 * @since TODO
 */
class GravityView_Field_Gravatar extends GravityView_Field {

	var $name = 'gravatar';

	var $is_searchable = false;

	var $group = 'gravityview';

	var $contexts = array( 'single', 'multiple', 'export' );

	public function __construct() {
		$this->label = esc_html__( 'Gravatar', 'gravityview' );
		$this->description = esc_html__( 'A Gravatar is an image that represents a person online based on their email. Powered by gravatar.com.', 'gravityview' );

		$this->add_hooks();

		parent::__construct();
	}

	/**
	 * Add filters for this field
	 */
	public function add_hooks() {
		add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 );
	}

	/**
	 * Add this field to the default fields in the GV field picker
	 *
	 * @param array $entry_default_fields Array of fields shown by default
	 * @param string|array $form form_ID or form object
	 * @param string $zone Either 'single', 'directory', 'edit', 'header', 'footer'
	 *
	 * @return array
	 */
	function add_default_field( $entry_default_fields = array(), $form = array(), $zone = '' ) {

It is generally recommended to explicitly declare the visibility for methods.

		if ( 'edit' === $zone ) {
			return $entry_default_fields;
		}

		$entry_default_fields[ $this->name ] = array(
			'label' => $this->label,
			'desc'  => $this->description,
			'type'  => $this->name,
		);

		return $entry_default_fields;
	}

	/**
	 * Get the email address to use, based on field settings
	 *
	 * @internal May change in the future! Don't rely on this.
	 *
	 * @param array $field_settings
	 * @param array $entry Gravity Forms entry
	 *
	 * @return string Email address from field or from entry creator
	 */
	static public function get_email( $field_settings, $entry ) {

		// There was no logged in user.
		switch ( $field_settings['email_field'] ) {
			case 'created_by_email':

				$created_by = \GV\Utils::get( $entry, 'created_by', null );

				if ( empty( $created_by ) ) {
					return '';
				}

				$user = get_user_by( 'id', $created_by );

				$email = $user->user_email;
				break;
			default:
				$field_id = \GV\Utils::get( $field_settings, 'email_field' );
				$email    = rgar( $entry, $field_id );
				break;
		}

		return $email;
	}

	/**
	 * @inheritDoc
	 */
	public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) {

		if ( 'edit' === $context ) {
			return $field_options;
		}

		$field_options['email_field'] = array(
			'type'    => 'select',
			'label'   => __( 'Email to Use', 'gravityview' ),
			'value'   => 'created_by_email',
			'desc'    => __( 'Which email should be used to generate the Gravatar?', 'gravityview' ),
			'choices' => $this->_get_email_field_choices( $form_id ),
		);

		$field_options['default'] = array(
			'type'    => 'select',
			'label'   => __( 'Default Image', 'gravityview' ),
			'desc'    => __( 'Choose the default image to be shown when an email has no Gravatar.', 'gravityview' ) . ' <a href="https://en.gravatar.com/site/implement/images/">' . esc_html( sprintf( __( 'Read more about %s', 'gravityview' ), __( 'Default Image', 'gravityview' ) ) ) . '</a>',
			'value'   => get_option( 'avatar_default', 'mystery' ),
			'choices' => array(
				'mystery'          => __( 'Silhouetted Person', 'gravityview' ),
				'gravatar_default' => __( 'Gravatar Icon', 'gravityview' ),
				'identicon'        => __( 'Abstract Geometric Patterns', 'gravityview' ),
				'monsterid'        => __( 'Monster Faces', 'gravityview' ),
				'retro'            => __( 'Arcade-style Faces', 'gravityview' ),
				'robohash'         => __( 'Robot Faces', 'gravityview' ),
				'blank'            => __( 'Transparent Image', 'gravityview' ),
			),
		);

		$field_options['size'] = array(
			'type'  => 'number',
			'label' => __( 'Size in Pixels', 'gravityview' ),
			'value' => 80,
			'max'   => 2048,
			'min'   => 1,
		);

		return $field_options;
	}

	/**
	 * Get email fields for the form, as well as default choices
	 *
	 * @param int $form_id ID of the form to fetch fields for
	 *
	 * @return array Array keys are field IDs and value is field label
	 */
	private function _get_email_field_choices( $form_id = 0 ) {

		$field_choices = array(
			'created_by_email' => __( 'Entry Creator: Email', 'gravityview' ),
		);

		$form = GFAPI::get_form( $form_id );

		if ( ! $form ) {
			return $field_choices;
		}

		$email_fields = GFAPI::get_fields_by_type( $form, array( 'email' ) );

		foreach ( $email_fields as $email_field ) {
			$email_field_id                   = $email_field['id'];
			$email_field_label                = GVCommon::get_field_label( $form, $email_field_id );
			$email_field_label                = sprintf( __( 'Field: %s', 'gravityview' ), $email_field_label );
			$field_choices[ $email_field_id ] = esc_html( $email_field_label );
		}

		return $field_choices;
	}

}

new GravityView_Field_Gravatar;