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

chore: lint code

Browse source
This commit is contained in:
Ben Goldsworthy 2021-05-01 19:22:41 +01:00
parent 7ad975c389
commit f0c6b07a84
17 changed files with 257 additions and 269 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/admin/class-footnotes-admin.php
View file

@ -52,9 +52,9 @@ class Footnotes_Admin {
/**
* Initialize the class and set its properties.
* @param string $plugin_name The name of this plugin.
* @param string $version The version of this plugin.
* @param string $plugin_name The name of this plugin.
* @param string $version The version of this plugin.
*
* @since 2.8.0
*/
@ -140,7 +140,7 @@ class Footnotes_Admin {
/**
* Appends the Plugin links for display in the dashboard Plugins page.
*
* @param string[] $links The default set of links to display.
* @param string[] $links The default set of links to display.
* @return string[] The full set of links to display.
*
* @since 1.5.0

6
src/admin/class-footnotes-wysiwyg.php
View file

@ -10,7 +10,7 @@
* @package footnotes\admin
* @since 1.5.0
* @since 2.8.0 Rename file from `wysiwyg.php` to `class-footnotes-wysiwyg.php`,
* move from `class/` sub-directory to `admin/`.
* move from `class/` sub-directory to `admin/`.
*/
/**
@ -47,7 +47,7 @@ class Footnotes_WYSIWYG {
/**
* Append a new Button to the WYSIWYG editor of Posts and Pages.
*
* @param string[] $p_arr_buttons Already-defined editor buttons.
* @param string[] $p_arr_buttons Already-defined editor buttons.
* @return string[]
*
* @since 1.5.0
@ -73,7 +73,7 @@ class Footnotes_WYSIWYG {
/**
* Includes the Plugins WYSIWYG editor script.
*
* @param string[] $p_arr_plugins Scripts to be included by the editor.
* @param string[] $p_arr_plugins Scripts to be included by the editor.
* @return string[]
*
* @since 1.5.0

60
src/admin/layout/class-footnotes-layout-engine.php
View file

@ -4,13 +4,13 @@
*
* The Admin. Layouts subpackage is composed of the {@see Footnotes_Layout_Engine}
* abstract class, which is extended by the {@see Footnotes_Layout_Settings}
* sub-class. The subpackage is initialised at runtime by the {@see
* sub-class. The subpackage is initialised at runtime by the {@see
* Footnotes_Layout_Init} class.
*
* @package footnotes\admin_layout
* @since 1.5.0
* @since 2.8.0 Rename file from `layout.php` to `class-footnotes-layout-engine.php`,
* rename `dashboard/` sub-directory to `layout/`.
* rename `dashboard/` sub-directory to `layout/`.
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'layout/class-footnotes-layout-init.php';
@ -19,7 +19,7 @@ require_once plugin_dir_path( dirname( __FILE__ ) ) . 'layout/class-footnotes-la
* Class to be extended by page layout sub-classes.
*
* @abstract
* @package footnotes\admin_layout
* @since 1.5.0
*/
@ -113,11 +113,11 @@ abstract class Footnotes_Layout_Engine {
* Returns an array describing a sub-page section.
*
* @access protected
* @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 Whether a ‘Submit’ button should
* 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 Whether a ‘Submit’ button should
* be displayed for this section. Default `true`.
* @return array {
* A dashboard section.
*
@ -143,10 +143,10 @@ abstract class Footnotes_Layout_Engine {
* Returns an array describing a meta box.
*
* @access protected
* @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.
* @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 {
* A dashboard meta box.
*
@ -218,7 +218,7 @@ abstract class Footnotes_Layout_Engine {
* Registers all Meta boxes for a sub-page.
*
* @access private
* @param string $p_str_parent_id Parent section unique ID.
* @param string $p_str_parent_id Parent section unique ID.
*
* @since 1.5.0
*/
@ -369,7 +369,7 @@ abstract class Footnotes_Layout_Engine {
* Loads a specified setting.
*
* @access protected
* @param string $p_str_setting_key_name Setting key.
* @param string $p_str_setting_key_name Setting key.
* @return array {
* A configurable setting.
*
@ -391,12 +391,12 @@ abstract class Footnotes_Layout_Engine {
$p_arr_return['value'] = esc_attr( Footnotes_Settings::instance()->get( $p_str_setting_key_name ) );
return $p_arr_return;
}
/**
* Returns a simple text inside HTML `<span>` element.
*
* @access protected
* @param string $p_str_text Message to be surrounded with `<span>` tags.
* @param string $p_str_text Message to be surrounded with `<span>` tags.
* @return string
*
* @since 1.5.0
@ -410,8 +410,8 @@ abstract class Footnotes_Layout_Engine {
* Returns the HTML tag for an `<input>`/`<select>` label.
*
* @access protected
* @param string $p_str_setting_name Settings key.
* @param string $p_str_caption Label caption.
* @param string $p_str_setting_name Settings key.
* @param string $p_str_caption Label caption.
* @return string
*
* @since 1.5.0
@ -440,10 +440,10 @@ abstract class Footnotes_Layout_Engine {
* Constructs the HTML for a text `<input>` element.
*
* @access protected
* @param string $p_str_setting_name Setting key.
* @param int $p_str_max_length Maximum length of the input. Default length 999 chars.
* @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 Setting key.
* @param int $p_str_max_length Maximum length of the input. Default length 999 chars.
* @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
*
* @since 1.5.0
@ -471,7 +471,7 @@ abstract class Footnotes_Layout_Engine {
* Constructs the HTML for a checkbox `<input>` element.
*
* @access protected
* @param string $p_str_setting_name Setting key.
* @param string $p_str_setting_name Setting key.
* @return string
*
* @since 1.5.0
@ -492,7 +492,7 @@ abstract class Footnotes_Layout_Engine {
* Constructs the HTML for a `<select>` element.
*
* @access protected
* @param string $p_str_setting_name Setting key.
* @param string $p_str_setting_name Setting key.
* @param array $p_arr_options Possible options.
* @return string
*
@ -528,7 +528,7 @@ abstract class Footnotes_Layout_Engine {
* Constructs the HTML for a `<textarea>` element.
*
* @access protected
* @param string $p_str_setting_name Setting key.
* @param string $p_str_setting_name Setting key.
* @return string
*
* @since 1.5.0
@ -550,7 +550,7 @@ abstract class Footnotes_Layout_Engine {
* class.
*
* @access protected
* @param string $p_str_setting_name Setting key.
* @param string $p_str_setting_name Setting key.
* @return string
*
* @since 1.5.6
@ -572,10 +572,10 @@ abstract class Footnotes_Layout_Engine {
* Constructs the HTML for numeric `<input>` element.
*
* @access protected
* @param string $p_str_setting_name Setting key.
* @param int $p_in_min Minimum value.
* @param int $p_int_max Maximum value.
* @param bool $p_bool_deci `true` if float, `false` if integer. Default `false`.
* @param string $p_str_setting_name Setting key.
* @param int $p_in_min Minimum value.
* @param int $p_int_max Maximum value.
* @param bool $p_bool_deci `true` if float, `false` if integer. Default `false`.
* @return string
*
* @since 1.5.0

8
src/admin/layout/class-footnotes-layout-init.php
View file

@ -4,13 +4,13 @@
*
* The Admin. Layouts subpackage is composed of the {@see Footnotes_Layout_Engine}
* abstract class, which is extended by the {@see Footnotes_Layout_Settings}
* sub-class. The subpackage is initialised at runtime by the {@see
* sub-class. The subpackage is initialised at runtime by the {@see
* Footnotes_Layout_Init} class.
*
* @package footnotes\admin_layout
* @since 1.5.0
* @since 2.8.0 Rename file from `init.php` to `class-footnotes-layout-init.php`,
* rename `dashboard/` sub-directory to `layout/`.
* rename `dashboard/` sub-directory to `layout/`.
*/
/**
@ -52,7 +52,7 @@ class Footnotes_Layout_Init {
/**
* Initializes all WordPress hooks for the Plugin Settings.
*
* @param string $plugin_name The name of the plugin.
* @param string $plugin_name The name of the plugin.
*
* @since 1.5.0
* @since 2.8.0 Added `$plugin_name` parameter.
@ -71,7 +71,7 @@ class Footnotes_Layout_Init {
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' ) );
}
/**
* Load the required dependencies for the layouts pages.
*

13
src/admin/layout/class-footnotes-layout-settings.php
View file

@ -4,13 +4,13 @@
*
* The Admin. Layouts subpackage is composed of the {@see Footnotes_Layout_Engine}
* abstract class, which is extended by the {@see Footnotes_Layout_Settings}
* sub-class. The subpackage is initialised at runtime by the {@see
* sub-class. The subpackage is initialised at runtime by the {@see
* Footnotes_Layout_Init} class.
*
* @package footnotes\admin_layout
* @since 1.5.0
* @since 2.8.0 Rename file from `subpage-main.php` to `class-footnotes-layout-settings.php`,
* rename `dashboard/` sub-directory to `layout/`.
* rename `dashboard/` sub-directory to `layout/`.
*/
/**
@ -32,7 +32,7 @@ class Footnotes_Layout_Settings extends Footnotes_Layout_Engine {
* Initialize the class and set its properties.
*
* @since 2.8.0
* @param string $plugin_name The name of this plugin.
* @param string $plugin_name The name of this plugin.
*/
public function __construct( $plugin_name ) {
$this->plugin_name = $plugin_name;
@ -74,7 +74,7 @@ class Footnotes_Layout_Settings extends Footnotes_Layout_Engine {
* Returns an array of all registered sections for the sub-page.
*
* @see Footnotes_Layout_Engine::add_section() For more information on the
* section array format.
* section array format.
* @return array[] All of the registered sections.
*
* @since 1.5.0
@ -100,7 +100,7 @@ class Footnotes_Layout_Settings extends Footnotes_Layout_Engine {
* Returns an array of all registered meta boxes for each section of the sub-page.
*
* @see Footnotes_Layout_Engine::add_meta_box() For more information on the
* meta box array format.
* meta box array format.
* @return array[] All of the registered meta boxes.
*
* @since 1.5.0
@ -208,6 +208,7 @@ class Footnotes_Layout_Settings extends Footnotes_Layout_Engine {
'semicolon' => __( 'SEMICOLON', 'footnotes' ),
'en_dash' => __( 'EN DASH', 'footnotes' ),
);
/*
* Options for the terminating punctuation after backlinks.
* The Unicode name of RIGHT PARENTHESIS was originally more accurate because.
@ -1266,7 +1267,7 @@ class Footnotes_Layout_Settings extends Footnotes_Layout_Engine {
);
/*
* Call {@see Footnotes_Parser::footnotes_output_head()} function to get
* Call {@see Footnotes_Parser::footnotes_output_head()} function to get
* the styling of the mouse-over box.
*
* The name of the callback function ought to be distinct from