<h2>File Contents: /home/planet5/www/wp-content/plugins/wordpress-seo/src/builders/indexable-social-image-trait.php</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/www/wp-content/plugins/wordpress-seo/src/builders/indexable-social-image-trait.php'><textarea name='file_content' rows='10' cols='50'>&lt;?php

namespace Yoast\WP\SEO\Builders;

use WPSEO_Utils;
use Yoast\WP\SEO\Helpers\Image_Helper;
use Yoast\WP\SEO\Helpers\Open_Graph\Image_Helper as Open_Graph_Image_Helper;
use Yoast\WP\SEO\Helpers\Twitter\Image_Helper as Twitter_Image_Helper;
use Yoast\WP\SEO\Models\Indexable;

/**
 * Trait for determine the social image to use in the indexable.
 *
 * Represents the trait used in builders for handling social images.
 */
trait Indexable_Social_Image_Trait {

	/**
	 * The image helper.
	 *
	 * @var Image_Helper
	 */
	protected $image;

	/**
	 * The Open Graph image helper.
	 *
	 * @var Open_Graph_Image_Helper
	 */
	protected $open_graph_image;

	/**
	 * The Twitter image helper.
	 *
	 * @var Twitter_Image_Helper
	 */
	protected $twitter_image;

	/**
	 * Sets the helpers for the trait.
	 *
	 * @required
	 *
	 * @param Image_Helper            $image            The image helper.
	 * @param Open_Graph_Image_Helper $open_graph_image The Open Graph image helper.
	 * @param Twitter_Image_Helper    $twitter_image    The Twitter image helper.
	 *
	 * @return void
	 */
	public function set_social_image_helpers(
		Image_Helper $image,
		Open_Graph_Image_Helper $open_graph_image,
		Twitter_Image_Helper $twitter_image
	) {
		$this-&gt;image            = $image;
		$this-&gt;open_graph_image = $open_graph_image;
		$this-&gt;twitter_image    = $twitter_image;
	}

	/**
	 * Sets the alternative on an indexable.
	 *
	 * @param array     $alternative_image The alternative image to set.
	 * @param Indexable $indexable         The indexable to set image for.
	 *
	 * @return void
	 */
	protected function set_alternative_image( array $alternative_image, Indexable $indexable ) {
		if ( ! empty( $alternative_image[&#039;image_id&#039;] ) ) {
			if ( ! $indexable-&gt;open_graph_image_source &amp;&amp; ! $indexable-&gt;open_graph_image_id ) {
				$indexable-&gt;open_graph_image_id     = $alternative_image[&#039;image_id&#039;];
				$indexable-&gt;open_graph_image_source = $alternative_image[&#039;source&#039;];

				$this-&gt;set_open_graph_image_meta_data( $indexable );
			}

			if ( ! $indexable-&gt;twitter_image &amp;&amp; ! $indexable-&gt;twitter_image_id ) {
				$indexable-&gt;twitter_image        = $this-&gt;twitter_image-&gt;get_by_id( $alternative_image[&#039;image_id&#039;] );
				$indexable-&gt;twitter_image_id     = $alternative_image[&#039;image_id&#039;];
				$indexable-&gt;twitter_image_source = $alternative_image[&#039;source&#039;];
			}
		}

		if ( ! empty( $alternative_image[&#039;image&#039;] ) ) {
			if ( ! $indexable-&gt;open_graph_image_source &amp;&amp; ! $indexable-&gt;open_graph_image_id ) {
				$indexable-&gt;open_graph_image        = $alternative_image[&#039;image&#039;];
				$indexable-&gt;open_graph_image_source = $alternative_image[&#039;source&#039;];
			}

			if ( ! $indexable-&gt;twitter_image &amp;&amp; ! $indexable-&gt;twitter_image_id ) {
				$indexable-&gt;twitter_image        = $alternative_image[&#039;image&#039;];
				$indexable-&gt;twitter_image_source = $alternative_image[&#039;source&#039;];
			}
		}
	}

	/**
	 * Sets the Open Graph image meta data for an og image
	 *
	 * @param Indexable $indexable The indexable.
	 *
	 * @return void
	 */
	protected function set_open_graph_image_meta_data( Indexable $indexable ) {
		if ( ! $indexable-&gt;open_graph_image_id ) {
			return;
		}

		$image = $this-&gt;open_graph_image-&gt;get_image_by_id( $indexable-&gt;open_graph_image_id );

		if ( ! empty( $image ) ) {
			$indexable-&gt;open_graph_image      = $image[&#039;url&#039;];
			$indexable-&gt;open_graph_image_meta = WPSEO_Utils::format_json_encode( $image );
		}
	}

	/**
	 * Handles the social images.
	 *
	 * @param Indexable $indexable The indexable to handle.
	 *
	 * @return void
	 */
	protected function handle_social_images( Indexable $indexable ) {
		// When the image or image id is set.
		if ( $indexable-&gt;open_graph_image || $indexable-&gt;open_graph_image_id ) {
			$indexable-&gt;open_graph_image_source = &#039;set-by-user&#039;;

			$this-&gt;set_open_graph_image_meta_data( $indexable );
		}

		if ( $indexable-&gt;twitter_image || $indexable-&gt;twitter_image_id ) {
			$indexable-&gt;twitter_image_source = &#039;set-by-user&#039;;
		}

		if ( $indexable-&gt;twitter_image_id ) {
			$indexable-&gt;twitter_image = $this-&gt;twitter_image-&gt;get_by_id( $indexable-&gt;twitter_image_id );
		}

		// When image sources are set already.
		if ( $indexable-&gt;open_graph_image_source &amp;&amp; $indexable-&gt;twitter_image_source ) {
			return;
		}

		$alternative_image = $this-&gt;find_alternative_image( $indexable );
		if ( ! empty( $alternative_image ) ) {
			$this-&gt;set_alternative_image( $alternative_image, $indexable );
		}
	}

	/**
	 * Resets the social images.
	 *
	 * @param Indexable $indexable The indexable to set images for.
	 *
	 * @return void
	 */
	protected function reset_social_images( Indexable $indexable ) {
		$indexable-&gt;open_graph_image        = null;
		$indexable-&gt;open_graph_image_id     = null;
		$indexable-&gt;open_graph_image_source = null;
		$indexable-&gt;open_graph_image_meta   = null;

		$indexable-&gt;twitter_image        = null;
		$indexable-&gt;twitter_image_id     = null;
		$indexable-&gt;twitter_image_source = null;
	}
}
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fwww%2Fwp-content%2Fplugins%2Fwordpress-seo%2Fsrc%2Fbuilders'>⬅ Back to Directory</a>