daf0a8612f
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2486043 b8457f37-d9ea-0310-8a92-e5e31aec5664
208 lines
7.2 KiB
PHP
208 lines
7.2 KiB
PHP
<?php // phpcs:disable WordPress.Files.FileName.InvalidClassFileName, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
|
|
/**
|
|
* Includes the Plugin settings menu.
|
|
*
|
|
* @filesource
|
|
* @package footnotes
|
|
* @since 1.5.0
|
|
* @date 12.09.14 10:26
|
|
*/
|
|
|
|
/**
|
|
* Handles the Settings interface of the Plugin.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
class MCI_Footnotes_Layout_Init {
|
|
|
|
/**
|
|
* Slug for the Plugin main menu.
|
|
*
|
|
* @since 1.5.0
|
|
* @var string
|
|
*/
|
|
const C_STR_MAIN_MENU_SLUG = 'mfmmf';
|
|
|
|
/**
|
|
* Plugin main menu name.
|
|
*
|
|
* @since 1.5.0
|
|
* @var string
|
|
*/
|
|
const C_STR_MAIN_MENU_TITLE = 'ManFisher';
|
|
|
|
/**
|
|
* Contains layout engine sub classes.
|
|
*
|
|
* @since 1.5.0
|
|
* @var array
|
|
*/
|
|
private $a_arr_sub_page_classes = array();
|
|
|
|
/**
|
|
* Class Constructor. Initializes all WordPress hooks for the Plugin Settings.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public function __construct() {
|
|
foreach ( get_declared_classes() as $l_str_class_name ) {
|
|
if ( is_subclass_of( $l_str_class_name, 'MCI_Footnotes_Layout_Engine' ) ) {
|
|
$l_obj_class = new $l_str_class_name();
|
|
// Append new instance of the layout engine sub class.
|
|
$this->a_arr_sub_page_classes[ $l_obj_class->get_priority() ] = $l_obj_class;
|
|
}
|
|
}
|
|
ksort( $this->a_arr_sub_page_classes );
|
|
|
|
// Register hooks/actions.
|
|
add_action( 'admin_init', array( $this, 'initialize_settings' ) );
|
|
add_action( 'admin_menu', array( $this, 'register_main_menu' ) );
|
|
// Register AJAX callbacks for Plugin information.
|
|
add_action( 'wp_ajax_nopriv_footnotes_get_plugin_info', array( $this, 'get_plugin_meta_information' ) );
|
|
add_action( 'wp_ajax_footnotes_get_plugin_info', array( $this, 'get_plugin_meta_information' ) );
|
|
}
|
|
|
|
/**
|
|
* Initializes all sub pages and registers the settings.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public function initialize_settings() {
|
|
MCI_Footnotes_Settings::instance()->register_settings();
|
|
// Iterate though each sub class of the layout engine and register their sections.
|
|
foreach ( $this->a_arr_sub_page_classes as $l_obj_layout_engine_sub_class ) {
|
|
$l_obj_layout_engine_sub_class->register_sections();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Registers the new main menu for the WordPress dashboard.
|
|
* Registers all sub menu pages for the new main menu.
|
|
*
|
|
* @since 1.5.0
|
|
* @see http://codex.wordpress.org/Function_Reference/add_menu_page
|
|
*/
|
|
public function register_main_menu() {
|
|
global $menu;
|
|
// Iterate through each main menu.
|
|
foreach ( $menu as $l_arr_main_menu ) {
|
|
// 3terate through each main menu attribute.
|
|
foreach ( $l_arr_main_menu as $l_str_attribute ) {
|
|
// Main menu already added, append sub pages and stop.
|
|
if ( self::C_STR_MAIN_MENU_SLUG === $l_str_attribute ) {
|
|
$this->register_sub_pages();
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Add a new main menu page to the WordPress dashboard.
|
|
add_menu_page(
|
|
self::C_STR_MAIN_MENU_TITLE, // Page title.
|
|
self::C_STR_MAIN_MENU_TITLE, // Menu title.
|
|
'manage_options', // Capability.
|
|
self::C_STR_MAIN_MENU_SLUG, // Menu slug.
|
|
array( $this, 'display_other_plugins' ), // Function.
|
|
plugins_url( 'footnotes/img/main-menu.png' ), // Icon URL.
|
|
null // Position.
|
|
);
|
|
$this->register_sub_pages();
|
|
}
|
|
|
|
/**
|
|
* Registers all SubPages for this Plugin.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
private function register_sub_pages() {
|
|
// First registered sub menu page MUST NOT contain a unique slug suffix.
|
|
// Iterate though each sub class of the layout engine and register their sub page.
|
|
foreach ( $this->a_arr_sub_page_classes as $l_obj_layout_engine_sub_class ) {
|
|
$l_obj_layout_engine_sub_class->register_sub_page();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Displays other Plugins from the developers.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public function display_other_plugins() {
|
|
printf( '<br/><br/>' );
|
|
// Load template file.
|
|
$l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'manfisher' );
|
|
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo $l_obj_template->get_content();
|
|
// phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
|
|
printf( '<em>visit <a href="https://cheret.de/plugins/footnotes-2/" target="_blank">Mark Cheret</a></em>' );
|
|
printf( '<br/><br/>' );
|
|
|
|
printf( '</div>' );
|
|
}
|
|
|
|
// phpcs:disable WordPress.Security.NonceVerification.Missing
|
|
/**
|
|
* AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public function get_plugin_meta_information() {
|
|
// TODO: add nonce verification.
|
|
|
|
// Get plugin internal name from POST data.
|
|
if ( isset( $_POST['plugin'] ) ) {
|
|
$l_str_plugin_name = wp_unslash( $_POST['plugin'] );
|
|
}
|
|
|
|
if ( empty( $l_str_plugin_name ) ) {
|
|
echo wp_json_encode( array( 'error' => 'Plugin name invalid.' ) );
|
|
exit;
|
|
}
|
|
$l_str_url = 'https://api.wordpress.org/plugins/info/1.0/' . $l_str_plugin_name . '.json';
|
|
// Call URL and collect data.
|
|
$l_arr_response = wp_remote_get( $l_str_url );
|
|
// Check if response is valid.
|
|
if ( is_wp_error( $l_arr_response ) ) {
|
|
echo wp_json_encode( array( 'error' => 'Error receiving Plugin Information from WordPress.' ) );
|
|
exit;
|
|
}
|
|
if ( ! array_key_exists( 'body', $l_arr_response ) ) {
|
|
echo wp_json_encode( array( 'error' => 'Error reading WordPress API response message.' ) );
|
|
exit;
|
|
}
|
|
// Get the body of the response.
|
|
$l_str_response = $l_arr_response['body'];
|
|
// Get plugin object.
|
|
$l_arr_plugin = json_decode( $l_str_response, true );
|
|
if ( empty( $l_arr_plugin ) ) {
|
|
echo wp_json_encode( array( 'error' => 'Error reading Plugin meta information.<br/>URL: ' . $l_str_url . '<br/>Response: ' . $l_str_response ) );
|
|
exit;
|
|
}
|
|
|
|
$l_int_num_ratings = array_key_exists( 'num_ratings', $l_arr_plugin ) ? intval( $l_arr_plugin['num_ratings'] ) : 0;
|
|
$l_int_rating = array_key_exists( 'rating', $l_arr_plugin ) ? floatval( $l_arr_plugin['rating'] ) : 0.0;
|
|
$l_int_stars = round( 5 * $l_int_rating / 100.0, 1 );
|
|
|
|
// Return Plugin information as JSON encoded string.
|
|
echo wp_json_encode(
|
|
array(
|
|
'error' => '',
|
|
'PluginDescription' => array_key_exists( 'short_description', $l_arr_plugin ) ? html_entity_decode( $l_arr_plugin['short_description'] ) : 'Error reading Plugin information',
|
|
'PluginAuthor' => array_key_exists( 'author', $l_arr_plugin ) ? html_entity_decode( $l_arr_plugin['author'] ) : 'unknown',
|
|
'PluginRatingText' => $l_int_stars . ' ' . __( 'rating based on', 'footnotes' ) . ' ' . $l_int_num_ratings . ' ' . __( 'ratings', 'footnotes' ),
|
|
'PluginRating1' => $l_int_stars >= 0.5 ? 'star-full' : 'star-empty',
|
|
'PluginRating2' => $l_int_stars >= 1.5 ? 'star-full' : 'star-empty',
|
|
'PluginRating3' => $l_int_stars >= 2.5 ? 'star-full' : 'star-empty',
|
|
'PluginRating4' => $l_int_stars >= 3.5 ? 'star-full' : 'star-empty',
|
|
'PluginRating5' => $l_int_stars >= 4.5 ? 'star-full' : 'star-empty',
|
|
'PluginRating' => $l_int_num_ratings,
|
|
'PluginLastUpdated' => array_key_exists( 'last_updated', $l_arr_plugin ) ? $l_arr_plugin['last_updated'] : 'unknown',
|
|
'PluginDownloads' => array_key_exists( 'downloaded', $l_arr_plugin ) ? $l_arr_plugin['downloaded'] : '---',
|
|
)
|
|
);
|
|
exit;
|
|
}
|
|
// phpcs:enable WordPress.Security.NonceVerification.Missing
|
|
}
|