OwlCyberSecurity - MANAGER

Edit File: Widget_Abstract.php

<?php

namespace Tribe\Widget;

use Tribe__Utils__Array as Arr;

/**
 * The abstract base without Views that all widgets should implement.
 *
 * @since   5.12.12
 *
 * @package Tribe\Widget
 */
abstract class Widget_Abstract extends \WP_Widget implements Widget_Interface {

/**
	 * Slug of the current widget.
	 *
	 * @since 5.12.12
	 *
	 * @var string
	 */
	protected $slug;

/**
	 * Default arguments to be merged into final arguments of the widget.
	 *
	 * @since 5.12.12
	 *
	 * @var array<string,mixed>
	 */
	protected $default_arguments = [];

/**
	 * Array map allowing aliased widget arguments.
	 *
	 * The array keys are aliases of the array values (i.e. the "real" widget attributes to parse).
	 * Example array: [ 'alias' => 'canonical', 'from' => 'to', 'that' => 'becomes_this' ]
	 * Example widget usage: [some_tag alias=17 to='Fred'] will be parsed as [some_tag canonical=17 to='Fred']
	 *
	 * @since 5.12.12
	 *
	 * @var array<string,string>
	 */
	protected $aliased_arguments = [];

/**
	 * Array of callbacks for validation of arguments.
	 *
	 * @since 5.12.12
	 *
	 * @var array<string,callable>
	 */
	protected $validate_arguments_map = [];

/**
	 * Arguments of the current widget.
	 *
	 * @since 5.12.12
	 *
	 * @var array<string,mixed>
	 */
	protected $arguments;

/**
	 * HTML content of the current widget.
	 *
	 * @since 5.12.12
	 *
	 * @var string
	 */
	protected $content;

/**
	 * {@inheritDoc}
	 */
	public function __construct( $id_base = '', $name = '', $widget_options = [], $control_options = [] ) {
		$arguments = $this->get_arguments();

parent::__construct(
			Arr::get( $arguments, 'id_base', '' ),
			Arr::get( $arguments, 'name', '' ),
			Arr::get( $arguments, 'widget_options', [] ),
			Arr::get( $arguments, 'control_options', [] )
		);

// @todo add what this does in in TEC-3612 & TEC-3613.
		$this->setup();
	}

/**
	 * Setup the widget.
	 *
	 * @todo update in TEC-3612 & TEC-3613
	 *
	 * @since 5.12.12
	 *
	 * @return mixed
	 */
	public abstract function setup();

/**
	 * Echoes the widget content.
	 *
	 * @todo Widget display will be handled in TEC-3620 & TEC-3597.
	 * @todo Add future support for passing along `$args` and `$instance` for the widget HTML view.
	 *
	 * @since 5.12.12
	 *
	 * @param array<string,mixed> $args     Display arguments including 'before_title', 'after_title',
	 *                                      'before_widget', and 'after_widget'.
	 * @param array<string,mixed> $instance The settings for the particular instance of the widget.
	 */
	public function widget( $args, $instance ) {
		echo $this->get_html();
	}

/**
	 * Returns the rendered View HTML code.
	 *
	 * @since 5.12.12
	 *
	 * @return string
	 */
	public abstract function get_html();

/**
	 * {@inheritDoc}
	 */
	public function set_aliased_arguments( array $alias_map ) {
		$this->aliased_arguments = Arr::filter_to_flat_scalar_associative_array( (array) $alias_map );
	}

/**
	 * {@inheritDoc}
	 */
	public function get_aliased_arguments() {
		return $this->aliased_arguments;
	}

/**
	 * {@inheritDoc}
	 */
	public function parse_arguments( array $arguments ) {
		$arguments = Arr::parse_associative_array_alias( (array) $arguments, (array) $this->get_aliased_arguments() );

return $this->validate_arguments( $arguments );
	}

/**
	 * {@inheritDoc}
	 */
	public function validate_arguments( array $arguments ) {
		$validate_arguments_map = $this->get_validated_arguments_map();
		foreach ( $validate_arguments_map as $key => $callback ) {
			$arguments[ $key ] = $callback( isset( $arguments[ $key ] ) ? $arguments[ $key ] : null );
		}

return $arguments;
	}

/**
	 * {@inheritDoc}
	 */
	public function get_registration_slug() {
		return $this->slug;
	}

/**
	 * {@inheritDoc}
	 */
	public function get_validated_arguments_map() {
		/**
		 * Applies a filter to the validation map for instance arguments.
		 *
		 * @since 5.12.12
		 *
		 * @param array<string,callable> $validate_arguments_map Current set of callbacks for arguments.
		 * @param static                             $instance                            The widget instance we are dealing with.
		 */
		$validate_arguments_map = apply_filters( 'tribe_widget_validate_arguments_map', $this->validate_arguments_map, $this );

$registration_slug = $this->get_registration_slug();

/**
		 * Applies a filter to the validation map for instance arguments for a specific widget. Based on the registration slug of the widget
		 *
		 * @since 5.12.12
		 *
		 * @param array<string,callable> $validate_arguments_map Current set of callbacks for arguments.
		 * @param static                            $instance                             The widget instance we are dealing with.
		 */
		$validate_arguments_map = apply_filters( "tribe__widget_{$registration_slug}_validate_arguments_map", $validate_arguments_map, $this );

return $validate_arguments_map;
	}

/**
	 * {@inheritDoc}
	 */
	public function get_arguments() {

return $this->filter_arguments( $this->arguments );
	}

/**
	 * {@inheritDoc}
	 */
	public function filter_arguments( $arguments ) {
		/**
		 * Applies a filter to instance arguments.
		 *
		 * @since 5.12.12
		 *
		 * @param array<string,mixed> $arguments Current set of arguments.
		 * @param static              $instance  The widget instance we are dealing with.
		 */
		$arguments = apply_filters( 'tribe_widget_arguments', $arguments, $this );

$registration_slug = $this->get_registration_slug();

/**
		 * Applies a filter to instance arguments based on the registration slug of the widget.
		 *
		 * @since 5.12.12
		 *
		 * @param array<string,mixed> $arguments Current set of arguments.
		 * @param static              $instance  The widget instance we are dealing with.
		 */
		$arguments = apply_filters( "tribe_widget_{$registration_slug}_arguments", $arguments, $this );

return $arguments;
	}

/**
	 * {@inheritDoc}
	 */
	public function get_argument( $index, $default = null ) {
		$arguments = $this->get_arguments();
		$argument  = Arr::get( $arguments, $index, $default );

return $this->filter_argument( $argument, $index, $default );
	}

/**
	 * {@inheritDoc}
	 */
	public function filter_argument( $argument, $index, $default = null  ) {
		/**
		 * Applies a filter to a specific widget argument, catch all for all widgets.
		 *
		 * @since 5.12.12
		 *
		 * @param mixed               $argument The argument.
		 * @param string|int          $index    Which index we intend to fetch from the arguments.
		 * @param array<string,mixed> $default  Default value if it doesn't exist.
		 * @param static              $instance The widget instance we are dealing with.
		 */
		$argument = apply_filters( 'tribe_widget_argument', $argument, $index, $default, $this );

$registration_slug = $this->get_registration_slug();

/**
		 * Applies a filter to a specific widget argument, to a particular registration slug.
		 *
		 * @since 5.12.12
		 *
		 * @param mixed      $argument The argument value.
		 * @param string|int $index    Which index we intend to fetch from the arguments.
		 * @param mixed      $default  Default value if it doesn't exist.
		 * @param static     $instance The widget instance we are dealing with.
		 */
		$argument = apply_filters( "tribe_widget_{$registration_slug}_argument", $argument, $index, $default, $this );

return $argument;
	}

/**
	 * {@inheritDoc}
	 */
	public function get_default_arguments() {
		return $this->filter_default_arguments( $this->default_arguments );
	}

/**
	 * {@inheritDoc}
	 */
	public function filter_default_arguments( array $default_arguments = [] ) {
		/**
		 * Applies a filter to default instance arguments.
		 *
		 * @since 5.12.12
		 *
		 * @param array<string,mixed>  $default_arguments Current set of default arguments.
		 * @param static               $instance          The widget instance we are dealing with.
		 */
		$default_arguments = apply_filters( 'tribe_widget_default_arguments', $default_arguments, $this );

$registration_slug = $this->get_registration_slug();

/**
		 * Applies a filter to default instance arguments based on the registration slug of the widget.
		 *
		 * @since 5.12.12
		 *
		 * @param array<string,mixed>  $default_arguments Current set of default arguments.
		 * @param static               $instance          The widget instance we are dealing with.
		 */
		$default_arguments = apply_filters( "tribe_widget_{$registration_slug}_default_arguments", $default_arguments, $this );

return $default_arguments;
	}
}