Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Ran [conversion script](https://gist.github.com/Rumperuu/51bccc659e1b7882f5101c1ed008cd9d)

Browse source
This commit is contained in:
Ben Goldsworthy 2021-02-21 09:50:23 +00:00
parent 81a41202bb
commit bb3b555148
13 changed files with 5243 additions and 5219 deletions
Download patch file Download diff file Expand all files Collapse all files

214
class/dashboard/class-mci-footnotes-layout-init.php Normal file
View file

@ -0,0 +1,214 @@
<?php
/**
* Includes the Plugin settings menu.
*
* @filesource
* @package footnotes
* @author Stefan Herndler
* @since 1.5.0 12.09.14 10:26
*/
/**
* Handles the Settings interface of the Plugin.
*
* @author Stefan Herndler
* @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.
*
* @author Stefan Herndler
* @since 1.5.0
* @var string
*/
const C_STR_MAIN_MENU_TITLE = 'ManFisher';
/**
* Contains layout engine sub classes.
*
* @author Stefan Herndler
* @since 1.5.0
* @var array
*/
private $a_arr_sub_page_classes = array();
/**
* Class Constructor. Initializes all WordPress hooks for the Plugin Settings.
*
* @author Stefan Herndler
* @since 1.5.0
*/
public function __construct() {
// iterate through each class define in the current script.
foreach ( get_declared_classes() as $l_str_class_name ) {
// accept only child classes of the layout engine.
if ( is_subclass_of( $l_str_class_name, 'MCI_Footnotes_LayoutEngine' ) ) {
$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->getPriority() ] = $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_getPluginInfo', array( $this, 'get_plugin_meta_information' ) );
add_action( 'wp_ajax_footnotes_getPluginInfo', array( $this, 'get_plugin_meta_information' ) );
}
/**
* Initializes all sub pages and registers the settings.
*
* @author Stefan Herndler
* @since 1.5.0
*/
public function initialize_settings() {
MCI_Footnotes_Settings::instance()->RegisterSettings();
// 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->registerSections();
}
}
/**
* Registers the new main menu for the WordPress dashboard.
* Registers all sub menu pages for the new main menu.
*
* @author Stefan Herndler
* @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 ) {
// iterate 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.
*
* @author Stefan Herndler
* @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.
*
* @author Stefan Herndler
* @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' );
echo wp_kses_post( $l_obj_template->getContent() );
printf( '<em>visit <a href="https://cheret.de/plugins/footnotes-2/" target="_blank">Mark Cheret</a></em>' );
printf( '<br/><br/>' );
printf( '</div>' );
}
/**
* AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.
*
* @author Stefan Herndler
* @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'] ) && 'true' === $_POST['plugin'] ) {
$l_str_plugin_name = wp_kses_post( wp_unslash( $_POST['plugin'] ) );
}
if ( empty( $l_str_plugin_name ) ) {
echo 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 json_encode( array( 'error' => 'Error receiving Plugin Information from WordPress.' ) );
exit;
}
if ( ! array_key_exists( 'body', $l_arr_response ) ) {
echo 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 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 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;
}
}

323
class/dashboard/layout.php → class/dashboard/class-mci-footnotes-layoutengine.php
View file

@ -3,6 +3,7 @@
* Includes Layout Engine for the admin dashboard.
*
* @filesource
* @package footnotes
* @author Stefan Herndler
* @since 1.5.0 12.09.14 10:56
*
@ -32,7 +33,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @var null|string
*/
protected $a_str_SubPageHook = null;
protected $a_str_sub_page_hook = null;
/**
* Stores all Sections for the child sub page.
@ -41,7 +42,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @var array
*/
protected $a_arr_Sections = array();
protected $a_arr_sections = array();
/**
* Returns a Priority index. Lower numbers have a higher Priority.
@ -50,7 +51,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return int
*/
abstract public function getPriority();
abstract public function get_priority();
/**
* Returns the unique slug of the child sub page.
@ -59,7 +60,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return string
*/
abstract protected function getSubPageSlug();
abstract protected function get_sub_page_slug();
/**
* Returns the title of the child sub page.
@ -68,7 +69,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return string
*/
abstract protected function getSubPageTitle();
abstract protected function get_sub_page_title();
/**
* Returns an array of all registered sections for a sub page.
@ -77,7 +78,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return array
*/
abstract protected function getSections();
abstract protected function get_sections();
/**
* Returns an array of all registered meta boxes.
@ -86,25 +87,25 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return array
*/
abstract protected function getMetaBoxes();
abstract protected function get_meta_boxes();
/**
* Returns an array describing a sub page section.
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_ID Unique ID suffix.
* @param string $p_str_Title Title of the section.
* @param int $p_int_SettingsContainerIndex Settings Container Index.
* @param bool $p_bool_hasSubmitButton Should a Submit Button be displayed for this section, default: true.
* @param string $p_str_id Unique ID suffix.
* @param string $p_str_title Title of the section.
* @param int $p_int_settings_container_index Settings Container Index.
* @param bool $p_bool_has_submit_button Should a Submit Button be displayed for this section, default: true.
* @return array Array describing the section.
*/
protected function addSection( $p_str_ID, $p_str_Title, $p_int_SettingsContainerIndex, $p_bool_hasSubmitButton = true ) {
protected function add_section( $p_str_id, $p_str_title, $p_int_settings_container_index, $p_bool_has_submit_button = true ) {
return array(
'id' => MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '-' . $p_str_ID,
'title' => $p_str_Title,
'submit' => $p_bool_hasSubmitButton,
'container' => $p_int_SettingsContainerIndex,
'id' => MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '-' . $p_str_id,
'title' => $p_str_title,
'submit' => $p_bool_has_submit_button,
'container' => $p_int_settings_container_index,
);
}
@ -113,18 +114,18 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SectionID Parent Section ID.
* @param string $p_str_ID Unique ID suffix.
* @param string $p_str_Title Title for the meta box.
* @param string $p_str_CallbackFunctionName Class method name for callback.
* @param string $p_str_section_id Parent Section ID.
* @param string $p_str_id Unique ID suffix.
* @param string $p_str_title Title for the meta box.
* @param string $p_str_callback_function_name Class method name for callback.
* @return array meta box description to be able to append a meta box to the output.
*/
protected function addMetaBox( $p_str_SectionID, $p_str_ID, $p_str_Title, $p_str_CallbackFunctionName ) {
protected function add_meta_box( $p_str_section_id, $p_str_id, $p_str_title, $p_str_callback_function_name ) {
return array(
'parent' => MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '-' . $p_str_SectionID,
'id' => $p_str_ID,
'title' => $p_str_Title,
'callback' => $p_str_CallbackFunctionName,
'parent' => MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '-' . $p_str_section_id,
'id' => $p_str_id,
'title' => $p_str_title,
'callback' => $p_str_callback_function_name,
);
}
@ -134,26 +135,26 @@ abstract class MCI_Footnotes_LayoutEngine {
* @author Stefan Herndler
* @since 1.5.0
*/
public function registerSubPage() {
public function register_sub_page() {
global $submenu;
// any sub menu for our main menu exists
if ( array_key_exists( plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG ), $submenu ) ) {
// iterate through all sub menu entries of the ManFisher main menu
foreach ( $submenu[ plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG ) ] as $l_arr_SubMenu ) {
if ( $l_arr_SubMenu[2] == plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->getSubPageSlug() ) ) {
foreach ( $submenu[ plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG ) ] as $l_arr_sub_menu ) {
if ( $l_arr_sub_menu[2] == plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug() ) ) {
// remove that sub menu and add it again to move it to the bottom
remove_submenu_page( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG, MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->getSubPageSlug() );
remove_submenu_page( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG, MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug() );
}
}
}
$this->a_str_SubPageHook = add_submenu_page(
$this->a_str_sub_page_hook = add_submenu_page(
MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG, // parent slug
$this->getSubPageTitle(), // page title
$this->getSubPageTitle(), // menu title
$this->get_sub_page_title(), // page title
$this->get_sub_page_title(), // menu title
'manage_options', // capability
MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->getSubPageSlug(), // menu slug
array( $this, 'displayContent' ) // function
MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug(), // menu slug
array( $this, 'display_content' ) // function
);
}
@ -163,18 +164,18 @@ abstract class MCI_Footnotes_LayoutEngine {
* @author Stefan Herndler
* @since 1.5.0
*/
public function registerSections() {
public function register_sections() {
// iterate through each section
foreach ( $this->getSections() as $l_arr_Section ) {
foreach ( $this->get_sections() as $l_arr_section ) {
// append tab to the tab-array
$this->a_arr_Sections[ $l_arr_Section['id'] ] = $l_arr_Section;
$this->a_arr_sections[ $l_arr_section['id'] ] = $l_arr_section;
add_settings_section(
$l_arr_Section['id'], // unique id
'', // $l_arr_Section["title"], // title
$l_arr_section['id'], // unique id
'', // $l_arr_section["title"], // title
array( $this, 'Description' ), // callback function for the description
$l_arr_Section['id'] // parent sub page slug
$l_arr_section['id'] // parent sub page slug
);
$this->registerMetaBoxes( $l_arr_Section['id'] );
$this->register_meta_boxes( $l_arr_section['id'] );
}
}
@ -183,19 +184,19 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_ParentID Parent section unique id.
* @param string $p_str_parent_iD Parent section unique id.
*/
private function registerMetaBoxes( $p_str_ParentID ) {
private function register_meta_boxes( $p_str_parent_iD ) {
// iterate through each meta box
foreach ( $this->getMetaBoxes() as $l_arr_MetaBox ) {
if ( $l_arr_MetaBox['parent'] != $p_str_ParentID ) {
foreach ( $this->get_meta_boxes() as $l_arr_meta_box ) {
if ( $l_arr_meta_box['parent'] != $p_str_parent_iD ) {
continue;
}
add_meta_box(
$p_str_ParentID . '-' . $l_arr_MetaBox['id'], // unique id
$l_arr_MetaBox['title'], // meta box title
array( $this, $l_arr_MetaBox['callback'] ), // callback function to display (echo) the content
$p_str_ParentID, // post type = parent section id
$p_str_parent_iD . '-' . $l_arr_meta_box['id'], // unique id
$l_arr_meta_box['title'], // meta box title
array( $this, $l_arr_meta_box['callback'] ), // callback function to display (echo) the content
$p_str_parent_iD, // post type = parent section id
'main' // context
);
}
@ -207,7 +208,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @author Stefan Herndler
* @since 1.5.0
*/
private function appendScripts() {
private function append_scripts() {
// enable meta boxes layout and close functionality
wp_enqueue_script( 'postbox' );
// add WordPress color picker layout
@ -252,20 +253,20 @@ abstract class MCI_Footnotes_LayoutEngine {
* @author Stefan Herndler
* @since 1.5.0
*/
public function displayContent() {
public function display_content() {
// register and enqueue scripts and styling
$this->appendScripts();
$this->append_scripts();
// get current section
reset( $this->a_arr_Sections );
$l_str_ActiveSectionID = isset( $_GET['t'] ) ? $_GET['t'] : key( $this->a_arr_Sections );
$l_arr_ActiveSection = $this->a_arr_Sections[ $l_str_ActiveSectionID ];
reset( $this->a_arr_sections );
$l_str_active_section_iD = isset( $_GET['t'] ) ? $_GET['t'] : key( $this->a_arr_sections );
$l_arr_active_section = $this->a_arr_sections[ $l_str_active_section_iD ];
// store settings
$l_bool_SettingsUpdated = false;
$l_bool_settings_updated = false;
if ( array_key_exists( 'save-settings', $_POST ) ) {
if ( $_POST['save-settings'] == 'save' ) {
unset( $_POST['save-settings'] );
unset( $_POST['submit'] );
$l_bool_SettingsUpdated = $this->saveSettings();
$l_bool_settings_updated = $this->save_settings();
}
}
@ -273,31 +274,31 @@ abstract class MCI_Footnotes_LayoutEngine {
echo '<div class="wrap">';
echo '<h2 class="nav-tab-wrapper">';
// iterate through all register sections
foreach ( $this->a_arr_Sections as $l_str_ID => $l_arr_Description ) {
foreach ( $this->a_arr_sections as $l_str_id => $l_arr_description ) {
echo sprintf(
'<a class="nav-tab%s" href="?page=%s&t=%s">%s</a>',
$l_arr_ActiveSection['id'] == $l_str_ID ? ' nav-tab-active' : '',
MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->getSubPageSlug(),
$l_str_ID,
$l_arr_Description['title']
$l_arr_active_section['id'] == $l_str_id ? ' nav-tab-active' : '',
MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug(),
$l_str_id,
$l_arr_description['title']
);
}
echo '</h2><br/>';
if ( $l_bool_SettingsUpdated ) {
if ( $l_bool_settings_updated ) {
echo sprintf( '<div id="message" class="updated">%s</div>', __( 'Settings saved', MCI_Footnotes_Config::C_STR_PLUGIN_NAME ) );
}
// form to submit the active section
echo '<!--suppress HtmlUnknownTarget --><form method="post" action="">';
// settings_fields($l_arr_ActiveSection["container"]);
echo '<!--suppress Html_unknown_target --><form method="post" action="">';
// settings_fields($l_arr_active_section["container"]);
echo '<input type="hidden" name="save-settings" value="save" />';
// outputs the settings field of the active section
do_settings_sections( $l_arr_ActiveSection['id'] );
do_meta_boxes( $l_arr_ActiveSection['id'], 'main', null );
do_settings_sections( $l_arr_active_section['id'] );
do_meta_boxes( $l_arr_active_section['id'], 'main', null );
// add submit button to active section if defined
if ( $l_arr_ActiveSection['submit'] ) {
if ( $l_arr_active_section['submit'] ) {
submit_button();
}
// close the form to submit data
@ -306,10 +307,10 @@ abstract class MCI_Footnotes_LayoutEngine {
echo '</div>';
// output special javascript for the expand/collapse function of the meta boxes
echo '<script type="text/javascript">';
echo 'jQuery(document).ready(function ($) {';
echo 'jQuery(".mfmmf-color-picker").wpColorPicker();';
echo "jQuery('.if-js-closed').removeClass('if-js-closed').addClass('closed');";
echo "postboxes.add_postbox_toggles('" . $this->a_str_SubPageHook . "');";
echo 'j_query(document).ready(function ($) {';
echo 'j_query(".mfmmf-color-picker").wp_color_picker();';
echo "j_query('.if-js-closed').remove_class('if-js-closed').add_class('closed');";
echo "postboxes.add_postbox_toggles('" . $this->a_str_sub_page_hook . "');";
echo '});';
echo '</script>';
}
@ -321,25 +322,25 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return bool
*/
private function saveSettings() {
$l_arr_newSettings = array();
private function save_settings() {
$l_arr_new_settings = array();
// get current section
reset( $this->a_arr_Sections );
$l_str_ActiveSectionID = isset( $_GET['t'] ) ? $_GET['t'] : key( $this->a_arr_Sections );
$l_arr_ActiveSection = $this->a_arr_Sections[ $l_str_ActiveSectionID ];
reset( $this->a_arr_sections );
$l_str_active_section_iD = isset( $_GET['t'] ) ? $_GET['t'] : key( $this->a_arr_sections );
$l_arr_active_section = $this->a_arr_sections[ $l_str_active_section_iD ];
// iterate through each value that has to be in the specific container
foreach ( MCI_Footnotes_Settings::instance()->getDefaults( $l_arr_ActiveSection['container'] ) as $l_str_Key => $l_mixed_Value ) {
foreach ( MCI_Footnotes_Settings::instance()->get_defaults( $l_arr_active_section['container'] ) as $l_str_key => $l_mixed_Value ) {
// setting is available in the POST array, use it
if ( array_key_exists( $l_str_Key, $_POST ) ) {
$l_arr_newSettings[ $l_str_Key ] = $_POST[ $l_str_Key ];
if ( array_key_exists( $l_str_key, $_POST ) ) {
$l_arr_new_settings[ $l_str_key ] = $_POST[ $l_str_key ];
} else {
// setting is not defined in the POST array, define it to avoid the Default value
$l_arr_newSettings[ $l_str_Key ] = '';
$l_arr_new_settings[ $l_str_key ] = '';
}
}
// update settings
return MCI_Footnotes_Settings::instance()->saveOptions( $l_arr_ActiveSection['container'], $l_arr_newSettings );
return MCI_Footnotes_Settings::instance()->save_options( $l_arr_active_section['container'], $l_arr_new_settings );
}
/**
@ -357,17 +358,17 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SettingKeyName Settings Array key name.
* @param string $p_str_setting_key_name Settings Array key name.
* @return array Contains Settings ID, Settings Name and Settings Value.
*/
protected function LoadSetting( $p_str_SettingKeyName ) {
protected function Load_setting( $p_str_setting_key_name ) {
// get current section
reset( $this->a_arr_Sections );
$p_arr_Return = array();
$p_arr_Return['id'] = sprintf( '%s', $p_str_SettingKeyName );
$p_arr_Return['name'] = sprintf( '%s', $p_str_SettingKeyName );
$p_arr_Return['value'] = esc_attr( MCI_Footnotes_Settings::instance()->get( $p_str_SettingKeyName ) );
return $p_arr_Return;
reset( $this->a_arr_sections );
$p_arr_return = array();
$p_arr_return['id'] = sprintf( '%s', $p_str_setting_key_name );
$p_arr_return['name'] = sprintf( '%s', $p_str_setting_key_name );
$p_arr_return['value'] = esc_attr( MCI_Footnotes_Settings::instance()->get( $p_str_setting_key_name ) );
return $p_arr_return;
}
/**
@ -377,7 +378,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return string
*/
protected function addNewline() {
protected function add_newline() {
return '<br/>';
}
@ -388,7 +389,7 @@ abstract class MCI_Footnotes_LayoutEngine {
* @since 1.5.0
* @return string
*/
protected function addLineSpace() {
protected function add_line_space() {
return '<br/><br/>';
}
@ -397,11 +398,11 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_Text Message to be surrounded with simple html tag (span).
* @param string $p_str_text Message to be surrounded with simple html tag (span).
* @return string
*/
protected function addText( $p_str_Text ) {
return sprintf( '<span>%s</span>', $p_str_Text );
protected function add_text( $p_str_text ) {
return sprintf( '<span>%s</span>', $p_str_text );
}
/**
@ -409,15 +410,15 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SettingName Name of the Settings key to connect the Label with the input/select field.
* @param string $p_str_Caption Label caption.
* @param string $p_str_setting_name Name of the Settings key to connect the Label with the input/select field.
* @param string $p_str_caption Label caption.
* @return string
*
* Edited 2020-12-01T0159+0100..
* @since 2.1.6 no colon
*/
protected function addLabel( $p_str_SettingName, $p_str_Caption ) {
if ( empty( $p_str_Caption ) ) {
protected function add_label( $p_str_setting_name, $p_str_caption ) {
if ( empty( $p_str_caption ) ) {
return '';
}
// remove the colon causing localization issues with French,
@ -429,7 +430,7 @@ abstract class MCI_Footnotes_LayoutEngine {
// Add colon to label strings for inclusion in localization.
// Colon after label is widely preferred best practice, mandatory per style guides.
// <https://softwareengineering.stackexchange.com/questions/234546/colons-in-internationalized-ui>
return sprintf( '<label for="%s">%s</label>', $p_str_SettingName, $p_str_Caption );
return sprintf( '<label for="%s">%s</label>', $p_str_setting_name, $p_str_caption );
// ^ here deleted colon 2020-12-08T1546+0100
}
@ -438,27 +439,27 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SettingName Name of the Settings key to pre load the input field.
* @param int $p_str_MaxLength Maximum length of the input, default 999 characters.
* @param bool $p_bool_Readonly Set the input to be read only, default false.
* @param bool $p_bool_Hidden Set the input to be hidden, default false.
* @param string $p_str_setting_name Name of the Settings key to pre load the input field.
* @param int $p_str_maxLength Maximum length of the input, default 999 characters.
* @param bool $p_bool_readonly Set the input to be read only, default false.
* @param bool $p_bool_hidden Set the input to be hidden, default false.
* @return string
*/
protected function addTextBox( $p_str_SettingName, $p_str_MaxLength = 999, $p_bool_Readonly = false, $p_bool_Hidden = false ) {
$l_str_Style = '';
protected function add_text_box( $p_str_setting_name, $p_str_maxLength = 999, $p_bool_readonly = false, $p_bool_hidden = false ) {
$l_str_style = '';
// collect data for given settings field
$l_arr_Data = $this->LoadSetting( $p_str_SettingName );
if ( $p_bool_Hidden ) {
$l_str_Style .= 'display:none;';
$l_arr_data = $this->Load_setting( $p_str_setting_name );
if ( $p_bool_hidden ) {
$l_str_style .= 'display:none;';
}
return sprintf(
'<input type="text" name="%s" id="%s" maxlength="%d" style="%s" value="%s" %s/>',
$l_arr_Data['name'],
$l_arr_Data['id'],
$p_str_MaxLength,
$l_str_Style,
$l_arr_Data['value'],
$p_bool_Readonly ? 'readonly="readonly"' : ''
$l_arr_data['name'],
$l_arr_data['id'],
$p_str_maxLength,
$l_str_style,
$l_arr_data['value'],
$p_bool_readonly ? 'readonly="readonly"' : ''
);
}
@ -467,17 +468,17 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SettingName Name of the Settings key to pre load the input field.
* @param string $p_str_setting_name Name of the Settings key to pre load the input field.
* @return string
*/
protected function addCheckbox( $p_str_SettingName ) {
protected function add_checkbox( $p_str_setting_name ) {
// collect data for given settings field
$l_arr_Data = $this->LoadSetting( $p_str_SettingName );
$l_arr_data = $this->Load_setting( $p_str_setting_name );
return sprintf(
'<input type="checkbox" name="%s" id="%s" %s/>',
$l_arr_Data['name'],
$l_arr_Data['id'],
MCI_Footnotes_Convert::toBool( $l_arr_Data['value'] ) ? 'checked="checked"' : ''
$l_arr_data['name'],
$l_arr_data['id'],
MCI_Footnotes_Convert::to_bool( $l_arr_data['value'] ) ? 'checked="checked"' : ''
);
}
@ -486,29 +487,29 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SettingName Name of the Settings key to pre select the current value.
* @param array $p_arr_Options Possible options to be selected.
* @param string $p_str_setting_name Name of the Settings key to pre select the current value.
* @param array $p_arr_options Possible options to be selected.
* @return string
*/
protected function addSelectBox( $p_str_SettingName, $p_arr_Options ) {
protected function add_select_box( $p_str_setting_name, $p_arr_options ) {
// collect data for given settings field
$l_arr_Data = $this->LoadSetting( $p_str_SettingName );
$l_str_Options = '';
$l_arr_data = $this->Load_setting( $p_str_setting_name );
$l_str_options = '';
/* loop through all array keys */
foreach ( $p_arr_Options as $l_str_Value => $l_str_Caption ) {
$l_str_Options .= sprintf(
foreach ( $p_arr_options as $l_str_value => $l_str_caption ) {
$l_str_options .= sprintf(
'<option value="%s" %s>%s</option>',
$l_str_Value,
$l_arr_Data['value'] == $l_str_Value ? 'selected' : '',
$l_str_Caption
$l_str_value,
$l_arr_data['value'] == $l_str_value ? 'selected' : '',
$l_str_caption
);
}
return sprintf(
'<select name="%s" id="%s">%s</select>',
$l_arr_Data['name'],
$l_arr_Data['id'],
$l_str_Options
$l_arr_data['name'],
$l_arr_data['id'],
$l_str_options
);
}
@ -517,17 +518,17 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SettingName Name of the Settings key to pre fill the text area.
* @param string $p_str_setting_name Name of the Settings key to pre fill the text area.
* @return string
*/
protected function addTextArea( $p_str_SettingName ) {
protected function add_text_area( $p_str_setting_name ) {
// collect data for given settings field
$l_arr_Data = $this->LoadSetting( $p_str_SettingName );
$l_arr_data = $this->Load_setting( $p_str_setting_name );
return sprintf(
'<textarea name="%s" id="%s">%s</textarea>',
$l_arr_Data['name'],
$l_arr_Data['id'],
$l_arr_Data['value']
$l_arr_data['name'],
$l_arr_data['id'],
$l_arr_data['value']
);
}
@ -536,17 +537,17 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.6
* @param string $p_str_SettingName Name of the Settings key to pre load the input field.
* @param string $p_str_setting_name Name of the Settings key to pre load the input field.
* @return string
*/
protected function addColorSelection( $p_str_SettingName ) {
protected function add_color_selection( $p_str_setting_name ) {
// collect data for given settings field
$l_arr_Data = $this->LoadSetting( $p_str_SettingName );
$l_arr_data = $this->Load_setting( $p_str_setting_name );
return sprintf(
'<input type="text" name="%s" id="%s" class="mfmmf-color-picker" value="%s"/>',
$l_arr_Data['name'],
$l_arr_Data['id'],
$l_arr_Data['value']
$l_arr_data['name'],
$l_arr_data['id'],
$l_arr_data['value']
);
}
@ -555,37 +556,37 @@ abstract class MCI_Footnotes_LayoutEngine {
*
* @author Stefan Herndler
* @since 1.5.0
* @param string $p_str_SettingName Name of the Settings key to pre load the input field.
* @param string $p_str_setting_name Name of the Settings key to pre load the input field.
* @param int $p_in_Min Minimum value.
* @param int $p_int_Max Maximum value.
* @param bool $p_bool_Deci true if 0.1 steps and floating to string, false if integer (default)
* @param int $p_int_max Maximum value.
* @param bool $p_bool_deci true if 0.1 steps and floating to string, false if integer (default)
* @return string
*
* Edited:
* @since 2.1.4 step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100
*/
protected function addNumBox( $p_str_SettingName, $p_in_Min, $p_int_Max, $p_bool_Deci = false ) {
protected function add_num_box( $p_str_setting_name, $p_in_Min, $p_int_max, $p_bool_deci = false ) {
// collect data for given settings field
$l_arr_Data = $this->LoadSetting( $p_str_SettingName );
$l_arr_data = $this->Load_setting( $p_str_setting_name );
if ( $p_bool_Deci ) {
$l_str_Value = number_format( floatval( $l_arr_Data['value'] ), 1 );
if ( $p_bool_deci ) {
$l_str_value = number_format( floatval( $l_arr_data['value'] ), 1 );
return sprintf(
'<input type="number" name="%s" id="%s" value="%s" step="0.1" min="%d" max="%d"/>',
$l_arr_Data['name'],
$l_arr_Data['id'],
$l_str_Value,
$l_arr_data['name'],
$l_arr_data['id'],
$l_str_value,
$p_in_Min,
$p_int_Max
$p_int_max
);
} else {
return sprintf(
'<input type="number" name="%s" id="%s" value="%d" min="%d" max="%d"/>',
$l_arr_Data['name'],
$l_arr_Data['id'],
$l_arr_Data['value'],
$l_arr_data['name'],
$l_arr_data['id'],
$l_arr_data['value'],
$p_in_Min,
$p_int_Max
$p_int_max
);
}
}

212
class/dashboard/init.php
View file

@ -1,212 +0,0 @@
<?php
/**
* Includes the Plugin settings menu.
*
* @filesource
* @author Stefan Herndler
* @since 1.5.0 12.09.14 10:26
*/
/**
* Handles the Settings interface of the Plugin.
*
* @author Stefan Herndler
* @since 1.5.0
*/
class MCI_Footnotes_Layout_Init {
/**
* Slug for the Plugin main menu.
*
* @author Stefan Herndler
* @since 1.5.0
* @var string
*/
const C_STR_MAIN_MENU_SLUG = 'mfmmf';
/**
* Plugin main menu name.
*
* @author Stefan Herndler
* @since 1.5.0
* @var string
*/
const C_STR_MAIN_MENU_TITLE = 'ManFisher';
/**
*
* @author Stefan Herndler
* @since 1.5.0
* @var array
*/
private $a_arr_SubPageClasses = array();
/**
* Class Constructor. Initializes all WordPress hooks for the Plugin Settings.
*
* @author Stefan Herndler
* @since 1.5.0
*/
public function __construct() {
// iterate through each class define in the current script
foreach ( get_declared_classes() as $l_str_ClassName ) {
// accept only child classes of the layout engine
if ( is_subclass_of( $l_str_ClassName, 'MCI_Footnotes_LayoutEngine' ) ) {
/** @var MCI_Footnotes_LayoutEngine $l_obj_Class */
$l_obj_Class = new $l_str_ClassName();
// append new instance of the layout engine sub class
$this->a_arr_SubPageClasses[ $l_obj_Class->getPriority() ] = $l_obj_Class;
}
}
ksort( $this->a_arr_SubPageClasses );
// register hooks/actions
add_action( 'admin_init', array( $this, 'initializeSettings' ) );
add_action( 'admin_menu', array( $this, 'registerMainMenu' ) );
// register AJAX callbacks for Plugin information
add_action( 'wp_ajax_nopriv_footnotes_getPluginInfo', array( $this, 'getPluginMetaInformation' ) );
add_action( 'wp_ajax_footnotes_getPluginInfo', array( $this, 'getPluginMetaInformation' ) );
}
/**
* Initializes all sub pages and registers the settings.
*
* @author Stefan Herndler
* @since 1.5.0
*/
public function initializeSettings() {
MCI_Footnotes_Settings::instance()->RegisterSettings();
// iterate though each sub class of the layout engine and register their sections
/** @var MCI_Footnotes_LayoutEngine $l_obj_LayoutEngineSubClass */
foreach ( $this->a_arr_SubPageClasses as $l_obj_LayoutEngineSubClass ) {
$l_obj_LayoutEngineSubClass->registerSections();
}
}
/**
* Registers the new main menu for the WordPress dashboard.
* Registers all sub menu pages for the new main menu.
*
* @author Stefan Herndler
* @since 1.5.0
* @see http://codex.wordpress.org/Function_Reference/add_menu_page
*/
public function registerMainMenu() {
global $menu;
// iterate through each main menu
foreach ( $menu as $l_arr_MainMenu ) {
// iterate through each main menu attribute
foreach ( $l_arr_MainMenu as $l_str_Attribute ) {
// main menu already added, append sub pages and stop
if ( $l_str_Attribute == self::C_STR_MAIN_MENU_SLUG ) {
$this->registerSubPages();
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, 'displayOtherPlugins' ), // function
plugins_url( 'footnotes/img/main-menu.png' ), // icon url
null // position
);
$this->registerSubPages();
}
/**
* Registers all SubPages for this Plugin.
*
* @author Stefan Herndler
* @since 1.5.0
*/
private function registerSubPages() {
// 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
/** @var MCI_Footnotes_LayoutEngine $l_obj_LayoutEngineSubClass */
foreach ( $this->a_arr_SubPageClasses as $l_obj_LayoutEngineSubClass ) {
$l_obj_LayoutEngineSubClass->registerSubPage();
}
}
/**
* Displays other Plugins from the developers.
*
* @author Stefan Herndler
* @since 1.5.0
*/
public function displayOtherPlugins() {
printf( '<br/><br/>' );
// load template file
$l_obj_Template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'manfisher' );
echo $l_obj_Template->getContent();
printf( '<em>visit <a href="https://cheret.de/plugins/footnotes-2/" target="_blank">Mark Cheret</a></em>' );
printf( '<br/><br/>' );
printf( '</div>' );
}
/**
* AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.
*
* @author Stefan Herndler
* @since 1.5.0
*/
public function getPluginMetaInformation() {
// get plugin internal name from POST data
$l_str_PluginName = array_key_exists( 'plugin', $_POST ) ? $_POST['plugin'] : null;
if ( empty( $l_str_PluginName ) ) {
echo json_encode( array( 'error' => 'Plugin name invalid.' ) );
exit;
}
$l_str_Url = 'https://api.wordpress.org/plugins/info/1.0/' . $l_str_PluginName . '.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 json_encode( array( 'error' => 'Error receiving Plugin Information from WordPress.' ) );
exit;
}
if ( ! array_key_exists( 'body', $l_arr_Response ) ) {
echo 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 json_encode( array( 'error' => 'Error reading Plugin meta information.<br/>URL: ' . $l_str_Url . '<br/>Response: ' . $l_str_Response ) );
exit;
}
$l_int_NumRatings = 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 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', MCI_Footnotes_Config::C_STR_PLUGIN_NAME ) . ' ' . $l_int_NumRatings . ' ' . __( 'ratings', MCI_Footnotes_Config::C_STR_PLUGIN_NAME ),
'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_NumRatings,
'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;
}
}