Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Builders;

[2] Fix | Delete

[3] Fix | Delete

use WPSEO_Utils;

[4] Fix | Delete

use Yoast\WP\SEO\Helpers\Image_Helper;

[5] Fix | Delete

use Yoast\WP\SEO\Helpers\Open_Graph\Image_Helper as Open_Graph_Image_Helper;

[6] Fix | Delete

use Yoast\WP\SEO\Helpers\Twitter\Image_Helper as Twitter_Image_Helper;

[7] Fix | Delete

use Yoast\WP\SEO\Models\Indexable;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Trait for determine the social image to use in the indexable.

[11] Fix | Delete

[12] Fix | Delete

* Represents the trait used in builders for handling social images.

[13] Fix | Delete

[14] Fix | Delete

trait Indexable_Social_Image_Trait {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* The image helper.

[18] Fix | Delete

[19] Fix | Delete

* @var Image_Helper

[20] Fix | Delete

[21] Fix | Delete

protected $image;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* The Open Graph image helper.

[25] Fix | Delete

[26] Fix | Delete

* @var Open_Graph_Image_Helper

[27] Fix | Delete

[28] Fix | Delete

protected $open_graph_image;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* The Twitter image helper.

[32] Fix | Delete

[33] Fix | Delete

* @var Twitter_Image_Helper

[34] Fix | Delete

[35] Fix | Delete

protected $twitter_image;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Sets the helpers for the trait.

[39] Fix | Delete

[40] Fix | Delete

* @required

[41] Fix | Delete

[42] Fix | Delete

* @param Image_Helper $image The image helper.

[43] Fix | Delete

* @param Open_Graph_Image_Helper $open_graph_image The Open Graph image helper.

[44] Fix | Delete

* @param Twitter_Image_Helper $twitter_image The Twitter image helper.

[45] Fix | Delete

[46] Fix | Delete

* @return void

[47] Fix | Delete

[48] Fix | Delete

public function set_social_image_helpers(

[49] Fix | Delete

Image_Helper $image,

[50] Fix | Delete

Open_Graph_Image_Helper $open_graph_image,

[51] Fix | Delete

Twitter_Image_Helper $twitter_image

[52] Fix | Delete

) {

[53] Fix | Delete

$this->image = $image;

[54] Fix | Delete

$this->open_graph_image = $open_graph_image;

[55] Fix | Delete

$this->twitter_image = $twitter_image;

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Sets the alternative on an indexable.

[60] Fix | Delete

[61] Fix | Delete

* @param array $alternative_image The alternative image to set.

[62] Fix | Delete

* @param Indexable $indexable The indexable to set image for.

[63] Fix | Delete

[64] Fix | Delete

* @return void

[65] Fix | Delete

[66] Fix | Delete

protected function set_alternative_image( array $alternative_image, Indexable $indexable ) {

[67] Fix | Delete

if ( ! empty( $alternative_image['image_id'] ) ) {

[68] Fix | Delete

if ( ! $indexable->open_graph_image_source && ! $indexable->open_graph_image_id ) {

[69] Fix | Delete

$indexable->open_graph_image_id = $alternative_image['image_id'];

[70] Fix | Delete

$indexable->open_graph_image_source = $alternative_image['source'];

[71] Fix | Delete

[72] Fix | Delete

$this->set_open_graph_image_meta_data( $indexable );

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

if ( ! $indexable->twitter_image && ! $indexable->twitter_image_id ) {

[76] Fix | Delete

$indexable->twitter_image = $this->twitter_image->get_by_id( $alternative_image['image_id'] );

[77] Fix | Delete

$indexable->twitter_image_id = $alternative_image['image_id'];

[78] Fix | Delete

$indexable->twitter_image_source = $alternative_image['source'];

[79] Fix | Delete

}

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

if ( ! empty( $alternative_image['image'] ) ) {

[83] Fix | Delete

if ( ! $indexable->open_graph_image_source && ! $indexable->open_graph_image_id ) {

[84] Fix | Delete

$indexable->open_graph_image = $alternative_image['image'];

[85] Fix | Delete

$indexable->open_graph_image_source = $alternative_image['source'];

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

if ( ! $indexable->twitter_image && ! $indexable->twitter_image_id ) {

[89] Fix | Delete

$indexable->twitter_image = $alternative_image['image'];

[90] Fix | Delete

$indexable->twitter_image_source = $alternative_image['source'];

[91] Fix | Delete

}

[92] Fix | Delete

}

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Sets the Open Graph image meta data for an og image

[97] Fix | Delete

[98] Fix | Delete

* @param Indexable $indexable The indexable.

[99] Fix | Delete

[100] Fix | Delete

* @return void

[101] Fix | Delete

[102] Fix | Delete

protected function set_open_graph_image_meta_data( Indexable $indexable ) {

[103] Fix | Delete

if ( ! $indexable->open_graph_image_id ) {

[104] Fix | Delete

return;

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

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

[108] Fix | Delete

[109] Fix | Delete

if ( ! empty( $image ) ) {

[110] Fix | Delete

$indexable->open_graph_image = $image['url'];

[111] Fix | Delete

$indexable->open_graph_image_meta = WPSEO_Utils::format_json_encode( $image );

[112] Fix | Delete

}

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

/**

[116] Fix | Delete

* Handles the social images.

[117] Fix | Delete

[118] Fix | Delete

* @param Indexable $indexable The indexable to handle.

[119] Fix | Delete

[120] Fix | Delete

* @return void

[121] Fix | Delete

[122] Fix | Delete

protected function handle_social_images( Indexable $indexable ) {

[123] Fix | Delete

// When the image or image id is set.

[124] Fix | Delete

if ( $indexable->open_graph_image || $indexable->open_graph_image_id ) {

[125] Fix | Delete

$indexable->open_graph_image_source = 'set-by-user';

[126] Fix | Delete

[127] Fix | Delete

$this->set_open_graph_image_meta_data( $indexable );

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

if ( $indexable->twitter_image || $indexable->twitter_image_id ) {

[131] Fix | Delete

$indexable->twitter_image_source = 'set-by-user';

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

if ( $indexable->twitter_image_id ) {

[135] Fix | Delete

$indexable->twitter_image = $this->twitter_image->get_by_id( $indexable->twitter_image_id );

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

// When image sources are set already.

[139] Fix | Delete

if ( $indexable->open_graph_image_source && $indexable->twitter_image_source ) {

[140] Fix | Delete

return;

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

$alternative_image = $this->find_alternative_image( $indexable );

[144] Fix | Delete

if ( ! empty( $alternative_image ) ) {

[145] Fix | Delete

$this->set_alternative_image( $alternative_image, $indexable );

[146] Fix | Delete

}

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Resets the social images.

[151] Fix | Delete

[152] Fix | Delete

* @param Indexable $indexable The indexable to set images for.

[153] Fix | Delete

[154] Fix | Delete

* @return void

[155] Fix | Delete

[156] Fix | Delete

protected function reset_social_images( Indexable $indexable ) {

[157] Fix | Delete

$indexable->open_graph_image = null;

[158] Fix | Delete

$indexable->open_graph_image_id = null;

[159] Fix | Delete

$indexable->open_graph_image_source = null;

[160] Fix | Delete

$indexable->open_graph_image_meta = null;

[161] Fix | Delete

[162] Fix | Delete

$indexable->twitter_image = null;

[163] Fix | Delete

$indexable->twitter_image_id = null;

[164] Fix | Delete

$indexable->twitter_image_source = null;

[165] Fix | Delete

}

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete