refactor: rename files in line with WPCS, split into public/admin/includes (a.k.a. common)

src/public/widget/class-footnotes-widget-reference-container.php

@@ -0,0 +1,80 @@
+<?php // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
+/**
+ * Includes the Plugin Widget to put the Reference Container to the Widget area.
+ *
+ * @filesource
+ * @package footnotes
+ * @since 1.5.0
+ */
+
+require_once dirname( __FILE__ ) . '/class-footnotes-widget-base.php';
+
+/**
+ * Registers a Widget to put the Reference Container to the widget area.
+ *
+ * @since 1.5.0
+ */
+class Footnotes_Widget_Reference_Container extends Footnotes_Widget_Base {
+
+	/**
+	 * Returns an unique ID as string used for the Widget Base ID.
+	 *
+	 * @since 1.5.0
+	 * @return string
+	 */
+	protected function get_id() {
+		return 'footnotes_widget';
+	}
+
+	/**
+	 * Returns the Public name of the Widget to be displayed in the Configuration page.
+	 *
+	 * @since 1.5.0
+	 * @return string
+	 */
+	protected function get_name() {
+		return Footnotes_Config::C_STR_PLUGIN_NAME;
+	}
+
+	/**
+	 * Returns the Description of the child widget.
+	 *
+	 * @since 1.5.0
+	 * @return string
+	 *
+	 * Edit: curly quotes 2.2.0
+	 */
+	protected function get_description() {
+		return __( 'The widget defines the position of the reference container if set to “widget area”.', 'footnotes' );
+	}
+
+	/**
+	 * Outputs the Settings of the Widget.
+	 *
+	 * @since 1.5.0
+	 * @param mixed $instance The instance of the widget.
+	 * @return void
+	 *
+	 * Edit: curly quotes 2.2.0
+	 */
+	public function form( $instance ) {
+		echo __( 'The widget defines the position of the reference container if set to “widget area”.', 'footnotes' );
+	}
+
+	/**
+	 * Outputs the Content of the Widget.
+	 *
+	 * @since 1.5.0
+	 * @param mixed $args     The widget's arguments.
+	 * @param mixed $instance The instance of the widget.
+	 */
+	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 ) ) {
+			// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
+			echo $footnotes->a_obj_task->reference_container();
+			// phpcs:enable
+		}
+	}
+}