Your IP : 216.73.216.138
<?php
defined( 'ABSPATH' ) || die( 'Cheatin\' uh?' );
abstract class SQ_Models_Abstract_Assistant {
/**
* @var object API audit for this page
*/
protected $_audit;
/**
* @var SQ_Models_Domain_Post The local data about the post
*/
protected $_post;
/**
* @var array Current Category tasks
*/
protected $_tasks;
/**
* @var string Task Category Name
*/
protected $_category;
/**
* @var array DB tasks signals
*/
protected $_dbtasks;
/**
* @var bool task statuses
*/
protected $_error = false;
protected $_completed = true;
protected $_pattern = false;
protected $_error_message = false;
/**
* @var boolean post indexed
*/
protected $_indexed = false;
/**
* @var string Task colors
*/
const TASK_COMPLETE = '#4CAF50';
const TASK_INCOMPLETE = '#D32F2F';
const TASK_OBSCURE = '#F9A825';
const TASK_ERROR = '#dddddd';
const TASK_PATTERN = '#4CAF50';
public function setAudit( $audit ) {
$this->_audit = $audit;
return $this;
}
public function setPost( $post ) {
$this->_post = $post;
return $this;
}
/**
* Get all the focus pages data
*/
public function init() {
//get data from DB with the completed tasks
$this->_dbtasks = json_decode( get_option( SQ_TASKS ), true );
if ( isset( $this->_audit->data->serp_checker->position ) && $this->_audit->data->serp_checker->position > 0 && $this->_audit->data->serp_checker->position <= 10 ) {
$this->_indexed = true;
} elseif ( isset( $this->_audit->data->sq_analytics_gsc->position ) && $this->_audit->data->sq_analytics_gsc->position > 0 && $this->_audit->data->sq_analytics_gsc->position <= 10 ) {
$this->_indexed = true;
}
//Add filters for tasks, color and value
add_filter( 'sq_assistant_tasks', array( $this, 'parseTasks' ) );
//parse the category
add_filter( 'sq_assistant_categories', array( $this, 'parseCategory' ) );
}
public function getCurrentURL( $url ) {
$html = '';
$html .= '<div class="font-weight-bold text-black-50 mb-1">' . esc_html__( "Current URL", 'squirrly-seo' ) . ': </div>';
$html .= '<a href="' . $url . '" target="_blank" style="word-break: break-word;">' . urldecode( $url ) . '</a>';
return $html;
}
/**
* Get the keywords used in the Focus Page
*
* @return string
*/
public function getUsedKeywords() {
$html = '';
if ( isset( $this->_audit->data ) && isset( $this->_audit->data->sq_seo_briefcase ) && ! empty( $this->_audit->data->sq_seo_briefcase ) ) {
$html .= '<div class="sq_keywords">';
$html .= '<table class="table m-0">';
$html .= '<tr><th>' . esc_html__( "Keywords", 'squirrly-seo' ) . '</th><th title="' . esc_html__( "Squirrly Live Assistant Optimization", 'squirrly-seo' ) . '">' . esc_html__( "SLA", 'squirrly-seo' ) . '</th></tr>';
foreach ( $this->_audit->data->sq_seo_briefcase as $lsikeyword ) {
$html .= '<tr><td class="text-black-50 mb-2 text-left" onclick="jQuery(\'.sq_main_keyword_dialog_' . $this->_post->ID . '\').modal(\'show\')"><span class="text-dark">' . $lsikeyword->keyword . '</span></td><td style="white-space: nowrap;">' . ( $lsikeyword->main ? '<i class="fa-solid fa-star small" style="display: inline; color: #F9A825;"></i>' : '' ) . '' . $lsikeyword->optimized . '%' . '</td></tr>';
}
$html .= '</table>';
$html .= '</div>';
} elseif ( isset( $this->_keyword ) && $this->_keyword <> '' ) {
$html .= '<div class="text-black-50 mb-2 text-left">' . esc_html__( "Keyword", 'squirrly-seo' ) . ':</div><div class="text-dark">' . $this->_keyword . '</div>';
} else {
$html .= '<div class="font-weight-bold m-0 text-center">' . esc_html__( "No Meta Keyword Found", 'squirrly-seo' ) . '</div>';
}
return $html;
}
/**
* Set all Tasks from all Assistant Classes
* Extend and add the current assistant tasks
*
* @param $tasks
*
* @return mixed
*/
public function setTasks( $tasks ) {
return $this->_tasks = $tasks;
}
/**
* Get all tasks
*
* @return mixed
*/
public function getTasks() {
return $this->_tasks;
}
/**
* Get all saved statuses from database
*
* @return array
*/
public function getDbTasks() {
return $this->_dbtasks;
}
/**
* Get the task value if exists
* Set false by default
*
* @return bool
*/
public function getValue() {
return false;
}
/**
* If data integrity is affected, return error
*
* @return bool
*/
public function isError() {
return $this->_error;
}
/**
* Get the task color
*
* @param $completed
*
* @return string
*/
public function getColor( $completed ) {
if ( $this->_error ) {
return self::TASK_ERROR;
} elseif ( ! $completed ) {
if ( $this->_indexed ) {
return self::TASK_OBSCURE;
}
return self::TASK_INCOMPLETE;
} elseif ( $this->_pattern ) {
return self::TASK_PATTERN;
} else {
return self::TASK_COMPLETE;
}
return self::TASK_INCOMPLETE;
}
public function getTitle( $title ) {
if ( $this->_error ) {
$title = esc_html__( "We are gathering data for this category", 'squirrly-seo' );
} elseif ( ! $this->_completed ) {
if ( $this->_indexed ) {
return esc_html__( "Congratulations for ranking with this keyword, but it will require special attention from you to keep it within TOP 10 positions", 'squirrly-seo' );
}
}
return $title;
}
/**
* Parse tasks for each category
*
* @param $tasks
* @param $category
*
* @return mixed
*/
public function parseTasks( $tasks, $category = null ) {
if ( ! isset( $category ) ) {
$category = $this->_category;
}
$this->setTasks( $tasks );
if ( isset( $this->_tasks[ $category ] ) ) {
foreach ( $this->_tasks[ $category ] as $name => &$task ) {
$task['completed'] = true;
$task['pattern'] = $task['error'] = $task['error_message'] = false;
//Set task status from DB or active
$task['active'] = true;
if ( isset( $this->_dbtasks[ $category ][ $name ]['active'] ) ) {
$task['active'] = $this->_dbtasks[ $category ][ $name ]['active'];
}
///
//set the current task
if ( $task['active'] ) {
if ( method_exists( $this, 'check' . ucfirst( $name ) ) ) {
$task = call_user_func_array( array( $this, 'check' . ucfirst( $name ) ), array( $task ) );
//Check if the task has errors
if ( $task['error'] ) {
$task['completed'] = false;
$task['error_message'] = ( isset( $task['error_message'] ) && $task['error_message'] <> '' ? $task['error_message'] : esc_html__( "Not enough data to process this task", 'squirrly-seo' ) );
} else {
//If the task has value
if ( isset( $task['value'] ) ) {
$task['description'] = '<div class="py-3 mb-3 border-bottom text-primary font-italic" style="word-break: break-word !important;">' . ( isset( $task['value_title'] ) ? $task['value_title'] : esc_html__( "Current", 'squirrly-seo' ) ) . ': <strong>' . $task['value'] . '</strong></div>' . $task['description'];
}
//Check if the task has patterns
if ( $task['pattern'] ) {
$this->_pattern = true;
}
}
}
} else {
//set complete if task inactive
$task['completed'] = true;
$this->_error = $task['error'] = $task['pattern'] = false;
$task['error_message'] = esc_html__( "You chose to ignore this task. Click to activate it.", 'squirrly-seo' );
}
if ( ! isset( $task['status'] ) ) {
$task['status'] = ( $task['active'] ? ( $task['error'] ? ' error' : ( $task['completed'] ? ( $task['pattern'] ? 'pattern' : 'completed' ) : '' ) ) : 'ignore' );
}
}
}
//Save the completed Tasks in DB
$this->saveDBTasks();
//Get the DbTasks
add_filter( 'sq_assistant_dbtasks', array( $this, 'getDbTasks' ) );
//return all tasks
return $this->getTasks();
}
/**
* Parse all the categories for this page
* Get status data for each category
*
* @param $categories
*
* @return mixed
*/
public function parseCategory( $categories ) {
if ( ! isset( $categories[ $this->_category ] ) ) {
$categories[ $this->_category ]['completed'] = true;
$categories[ $this->_category ]['title'] = '';
$categories[ $this->_category ]['penalty'] = 0; //initialize the category penalty to 0
foreach ( $this->_tasks[ $this->_category ] as $task ) {
if ( $task['active'] ) {
if ( ! $task['completed'] ) {
$categories[ $this->_category ]['completed'] = false;
$this->_completed = false;
}
if ( $task['error'] ) {
$categories[ $this->_category ]['error'] = true;
$this->_error = true;
break;
}
if ( ! $task['completed'] && ! $task['error'] && isset( $task['penalty'] ) ) {
$categories[ $this->_category ]['penalty'] += (int) $task['penalty'];
}
}
}
$categories[ $this->_category ]['color'] = $this->getColor( $categories[ $this->_category ]['completed'] );
$categories[ $this->_category ]['title'] = $this->getTitle( $categories[ $this->_category ]['title'] );
$categories[ $this->_category ]['value'] = $this->getValue();
$categories[ $this->_category ]['error'] = $this->isError();
if ( method_exists( $this, 'getHeader' ) ) {
$categories[ $this->_category ]['header'] = call_user_func( array( $this, 'getHeader' ) );
}
}
return $categories;
}
/**
* Modify task for best practice
*
* @param $content
* @param $task
*
* @return string
*/
public function getPractice( $content, $task ) {
return '<li class="sq_task sq_practice row completed" data-category="' . $this->_category . '" data-name="practice" data-active="' . $task['active'] . '" data-completed="' . $task['completed'] . '" data-dismiss="modal">
<i class="fa-solid fa-warning"></i>
<h4>' . $task['title'] . '</h4>
<div class="description" style="display: none">' . $task['description'] . '</li>';
}
/**
* Save the completed tasks in DB
*/
public function saveDBTasks() {
update_option( SQ_TASKS, wp_json_encode( $this->_dbtasks ) );
}
}