pods-framework / pods

classes/fields/avatar.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 9 and the first side effect is on line 2.

require_once PODS_DIR . 'classes/fields/file.php';

/**
 * PodsField_Avatar class.
 *
 * @package Pods\Fields
 */
class PodsField_Avatar extends PodsField_File {

	/**
	 * {@inheritdoc}
	 */
	public static $group = 'Relationships / Media';

	/**
	 * {@inheritdoc}
	 */
	public static $type = 'avatar';

	/**
	 * {@inheritdoc}
	 */
	public static $label = 'Avatar';

	/**
	 * {@inheritdoc}
	 */
	public static $pod_types = array(
		'user',
	);

	/**
	 * {@inheritdoc}
	 */
	public function setup() {

		self::$label = __( 'Avatar', 'pods' );
	}

	/**
	 * {@inheritdoc}
	 */
	public function options() {

		$options = parent::options();

		unset( $options[ static::$type . '_type' ], $options[ static::$type . '_allowed_extensions' ], $options[ static::$type . '_field_template' ], $options[ static::$type . '_wp_gallery_output' ], $options[ static::$type . '_wp_gallery_link' ], $options[ static::$type . '_wp_gallery_columns' ], $options[ static::$type . '_wp_gallery_random_sort' ], $options[ static::$type . '_wp_gallery_size' ] );

		return $options;

	}

	/**
	 * {@inheritdoc}
	 */
	public function input( $name, $value = null, $options = null, $pod = null, $id = null ) {

		$options = (array) $options;

		$options[ static::$type . '_type' ]              = 'images';
		$options[ static::$type . '_field_template' ]    = 'rows';
		$options[ static::$type . '_wp_gallery_output' ] = 0;

		parent::input( $name, $value, $options, $pod, $id );

	}

	/**
	 * Take over the avatar served from WordPress
	 *
	 * @param string            $avatar      Default Avatar Image output from WordPress.
	 * @param int|string|object $id_or_email A user ID, email address, or comment object.
	 * @param int               $size        Size of the avatar image.
	 * @param string            $default     URL to a default image to use if no avatar is available.
	 * @param string            $alt         Alternate text to use in image tag. Defaults to blank.
	 *
	 * @return string <img> tag for the user's avatar

Should the return type not be string|boolean?

	 */
	public function get_avatar( $avatar, $id_or_email, $size, $default = '', $alt = '' ) {

		// Don't replace for the Avatars section of the Discussion settings page.
		if ( is_admin() ) {
			$current_screen = get_current_screen();

			if ( null !== $current_screen && 'options-discussion' === $current_screen->id && 32 === $size ) {
				return $avatar;
			}
		}

		$user_id = 0;

		if ( is_numeric( $id_or_email ) && 0 < $id_or_email ) {
			$user_id = (int) $id_or_email;
		} elseif ( is_object( $id_or_email ) && isset( $id_or_email->user_id ) && 0 < $id_or_email->user_id ) {
			$user_id = (int) $id_or_email->user_id;
		} elseif ( is_object( $id_or_email ) && isset( $id_or_email->ID ) && isset( $id_or_email->user_login ) && 0 < $id_or_email->ID ) {
			$user_id = (int) $id_or_email->ID;
		} elseif ( ! is_object( $id_or_email ) && false !== strpos( $id_or_email, '@' ) ) {
			$_user = get_user_by( 'email', $id_or_email );

			if ( ! empty( $_user ) ) {
				$user_id = (int) $_user->ID;
			}
		}

		// Include PodsMeta if not already included.
		pods_meta();

		if ( 0 < $user_id && ! empty( PodsMeta::$user ) ) {
			$avatar_cached = pods_cache_get( $user_id . '-' . $size, 'pods_avatars' );

			if ( ! empty( $avatar_cached ) ) {
				$avatar = $avatar_cached;
			} else {
				$avatar_field = pods_transient_get( 'pods_avatar_field' );

				$user = current( PodsMeta::$user );

				if ( empty( $avatar_field ) ) {
					foreach ( $user['fields'] as $field ) {
						if ( 'avatar' === $field['type'] ) {
							$avatar_field = $field['name'];

							pods_transient_set( 'pods_avatar_field', $avatar_field );

							break;
						}
					}
				} elseif ( ! isset( $user['fields'][ $avatar_field ] ) ) {
					$avatar_field = false;
				}

				if ( ! empty( $avatar_field ) ) {
					$user_avatar = get_user_meta( $user_id, $avatar_field . '.ID', true );

get_user_meta() usage is highly discouraged, check VIP documentation on "Working with wp_users"

					if ( ! empty( $user_avatar ) ) {
						$attributes = array(
							'alt'   => '',
							'class' => 'avatar avatar-' . $size . ' photo',
						);

						if ( ! empty( $alt ) ) {
							$attributes['alt'] = $alt;
						}

						$user_avatar = pods_image( $user_avatar, array( $size, $size ), 0, $attributes );

						if ( ! empty( $user_avatar ) ) {
							$avatar = $user_avatar;

							pods_cache_set( $user_id . '-' . $size, $avatar, 'pods_avatars' );
						}
					}
				}//end if
			}//end if
		}//end if

		return $avatar;

	}

}