File Editor

Directories:

Files:

Create New File

Edit File: Url.php

<?php
/**
 * Models a URL passed to a view.
 *
 * @package Tribe\Events\Views\V2
 * @since   4.9.2
 */

namespace Tribe\Events\Views\V2;

use Tribe\Events\Views\V2\Views\List_View;
use Tribe__Context as Context;
use Tribe__Events__Rewrite as TEC_Rewrite;
use Tribe__Utils__Array as Arr;

/**
 * Class Url
 *
 * @package Tribe\Events\Views\V2
 * @since   4.9.2
 */
class Url {

/**
	 * The URL abstracted by the instance.
	 *
	 * @since 4.9.3
	 *
	 * @var string
	 */
	protected $url = '';

/**
	 * An array of the default URL components produced by the `parse_url` function.
	 *
	 * @since 4.9.3
	 *
	 * @var array
	 */
	protected static $default_url_components = [
		'scheme'   => '',
		'host'     => '',
		'port'     => '',
		'user'     => '',
		'pass'     => '',
		'path'     => '',
		'query'    => '',
		'fragment' => '',
	];

/**
	 * An array of the URL components as produced by the `parse_url` function.
	 *
	 * @since 4.9.3
	 *
	 * @var array
	 */
	protected $components = [];

/**
	 * An array of the parsed query arguments from the URL.
	 *
	 * @since 4.9.3
	 *
	 * @var array
	 */
	protected $query_args = [];

/**
	 * A flag to define how conflicts between parameters set in the query arguments and parameters set by the path
	 * should be resolved.
	 * If `false` then arguments parsed from the path will override the query ones, if `false` the arguments parsed from
	 * the query will override the path ones.
	 *
	 * @var bool
	 */
	protected $query_overrides_path = false;

/**
	 * Url constructor.
	 *
	 * @param null|string $url The url to build the object with or `null` to use the current URL.
	 * @param bool $query_overrides_path A flag to define how conflicts between parameters set in the query
	 *                                   arguments and parameters set by the path should be resolved.
	 */
	public function __construct( $url = null, $query_overrides_path = false ) {
		if ( empty( $url ) ) {
			$url = home_url( add_query_arg( [] ) );
		}

$this->url = $url;
		$this->query_overrides_path = (bool)$query_overrides_path;
		$this->parse_url();
	}

/**
	 * Returns the slug of the view as defined in the URL.
	 *
	 * @since 4.9.2
	 *
	 * @return mixed|string The view slug as defined in the URL.
	 */
	public function get_view_slug() {
		$slug = 'default';

if ( empty( $this->url ) ) {
			return $slug;
		}

return Arr::get_first_set( $this->get_query_args(), [ 'view', 'tribe_view', 'eventDisplay' ], $slug );
	}

/**
	 * Returns the full URL this instance was built on.
	 *
	 * @since 4.9.3
	 *
	 * @return string The full URL this instance was built on; an empty string if the URL is not set.
	 */
	public function __toString() {
		return tribe_build_url( $this->components );
	}

/**
	 * Returns the current page number for the URL.
	 *
	 * @since 4.9.3
	 *
	 * @return int The current page number if specified in the URL or the default value.
	 */
	public function get_current_page() {
		return Arr::get_first_set( $this->get_query_args(), [ 'paged', 'page' ], 1 );
	}

/**
	 * Returns the current query arguments
	 *
	 * @since 4.9.3
	 *
	 * @return array Returns the current Query Arguments
	 */
	public function get_query_args() {
		return $this->query_args;
	}

/**
	 * Parses the current URL and initializes its components.
	 *
	 * @since 4.9.3
	 *
	 * @return Url This object instance.
	 */
	public function parse_url() {
		$this->components = array_merge( static::$default_url_components, parse_url( $this->url ) );
		$this->query_args = TEC_Rewrite::instance()->parse_request( $this->url );
		if ( ! empty( $this->components['query'] ) ) {
			parse_str( $this->components['query'], $query_component_args );
			$this->query_args     = $this->query_overrides_path
				? array_merge( $this->query_args, $query_component_args )
				: array_merge( $query_component_args, $this->query_args );
		}

return $this;
	}

/**
	 * Adds query args to the object merging them with the current ones.
	 *
	 * @since 4.9.3
	 *
	 * @param array $query_args An associative array of query args to add to the object.
	 *
	 * @return $this The object instance.
	 */
	public function add_query_args( array $query_args = [] ) {
		$this->query_args          = array_merge( $this->query_args, $query_args );
		$this->components['query'] = http_build_query( $this->query_args );

return $this;
	}

/**
	 * Sets whether the parameters set in the query should override the ones parsed by the path or not.
	 *
	 * By default path parameters will take precedence over query parameters.
	 * When set to `false`  then `/events/list?eventDisplay=month` will result in an `eventDisplay=list`;
	 * when set to `true` the resulting `eventDisplay` will be `month`.
	 *
	 * @since 4.9.3
	 *
	 * @param bool $query_overrides_path Whether the parameters set in the query should override the ones parsed by the
	 *                                   path or not.
	 *
	 * @return Url This object instance to chain method calls.
	 */
	public function query_overrides_path( $query_overrides_path ) {
		$this->query_overrides_path = (bool) $query_overrides_path;

return $this;
	}

/**
	 * Returns the alias of the variable set in the Url query args, if any.
	 *
	 * @since 4.9.4
	 *
	 * @param              string $var The name of the variable to search an alias for.
	 * @param Context|null $context The Context object to use to fetch locations, if `null` the global Context will be
	 *                              used.
	 *
	 * @return false|string The variable alias set in the URL query args, or `false` if no alias was found.
	 */
	public function get_query_arg_alias_of( $var, Context $context = null ) {
		$aliases = $this->get_query_args_aliases_of( $var, $context, false );

return count( $aliases ) ? reset( $aliases ) : false;
	}

/**
	 * Returns the value of a query arg set on the URL, or a default value if not found.
	 *
	 * @since 4.9.4
	 *
	 * @param      string $key The
	 * @param null $default
	 *
	 * @return mixed
	 */
	public function get_query_arg( $key, $default = null ) {
		return Arr::get( (array) $this->get_query_args(), $key, $default );
	}

/**
	 * Returns all the aliases of the variable set in the Url query args, if any.
	 *
	 * @since 4.9.9
	 *
	 * @param string       $var     The name of the variable to search the aliases for.
	 * @param Context|null $context The Context object to use to fetch locations, if `null` the global Context will be
	 *                              used.
	 *
	 * @return array An array of the variable aliases set in the URL query args.
	 */
	public function get_query_args_aliases_of( $var, Context $context = null ) {
		$context    = $context ?: tribe_context();
		$query_args = $this->get_query_args();
		$aliases    = $context->translate_sub_locations(
			$query_args,
			Context::QUERY_VAR,
			'read'
		);

if ( empty( $aliases ) ) {
			return [];
		}

$query_aliases   = (array) Arr::get( $context->get_locations(), [ $var, 'read', Context::QUERY_VAR ], [] );
		$request_aliases = (array) Arr::get( $context->get_locations(), [ $var, 'read', Context::REQUEST_VAR ], [] );
		$context_aliases = array_unique( array_merge( $query_aliases, $request_aliases ) );

$matches = array_intersect(
			array_unique( array_merge( $context_aliases, [ $var ] ) ),
			array_keys( array_merge( $query_args, tribe_get_request_vars() ) )
		);

return $matches;
	}

/**
	 * Builds and returns an instance of the object taking care to parse additional parameters to use the correct URL.
	 *
	 * @since 4.9.10
	 *
	 * @param string $url The URL address to build the object on.
	 * @param array  $params An array of additional parameters to parse; these parameters might be more up to date in
	 *                       respect to the `$url` argument and will be used to build an instance of the class on the
	 *                       correct URL. Passing an empty array here is, in fact, the same as calling
	 *                       `new Url( $url )`;
	 *
	 * @return static The built instance of this class.
	 */
	public static function from_url_and_params( $url = null, array $params = [] ) {
		if ( empty( $url ) ) {
			$url = home_url( add_query_arg( [] ) );
		}

/*
		 * Depending on the source of the request the encoded chars might be in uppercase (`%C3`) or lowercase (`%c2j`) format.
		 * Ensure the format of the encoded chars is consistently lowercase.
		 */
		$lowercase_encoded_url = preg_replace_callback(
			'/%[A-F0-9]{2}/',
			static function ( array $matches ) {
				return strtolower( reset( $matches ) );
			},
			$url
		);

$url = is_string( $lowercase_encoded_url ) ? $lowercase_encoded_url : $url;

if ( isset( $params['view_data'] ) ) {
			// If we have it, then use the up-to-date View data to "correct" the URL.
			$bar_params           = array_intersect_key(
				$params['view_data'],
				array_filter( $params['view_data'], static function ( $value, $key ) {
					return 0 === strpos( $key, 'tribe-bar-' );
				}, ARRAY_FILTER_USE_BOTH )
			);
			$empty_bar_params     = array_filter( $bar_params, static function ( $value ) {
				return $value === '';
			} );
			$non_empty_bar_params = array_diff_key( $bar_params, $empty_bar_params );

/*
			 * Here we add and remove tribe-bar parameters that might have been set in the View data, but
			 * not yet reflected in the URL.
			 */
			if ( count( $bar_params ) ) {
				$url = add_query_arg(
					$non_empty_bar_params,
					remove_query_arg(
						array_keys( $empty_bar_params ),
						$url
					)
				);
			}
		}

return new static( $url );
	}

/**
	 * Differentiates two URLs with knowledge of rewrite rules to check if, resolved request arguments wise, they are
	 * the same or not.
	 *
	 * @since 4.9.11
	 *
	 * @param string $url_a  The first URL to check.
	 * @param string $url_b  The second URL to check.
	 * @param array  $ignore An array of resolved query arguments that should not be taken into account in the check.
	 *
	 * @return bool Whether the two URLs, resolved request arguments wise, they are the same or not.
	 */
	public static function is_diff( $url_a, $url_b, array $ignore = [] ) {
		if ( $url_a === $url_b ) {
			return false;
		}

if ( empty( $url_a ) || empty( $url_b ) ) {
			// We cannot know if one or both are empty.
			return false;
		}

if ( $url_a && $url_b ) {
			$a_args = ( new static( $url_a ) )->get_query_args();
			$b_args = ( new static( $url_b ) )->get_query_args();
			// Ignore any argument that should not trigger a reset.
			$a_args = array_diff_key( $a_args, array_combine( $ignore, $ignore ) );
			$b_args = array_diff_key( $b_args, array_combine( $ignore, $ignore ) );

// "Fix" the `eventDisplay` query argument transforming `default` to the actual default view slug.
			$default_view_slug = tribe_get_option( 'viewOption', 'default' );
			if ( isset( $a_args['eventDisplay'] ) && $a_args['eventDisplay'] === 'default' ) {
				$a_args['eventDisplay'] = $default_view_slug;
			}
			if ( isset( $b_args['eventDisplay'] ) && $b_args['eventDisplay'] === 'default' ) {
				$b_args['eventDisplay'] = List_View::get_view_slug();
			}

// Query vars might just be ordered differently, so we sort them.
			ksort( $a_args );
			ksort( $b_args );

if ( array_merge( $a_args, $b_args ) !== $a_args ) {
				// If the quantity or quality of the arguments changes, then reset.
				return true;
			}
		}

return false;
	}
}

File Editor

Directories:

Files:

Create New File

Edit File: Url.php

Rename File