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

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);
}
}