Sophia/avatar-privacy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
Sophia Atkinson
2023-09-01 00:37:57 -07:00
commit 9caab8ce68
602 changed files with 33485 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

339
vendor-scoped/mundschenk-at/check-wp-requirements/LICENSE Normal file
View File

@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

59
vendor-scoped/mundschenk-at/check-wp-requirements/README.md Normal file
View File

@ -0,0 +1,59 @@
# check-wp-requirements
[![Build Status](https://travis-ci.com/mundschenk-at/check-wp-requirements.svg?branch=master)](https://travis-ci.com/mundschenk-at/check-wp-requirements)
[![Latest Stable Version](https://poser.pugx.org/mundschenk-at/check-wp-requirements/v/stable)](https://packagist.org/packages/mundschenk-at/check-wp-requirements)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mundschenk-at/check-wp-requirements/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mundschenk-at/check-wp-requirements/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/mundschenk-at/check-wp-requirements/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mundschenk-at/check-wp-requirements/?branch=master)
[![License](https://poser.pugx.org/mundschenk-at/check-wp-requirements/license)](https://packagist.org/packages/mundschenk-at/check-wp-requirements)
A helper class for WordPress plugins to check PHP version and other requirements.
## Requirements
* PHP 5.6.0 or above
* WordPress 5.2 or higher.
## Installation
The best way to use this package is through Composer:
```BASH
$ composer require mundschenk-at/check-wp-requirements
```
## Basic Usage
1. Create a `\Mundschenk\WP_Requirements` object and set the requirements in the constructor.
2. Call the `\Mundschenk\WP_Requirements::check()` method and start your plugin normally if it
returns `true`.
```PHP
// Set up autoloader.
require_once __DIR__ . '/vendor/autoload.php';
/**
* Load the plugin after checking for the necessary PHP version.
*
* It's necessary to do this here because main class relies on namespaces.
*/
function run_your_plugin() {
$requirements = new \Mundschenk\WP_Requirements( 'Your Plugin Name', __FILE__, 'your-textdomain', [
'php' => '5.6.0',
'multibyte' => true,
'utf-8' => false,
] );
if ( $requirements->check() ) {
// Autoload the rest of your classes.
// Create and start the plugin.
...
}
}
run_your_plugin();
```
## License
check-wp-requirements is licensed under the GNU General Public License 2 or later - see the [LICENSE](LICENSE) file for details.

219
vendor-scoped/mundschenk-at/check-wp-requirements/class-wp-requirements.php Normal file
View File

@ -0,0 +1,219 @@
<?php
/**
* This file is part of mundschenk-at/check-wp-requirements.
*
* Copyright 2014-2019 Peter Putzer.
* Copyright 2009-2011 KINGdesk, LLC.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/check-wp-requirements
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk;
/**
* This class checks if the required runtime environment is available.
*
* Included checks:
* - PHP version
* - mb_string extension
* - UTF-8 encoding
*
* Note: All code must be executable on PHP 5.2.
*/
class WP_Requirements
{
/**
* The minimum requirements for running the plugins. Must contain:
* - 'php'
* - 'multibyte'
* - 'utf-8'
*
* @var array A hash containing the version requirements for the plugin.
*/
private $install_requirements;
/**
* The user-visible name of the plugin.
*
* @todo Should the plugin name be translated?
* @var string
*/
private $plugin_name;
/**
* The full path to the main plugin file.
*
* @var string
*/
private $plugin_file;
/**
* The textdomain used for loading plugin translations.
*
* @var string
*/
private $textdomain;
/**
* The base directory of the Check_WP_Requirements component (i.e. the equivalent of __DIR__).
*
* @var string
*/
private $base_dir;
/**
* Sets up a new Mundschenk\WP_Requirements object.
*
* @param string $name The plugin name.
* @param string $plugin_path The full path to the main plugin file.
* @param string $textdomain The text domain used for i18n.
* @param array $requirements The requirements to check against.
*/
public function __construct($name, $plugin_path, $textdomain, $requirements)
{
$this->plugin_name = $name;
$this->plugin_file = $plugin_path;
$this->textdomain = $textdomain;
$this->base_dir = \dirname(__FILE__);
$this->install_requirements = \wp_parse_args($requirements, ['php' => '5.2.0', 'multibyte' => \false, 'utf-8' => \false]);
}
/**
* Checks if all runtime requirements for the plugin are met.
*
* @return bool
*/
public function check()
{
$requirements_met = \true;
foreach ($this->get_requirements() as $requirement) {
if (!empty($this->install_requirements[$requirement['enable_key']]) && !\call_user_func($requirement['check'])) {
$notice = $requirement['notice'];
$requirements_met = \false;
break;
}
}
if (!$requirements_met && !empty($notice) && \is_admin()) {
// Load text domain to ensure translated admin notices.
\load_plugin_textdomain($this->textdomain);
// Add admin notice.
\add_action('admin_notices', $notice);
}
return $requirements_met;
}
/**
* Retrieves an array of requirement specifications.
*
* @return array {
* An array of requirements checks.
*
* @type string $enable_key An index in the $install_requirements array to switch the check on and off.
* @type callable $check A function returning true if the check was successful, false otherwise.
* @type callable $notice A function displaying an appropriate error notice.
* }
*/
protected function get_requirements()
{
return [['enable_key' => 'php', 'check' => [$this, 'check_php_support'], 'notice' => [$this, 'admin_notices_php_version_incompatible']], ['enable_key' => 'multibyte', 'check' => [$this, 'check_multibyte_support'], 'notice' => [$this, 'admin_notices_mbstring_incompatible']], ['enable_key' => 'utf-8', 'check' => [$this, 'check_utf8_support'], 'notice' => [$this, 'admin_notices_charset_incompatible']]];
}
/**
* Deactivates the plugin.
*/
public function deactivate_plugin()
{
\deactivate_plugins(\plugin_basename($this->plugin_file));
}
/**
* Checks if the PHP version in use is at least equal to the required version.
*
* @return bool
*/
protected function check_php_support()
{
return \version_compare(\PHP_VERSION, $this->install_requirements['php'], '>=');
}
/**
* Checks if multibyte functions are supported.
*
* @return bool
*/
protected function check_multibyte_support()
{
return \function_exists('mb_strlen') && \function_exists('mb_strtolower') && \function_exists('mb_substr') && \function_exists('mb_detect_encoding');
}
/**
* Checks if the blog charset is set to UTF-8.
*
* @return bool
*/
protected function check_utf8_support()
{
return 'utf-8' === \strtolower(\get_bloginfo('charset'));
}
/**
* Print 'PHP version incompatible' admin notice
*/
public function admin_notices_php_version_incompatible()
{
$this->display_error_notice(
/* translators: 1: plugin name 2: target PHP version number 3: actual PHP version number */
\__('The activated plugin %1$s requires PHP %2$s or later. Your server is running PHP %3$s. Please deactivate this plugin, or upgrade your server\'s installation of PHP.', $this->textdomain),
"<strong>{$this->plugin_name}</strong>",
$this->install_requirements['php'],
\PHP_VERSION
);
}
/**
* Prints 'mbstring extension missing' admin notice
*/
public function admin_notices_mbstring_incompatible()
{
$this->display_error_notice(
/* translators: 1: plugin name 2: mbstring documentation URL */
\__('The activated plugin %1$s requires the mbstring PHP extension to be enabled on your server. Please deactivate this plugin, or <a href="%2$s">enable the extension</a>.', $this->textdomain),
"<strong>{$this->plugin_name}</strong>",
/* translators: URL with mbstring PHP extension installation instructions */
\__('http://www.php.net/manual/en/mbstring.installation.php', $this->textdomain)
);
}
/**
* Prints 'Charset incompatible' admin notice
*/
public function admin_notices_charset_incompatible()
{
$this->display_error_notice(
/* translators: 1: plugin name 2: current character encoding 3: options URL */
\__('The activated plugin %1$s requires your blog use the UTF-8 character encoding. You have set your blogs encoding to %2$s. Please deactivate this plugin, or <a href="%3$s">change your character encoding to UTF-8</a>.', $this->textdomain),
"<strong>{$this->plugin_name}</strong>",
\get_bloginfo('charset'),
'/wp-admin/options-reading.php'
);
}
/**
* Shows an error message in the admin area.
*
* @param string $format ... An `sprintf` format string, followd by an unspecified number of optional parameters.
*/
protected function display_error_notice($format)
{
if (\func_num_args() < 1 || empty($format)) {
return;
// abort.
}
$args = \func_get_args();
$format = \array_shift($args);
$message = \vsprintf($format, $args);
require "{$this->base_dir}/partials/requirements-error-notice.php";
}
}

31
vendor-scoped/mundschenk-at/check-wp-requirements/partials/requirements-error-notice.php Normal file
View File

@ -0,0 +1,31 @@
<?php
/**
* This file is part of wp-Typography.
*
* Copyright 2017 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-typography
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
?>
<div class="notice notice-error">
<p><?php echo wp_kses( $message, wp_kses_allowed_html(), array( 'http', 'https' ) ); ?></p>
</div>
<?php

339
vendor-scoped/mundschenk-at/wp-data-storage/LICENSE Normal file
View File

@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

22
vendor-scoped/mundschenk-at/wp-data-storage/README.md Normal file
View File

@ -0,0 +1,22 @@
# WordPress Data Storage
[![Build Status](https://travis-ci.org/mundschenk-at/wp-data-storage.svg?branch=master)](https://travis-ci.org/mundschenk-at/wp-data-storage)
[![Latest Stable Version](https://poser.pugx.org/mundschenk-at/wp-data-storage/v/stable)](https://packagist.org/packages/mundschenk-at/wp-data-storage)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mundschenk-at/wp-data-storage/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mundschenk-at/wp-data-storage/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/mundschenk-at/wp-data-storage/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mundschenk-at/wp-data-storage/?branch=master)
[![License](https://poser.pugx.org/mundschenk-at/wp-data-storage/license)](https://packagist.org/packages/mundschenk-at/wp-data-storage)
An object oriented library for dealing with WordPress options and caching.
## Requirements
* PHP 5.6.0 or above
* WordPress 4.4 or higher (for transient keys longer than 64 characters).
## Installation
The best way to use this package is through Composer:
```BASH
$ composer require mundschenk-at/wp-data-storage
```

112
vendor-scoped/mundschenk-at/wp-data-storage/src/class-abstract-cache.php Normal file
View File

@ -0,0 +1,112 @@
<?php
/**
* This file is part of mundschenk-at/wp-data-storage.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or ( at your option ) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* @package mundschenk-at/wp-data-storage/tests
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\Data_Storage;
/**
* Implements a generic caching mechanism for WordPress.
*
* @since 1.0.0
*
* @author Peter Putzer <github@mundschenk.at>
*/
abstract class Abstract_Cache
{
/**
* Incrementor for cache invalidation.
*
* @var int
*/
protected $incrementor;
/**
* The prefix added to all keys.
*
* @var string
*/
private $prefix;
/**
* Create new cache instance.
*
* @param string $prefix The prefix automatically added to cache keys.
*/
public function __construct($prefix)
{
$this->prefix = $prefix;
if (empty($this->incrementor)) {
$this->invalidate();
}
}
/**
* Invalidate all cached elements by reseting the incrementor.
*
* @return void
*/
public abstract function invalidate();
/**
* Retrieves a cached value.
*
* @param string $key The cache key root.
*
* @return mixed
*/
public abstract function get($key);
/**
* Sets an entry in the cache and stores the key.
*
* @param string $key The cache key root.
* @param mixed $value The value to store.
* @param int $duration Optional. The duration in seconds. Default 0 (no expiration).
*
* @return bool True if the cache could be set successfully.
*/
public abstract function set($key, $value, $duration = 0);
/**
* Deletes an entry from the cache.
*
* @param string $key The cache key root.
*
* @return bool True on successful removal, false on failure.
*/
public abstract function delete($key);
/**
* Retrieves the complete key to use.
*
* @param string $key The cache key root.
*
* @return string
*/
protected function get_key($key)
{
return "{$this->prefix}{$this->incrementor}_{$key}";
}
/**
* Retrieves the set prefix.
*
* @return string
*/
protected function get_prefix()
{
return $this->prefix;
}
}

105
vendor-scoped/mundschenk-at/wp-data-storage/src/class-cache.php Normal file
View File

@ -0,0 +1,105 @@
<?php
/**
* This file is part of mundschenk-at/wp-data-storage.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or ( at your option ) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* @package mundschenk-at/wp-data-storage/tests
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\Data_Storage;
/**
* Implements an inteface to the WordPress Object Cache.
*
* @since 1.0.0
*
* @author Peter Putzer <github@mundschenk.at>
*/
class Cache extends Abstract_Cache
{
/**
* The incrementor cache key.
*
* @var string
*/
private $incrementor_key;
/**
* The cache group.
*
* @var string
*/
private $group;
/**
* Create new cache instance.
*
* @param string $prefix The prefix automatically added to cache keys.
* @param string|null $group Optional. The cache group. Defaults to $prefix.
*/
public function __construct($prefix, $group = null)
{
$this->group = !isset($group) ? $prefix : $group;
$this->incrementor_key = "{$prefix}cache_incrementor";
$this->incrementor = (int) \wp_cache_get($this->incrementor_key, $this->group);
parent::__construct($prefix);
}
/**
* Invalidate all cached elements by reseting the incrementor.
*/
public function invalidate()
{
$this->incrementor = \time();
\wp_cache_set($this->incrementor_key, $this->incrementor, $this->group, 0);
}
/**
* Retrieves a cached value.
*
* @param string $key The cache key.
* @param bool|null $found Optional. Whether the key was found in the cache. Disambiguates a return of false as a storable value. Passed by reference. Default null.
*
* @return mixed
*/
public function get($key, &$found = null)
{
return \wp_cache_get($this->get_key($key), $this->group, \false, $found);
}
/**
* Sets an entry in the cache and stores the key.
*
* @param string $key The cache key.
* @param mixed $value The value to store.
* @param int $duration Optional. The duration in seconds. Default 0 (no expiration).
*
* @return bool True if the cache could be set successfully.
*/
public function set($key, $value, $duration = 0)
{
return \wp_cache_set($this->get_key($key), $value, $this->group, $duration);
}
/**
* Deletes an entry from the cache.
*
* @param string $key The cache key root.
*
* @return bool True on successful removal, false on failure.
*/
public function delete($key)
{
return \wp_cache_delete($this->get_key($key), $this->group);
}
}

97
vendor-scoped/mundschenk-at/wp-data-storage/src/class-network-options.php Normal file
View File

@ -0,0 +1,97 @@
<?php
/**
* This file is part of mundschenk-at/wp-data-storage.
*
* Copyright 2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or ( at your option ) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* @package mundschenk-at/wp-data-storage/tests
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\Data_Storage;
/**
* Implements an interface to the WordPress Network Options API.
*
* @since 1.0.0
*
* @author Peter Putzer <github@mundschenk.at>
*/
class Network_Options extends Options
{
/**
* The network ID.
*
* @var int
*/
private $network_id;
/**
* Create new Network Options instance.
*
* @param string $prefix The prefix automatically added to option names.
* @param int|null $network_id Optional. The network ID or null for the current network. Default null.
*/
public function __construct($prefix, $network_id = null)
{
$this->network_id = !empty($network_id) ? $network_id : \get_current_network_id();
parent::__construct($prefix);
}
/**
* Retrieves an option value.
*
* @param string $option The option name (without the plugin-specific prefix).
* @param mixed $default Optional. Default value to return if the option does not exist. Default null.
* @param bool $raw Optional. Use the raw option name (i.e. don't call get_name). Default false.
*
* @return mixed Value set for the option.
*/
public function get($option, $default = null, $raw = \false)
{
$value = \get_network_option($this->network_id, $raw ? $option : $this->get_name($option), $default);
if (\is_array($default) && '' === $value) {
$value = [];
}
return $value;
}
/**
* Sets or updates an option.
*
* @param string $option The option name (without the plugin-specific prefix).
* @param mixed $value The value to store.
* @param bool $autoload Optional. This value is ignored for network options,
* which are always autoloaded. Default true.
* @param bool $raw Optional. Use the raw option name (i.e. don't call get_name). Default false.
*
* @return bool False if value was not updated and true if value was updated.
*/
public function set($option, $value, $autoload = \true, $raw = \false)
{
return \update_network_option($this->network_id, $raw ? $option : $this->get_name($option), $value);
}
/**
* Deletes an option.
*
* @param string $option The option name (without the plugin-specific prefix).
* @param bool $raw Optional. Use the raw option name (i.e. don't call get_name). Default false.
*
* @return bool True, if option is successfully deleted. False on failure.
*/
public function delete($option, $raw = \false)
{
return \delete_network_option($this->network_id, $raw ? $option : $this->get_name($option));
}
}

108
vendor-scoped/mundschenk-at/wp-data-storage/src/class-options.php Normal file
View File

@ -0,0 +1,108 @@
<?php
/**
* This file is part of mundschenk-at/wp-data-storage.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or ( at your option ) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* @package mundschenk-at/wp-data-storage/tests
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\Data_Storage;
/**
* Implements an interface to the WordPress Options API.
*
* @since 1.0.0
*
* @author Peter Putzer <github@mundschenk.at>
*/
class Options
{
/**
* The prefix added to all keys.
*
* @var string
*/
private $prefix;
/**
* Create new Options instance.
*
* @param string $prefix The prefix automatically added to option names.
*/
public function __construct($prefix)
{
$this->prefix = $prefix;
}
/**
* Retrieves an option value.
*
* @param string $option The option name (without the plugin-specific prefix).
* @param mixed $default Optional. Default value to return if the option does not exist. Default null.
* @param bool $raw Optional. Use the raw option name (i.e. don't call get_name). Default false.
*
* @return mixed Value set for the option.
*/
public function get($option, $default = null, $raw = \false)
{
$value = \get_option($raw ? $option : $this->get_name($option), $default);
if (\is_array($default) && '' === $value) {
$value = [];
}
return $value;
}
/**
* Sets or updates an option.
*
* @param string $option The option name (without the plugin-specific prefix).
* @param mixed $value The value to store.
* @param bool $autoload Optional. Whether to load the option when WordPress
* starts up. For existing options, $autoload can only
* be updated using update_option() if $value is also
* changed. Default true.
* @param bool $raw Optional. Use the raw option name (i.e. don't call get_name). Default false.
*
* @return bool False if value was not updated and true if value was updated.
*/
public function set($option, $value, $autoload = \true, $raw = \false)
{
return \update_option($raw ? $option : $this->get_name($option), $value, $autoload);
}
/**
* Deletes an option.
*
* @param string $option The option name (without the plugin-specific prefix).
* @param bool $raw Optional. Use the raw option name (i.e. don't call get_name). Default false.
*
* @return bool True, if option is successfully deleted. False on failure.
*/
public function delete($option, $raw = \false)
{
return \delete_option($raw ? $option : $this->get_name($option));
}
/**
* Retrieves the complete option name to use.
*
* @param string $option The option name (without the plugin-specific prefix).
*
* @return string
*/
public function get_name($option)
{
return "{$this->prefix}{$option}";
}
}

96
vendor-scoped/mundschenk-at/wp-data-storage/src/class-site-transients.php Normal file
View File

@ -0,0 +1,96 @@
<?php
/**
* This file is part of mundschenk-at/wp-data-storage.
*
* Copyright 2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or ( at your option ) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* @package mundschenk-at/wp-data-storage/tests
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\Data_Storage;
/**
* Implements an interface to the WordPress Site Transients API.
*
* @since 1.0.0
*
* @author Peter Putzer <github@mundschenk.at>
*/
class Site_Transients extends Transients
{
const TRANSIENT_SQL_PREFIX = '_site_transient_';
/**
* Retrieves a list of transients set by the plugin from the options table.
*
* @return string[]
*/
public function get_keys_from_database()
{
// If we are not running on multisite, fall back to the parent implementation.
if (!\is_multisite()) {
return parent::get_keys_from_database();
}
/**
* WordPress database handler.
*
* @var \wpdb
*/
global $wpdb;
$results = $wpdb->get_results($wpdb->prepare("SELECT meta_key FROM {$wpdb->sitemeta} WHERE meta_key like %s and site_id = %d", self::TRANSIENT_SQL_PREFIX . "{$this->get_prefix()}%", \get_current_network_id()), \ARRAY_A);
// WPCS: db call ok, cache ok.
return \str_replace(self::TRANSIENT_SQL_PREFIX, '', \wp_list_pluck($results, 'meta_key'));
}
/**
* Retrieves a cached value.
*
* @param string $key The cache key.
* @param bool $raw Optional. Use the raw key name (i.e. don't call get_key). Default false.
*
* @return mixed
*/
public function get($key, $raw = \false)
{
return \get_site_transient($raw ? $key : $this->get_key($key));
}
/**
* Sets an entry in the cache and stores the key.
*
* @param string $key The cache key.
* @param mixed $value The value to store.
* @param int $duration Optional. The duration in seconds. Default 0 (no expiration).
* @param bool $raw Optional. Use the raw key name (i.e. don't call get_key). Default false.
*
* @return bool True if the cache could be set successfully.
*/
public function set($key, $value, $duration = 0, $raw = \false)
{
return \set_site_transient($raw ? $key : $this->get_key($key), $value, $duration);
}
/**
* Deletes an entry from the cache.
*
* @param string $key The cache key root.
* @param bool $raw Optional. Use the raw key name (i.e. don't call get_key). Default false.
*
* @return bool True on successful removal, false on failure.
*/
public function delete($key, $raw = \false)
{
return \delete_site_transient($raw ? $key : $this->get_key($key));
}
}

183
vendor-scoped/mundschenk-at/wp-data-storage/src/class-transients.php Normal file
View File

@ -0,0 +1,183 @@
<?php
/**
* This file is part of mundschenk-at/wp-data-storage.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or ( at your option ) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* @package mundschenk-at/wp-data-storage/tests
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\Data_Storage;
/**
* Implements an interface to the WordPress Transients API.
*
* @since 1.0.0
*
* @author Peter Putzer <github@mundschenk.at>
*/
class Transients extends Abstract_Cache
{
const TRANSIENT_SQL_PREFIX = '_transient_';
/**
* The incrementor transient key.
*
* @var string
*/
protected $incrementor_key;
/**
* Create new cache instance.
*
* @param string $prefix The prefix automatically added to transient names.
*/
public function __construct($prefix)
{
$this->incrementor_key = $prefix . 'transients_incrementor';
$this->incrementor = $this->get($this->incrementor_key, \true);
parent::__construct($prefix);
}
/**
* Invalidate all cached elements by reseting the incrementor.
*/
public function invalidate()
{
if (!\wp_using_ext_object_cache()) {
// Clean up old transients.
foreach ($this->get_keys_from_database() as $old_transient) {
$this->delete($old_transient, \true);
}
}
// Update incrementor.
$this->incrementor = \time();
$this->set($this->incrementor_key, $this->incrementor, 0, \true);
}
/**
* Retrieves a list of transients set by the plugin from the options table.
*
* @return string[]
*/
public function get_keys_from_database()
{
/**
* WordPress database handler.
*
* @var \wpdb
*/
global $wpdb;
$results = $wpdb->get_results($wpdb->prepare("SELECT option_name FROM {$wpdb->options} WHERE option_name like %s", static::TRANSIENT_SQL_PREFIX . "{$this->get_prefix()}%"), \ARRAY_A);
// WPCS: db call ok, cache ok.
return \str_replace(static::TRANSIENT_SQL_PREFIX, '', \wp_list_pluck($results, 'option_name'));
}
/**
* Retrieves a cached value.
*
* @param string $key The cache key.
* @param bool $raw Optional. Use the raw key name (i.e. don't call get_key). Default false.
*
* @return mixed
*/
public function get($key, $raw = \false)
{
return \get_transient($raw ? $key : $this->get_key($key));
}
/**
* Retrieves a cached large object.
*
* @param string $key The cache key.
*
* @return mixed
*/
public function get_large_object($key)
{
$encoded = $this->get($key);
if (\false === $encoded) {
return \false;
}
$uncompressed = @\gzdecode(\base64_decode($encoded));
// @codingStandardsIgnoreLine
if (\false === $uncompressed) {
return \false;
}
return $this->maybe_fix_object(\unserialize($uncompressed));
// @codingStandardsIgnoreLine
}
/**
* Sets an entry in the cache and stores the key.
*
* @param string $key The cache key.
* @param mixed $value The value to store.
* @param int $duration Optional. The duration in seconds. Default 0 (no expiration).
* @param bool $raw Optional. Use the raw key name (i.e. don't call get_key). Default false.
*
* @return bool True if the cache could be set successfully.
*/
public function set($key, $value, $duration = 0, $raw = \false)
{
return \set_transient($raw ? $key : $this->get_key($key), $value, $duration);
}
/**
* Sets a transient for a large PHP object. The object will be stored in
* serialized and gzip encoded form using Base64 encoding to ensure binary safety.
*
* @param string $key The cache key.
* @param mixed $value The value to store.
* @param int $duration Optional. The duration in seconds. Default 0 (no expiration).
*
* @return bool True if the cache could be set successfully.
*/
public function set_large_object($key, $value, $duration = 0)
{
$compressed = \gzencode(\serialize($value));
// @codingStandardsIgnoreLine
if (\false === $compressed) {
return \false;
// @codeCoverageIgnore
}
return $this->set($key, \base64_encode($compressed), $duration);
}
/**
* Deletes an entry from the cache.
*
* @param string $key The cache key root.
* @param bool $raw Optional. Use the raw key name (i.e. don't call get_key). Default false.
*
* @return bool True on successful removal, false on failure.
*/
public function delete($key, $raw = \false)
{
return \delete_transient($raw ? $key : $this->get_key($key));
}
/**
* Tries to fix object cache implementations sometimes returning __PHP_Incomplete_Class.
*
* Originally based on http://stackoverflow.com/a/1173769/6646342 and refactored
* for PHP 7.2 compatibility.
*
* @param object $object An object that should have been unserialized, but may be of __PHP_Incomplete_Class.
*
* @return object The object with its real class.
*/
protected function maybe_fix_object($object)
{
if ('__PHP_Incomplete_Class' === \get_class($object)) {
$object = \unserialize(\serialize($object));
// phpcs:disable WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize,WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
}
return $object;
}
}

339
vendor-scoped/mundschenk-at/wp-settings-ui/LICENSE Normal file
View File

@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

17
vendor-scoped/mundschenk-at/wp-settings-ui/README.md Normal file
View File

@ -0,0 +1,17 @@
# WordPress Settings UI
A library providing an object-oriented interface to the WordPress Settings API.
## Features
* A WordPress plugin's settings page can be specified as an array of textual properties.
* A plugin can provide additional custom controls by implementing the `Mundschenk\UI\Control` interface.
* Standard controls included with the library:
- Checkbox (`Mundschenk\UI\Controls\Checkbox_Input`),
- Text field (`Mundschenk\UI\Controls\Text_Input`),
- Number field (`Mundschenk\UI\Controls\Number_Input`),
- Hidden field (`Mundschenk\UI\Controls\Hidden_Input`),
- Submit button (`Mundschenk\UI\Controls\Submit_Input`),
- Select box (`Mundschenk\UI\Controls\Select`),
- Plain text (`Mundschenk\UI\Controls\Display_Text`), and
- Text Area (`Mundschenk\UI\Controls\Textarea`).

65
vendor-scoped/mundschenk-at/wp-settings-ui/partials/control.php Normal file
View File

@ -0,0 +1,65 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2019 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
$outer_attributes = $this->get_outer_html_attributes(); // These are already escaped.
$outer_attributes = empty( $outer_attributes ) ? '' : " {$outer_attributes}";
$control_id = $this->get_id();
?>
<?php if ( ! empty( $this->grouped_controls ) ) : ?>
<fieldset<?php echo $outer_attributes; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>>
<legend class="screen-reader-text"><?php echo \esc_html( $this->short ); ?></legend>
<?php else : ?>
<div<?php echo $outer_attributes; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>>
<?php endif; // grouped_controls. ?>
<?php if ( ! empty( $this->label ) ) : ?>
<label for="<?php echo \esc_attr( $control_id ); ?>"><?php echo \wp_kses( $this->get_label(), self::ALLOWED_HTML ); ?></label>
<?php elseif ( $this->has_inline_help() ) : ?>
<label for="<?php echo \esc_attr( $control_id ); ?>">
<?php endif; ?>
<?php if ( ! $this->label_has_placeholder() ) : ?>
<?php $this->render_element(); // Control-specific markup. ?>
<?php endif; ?>
<?php if ( $this->has_inline_help() ) : ?>
<span id="<?php echo esc_attr( $control_id ); ?>-description" class="description"><?php echo \wp_kses( $this->help_text, self::ALLOWED_DESCRIPTION_HTML ); ?></span></label>
<?php elseif ( ! empty( $this->help_text ) ) : ?>
<p id="<?php echo esc_attr( $control_id ); ?>-description" class="description"><?php echo \wp_kses( $this->help_text, self::ALLOWED_DESCRIPTION_HTML ); ?></p>
<?php endif; ?>
<?php if ( ! empty( $this->grouped_controls ) ) : ?>
<?php foreach ( $this->grouped_controls as $control ) : ?>
<br />
<?php $control->render(); ?>
<?php endforeach; ?>
</fieldset>
<?php else : ?>
</div>
<?php endif; // grouped_controls. ?>
<?php

413
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/class-abstract-control.php Normal file
View File

@ -0,0 +1,413 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2014-2019 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* Abstract base class for HTML controls.
*/
abstract class Abstract_Control implements Control
{
/**
* Control ID (= option name).
*
* @var string
*/
protected $id;
/**
* Tab ID.
*
* @var string
*/
protected $tab_id;
/**
* Section ID.
*
* @var string
*/
protected $section;
/**
* Short label. Optional.
*
* @var string|null
*/
protected $short;
/**
* Label content with the position of the control marked as %1$s. Optional.
*
* @var string|null
*/
protected $label;
/**
* Help text. Optional.
*
* @var string|null
*/
protected $help_text;
/**
* Whether the help text should be displayed inline.
*
* @var bool
*/
protected $inline_help;
/**
* The default value. Required, but may be an empty string.
*
* @var string|int
*/
protected $default;
/**
* Additional HTML attributes to add to the main element (`<input>` etc.).
*
* @var array {
* Attribute/value pairs.
*
* string $attr Attribute value.
* }
*/
protected $attributes;
/**
* Additional HTML attributes to add to the outer element (either `<fieldset>` or `<div>`).
*
* @var array {
* Attribute/value pairs.
*
* string $attr Attribute value.
* }
*/
protected $outer_attributes;
/**
* Grouped controls.
*
* @var array {
* An array of Controls.
*
* Control $control Grouped control.
* }
*/
protected $grouped_controls = [];
/**
* The Control this one is grouped with.
*
* @var Control|null
*/
protected $grouped_with = null;
/**
* An abstraction of the WordPress Options API.
*
* @var Options
*/
protected $options;
/**
* The base path for includes.
*
* @var string
*/
protected $base_path;
/**
* The options key.
*
* @var string
*/
protected $options_key;
/**
* Additional arguments passed to the `add_settings_field` function.
*
* @var array {
* Attribute/value pairs.
*
* string $attr Attribute value.
* }
*/
protected $settings_args;
/**
* A sanitiziation callback.
*
* @var callable|null
*/
protected $sanitize_callback;
const ALLOWED_INPUT_ATTRIBUTES = ['id' => [], 'name' => [], 'value' => [], 'checked' => [], 'type' => [], 'class' => [], 'aria-describedby' => []];
const ALLOWED_HTML = ['span' => ['class' => []], 'input' => self::ALLOWED_INPUT_ATTRIBUTES, 'select' => self::ALLOWED_INPUT_ATTRIBUTES, 'option' => ['value' => [], 'selected' => []], 'code' => [], 'strong' => [], 'em' => [], 'sub' => [], 'sup' => [], 'br' => []];
const ALLOWED_DESCRIPTION_HTML = ['code' => [], 'strong' => [], 'em' => [], 'sub' => [], 'sup' => [], 'br' => [], 'span' => ['class' => []]];
/**
* Create a new UI control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param string $tab_id Tab ID. Required.
* @param string $section Section ID. Required.
* @param string|int $default The default value. Required, but may be an empty string.
* @param string|null $short Optional. Short label. Default null.
* @param string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @param string|null $help_text Optional. Help text. Default null.
* @param bool $inline_help Optional. Display help inline. Default false.
* @param array $attributes Optional. Attributes for the main element of the control. Default [].
* @param array $outer_attributes Optional. Attributes for the outer element (´<fieldset>` or `<div>`) of the control. Default [].
* @param array $settings_args Optional. Arguments passed to `add_settings_Field`. Default [].
* @param callable|null $sanitize_callback Optional. A callback to sanitize $_POST data. Default null.
*/
protected function __construct(Options $options, $options_key, $id, $tab_id, $section, $default, $short = null, $label = null, $help_text = null, $inline_help = \false, array $attributes = [], array $outer_attributes = [], $settings_args = [], $sanitize_callback = null)
{
$this->options = $options;
$this->options_key = $options_key;
$this->id = $id;
$this->tab_id = $tab_id;
$this->section = $section;
$this->short = $short ?: '';
$this->label = $label;
$this->help_text = $help_text;
$this->inline_help = $inline_help;
$this->default = $default;
$this->attributes = $attributes;
$this->outer_attributes = $outer_attributes;
$this->settings_args = $settings_args;
$this->sanitize_callback = $sanitize_callback;
$this->base_path = \dirname(\dirname(__DIR__));
}
/**
* Prepares keyowrd arguments passed via an array for usage.
*
* @param array $args Arguments.
* @param array $required Required argument names. 'tab_id' is always required.
*
* @return array
*
* @throws \InvalidArgumentException Thrown when a required argument is missing.
*/
protected function prepare_args(array $args, array $required)
{
// Check for required arguments.
$required = \wp_parse_args($required, ['tab_id']);
foreach ($required as $property) {
if (!isset($args[$property])) {
throw new \InvalidArgumentException("Missing argument '{$property}'.");
}
}
// Add default arguments.
$defaults = ['section' => $args['tab_id'], 'short' => null, 'label' => null, 'help_text' => null, 'inline_help' => \false, 'attributes' => [], 'outer_attributes' => [], 'settings_args' => [], 'sanitize_callback' => null];
$args = \wp_parse_args($args, $defaults);
return $args;
}
/**
* Retrieve the current value for the control.
* May be overridden by subclasses.
*
* @return mixed
*/
public function get_value()
{
$key = $this->options_key ?: $this->id;
$options = $this->options->get($key);
if ($key === $this->id) {
return $options;
} elseif (isset($options[$this->id])) {
return $options[$this->id];
} else {
return null;
}
}
/**
* Renders control-specific HTML.
*
* @return void
*/
protected function render_element()
{
echo $this->get_element_markup();
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Retrieves the control-specific HTML markup.
*
* @return string
*/
protected abstract function get_element_markup();
/**
* Render the HTML representation of the control.
*/
public function render()
{
require $this->base_path . '/partials/control.php';
}
/**
* Retrieves additional HTML attributes as a string ready for inclusion in markup.
*
* @param array $attributes Required.
*
* @return string
*/
protected function get_html_attributes(array $attributes)
{
$html_attributes = '';
if (!empty($attributes)) {
foreach ($attributes as $attr => $val) {
$html_attributes .= \esc_attr($attr) . '="' . \esc_attr($val) . '" ';
}
}
return $html_attributes;
}
/**
* Retrieves additional HTML attributes for the inner element as a string
* ready for inclusion in markup.
*
* @return string
*/
protected function get_inner_html_attributes()
{
return $this->get_html_attributes($this->attributes);
}
/**
* Retrieves additional HTML attributes for the outer element as a string
* ready for inclusion in markup.
*
* @return string
*/
protected function get_outer_html_attributes()
{
return $this->get_html_attributes($this->outer_attributes);
}
/**
* Retrieve default value.
*
* @return string|int
*/
public function get_default()
{
return $this->default;
}
/**
* Retrieve control ID.
*
* @return string
*/
public function get_id()
{
if (!empty($this->options_key)) {
return "{$this->options->get_name($this->options_key)}[{$this->id}]";
} else {
return "{$this->options->get_name($this->id)}";
}
}
/**
* Retrieves the markup for ID, name and class(es).
* Also adds additional attributes if they are set.
*
* @return string
*/
protected function get_id_and_class_markup()
{
$id = \esc_attr($this->get_id());
$aria = !empty($this->help_text) ? " aria-describedby=\"{$id}-description\"" : '';
// Set default ID & name, no class (except for submit buttons).
return "id=\"{$id}\" name=\"{$id}\" {$this->get_inner_html_attributes()}{$aria}";
}
/**
* Determines if the label contains a placeholder for the actual control element(s).
*
* @return bool
*/
protected function label_has_placeholder()
{
return \false !== \strpos($this->label, '%1$s');
}
/**
* Determines if this control has an inline help text to display.
*
* @return bool
*/
protected function has_inline_help()
{
return $this->inline_help && !empty($this->help_text);
}
/**
* Retrieves the label. If the label text contains a string placeholder, it
* is replaced by the control element markup.
*
* @var string
*/
public function get_label()
{
if ($this->label_has_placeholder()) {
return \sprintf($this->label, $this->get_element_markup());
} else {
return $this->label;
}
}
/**
* Register the control with the settings API.
*
* @param string $option_group Application-specific prefix.
*/
public function register($option_group)
{
// Register rendering callbacks only for non-grouped controls.
if (empty($this->grouped_with)) {
\add_settings_field($this->get_id(), $this->short, [$this, 'render'], $option_group . $this->tab_id, $this->section, $this->settings_args);
}
}
/**
* Group another control with this one.
*
* @param Control $control Any control.
*/
public function add_grouped_control(Control $control)
{
// Prevent self-references.
if ($this !== $control) {
$this->grouped_controls[] = $control;
$control->group_with($this);
}
}
/**
* Registers this control as grouped with another one.
*
* @param Control $control Any control.
*/
public function group_with(Control $control)
{
// Prevent self-references.
if ($this !== $control) {
$this->grouped_with = $control;
}
}
/**
* Sanitizes an option value.
*
* @param mixed $value The unslashed post variable.
*
* @return mixed The sanitized value.
*/
public function sanitize($value)
{
$sanitize = $this->sanitize_callback;
if (\is_callable($sanitize)) {
return $sanitize($value);
}
return $value;
}
}

76
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/class-control-factory.php Normal file
View File

@ -0,0 +1,76 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* A factory class for Controls.
*/
abstract class Control_Factory
{
/**
* Initialize controls for a plugin settings page.
*
* @param array $defaults {
* An array of control definitions, indexed by control ID.
*
* @type array $control_id {
* A control definition. There may be additional parameters that are passed to the control constructor.
*
* @type string $ui The UI object class name.
* @type string $grouped_with The control ID of the control this one should be grouped with.
* }
* }
* @param Options $options The options handler.
* @param string $options_key The options key.
*
* @return array {
* An array of control objects, indexed by control ID.
*
* @type Control $id A control object.
* }
*/
public static function initialize(array $defaults, Options $options, $options_key)
{
// Create controls from default configuration.
$controls = [];
$groups = [];
foreach ($defaults as $control_id => $control_info) {
$controls[$control_id] = $control_info['ui']::create($options, $options_key, $control_id, $control_info);
if (!empty($control_info['grouped_with'])) {
$groups[$control_info['grouped_with']][] = $control_id;
}
}
// Group controls.
foreach ($groups as $group => $control_ids) {
foreach ($control_ids as $control_id) {
$controls[$group]->add_grouped_control($controls[$control_id]);
}
}
return $controls;
}
}

116
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/class-control.php Normal file
View File

@ -0,0 +1,116 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* An interface for HTML controls.
*/
interface Control
{
/**
* Retrieve the current value for the control.
* May be overridden by subclasses.
*
* @return mixed
*/
public function get_value();
/**
* Render the HTML representation of the control.
*/
public function render();
/**
* Retrieve default value.
*
* @return string|int
*/
public function get_default();
/**
* Retrieve control ID.
*
* @return string
*/
public function get_id();
/**
* Retrieves the label. If the label text contains a string placeholder, it
* is replaced by the control element markup.
*
* @var string
*/
public function get_label();
/**
* Register the control with the settings API.
*
* @param string $option_group Application-specific prefix.
*/
public function register($option_group);
/**
* Groups another control with this one.
*
* @param Control $control Any control.
*/
public function add_grouped_control(Control $control);
/**
* Registers this control as grouped with another one.
*
* @param Control $control Any control.
*/
public function group_with(Control $control);
/**
* Sanitizes an option value.
*
* @param mixed $value The unslashed post variable.
*
* @return mixed The sanitized value.
*/
public function sanitize($value);
/**
* Creates a new control.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Section ID. Required.
* @type string|int $default The default value. Required, but may be an empty string.
* @type array $option_values The allowed values. Required.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* }
*
* @return Control
*
* @throws \InvalidArgumentException Missing argument.
*/
public static function create(Options $options, $options_key, $id, array $args);
}

75
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-checkbox-input.php Normal file
View File

@ -0,0 +1,75 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <input> element.
*/
class Checkbox_Input extends Input
{
/**
* Create a new input control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* }
*
* @throws \InvalidArgumentException Missing argument.
*/
public function __construct(Options $options, $options_key, $id, array $args)
{
$args['input_type'] = 'checkbox';
$args['sanitize_callback'] = 'boolval';
parent::__construct($options, $options_key, $id, $args);
}
/**
* Retrieves the value markup for this input.
*
* @param mixed $value The input value.
*
* @return string
*/
protected function get_value_markup($value)
{
return 'value="1" ' . \checked($value, \true, \false);
}
}

121
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-display-text.php Normal file
View File

@ -0,0 +1,121 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\UI\Abstract_Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* A control displaying read-only text.
*/
class Display_Text extends Abstract_Control
{
const ALLOWED_ATTRIBUTES = ['id' => [], 'name' => [], 'class' => [], 'aria-describedby' => []];
const ALLOWED_HTML = ['div' => self::ALLOWED_ATTRIBUTES, 'span' => self::ALLOWED_ATTRIBUTES, 'p' => self::ALLOWED_ATTRIBUTES, 'ul' => self::ALLOWED_ATTRIBUTES, 'ol' => self::ALLOWED_ATTRIBUTES, 'li' => self::ALLOWED_ATTRIBUTES, 'a' => ['class' => [], 'href' => [], 'rel' => [], 'target' => []], 'code' => [], 'strong' => [], 'em' => [], 'sub' => [], 'sup' => []];
/**
* The HTML elements to display.
*
* @var string[]
*/
protected $elements;
/**
* Create a new input control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $input_type HTML input type ('checkbox' etc.). Required.
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type array $elements The HTML elements to display (including the outer tag). Required.
* @type string|null $short Optional. Short label. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* @type array $settings_args Optional. Default [],
* }
*/
protected function __construct(Options $options, $options_key, $id, array $args)
{
$args = $this->prepare_args($args, ['elements']);
$this->elements = $args['elements'];
$sanitize = function () {
return '';
};
parent::__construct($options, $options_key, $id, $args['tab_id'], $args['section'], '', $args['short'], null, $args['help_text'], $args['inline_help'], $args['attributes'], $args['outer_attributes'], $args['settings_args'], $sanitize);
}
/**
* Retrieves the current value for the control. In this case, the method always returns ''.
*
* @return string
*/
public function get_value()
{
return '';
}
/**
* Retrieves the control-specific HTML markup.
*
* @var string
*/
protected function get_element_markup()
{
return \wp_kses(\implode('', $this->elements), self::ALLOWED_HTML);
}
/**
* Creates a new input control, provided the concrete subclass constructors follow
* this methods signature.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Section ID. Required.
* @type string|int $default The default value. Required, but may be an empty string.
* @type array $option_values The allowed values. Required.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* }
*
* @return Control
*
* @throws \InvalidArgumentException Missing argument.
*/
public static function create(Options $options, $options_key, $id, array $args)
{
return new static($options, $options_key, $id, $args);
}
}

63
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-hidden-input.php Normal file
View File

@ -0,0 +1,63 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <input> element.
*/
class Hidden_Input extends Input
{
/**
* Create a new input control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type string|null $short Optional. Short label. Default null.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* }
*
* @throws \InvalidArgumentException Missing argument.
*/
public function __construct(Options $options, $options_key, $id, array $args)
{
$args['input_type'] = 'hidden';
$args['label'] = null;
$args['help_text'] = null;
$args['inline_help'] = \false;
parent::__construct($options, $options_key, $id, $args);
}
}

121
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-input.php Normal file
View File

@ -0,0 +1,121 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\UI\Abstract_Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <input> element.
*/
abstract class Input extends Abstract_Control
{
/**
* The input type ('checkbox', ...).
*
* @var string
*/
protected $input_type;
/**
* Create a new input control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $input_type HTML input type ('checkbox' etc.). Required.
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* @type array $settings_args Optional. Default [],
* }
*/
protected function __construct(Options $options, $options_key, $id, array $args)
{
$args = $this->prepare_args($args, ['input_type', 'tab_id', 'default']);
$this->input_type = $args['input_type'];
$sanitize = isset($args['sanitize_callback']) ? $args['sanitize_callback'] : 'sanitize_text_field';
parent::__construct($options, $options_key, $id, $args['tab_id'], $args['section'], $args['default'], $args['short'], $args['label'], $args['help_text'], $args['inline_help'], $args['attributes'], $args['outer_attributes'], $args['settings_args'], $sanitize);
}
/**
* Retrieves the value markup for this input.
*
* @param mixed $value The input value.
*
* @return string
*/
protected function get_value_markup($value)
{
return $value ? 'value="' . \esc_attr($value) . '" ' : '';
}
/**
* Retrieves the control-specific HTML markup.
*
* @var string
*/
protected function get_element_markup()
{
return '<input type="' . \esc_attr($this->input_type) . '" ' . "{$this->get_id_and_class_markup()} {$this->get_value_markup($this->get_value())}/>";
}
/**
* Creates a new input control, provided the concrete subclass constructors follow
* this methods signature.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Section ID. Required.
* @type string|int $default The default value. Required, but may be an empty string.
* @type array $option_values The allowed values. Required.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* }
*
* @return Control
*
* @throws \InvalidArgumentException Missing argument.
*/
public static function create(Options $options, $options_key, $id, array $args)
{
return new static($options, $options_key, $id, $args);
}
}

78
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-number-input.php Normal file
View File

@ -0,0 +1,78 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <input> element.
*/
class Number_Input extends Input
{
/**
* Create a new input control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* }
*
* @throws \InvalidArgumentException Missing argument.
*/
public function __construct(Options $options, $options_key, $id, array $args)
{
$args['input_type'] = 'number';
$args['sanitize_callback'] = function ($value) {
return $value + 0;
};
parent::__construct($options, $options_key, $id, $args);
}
/**
* Render the value markup for this input.
*
* @param mixed $value The input value.
*
* @return string
*/
protected function get_value_markup($value)
{
// Include 0 values.
return 'value="' . \esc_attr($value) . '" ';
}
}

152
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-select.php Normal file
View File

@ -0,0 +1,152 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\UI\Abstract_Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <select> element.
*/
class Select extends Abstract_Control
{
/**
* The selectable values.
*
* @var array
*/
protected $option_values;
/**
* Create a new select control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type array $option_values The allowed values. Required.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* @type array $settings_args Optional. Default [],
* }
*
* @throws \InvalidArgumentException Missing argument.
*/
public function __construct(Options $options, $options_key, $id, array $args)
{
$args = $this->prepare_args($args, ['tab_id', 'default', 'option_values']);
$sanitize = $args['sanitize_callback'] ?: 'sanitize_text_field';
$this->option_values = $args['option_values'];
parent::__construct($options, $options_key, $id, $args['tab_id'], $args['section'], $args['default'], $args['short'], $args['label'], $args['help_text'], $args['inline_help'], $args['attributes'], $args['outer_attributes'], $args['settings_args'], $sanitize);
}
/**
* Set selectable options.
*
* @param array $option_values An array of VALUE => DISPLAY.
*/
public function set_option_values(array $option_values)
{
$this->option_values = $option_values;
}
/**
* Retrieve the current value for the select control.
*
* @return mixed
*/
public function get_value()
{
$config = $this->options->get($this->options_key);
$value = $config[$this->id];
// Make sure $value is in $option_values if $option_values is set.
if (isset($this->option_values) && !isset($this->option_values[$value])) {
$value = null;
}
return $value;
}
/**
* Retrieves the control-specific HTML markup.
*
* @return string
*/
protected function get_element_markup()
{
$select_markup = "<select {$this->get_id_and_class_markup()}>";
$value = $this->get_value();
foreach ($this->option_values as $option_value => $display) {
$select_markup .= '<option value="' . \esc_attr($option_value) . '" ' . \selected($value, $option_value, \false) . '>' . \esc_html($display) . '</option>';
}
$select_markup .= '</select>';
return $select_markup;
}
/**
* Sanitizes an option value.
*
* @param mixed $value The unslashed post variable.
*
* @return string The sanitized value.
*/
public function sanitize_value($value)
{
return \sanitize_text_field($value);
}
/**
* Creates a new select control
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Section ID. Required.
* @type string|int $default The default value. Required, but may be an empty string.
* @type array $option_values The allowed values. Required.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* }
*
* @return Control
*
* @throws \InvalidArgumentException Missing argument.
*/
public static function create(Options $options, $options_key, $id, array $args)
{
return new static($options, $options_key, $id, $args);
}
}

100
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-submit-input.php Normal file
View File

@ -0,0 +1,100 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <input> element.
*/
class Submit_Input extends Input
{
/**
* Optional HTML class for buttons.
*
* @var string
*/
protected $button_class;
/**
* Optional button label.
*
* @var string
*/
protected $button_label;
/**
* Create a new input control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type string $button_class Required.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. The actual button label. Default null (browser dependant).
* @type array $attributes Optional. Default [],
* }
*
* @throws \InvalidArgumentException Missing argument.
*/
public function __construct(Options $options, $options_key, $id, array $args)
{
// Ensure that there is a button class argument.
$args = $this->prepare_args($args, ['button_class']);
// Ensure proper button label handling.
$this->button_label = $args['label'];
$args['label'] = null;
// Force these addtional arguments.
$args['input_type'] = 'submit';
// Store button class attribute.
$this->button_class = $args['button_class'];
// Call parent.
parent::__construct($options, $options_key, $id, $args);
}
/**
* Retrieve the current button name.
*
* @return string
*/
public function get_value()
{
return $this->button_label;
}
/**
* Markup ID and class(es).
*
* @return string
*/
protected function get_id_and_class_markup()
{
return parent::get_id_and_class_markup() . ' class="' . \esc_attr($this->button_class) . '"';
}
}

63
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-text-input.php Normal file
View File

@ -0,0 +1,63 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2019 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <input> element.
*/
class Text_Input extends Input
{
/**
* Create a new input control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* }
*
* @throws \InvalidArgumentException Missing argument.
*/
public function __construct(Options $options, $options_key, $id, array $args)
{
$args['input_type'] = 'text';
parent::__construct($options, $options_key, $id, $args);
}
}

104
vendor-scoped/mundschenk-at/wp-settings-ui/src/ui/controls/class-textarea.php Normal file
View File

@ -0,0 +1,104 @@
<?php
/**
* This file is part of WordPress Settings UI.
*
* Copyright 2017-2018 Peter Putzer.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***
*
* @package mundschenk-at/wp-settings-ui
* @license http://www.gnu.org/licenses/gpl-2.0.html
*/
namespace Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
use Avatar_Privacy\Vendor\Mundschenk\UI\Control;
use Avatar_Privacy\Vendor\Mundschenk\UI\Abstract_Control;
use Avatar_Privacy\Vendor\Mundschenk\Data_Storage\Options;
/**
* HTML <textarea> element.
*/
class Textarea extends Abstract_Control
{
/**
* Create a new textarea control object.
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Optional. Section ID. Default Tab ID.
* @type string|int $default The default value. Required, but may be an empty string.
* @type string $short Optional. Short label.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type array $attributes Optional. Default [],
* @type array $outer_attributes Optional. Default [],
* @type array $settings_args Optional. Default [],
* }
*
* @throws \InvalidArgumentException Missing argument.
*/
public function __construct(Options $options, $options_key, $id, array $args)
{
$args = $this->prepare_args($args, ['tab_id', 'default']);
$sanitize = 'sanitize_textarea_field';
parent::__construct($options, $options_key, $id, $args['tab_id'], $args['section'], $args['default'], $args['short'], $args['label'], $args['help_text'], \false, $args['attributes'], $args['outer_attributes'], $args['settings_args'], $sanitize);
}
/**
* Retrieves the control-specific HTML markup.
*
* @var string
*/
protected function get_element_markup()
{
$value = $this->get_value();
$value = !empty($value) ? \esc_textarea($value) : '';
return "<textarea class=\"large-text\" {$this->get_id_and_class_markup()}>{$value}</textarea>";
}
/**
* Creates a new textarea control
*
* @param Options $options Options API handler.
* @param string $options_key Database key for the options array. Passing '' means that the control ID is used instead.
* @param string $id Control ID (equivalent to option name). Required.
* @param array $args {
* Optional and required arguments.
*
* @type string $tab_id Tab ID. Required.
* @type string $section Section ID. Required.
* @type string|int $default The default value. Required, but may be an empty string.
* @type array $option_values The allowed values. Required.
* @type string|null $short Optional. Short label. Default null.
* @type string|null $label Optional. Label content with the position of the control marked as %1$s. Default null.
* @type string|null $help_text Optional. Help text. Default null.
* @type bool $inline_help Optional. Display help inline. Default false.
* @type array $attributes Optional. Default [],
* }
*
* @return Control
*
* @throws \InvalidArgumentException Missing argument.
*/
public static function create(Options $options, $options_key, $id, array $args)
{
return new static($options, $options_key, $id, $args);
}
}