Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Actions\Wincher;

[2] Fix | Delete

[3] Fix | Delete

use Exception;

[4] Fix | Delete

use WP_Post;

[5] Fix | Delete

use WPSEO_Utils;

[6] Fix | Delete

use Yoast\WP\SEO\Config\Wincher_Client;

[7] Fix | Delete

use Yoast\WP\SEO\Helpers\Options_Helper;

[8] Fix | Delete

use Yoast\WP\SEO\Repositories\Indexable_Repository;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Class Wincher_Keyphrases_Action

[12] Fix | Delete

[13] Fix | Delete

class Wincher_Keyphrases_Action {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* The Wincher keyphrase URL for bulk addition.

[17] Fix | Delete

[18] Fix | Delete

* @var string

[19] Fix | Delete

[20] Fix | Delete

public const KEYPHRASES_ADD_URL = 'https://api.wincher.com/beta/websites/%s/keywords/bulk';

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* The Wincher tracked keyphrase retrieval URL.

[24] Fix | Delete

[25] Fix | Delete

* @var string

[26] Fix | Delete

[27] Fix | Delete

public const KEYPHRASES_URL = 'https://api.wincher.com/beta/yoast/%s';

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* The Wincher delete tracked keyphrase URL.

[31] Fix | Delete

[32] Fix | Delete

* @var string

[33] Fix | Delete

[34] Fix | Delete

public const KEYPHRASE_DELETE_URL = 'https://api.wincher.com/beta/websites/%s/keywords/%s';

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* The Wincher_Client instance.

[38] Fix | Delete

[39] Fix | Delete

* @var Wincher_Client

[40] Fix | Delete

[41] Fix | Delete

protected $client;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* The Options_Helper instance.

[45] Fix | Delete

[46] Fix | Delete

* @var Options_Helper

[47] Fix | Delete

[48] Fix | Delete

protected $options_helper;

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* The Indexable_Repository instance.

[52] Fix | Delete

[53] Fix | Delete

* @var Indexable_Repository

[54] Fix | Delete

[55] Fix | Delete

protected $indexable_repository;

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Wincher_Keyphrases_Action constructor.

[59] Fix | Delete

[60] Fix | Delete

* @param Wincher_Client $client The API client.

[61] Fix | Delete

* @param Options_Helper $options_helper The options helper.

[62] Fix | Delete

* @param Indexable_Repository $indexable_repository The indexables repository.

[63] Fix | Delete

[64] Fix | Delete

public function __construct(

[65] Fix | Delete

Wincher_Client $client,

[66] Fix | Delete

Options_Helper $options_helper,

[67] Fix | Delete

Indexable_Repository $indexable_repository

[68] Fix | Delete

) {

[69] Fix | Delete

$this->client = $client;

[70] Fix | Delete

$this->options_helper = $options_helper;

[71] Fix | Delete

$this->indexable_repository = $indexable_repository;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Sends the tracking API request for one or more keyphrases.

[76] Fix | Delete

[77] Fix | Delete

* @param string|array $keyphrases One or more keyphrases that should be tracked.

[78] Fix | Delete

* @param Object $limits The limits API call response data.

[79] Fix | Delete

[80] Fix | Delete

* @return Object The reponse object.

[81] Fix | Delete

[82] Fix | Delete

public function track_keyphrases( $keyphrases, $limits ) {

[83] Fix | Delete

try {

[84] Fix | Delete

$endpoint = \sprintf(

[85] Fix | Delete

self::KEYPHRASES_ADD_URL,

[86] Fix | Delete

$this->options_helper->get( 'wincher_website_id' )

[87] Fix | Delete

);

[88] Fix | Delete

[89] Fix | Delete

// Enforce arrrays to ensure a consistent way of preparing the request.

[90] Fix | Delete

if ( ! \is_array( $keyphrases ) ) {

[91] Fix | Delete

$keyphrases = [ $keyphrases ];

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

// Calculate if the user would exceed their limit.

[95] Fix | Delete

// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- To ensure JS code style, this can be ignored.

[96] Fix | Delete

if ( ! $limits->canTrack || $this->would_exceed_limits( $keyphrases, $limits ) ) {

[97] Fix | Delete

$response = [

[98] Fix | Delete

'limit' => $limits->limit,

[99] Fix | Delete

'error' => 'Account limit exceeded',

[100] Fix | Delete

'status' => 400,

[101] Fix | Delete

];

[102] Fix | Delete

[103] Fix | Delete

return $this->to_result_object( $response );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

$formatted_keyphrases = \array_values(

[107] Fix | Delete

\array_map(

[108] Fix | Delete

static function ( $keyphrase ) {

[109] Fix | Delete

return [

[110] Fix | Delete

'keyword' => $keyphrase,

[111] Fix | Delete

'groups' => [],

[112] Fix | Delete

];

[113] Fix | Delete

[114] Fix | Delete

$keyphrases

[115] Fix | Delete

)

[116] Fix | Delete

);

[117] Fix | Delete

[118] Fix | Delete

$results = $this->client->post( $endpoint, WPSEO_Utils::format_json_encode( $formatted_keyphrases ) );

[119] Fix | Delete

[120] Fix | Delete

if ( ! \array_key_exists( 'data', $results ) ) {

[121] Fix | Delete

return $this->to_result_object( $results );

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

// The endpoint returns a lot of stuff that we don't want/need.

[125] Fix | Delete

$results['data'] = \array_map(

[126] Fix | Delete

static function ( $keyphrase ) {

[127] Fix | Delete

return [

[128] Fix | Delete

'id' => $keyphrase['id'],

[129] Fix | Delete

'keyword' => $keyphrase['keyword'],

[130] Fix | Delete

];

[131] Fix | Delete

[132] Fix | Delete

$results['data']

[133] Fix | Delete

);

[134] Fix | Delete

[135] Fix | Delete

$results['data'] = \array_combine(

[136] Fix | Delete

\array_column( $results['data'], 'keyword' ),

[137] Fix | Delete

\array_values( $results['data'] )

[138] Fix | Delete

);

[139] Fix | Delete

[140] Fix | Delete

return $this->to_result_object( $results );

[141] Fix | Delete

} catch ( Exception $e ) {

[142] Fix | Delete

return (object) [

[143] Fix | Delete

'error' => $e->getMessage(),

[144] Fix | Delete

'status' => $e->getCode(),

[145] Fix | Delete

];

[146] Fix | Delete

}

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Sends an untrack request for the passed keyword ID.

[151] Fix | Delete

[152] Fix | Delete

* @param int $keyphrase_id The ID of the keyphrase to untrack.

[153] Fix | Delete

[154] Fix | Delete

* @return object The response object.

[155] Fix | Delete

[156] Fix | Delete

public function untrack_keyphrase( $keyphrase_id ) {

[157] Fix | Delete

try {

[158] Fix | Delete

$endpoint = \sprintf(

[159] Fix | Delete

self::KEYPHRASE_DELETE_URL,

[160] Fix | Delete

$this->options_helper->get( 'wincher_website_id' ),

[161] Fix | Delete

$keyphrase_id

[162] Fix | Delete

);

[163] Fix | Delete

[164] Fix | Delete

$this->client->delete( $endpoint );

[165] Fix | Delete

[166] Fix | Delete

return (object) [

[167] Fix | Delete

'status' => 200,

[168] Fix | Delete

];

[169] Fix | Delete

} catch ( Exception $e ) {

[170] Fix | Delete

return (object) [

[171] Fix | Delete

'error' => $e->getMessage(),

[172] Fix | Delete

'status' => $e->getCode(),

[173] Fix | Delete

];

[174] Fix | Delete

}

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Gets the keyphrase data for the passed keyphrases.

[179] Fix | Delete

* Retrieves all available data if no keyphrases are provided.

[180] Fix | Delete

[181] Fix | Delete

* @param array|null $used_keyphrases The currently used keyphrases. Optional.

[182] Fix | Delete

* @param string|null $permalink The current permalink. Optional.

[183] Fix | Delete

* @param string|null $start_at The position start date. Optional.

[184] Fix | Delete

[185] Fix | Delete

* @return object The keyphrase chart data.

[186] Fix | Delete

[187] Fix | Delete

public function get_tracked_keyphrases( $used_keyphrases = null, $permalink = null, $start_at = null ) {

[188] Fix | Delete

try {

[189] Fix | Delete

if ( $used_keyphrases === null ) {

[190] Fix | Delete

$used_keyphrases = $this->collect_all_keyphrases();

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

// If we still have no keyphrases the API will return an error, so

[194] Fix | Delete

// don't even bother sending a request.

[195] Fix | Delete

if ( empty( $used_keyphrases ) ) {

[196] Fix | Delete

return $this->to_result_object(

[197] Fix | Delete

[

[198] Fix | Delete

'data' => [],

[199] Fix | Delete

'status' => 200,

[200] Fix | Delete

]

[201] Fix | Delete

);

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

$endpoint = \sprintf(

[205] Fix | Delete

self::KEYPHRASES_URL,

[206] Fix | Delete

$this->options_helper->get( 'wincher_website_id' )

[207] Fix | Delete

);

[208] Fix | Delete

[209] Fix | Delete

$results = $this->client->post(

[210] Fix | Delete

$endpoint,

[211] Fix | Delete

WPSEO_Utils::format_json_encode(

[212] Fix | Delete

[

[213] Fix | Delete

'keywords' => $used_keyphrases,

[214] Fix | Delete

'url' => $permalink,

[215] Fix | Delete

'start_at' => $start_at,

[216] Fix | Delete

]

[217] Fix | Delete

[218] Fix | Delete

[

[219] Fix | Delete

'timeout' => 60,

[220] Fix | Delete

]

[221] Fix | Delete

);

[222] Fix | Delete

[223] Fix | Delete

if ( ! \array_key_exists( 'data', $results ) ) {

[224] Fix | Delete

return $this->to_result_object( $results );

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

$results['data'] = $this->filter_results_by_used_keyphrases( $results['data'], $used_keyphrases );

[228] Fix | Delete

[229] Fix | Delete

// Extract the positional data and assign it to the keyphrase.

[230] Fix | Delete

$results['data'] = \array_combine(

[231] Fix | Delete

\array_column( $results['data'], 'keyword' ),

[232] Fix | Delete

\array_values( $results['data'] )

[233] Fix | Delete

);

[234] Fix | Delete

[235] Fix | Delete

return $this->to_result_object( $results );

[236] Fix | Delete

} catch ( Exception $e ) {

[237] Fix | Delete

return (object) [

[238] Fix | Delete

'error' => $e->getMessage(),

[239] Fix | Delete

'status' => $e->getCode(),

[240] Fix | Delete

];

[241] Fix | Delete

}

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Collects the keyphrases associated with the post.

[246] Fix | Delete

[247] Fix | Delete

* @param WP_Post $post The post object.

[248] Fix | Delete

[249] Fix | Delete

* @return array The keyphrases.

[250] Fix | Delete

[251] Fix | Delete

public function collect_keyphrases_from_post( $post ) {

[252] Fix | Delete

$keyphrases = [];

[253] Fix | Delete

$primary_keyphrase = $this->indexable_repository

[254] Fix | Delete

->query()

[255] Fix | Delete

->select( 'primary_focus_keyword' )

[256] Fix | Delete

->where( 'object_id', $post->ID )

[257] Fix | Delete

->find_one();

[258] Fix | Delete

[259] Fix | Delete

if ( $primary_keyphrase ) {

[260] Fix | Delete

$keyphrases[] = $primary_keyphrase->primary_focus_keyword;

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

/**

[264] Fix | Delete

* Filters the keyphrases collected by the Wincher integration from the post.

[265] Fix | Delete

[266] Fix | Delete

* @param array $keyphrases The keyphrases array.

[267] Fix | Delete

* @param int $post_id The ID of the post.

[268] Fix | Delete

[269] Fix | Delete

return \apply_filters( 'wpseo_wincher_keyphrases_from_post', $keyphrases, $post->ID );

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Collects all keyphrases known to Yoast.

[274] Fix | Delete

[275] Fix | Delete

* @return array

[276] Fix | Delete

[277] Fix | Delete

protected function collect_all_keyphrases() {

[278] Fix | Delete

// Collect primary keyphrases first.

[279] Fix | Delete

$keyphrases = \array_column(

[280] Fix | Delete

$this->indexable_repository

[281] Fix | Delete

->query()

[282] Fix | Delete

->select( 'primary_focus_keyword' )

[283] Fix | Delete

->where_not_null( 'primary_focus_keyword' )

[284] Fix | Delete

->where( 'object_type', 'post' )

[285] Fix | Delete

->where_not_equal( 'post_status', 'trash' )

[286] Fix | Delete

->distinct()

[287] Fix | Delete

->find_array(),

[288] Fix | Delete

'primary_focus_keyword'

[289] Fix | Delete

);

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Filters the keyphrases collected by the Wincher integration from all the posts.

[293] Fix | Delete

[294] Fix | Delete

* @param array $keyphrases The keyphrases array.

[295] Fix | Delete

[296] Fix | Delete

$keyphrases = \apply_filters( 'wpseo_wincher_all_keyphrases', $keyphrases );

[297] Fix | Delete

[298] Fix | Delete

// Filter out empty entries.

[299] Fix | Delete

return \array_filter( $keyphrases );

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

/**

[303] Fix | Delete

* Filters the results based on the passed keyphrases.

[304] Fix | Delete

[305] Fix | Delete

* @param array $results The results to filter.

[306] Fix | Delete

* @param array $used_keyphrases The used keyphrases.

[307] Fix | Delete

[308] Fix | Delete

* @return array The filtered results.

[309] Fix | Delete

[310] Fix | Delete

protected function filter_results_by_used_keyphrases( $results, $used_keyphrases ) {

[311] Fix | Delete

return \array_filter(

[312] Fix | Delete

$results,

[313] Fix | Delete

static function ( $result ) use ( $used_keyphrases ) {

[314] Fix | Delete

return \in_array( $result['keyword'], \array_map( 'strtolower', $used_keyphrases ), true );

[315] Fix | Delete

}

[316] Fix | Delete

);

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

/**

[320] Fix | Delete

* Determines whether the amount of keyphrases would mean the user exceeds their account limits.

[321] Fix | Delete

[322] Fix | Delete

* @param string|array $keyphrases The keyphrases to be added.

[323] Fix | Delete

* @param object $limits The current account limits.

[324] Fix | Delete

[325] Fix | Delete

* @return bool Whether the limit is exceeded.

[326] Fix | Delete

[327] Fix | Delete

protected function would_exceed_limits( $keyphrases, $limits ) {

[328] Fix | Delete

if ( ! \is_array( $keyphrases ) ) {

[329] Fix | Delete

$keyphrases = [ $keyphrases ];

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

if ( \is_null( $limits->limit ) ) {

[333] Fix | Delete

return false;

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

return ( \count( $keyphrases ) + $limits->usage ) > $limits->limit;

[337] Fix | Delete

}

[338] Fix | Delete

[339] Fix | Delete

/**

[340] Fix | Delete

* Converts the passed dataset to an object.

[341] Fix | Delete

[342] Fix | Delete

* @param array $result The result dataset to convert to an object.

[343] Fix | Delete

[344] Fix | Delete

* @return object The result object.

[345] Fix | Delete

[346] Fix | Delete

protected function to_result_object( $result ) {

[347] Fix | Delete

if ( \array_key_exists( 'data', $result ) ) {

[348] Fix | Delete

$result['results'] = (object) $result['data'];

[349] Fix | Delete

[350] Fix | Delete

unset( $result['data'] );

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

if ( \array_key_exists( 'message', $result ) ) {

[354] Fix | Delete

$result['error'] = $result['message'];

[355] Fix | Delete

[356] Fix | Delete

unset( $result['message'] );

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

return (object) $result;

[360] Fix | Delete

}

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete