diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..4235972 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +custom: ['https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6Z6CZDW8PPBBJ'] diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml deleted file mode 100644 index 1eb8882..0000000 --- a/.github/workflows/pre-release.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Pre-release Handler - -on: - release: - types: [published] - -jobs: - build: - name: Build the Plugin for pre-release - if: "github.event.release.prerelease" - runs-on: ubuntu-latest - - steps: - - name: Checkout code - uses: actions/checkout@v2 - - - name: Install dependencies - run: | - composer install --no-dev --optimize-autoloader --no-progress - - - name: Build Plugin - run: | - composer run build - - - name: Rename dist/ folder - run: | - mv dist/ footnotes/ - - - name: Create release archive - uses: montudor/action-zip@v0.1.0 - with: - args: zip -X -r footnotes-${{ github.event.release.tag_name }}.zip footnotes - - - name: Upload archive as artifact - uses: actions/upload-artifact@v2 - with: - name: footnotes-${{ github.event.release.tag_name }} - path: footnotes-${{ github.event.release.tag_name }}.zip - - - name: Upload archive to release - uses: JasonEtco/upload-to-release@master - with: - args: footnotes-${{ github.event.release.tag_name }}.zip application/zip - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - #- name: Deploy release to Wordpress.org - # uses: 10up/action-wordpress-plugin-deploy@stable - # with: - # generate-zip: true - # env: - # SVN_USERNAME: ${{ secrets.SVN_USERNAME }} - # SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} diff --git a/.github/workflows/release-handler.yml b/.github/workflows/release-handler.yml new file mode 100644 index 0000000..eeb93f5 --- /dev/null +++ b/.github/workflows/release-handler.yml @@ -0,0 +1,87 @@ +# This workflow handles GitHub releases and pre-releases. +# It builds the Plugin, zips up an archive to add to the +# release entry on GitHub and (in the case of a full release) +# pushes the release to the WP Plugin Directory SVN repo. + +name: Release Handler + +on: + release: + types: [published] + +jobs: + build_plugin: + name: Build the Plugin for pre-release + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Install dependencies + run: | + composer install --no-dev --optimize-autoloader --no-progress + + - name: Build Plugin + run: | + composer run build + + - name: Rename Plugin folder + run: | + mv dist/ footnotes/ + + - name: Upload Plugin artifact + uses: actions/upload-artifact@v2 + with: + name: footnotes-${{ github.event.release.tag_name }} + path: footnotes + + create_archive: + name: Create an archive for the release and add it to GitHub + runs-on: ubuntu-latest + needs: build_plugin + + steps: + - name: Download Plugin artifact + uses: actions/download-artifact@v2 + with: + name: footnotes-${{ github.event.release.tag_name }} + + - name: Create release archive + uses: montudor/action-zip@v0.1.0 + with: + args: zip -X -r footnotes-${{ github.event.release.tag_name }}.zip footnotes + + #- name: Upload archive as artifact + # uses: actions/upload-artifact@v2 + # with: + # name: footnotes-${{ github.event.release.tag_name }} + # path: footnotes-${{ github.event.release.tag_name }}.zip + + - name: Upload archive to release + uses: JasonEtco/upload-to-release@master + with: + args: footnotes-${{ github.event.release.tag_name }}.zip application/zip + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + release_to_svn: + name: Push the release to the WordPress Plugin Directory repo. + if: "!github.event.release.prerelease" + runs-on: ubuntu-latest + needs: create_archive + + steps: + - name: Download Plugin artifact + uses: actions/download-artifact@v2 + with: + name: footnotes-${{ github.event.release.tag_name }} + + - name: Deploy release to Wordpress.org + id: deploy + uses: 10up/action-wordpress-plugin-deploy@stable + env: + SVN_USERNAME: ${{ secrets.SVN_USERNAME }} + SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} + SLUG: footnotes/branches/svn-test + ASSETS_DIR: assets diff --git a/.github/workflows/snyk.yml b/.github/workflows/snyk.yml index 4487527..c8d179c 100644 --- a/.github/workflows/snyk.yml +++ b/.github/workflows/snyk.yml @@ -1,6 +1,6 @@ name: Snyk -on: push +on: pull_request jobs: security: @@ -13,7 +13,12 @@ jobs: - name: Run Snyk to check for vulnerabilities uses: snyk/actions/php@master + continue-on-error: true # To make sure that SARIF upload gets called env: SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} with: - args: --all-projects + args: --all-projects --sarif-file-output=snyk.sarif + - name: Upload result to GitHub Code Scanning + uses: github/codeql-action/upload-sarif@v1 + with: + sarif_file: snyk.sarif diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 8c05b85..81a3340 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,40 +1,23 @@ -# Contributor Covenant Code of Conduct +# Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. +community a safe and enjoyable experience for *everyone*. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards -Examples of behavior that contributes to a positive environment for our -community include: +All participants in this community must abide by the following policy: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community +> Be excellent to each other -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +Treat everyone with respect. Participate while acknowledging that everyone +deserves to be here — and each of us has the right to enjoy our experience +without fear. Consider what you are saying and how it would feel if it were +said to or about you. ## Enforcement Responsibilities @@ -52,6 +35,7 @@ decisions when appropriate. This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. + Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. @@ -59,8 +43,8 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -mark@cheret.de. +reported to the project leader, [Mark Cheret][mailto:mark@cheret.de]. + All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the @@ -114,15 +98,10 @@ the community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -. +This Code of Conduct is adapted from the [Contributor Covenant][covenant], +version 2.0, [Mozilla's code of conduct enforcement ladder][mozilla] and the +[Google Event Community Guidelines and Anti-Harassment Policy][google]. -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -. Translations are available at -. +[covenant]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[mozilla]: https://github.com/mozilla/diversity +[google]: https://www.google.com/events/policy/anti-harassmentpolicy.html diff --git a/README.md b/README.md index 3304714..54539e7 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![GitHub contributors](https://img.shields.io/github/contributors/markcheret/footnotes?style=flat-square) ![GitHub commits since tagged version](https://img.shields.io/github/commits-since/markcheret/footnotes/2.7.3?style=flat-square) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/markcheret/footnotes?style=flat-square) ![issues](https://img.shields.io/github/issues/markcheret/footnotes?style=flat-square) ![PRs](https://img.shields.io/github/issues-pr/markcheret/footnotes?style=flat-square) -[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/markcheret/footnotes?style=flat-square) [![OSSAR](https://github.com/markcheret/footnotes/actions/workflows/ossar-analysis.yml/badge.svg)](https://github.com/markcheret/footnotes/actions/workflows/ossar-analysis.yml) [![PHP Composer](https://github.com/markcheret/footnotes/actions/workflows/php.yml/badge.svg)](https://github.com/markcheret/footnotes/actions/workflows/php.yml) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/markcheret/footnotes?style=flat-square) [![OSSAR](https://github.com/markcheret/footnotes/actions/workflows/ossar-analysis.yml/badge.svg)](https://github.com/markcheret/footnotes/actions/workflows/ossar-analysis.yml) [![Code Linting](https://github.com/markcheret/footnotes/actions/workflows/php.yml/badge.svg)](https://github.com/markcheret/footnotes/actions/workflows/lint-code.yml) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Coverage Status](https://coveralls.io/repos/github/markcheret/footnotes/badge.svg?branch=main)](https://coveralls.io/github/markcheret/footnotes?branch=main) @@ -27,6 +27,7 @@ Featured on [wpmudev][wpmudev] — cheers for the review, folks! * [Features](#features) * [Getting Started](#getting-started) * [Documentation](#documentation) +* [Testing](#testing) * [Acknowledgments](#acknowledgements) * [License](#license) * [Contact Information](#contact-information) @@ -53,11 +54,20 @@ This Plugin provides: 1. install all dependencies (`composer install`): * you will have to install `php-mbstring` manually if you do not already have it. - + ## Documentation View the current docs [here][footnotes-docs]. +## Testing + +This repo. uses [PHPUnit](phpunit) to run automated tests. To run the full test +suite, use `composer run test`. + +Test cases are found in the `tests/` directory. + +PHPUnit settings are available in the file `phpunit.xml`. + ## Acknowledgements Huge thanks to every **footnotes** user, contributor, bug reporter, feature @@ -86,6 +96,7 @@ This project is licensed under the [GNU GPL v3][gpl-v3]. [prettier]: https://prettier.io/ [eslint]: https://eslint.org/ [stylelint]: https://stylelint.io/ +[phpunit]: https://phpunit.de/ [phpdocumentor]: https://phpdoc.org/ [footnotes-docs]: https://markcheret.github.io/footnotes/ [gpl-v3]: https://www.gnu.org/licenses/gpl-3.0.en.html diff --git a/_tools/release.sh b/_tools/release.sh index 4a9f0ec..e6048c5 100755 --- a/_tools/release.sh +++ b/_tools/release.sh @@ -65,7 +65,7 @@ echo "- Checking versions..." STABLE_TAG="$(grep "Stable Tag:" src/readme.txt)" ROOT_HEADER_VERSION="$(grep " Version:" src/footnotes.php | grep -Po " Version: \d+\.\d+(\.\d+)?[a-z]?$")" -JS_VERSION="$(grep "version :" src/js/wysiwyg-editor.js)" +JS_VERSION="$(grep "version:" src/js/wysiwyg-editor.js)" # Step 3(b): Check that all version declarations exists diff --git a/composer.json b/composer.json index 0d21b43..1a20e09 100644 --- a/composer.json +++ b/composer.json @@ -24,7 +24,8 @@ "post-install-cmd": "npm install", "minify": "npm run minify", "minify:css": "npm run minify:css", - "minify:js": "npm run minify:js" + "minify:js": "npm run minify:js", + "test": "phpunit" }, "require-dev": { "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1", diff --git a/docs/classes/footnotes-admin-layout-Settings.html b/docs/classes/footnotes-admin-layout-Settings.html index 1a00067..30e6468 100644 --- a/docs/classes/footnotes-admin-layout-Settings.html +++ b/docs/classes/footnotes-admin-layout-Settings.html @@ -8,12 +8,16 @@ - + + + + + + - @@ -48,10 +52,11 @@ Menu + +

Class to initialise all defined page layouts.

-
@@ -128,8 +132,7 @@
1.5.0 -
- +
see @@ -137,8 +140,7 @@
Engine -
- +
@@ -540,7 +542,8 @@ class. class-engine.php : 42 - + +

The ID of this plugin.

@@ -550,7 +553,9 @@ class. $plugin_name -
+ +

The ID of this plugin.

+
@@ -573,8 +578,7 @@ class.
2.8.0 -
- +
@@ -596,7 +600,8 @@ class. class-engine.php : 62 - + +

Stores all Sections for the child sub-page.

@@ -606,8 +611,8 @@ class. $sections = array() -
- + +
Tags @@ -629,8 +634,7 @@ class.
1.5.0 -
- +
@@ -652,7 +656,8 @@ class. class-engine.php : 52 - + +

Stores the Hook connection string for the child sub-page.

@@ -662,8 +667,8 @@ class. $sub_page_hook = null -
- + +
Tags @@ -685,8 +690,7 @@ class.
1.5.0 -
- +
@@ -712,7 +716,8 @@ class. class-settings.php : 44 - + +

Initialize the class and set its properties.

@@ -720,8 +725,7 @@ class. public __construct(string $plugin_name) : mixed -
- +
Parameters
@@ -747,16 +751,14 @@ class.
2.8.0 -
- +
Return values
mixed — -
- +
class-settings.php : 65 - + +

Displays the AMP compatibility mode option.

@@ -781,8 +784,7 @@ class. public amp_compat() : void -
- +
@@ -805,8 +807,7 @@ class.
Return values
void — -
- +
class-settings.php : 976 - + +

Displays the Custom CSS box.

@@ -831,8 +833,7 @@ class. public custom_css() : mixed -
- +
@@ -846,16 +847,14 @@ class.
1.5.0 -
- +
Return values
mixed — -
- +
class-settings.php : 1016 - + +

Displays transitional legacy Custom CSS box.

@@ -880,8 +880,7 @@ class. public custom_css_migration() : void -
- +
@@ -895,24 +894,21 @@ class.
2.2.2 -
- +
deprecated
-
- +
Return values
void — -
- +
class-settings.php : 1052 - + +

Displays the new Custom CSS box.

@@ -937,8 +934,7 @@ class. public custom_css_new() : void -
- +
@@ -952,16 +948,14 @@ class.
2.2.2 -
- +
Return values
void — -
- +
class-engine.php : 184 - + +

Output the description of a section. May be overwritten in any section.

@@ -986,8 +981,7 @@ class. public description() : void -
- +
@@ -1001,8 +995,7 @@ class.
1.5.0 -
- +
todo @@ -1018,8 +1011,7 @@ class.
Return values
void — -
- +
class-engine.php : 122 - + +

Displays the content of specific sub-page.

@@ -1044,8 +1037,7 @@ class. public display_content() : void -
- +
@@ -1059,8 +1051,7 @@ class.
1.5.0 -
- +
todo @@ -1076,8 +1067,7 @@ class.
Return values
void — -
- +
class-settings.php : 1204 - + +

Displays all Donate button to support the developers.

@@ -1102,8 +1093,7 @@ class. public donate() : void -
- +
@@ -1117,16 +1107,14 @@ class.
1.5.0 -
- +
Return values
void — -
- +
class-settings.php : 543 - + +

Displays the footnotes in excerpt setting.

@@ -1151,8 +1140,7 @@ class. public excerpts() : void -
- +
@@ -1166,16 +1154,14 @@ class.
1.5.0 -
- +
Return values
void — -
- +
class-settings.php : 56 - + +

Returns a priority index.

@@ -1216,16 +1203,14 @@ class.
1.5.0 -
- +
Return values
int — -
- +
class-settings.php : 445 - + +

Displays all options for the fragment identifier configuration.

@@ -1250,8 +1236,7 @@ class. public hard_links() : void -
- +
@@ -1265,16 +1250,14 @@ class.
2.2.0 -
- +
Return values
void — -
- +
class-settings.php : 1139 - + +

Displays a short introduction to the plugin.

@@ -1299,8 +1283,7 @@ class. public help() : void -
- +
@@ -1314,8 +1297,7 @@ class.
1.5.0 -
- +
todo @@ -1331,8 +1313,7 @@ class.
Return values
void — -
- +
class-settings.php : 952 - + +

Displays all settings for the backlink symbol.

@@ -1357,8 +1339,7 @@ class. public hyperlink_arrow() : void -
- +
@@ -1372,16 +1353,14 @@ class.
1.5.0 -
- +
Return values
void — -
- +
class-settings.php : 620 - + +

Displays the setting for the input label issue solution.

@@ -1406,8 +1386,7 @@ class. public label_solution() : void -
- +
@@ -1421,16 +1400,14 @@ class.
2.5.12 -
- +
Return values
void — -
- +
class-settings.php : 1082 - + +

Displays available Hooks to look for Footnote short codes.

@@ -1475,16 +1453,14 @@ define -1 as PHP_INT_MAX instead

1.5.5 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 497 - + +

Displays all settings for ‘I love Footnotes’ note.

@@ -1509,8 +1486,7 @@ define -1 as PHP_INT_MAX instead

public love() : void -
- +
@@ -1524,16 +1500,14 @@ define -1 as PHP_INT_MAX instead

1.5.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 649 - + +

Displays enabled status for the footnotes mouse-over box.

@@ -1558,8 +1533,7 @@ define -1 as PHP_INT_MAX instead

public mouseover_box() : void -
- +
@@ -1573,16 +1547,14 @@ define -1 as PHP_INT_MAX instead

1.5.2 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 882 - + +

Displays style settings for the footnotes mouse-over box.

@@ -1607,8 +1580,7 @@ define -1 as PHP_INT_MAX instead

public mouseover_box_appearance() : void -
- +
@@ -1622,16 +1594,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 740 - + +

Displays dimensions setting for the footnotes mouse-over box.

@@ -1656,8 +1627,7 @@ define -1 as PHP_INT_MAX instead

public mouseover_box_dimensions() : void -
- +
@@ -1671,16 +1641,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 685 - + +

Displays position settings for the footnotes mouse-over box.

@@ -1705,8 +1674,7 @@ define -1 as PHP_INT_MAX instead

public mouseover_box_position() : void -
- +
@@ -1720,16 +1688,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 840 - + +

Displays dedicated tooltip text settings for the footnotes mouse-over box.

@@ -1754,8 +1721,7 @@ define -1 as PHP_INT_MAX instead

public mouseover_box_text() : void -
- +
@@ -1769,16 +1735,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 766 - + +

Displays timing settings for the footnotes mouse-over box.

@@ -1803,8 +1768,7 @@ define -1 as PHP_INT_MAX instead

public mouseover_box_timing() : void -
- +
@@ -1818,16 +1782,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 803 - + +

Displays truncation settings for the footnotes mouse-over box.

@@ -1852,8 +1815,7 @@ define -1 as PHP_INT_MAX instead

public mouseover_box_truncation() : void -
- +
@@ -1867,16 +1829,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 344 - + +

Displays all options for the footnotes numbering.

@@ -1901,8 +1862,7 @@ define -1 as PHP_INT_MAX instead

public numbering() : void -
- +
@@ -1916,16 +1876,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 92 - + +

Displays all settings for the reference container.

@@ -1950,8 +1909,7 @@ define -1 as PHP_INT_MAX instead

public reference_container() : void -
- +
@@ -1965,16 +1923,14 @@ define -1 as PHP_INT_MAX instead

1.5.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-engine.php : 102 - + +

Registers all sections for a sub-page.

@@ -1999,8 +1956,7 @@ define -1 as PHP_INT_MAX instead

public register_sections() : void -
- +
@@ -2014,16 +1970,14 @@ define -1 as PHP_INT_MAX instead

1.5.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-engine.php : 77 - + +

Registers a sub-page.

@@ -2048,8 +2003,7 @@ define -1 as PHP_INT_MAX instead

public register_sub_page() : void -
- +
@@ -2063,16 +2017,14 @@ define -1 as PHP_INT_MAX instead

1.5.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 389 - + +

Displays all options for the scrolling behavior.

@@ -2097,8 +2050,7 @@ define -1 as PHP_INT_MAX instead

public scrolling() : void -
- +
@@ -2112,16 +2064,14 @@ define -1 as PHP_INT_MAX instead

2.2.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 267 - + +

Displays all options for the footnotes start and end tag short codes.

@@ -2146,8 +2097,7 @@ define -1 as PHP_INT_MAX instead

public start_end() : void -
- +
@@ -2161,16 +2111,14 @@ define -1 as PHP_INT_MAX instead

1.5.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-settings.php : 575 - + +

Displays all settings for the footnote referrers.

@@ -2195,8 +2144,7 @@ define -1 as PHP_INT_MAX instead

public superscript() : void -
- +
@@ -2210,16 +2158,14 @@ define -1 as PHP_INT_MAX instead

1.5.0 -
- +
Return values
void — -
- +
PHP_INT_MAX instead

class-engine.php : 396 - + +

Constructs the HTML for a checkbox 'input' element.

@@ -2244,8 +2191,7 @@ define -1 as PHP_INT_MAX instead

protected add_checkbox(string $setting_name) : string -
- +
Parameters
@@ -2280,8 +2226,7 @@ define -1 as PHP_INT_MAX instead

1.5.0 -
- +
todo @@ -2297,8 +2242,7 @@ define -1 as PHP_INT_MAX instead

Return values
string — -
- +
PHP_INT_MAX instead

class-engine.php : 473 - + +

Constructs the HTML for a text 'input' element with the colour selection class.

@@ -2324,8 +2269,7 @@ class.

protected add_color_selection(string $setting_name) : string -
- +
Parameters
@@ -2360,8 +2304,7 @@ class.

1.5.6 -
- +
todo @@ -2386,8 +2329,7 @@ class.

Return values
string — -
- +
class-engine.php : 338 - + +

Returns the HTML tag for a 'label' element.

@@ -2412,8 +2355,7 @@ class.

protected add_label(string $setting_name, string $caption) : string -
- +
Parameters
@@ -2457,8 +2399,7 @@ class.

1.5.0 -
- +
todo @@ -2474,8 +2415,7 @@ class.

Return values
string — -
- +
class-engine.php : 279 - + +

Returns an array describing a meta box.

@@ -2500,8 +2441,7 @@ class.

protected add_meta_box(string $section_id, string $id, string $title, string $callback_function_name) : array<string|int, mixed> -
- +
Parameters
@@ -2563,8 +2503,7 @@ class.

1.5.0 -
- +
todo @@ -2615,7 +2554,8 @@ A dashboard meta box.

class-engine.php : 496 - + +

Constructs the HTML for numeric 'input' element.

@@ -2623,8 +2563,7 @@ A dashboard meta box.

protected add_num_box(string $setting_name, int $p_in_min, int $max[, bool $deci = false ]) : string -
- +
Parameters
@@ -2686,8 +2625,7 @@ A dashboard meta box.

1.5.0 -
- +
todo @@ -2703,8 +2641,7 @@ A dashboard meta box.

Return values
string — -
- +
class-engine.php : 249 - + +

Returns an array describing a sub-page section.

@@ -2729,8 +2667,7 @@ A dashboard meta box.

protected add_section(string $id, string $title, int $settings_container_index[, bool $has_submit_button = true ]) : array<string|int, mixed> -
- +
Parameters
@@ -2793,8 +2730,7 @@ be displayed for this section. Default true.

1.5.0 -
- +
todo @@ -2836,7 +2772,8 @@ A dashboard section.

class-engine.php : 417 - + +

Constructs the HTML for a 'select' element.

@@ -2844,8 +2781,7 @@ A dashboard section.

protected add_select_box(string $setting_name, array<string|int, mixed> $options) : string -
- +
Parameters
@@ -2889,8 +2825,7 @@ A dashboard section.

1.5.0 -
- +
todo @@ -2906,8 +2841,7 @@ A dashboard section.

Return values
string — -
- +
class-engine.php : 324 - + +

Returns a simple text inside a 'span' element.

@@ -2932,8 +2867,7 @@ A dashboard section.

protected add_text(string $text) : string -
- +
Parameters
@@ -2968,8 +2902,7 @@ A dashboard section.

1.5.0 -
- +
todo @@ -2985,8 +2918,7 @@ A dashboard section.

Return values
string — -
- +
class-engine.php : 369 - + +

Constructs the HTML for a text 'input' element.

@@ -3011,8 +2944,7 @@ A dashboard section.

protected add_text_box(string $setting_name[, int $max_length = 999 ][, bool $readonly = false ][, bool $hidden = false ]) : string -
- +
Parameters
@@ -3074,8 +3006,7 @@ A dashboard section.

1.5.0 -
- +
todo @@ -3091,8 +3022,7 @@ A dashboard section.

Return values
string — -
- +
class-engine.php : 451 - + +

Constructs the HTML for a 'textarea' element.

@@ -3117,8 +3048,7 @@ A dashboard section.

protected add_textarea(string $setting_name) : string -
- +
Parameters
@@ -3153,8 +3083,7 @@ A dashboard section.

1.5.0 -
- +
todo @@ -3170,8 +3099,7 @@ A dashboard section.

Return values
string — -
- +
class-settings.php : 1270 - + +

Returns an array of all registered meta boxes for each section of the sub-page.

@@ -3196,8 +3125,7 @@ A dashboard section.

protected get_meta_boxes() : array<string|int, array<string|int, mixed>> -
- +
@@ -3222,8 +3150,7 @@ meta box array format.

1.5.0 -
- +
since @@ -3259,7 +3186,8 @@ meta box array format.

class-settings.php : 1245 - + +

Returns an array of all registered sections for the sub-page.

@@ -3267,8 +3195,7 @@ meta box array format.

protected get_sections() : array<string|int, array<string|int, mixed>> -
- +
@@ -3292,8 +3219,7 @@ meta box array format.

1.5.0 -
- +
since @@ -3329,7 +3255,8 @@ meta box array format.

class-settings.php : 1224 - + +

Returns the unique slug of the sub-page.

@@ -3337,8 +3264,7 @@ meta box array format.

protected get_sub_page_slug() : string -
- +
@@ -3352,16 +3278,14 @@ meta box array format.

1.5.0 -
- +
Return values
string — -
- +
class-settings.php : 1233 - + +

Returns the title of the sub-page.

@@ -3386,8 +3311,7 @@ meta box array format.

protected get_sub_page_title() : string -
- +
@@ -3401,16 +3325,14 @@ meta box array format.

1.5.0 -
- +
Return values
string — -
- +
class-engine.php : 305 - + +

Loads a specified setting.

@@ -3435,8 +3358,7 @@ meta box array format.

protected load_setting(string $setting_key_name) : array<string|int, mixed> -
- +
Parameters
@@ -3471,8 +3393,7 @@ meta box array format.

1.5.0 -
- +
since @@ -3524,7 +3445,8 @@ A configurable setting.

class-engine.php : 551 - + +

Append JavaScript and CSS files for specific sub-page.

@@ -3532,8 +3454,7 @@ A configurable setting.

private append_scripts() : void -
- +
@@ -3556,8 +3477,7 @@ A configurable setting.

1.5.0 -
- +
todo @@ -3573,8 +3493,7 @@ A configurable setting.

Return values
void — -
- +
class-engine.php : 528 - + +

Registers all Meta boxes for a sub-page.

@@ -3599,8 +3519,7 @@ A configurable setting.

private register_meta_boxes(string $parent_id) : void -
- +
Parameters
@@ -3635,16 +3554,14 @@ A configurable setting.

1.5.0 -
- +
Return values
void — -
- +
class-engine.php : 567 - + +

Save all plugin settings.

@@ -3669,8 +3587,7 @@ A configurable setting.

private save_settings() : bool -
- +
@@ -3693,8 +3610,7 @@ A configurable setting.

1.5.0 -
- +
todo @@ -3717,6 +3633,68 @@ A configurable setting.

+ + +
@@ -3738,5 +3716,9 @@ A configurable setting.

+ + + + diff --git a/docs/files/src-admin-layout-class-settings.html b/docs/files/src-admin-layout-class-settings.html index b48e4cd..81ec47e 100644 --- a/docs/files/src-admin-layout-class-settings.html +++ b/docs/files/src-admin-layout-class-settings.html @@ -8,12 +8,16 @@ - + + + + + + - @@ -48,10 +52,11 @@ Menu