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

refactor: namespace everything

Browse source
This commit is contained in:
Ben Goldsworthy 2021-05-01 21:34:46 +01:00
parent 6683c0b169
commit ce41cd8353
21 changed files with 939 additions and 839 deletions
Download patch file Download diff file Expand all files Collapse all files

63
src/public/class-footnotes-public.php → src/public/class-general.php
View file

@ -2,20 +2,23 @@
/**
* The public-facing functionality of the plugin.
*
* @package footnotes\public
* @since 2.8.0
* @package footnotes
* @since 2.8.0
*/
namespace footnotes\general;
use footnotes\includes as Includes;
/**
* Class provide all admin-specific functionality of the plugin.
* Class provide all public-facing functionality of the plugin.
*
* Defines the plugin name, version, and enqueues all public-facing stylesheets
* and JavaScript.
*
* @package footnotes\public
* @since 2.8.0
* @package footnotes
* @since 2.8.0
*/
class Footnotes_Public {
class General {
/**
* The ID of this plugin.
@ -42,7 +45,7 @@ class Footnotes_Public {
*
* @since 2.8.0
*
* @var Footnotes_Widget_Reference_Container $reference_container_widget The reference container widget
* @var Widget\Reference_Container $reference_container_widget The reference container widget
*/
private $reference_container_widget;
@ -50,9 +53,9 @@ class Footnotes_Public {
* The footnote parser.
*
* @since 1.5.0
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*
* @var Footnotes_Parser $task The Plugin task.
* @var Parser $task The Plugin task.
*/
public $a_obj_task = null;
@ -60,7 +63,7 @@ class Footnotes_Public {
* Flag for using tooltips.
*
* @since 2.4.0
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*
* @var bool $tooltips_enabled Whether tooltips are enabled or not.
*/
@ -70,7 +73,7 @@ class Footnotes_Public {
* Allows to determine whether alternative tooltips are enabled.
*
* @since 2.1.1
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*
* @var bool
*/
@ -80,7 +83,7 @@ class Footnotes_Public {
* Allows to determine whether AMP compatibility mode is enabled.
*
* @since 2.6.0
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*
* @var bool
*/
@ -90,7 +93,7 @@ class Footnotes_Public {
* Allows to determine the script mode among jQuery or plain JS.
*
* @since 2.5.6
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*
* @var string ‘js’ to use plain JavaScript, ‘jquery’ to use jQuery.
*/
@ -111,10 +114,10 @@ class Footnotes_Public {
$this->load_dependencies();
// Set conditions re-used for stylesheet enqueuing and in class/task.php.
self::$a_bool_amp_enabled = Footnotes_Convert::to_bool( Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE ) );
self::$a_bool_tooltips_enabled = Footnotes_Convert::to_bool( Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED ) );
self::$a_bool_alternative_tooltips_enabled = Footnotes_Convert::to_bool( Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE ) );
self::$a_str_script_mode = Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE );
self::$a_bool_amp_enabled = Includes\Convert::to_bool( Includes\Settings::instance()->get( Includes\Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE ) );
self::$a_bool_tooltips_enabled = Includes\Convert::to_bool( Includes\Settings::instance()->get( Includes\Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED ) );
self::$a_bool_alternative_tooltips_enabled = Includes\Convert::to_bool( Includes\Settings::instance()->get( Includes\Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE ) );
self::$a_str_script_mode = Includes\Settings::instance()->get( Includes\Settings::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE );
}
/**
@ -123,23 +126,23 @@ class Footnotes_Public {
* Include the following files that provide the public-facing functionality
* of this plugin:
*
* - {@see Footnotes_Parser}: parses Posts and Pages for footnote shortcodes; and
* - {@see Footnotes_Widget_Reference_Container}: defines the Reference Container widget.
* - {@see Parser}: parses Posts and Pages for footnote shortcodes; and
* - {@see Widget\Reference_Container}: defines the Reference Container widget.
*
* @since 2.8.0
*/
private function load_dependencies() {
// TODO: neaten up and document once placements and names are settled.
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-config.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-settings.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-convert.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-config.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-settings.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-convert.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-footnotes-parser.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/widget/class-footnotes-widget-reference-container.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-parser.php';
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/widget/class-reference-container.php';
$this->reference_container_widget = new Footnotes_Widget_Reference_Container( $this->plugin_name );
$this->reference_container_widget = new Widget\Reference_Container( $this->plugin_name );
$this->a_obj_task = new Footnotes_Parser();
$this->a_obj_task = new Parser();
}
/**
@ -150,7 +153,7 @@ class Footnotes_Public {
*
* @since 1.5.0
* @since 2.5.5 Change stylesheet schema.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*/
public function enqueue_styles() {
if ( PRODUCTION_ENV ) {
@ -176,7 +179,7 @@ class Footnotes_Public {
}
// Set basic responsive page layout mode for use in stylesheet name.
$l_str_page_layout_option = Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT );
$l_str_page_layout_option = Includes\Settings::instance()->get( Includes\Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT );
switch ( $l_str_page_layout_option ) {
case 'reference-container':
$l_str_layout_mode = '1';
@ -215,7 +218,7 @@ class Footnotes_Public {
* @since 2.0.0 Add jQueryUI dependency.
* @since 2.1.2 Add jQuery Tools dependency.
* @since 2.5.6 Add jQuery dependency.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*/
public function enqueue_scripts() {
/*
@ -264,7 +267,7 @@ class Footnotes_Public {
* Register the widget(s) for the public-facing side of the site.
*
* @since 1.5.0
* @since 2.8.0 Moved from {@see Footnotes} to {@see Footnotes_Public}.
* @since 2.8.0 Moved from {@see Footnotes} to {@see Includes\Public}.
*/
public function register_widgets() {
register_widget( $this->reference_container_widget );

549
src/public/class-footnotes-parser.php → src/public/class-parser.php
View file

File diff suppressed because it is too large Load diff

19
src/public/widget/class-footnotes-widget-base.php → src/public/widget/class-base.php
View file

@ -1,15 +1,18 @@
<?php
/**
* Widgets: Footnotes_Widget_Base class
* Widgets: Base class
*
* The Widget subpackage is composed of the {@see Footnotes_Widget_Base}
* abstract class, which is extended by the {@see Footnotes_Widget_Reference_Container}
* The Widget subpackage is composed of the {@see Base}
* abstract class, which is extended by the {@see Reference_Container}
* sub-class.
*
* @package footnotes\public\widget
* @package footnotes
* @since 1.5.0
*/
namespace footnotes\general\Widget;
use footnotes\includes as Includes;
/**
* Base class to be extended by all widget sub-classes.
*
@ -18,11 +21,11 @@
*
* @abstract
*
* @package footnotes\public\widget
* @since 1.5.0
* @todo Review implemenation of Widgets API.
* @package footnotes
* @since 1.5.0
* @todo Review implemenation of Widgets API.
*/
abstract class Footnotes_Widget_Base extends WP_Widget {
abstract class Base extends \WP_Widget {
/**
* Returns an unique ID as string used for the Widget Base ID.

33
src/public/widget/class-footnotes-widget-reference-container.php → src/public/widget/class-reference-container.php
View file

@ -1,33 +1,36 @@
<?php // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
/**
* Widgets: Footnotes_Widget_Reference_Container class
* Widgets: Reference_Container class
*
* The Widget subpackage is composed of the {@see Footnotes_Widget_Base}
* abstract class, which is extended by the {@see Footnotes_Widget_Reference_Container}
* The Widget subpackage is composed of the {@see Base}
* abstract class, which is extended by the {@see Reference_Container}
* sub-class.
*
* @package footnotes\public\widget
* @package footnotes
* @since 1.5.0
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'widget/class-footnotes-widget-base.php';
namespace footnotes\general\Widget;
use footnotes\includes as Includes;
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'widget/class-base.php';
/**
* Registers a Widget to put the Reference Container to the widget area.
*
* @package footnotes\public\widget
* @since 1.5.0
* @see Footnotes_Widget_Base
* @todo Review implemenation of Widgets API.
* @package footnotes
* @since 1.5.0
* @todo Review implemenation of Widgets API.
* @see Base
*/
class Footnotes_Widget_Reference_Container extends Footnotes_Widget_Base {
class Reference_Container extends Base {
/**
* The ID of this plugin.
*
* @access private
* @since 2.8.0
* @see Footnotes::$plugin_name
* @see Includes\Footnotes::$plugin_name
* @var string $plugin_name The ID of this plugin.
*/
private $plugin_name;
@ -47,7 +50,7 @@ class Footnotes_Widget_Reference_Container extends Footnotes_Widget_Base {
/**
* Returns an unique ID as string used for the Widget Base ID.
*
* @see Footnotes_Widget_Base::get_id()
* @see Base::get_id()
* @since 1.5.0
*
* @return string
@ -59,7 +62,7 @@ class Footnotes_Widget_Reference_Container extends Footnotes_Widget_Base {
/**
* Returns the Public name of the Widget to be displayed in the Configuration page.
*
* @see Footnotes_Widget_Base::get_name()
* @see Base::get_name()
* @since 1.5.0
*
* @return string
@ -71,7 +74,7 @@ class Footnotes_Widget_Reference_Container extends Footnotes_Widget_Base {
/**
* Returns the Description of the child widget.
*
* @see Footnotes_Widget_Base::get_description()
* @see Base::get_description()
* @since 1.5.0
*
* @return string
@ -104,7 +107,7 @@ class Footnotes_Widget_Reference_Container extends Footnotes_Widget_Base {
public function widget( $args, $instance ) {
global $footnotes;
// Reference container positioning is set to "widget area".
if ( 'widget' === Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION ) ) {
if ( 'widget' === Includes\Settings::instance()->get( Includes\Settings::C_STR_REFERENCE_CONTAINER_POSITION ) ) {
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
echo $footnotes->a_obj_task->reference_container();
// phpcs:enable