Current File : /home/dopla/www/wp-content/plugins/ml-slider/admin/lib/Updraft_Notices.php
<?php
if (!defined('ABSPATH')) {
die('No direct access allowed');
}
/**
* If we ever change the API of the Updraft_Notices class, then we'll need to rename and version it, e.g. Updraft_Notices_1_0, because otherwise a plugin may find that it's loaded an older instance than it wanted from another plugin.
*/
abstract class Updraft_Notices_1_0
{
protected $notices_content;
/**
* These variables are just short-hands to be used in advert content.
*
* @var array
*/
protected $dashboard_top = array('top');
protected $dashboard_top_or_report = array('top', 'report', 'report-plain');
protected $dashboard_bottom_or_report = array('bottom', 'report', 'report-plain');
protected $anywhere = array('top', 'bottom', 'report', 'report-plain');
protected $autobackup = array('autobackup');
protected $autobackup_bottom_or_report = array('autobackup', 'bottom', 'report', 'report-plain');
/**
* This method returns any parent notices to the child caller
*
* @return Array returns an array of notices
*/
protected function populate_notices_content()
{
// Global adverts that appear in all products will be returned to the child to display.
return array();
}
/**
* This method is called to setup the notices
*/
abstract protected function notices_init();
/**
* This method will check if the specified plugin is installed and if it is will return false otherwise returns true and the notice can be displayed
*
* @param String $product the plugin name to check
* @param boolean $also_require_active a bool value to indicate if the plugin has to be active or not
* @return boolean a bool value to indicate if the notice can be displayed or not
*/
protected function is_plugin_installed($product = null, $also_require_active = false)
{
if ($also_require_active) {
return class_exists($product);
}
if (!function_exists('get_plugins')) {
include_once(ABSPATH.'wp-admin/includes/plugin.php');
}
$plugins = get_plugins();
$product_file = false;
foreach ($plugins as $key => $value) {
if ($value['TextDomain'] == $product) {
// We have found the plugin so return false so that we do not display this advert.
return false;
}
}
return true;
}
/**
* This method will work out if the user is using a non english language and if so returns true so that they can see the translation advert.
*
* @param String $plugin_base_dir the plugin base directory
* @param String $product_name the name of the plugin
* @return Boolean returns true if the user is using a non english language and could translate otherwise false
*/
protected function translation_needed($plugin_base_dir, $product_name)
{
$wplang = get_locale();
if (strlen($wplang) < 1 || 'en_US' == $wplang || 'en_GB' == $wplang) {
return false;
}
if (defined('WP_LANG_DIR') && is_file(WP_LANG_DIR.'/plugins/'.$product_name.'-'.$wplang.'.mo')) {
return false;
}
if (is_file($plugin_base_dir.'/languages/'.$product_name.'-'.$wplang.'.mo')) {
return false;
}
return true;
}
/**
* This method is used to generate the correct URL output for the start of the URL
*
* @param Boolean $html_allowed a boolean value to indicate if HTML can be used or not
* @param String $url the url to use
* @param Boolean $https a boolean value to indicate if https should be used or not
* @param String $website_home a string to be displayed
* @return String returns a string of the completed url
*/
protected function url_start($html_allowed = false, $url = '', $https = false, $website_home = null)
{
$proto = ($https) ? 'https' : 'http';
if (strpos($url, $website_home) !== false) {
return (($html_allowed) ? "<a href=".apply_filters(str_replace('.', '_', $website_home).'_link', $proto.'://'.$url).">" : "");
} else {
return (($html_allowed) ? '<a href="'.$proto.'://'.$url.'">' : "");
}
}
/**
* This method is used to generate the correct URL output for the end of the URL
*
* @param Boolean $html_allowed a boolean value to indicate if HTML can be used or not
* @param String $url the url to use
* @param Boolean $https a boolean value to indicate if https should be used or not
* @return String returns a string of the completed url
*/
protected function url_end($html_allowed, $url, $https = false)
{
$proto = (($https) ? 'https' : 'http');
return (($html_allowed) ? '</a>' : " (".$proto."://".$url.")");
}
/**
* This method prepares the notice for display
*
* @param Boolean|String $notice the notice to display or false if we want a random one
* @param string $position the position to display the notice in
* @param boolean $return_instead_of_echo a bool to indicate if the notice should be returned or printed
* @return String a notice to display
*/
public function do_notice($notice = false, $position = 'top', $return_instead_of_echo = false)
{
$this->notices_init();
if (false === $notice) {
$notice = apply_filters('updraft_notices_force_id', false, $this);
}
$notice_content = $this->get_notice_data($notice, $position);
if (false != $notice_content) {
return $this->render_specified_notice($notice_content, $return_instead_of_echo, $position);
}
}
/**
* This method will return a notice ready for display.
*
* @param boolean $notice Sends True or False if there are notices to show.
* @param string $position Which screen position the notice is.
* @return array Returns Notice data.
*/
protected function get_notice_data($notice = false, $position = 'top')
{
// If a specific notice has been passed to this method then return that notice.
if ($notice) {
if (!isset($this->notices_content[$notice])) {
return false;
}
// Does the notice support the position specified?
if (isset($this->notices_content[$notice]['supported_positions']) && !in_array($position, $this->notices_content[$notice]['supported_positions'])) {
return false;
}
// First check if the advert passed can be displayed and hasn't been dismissed, we do this by checking what dismissed value we should be checking.
$dismiss_time = $this->notices_content[$notice]['dismiss_time'];
$dismiss = $this->check_notice_dismissed($dismiss_time);
if ($dismiss) {
return false;
}
return $this->notices_content[$notice];
}
// Create an array to add non-seasonal adverts to so that if a seasonal advert can't be returned we can choose a random advert from this array.
$available_notices = array();
// If Advert wasn't passed then next we should check to see if a seasonal advert can be returned.
foreach ($this->notices_content as $notice_id => $notice_data) {
// Does the notice support the position specified?
if (isset($this->notices_content[$notice_id]['supported_positions']) && !in_array($position, $this->notices_content[$notice_id]['supported_positions'])) {
continue;
}
// If the advert has a validity function, then require the advert to be valid.
if (!empty($notice_data['validity_function']) && !call_user_func(array($this, $notice_data['validity_function']))) {
continue;
}
if (isset($notice_data['valid_from']) && isset($notice_data['valid_to'])) {
if ($this->skip_seasonal_notices($notice_data)) {
return $notice_data;
}
} else {
$dismiss_time = $this->notices_content[$notice_id]['dismiss_time'];
$dismiss = $this->check_notice_dismissed($dismiss_time);
if (!$dismiss) {
$available_notices[$notice_id] = $notice_data;
}
}
}
if (empty($available_notices)) {
return false;
}
// If a seasonal advert can't be returned then we will return a random advert.
// Using shuffle here as something like rand which produces a random number and uses that as the array index fails, this is because in future an advert may not be numbered and could have a string as its key which will then cause errors.
shuffle($available_notices);
return $available_notices[0];
}
/**
* This method should be overwritten by the child class if they have seasonal notices
*
* @param String $notice_data the notice to check if it should be skipped or not
* @return Boolean returns false if the notice can be displayed
*/
protected function skip_seasonal_notices($notice_data)
{
return false;
}
/**
* This method returns the affilate ID
*
* @return Integer an affilate id to return
*/
public function get_affiliate_id()
{
return $this->self_affiliate_id;
}
/**
* This method checks to see if the notices dismiss_time parameter has been dismissed
*
* @param String $dismiss_time a string containing the dimiss time ID
* @return Boolaen returns true if the notice has been dismissed and shouldn't be shown otherwise display it
*/
abstract protected function check_notice_dismissed($dismiss_time);
}
Mini Shell