<?php
/**
 * Deprecated functions
 *
 * @package notification
 */

use BracketSpace\Notification\Admin\Wizard;
use BracketSpace\Notification\Core\Resolver;
use BracketSpace\Notification\Core\Sync;
use BracketSpace\Notification\Core\Templates;
use BracketSpace\Notification\Core\Whitelabel;
use BracketSpace\Notification\Interfaces;
use BracketSpace\Notification\Register;
use BracketSpace\Notification\Store;
use BracketSpace\Notification\Dependencies\Micropackage\DocHooks\Helper as DocHooksHelper;
use BracketSpace\Notification\Queries\NotificationQueries;

/**
 * Helper function.
 * Throws a deprecation notice from deprecated class
 *
 * @since  6.0.0
 * @param  string $class       Deprecated class name.
 * @param  string $version     Version since deprecated.
 * @param  string $replacement Replacement class.
 * @return void
 */
function notification_deprecated_class( $class, $version, $replacement = null ) {

	// phpcs:disable
	if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
		if ( function_exists( '__' ) ) {
			if ( ! is_null( $replacement ) ) {
				/* translators: 1: Class name, 2: version number, 3: alternative function name */
				trigger_error( sprintf( __('Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $class, $version, $replacement ) );
			} else {
				/* translators: 1: Class name, 2: version number */
				trigger_error( sprintf( __('Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $class, $version ) );
			}
		} else {
			if ( ! is_null( $replacement ) ) {
				trigger_error( sprintf( 'Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $class, $version, $replacement ) );
			} else {
				trigger_error( sprintf( 'Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $class, $version ) );
			}
		}
	}
	// phpcs:enable

}

/**
 * Gets the plugin Runtime.
 *
 * @deprecated 7.0.0 New Notification static class should be used.
 * @param      string $property Optional property to get.
 * @return     object           Runtime class instance
 */
function notification_runtime( $property = null ) {
	_deprecated_function( __FUNCTION__, '7.0.0', '\Notification' );

	if ( null !== $property ) {
		return Notification::component( $property );
	}

	return Notification::runtime();
}

/**
 * Checks if notification post has been just started
 *
 * @since  5.0.0
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  mixed $post Post ID or WP_Post.
 * @return boolean     True if notification has been just started
 */
function notification_is_new_notification( $post ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_post_is_new' );
	return notification_post_is_new( $post );
}

/**
 * Registers notification
 *
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  Interfaces\Sendable $notification Carrier object.
 * @return void
 */
function register_notification( Interfaces\Sendable $notification ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_register_carrier' );
	notification_register_carrier( $notification );
}

/**
 * Gets all registered notifications
 *
 * @since  5.0.0
 * @deprecated 6.0.0 Changed name for consistency.
 * @return array notifications
 */
function notification_get_notifications() {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_get_carriers' );
	return notification_get_carriers();
}

/**
 * Gets single registered notification
 *
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  string $notification_slug notification slug.
 * @return mixed                     notification object or false
 */
function notification_get_single_notification( $notification_slug ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_get_carrier' );
	return notification_get_carrier( $notification_slug );
}

/**
 * Registers trigger
 * Uses notification/triggers filter
 *
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  Interfaces\Triggerable $trigger trigger object.
 * @return void
 */
function register_trigger( Interfaces\Triggerable $trigger ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_register_trigger' );
	notification_register_trigger( $trigger );
}

/**
 * Gets single registered recipient for notification type
 *
 * @since  5.0.0
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  string $carrier_slug   Carrier slug.
 * @param  string $recipient_slug Recipient slug.
 * @return mixed                  Recipient object or false
 */
function notification_get_single_recipient( $carrier_slug, $recipient_slug ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_get_recipient' );
	return notification_get_recipient( $carrier_slug, $recipient_slug );
}

/**
 * Gets register recipients for notification type
 *
 * @since  5.0.0
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  string $carrier_slug Carrier slug.
 * @return array                Recipients array
 */
function notification_get_notification_recipients( $carrier_slug ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_get_carrier_recipients' );
	return notification_get_carrier_recipients( $carrier_slug );
}

/**
 * Gets single registered trigger
 *
 * @since  5.0.0
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  string $trigger_slug trigger slug.
 * @return mixed                trigger object or false
 */
function notification_get_single_trigger( $trigger_slug ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_get_trigger' );
	return notification_get_trigger( $trigger_slug );
}

/**
 * Registers recipient
 * Uses notification/recipients filter
 *
 * @deprecated 6.0.0 Changed name for consistency.
 * @param  string                $carrier_slug Carrier slug.
 * @param  Interfaces\Receivable $recipient    Recipient object.
 * @return void
 */
function register_recipient( $carrier_slug, Interfaces\Receivable $recipient ) {
	_deprecated_function( __FUNCTION__, '6.0.0', 'notification_register_recipient' );
	notification_register_recipient( $carrier_slug, $recipient );
}

/**
 * Adds handlers for doc hooks to an object
 *
 * @since      5.2.2
 * @deprecated 7.0.0 Use `the micropackage/dochooks` package.
 * @param      object $object Object to create the hooks.
 * @return     object
 */
function notification_add_doc_hooks( $object ) {
	_deprecated_function( __FUNCTION__, '7.0.0' );
	return DocHooksHelper::hook( $object );
}

/**
 * Checks if the DocHooks are enabled and working.
 *
 * @since      6.1.0
 * @deprecated 7.0.0 Use the `micropackage/dochooks` package.
 * @return     bool
 */
function notification_dochooks_enabled() {
	_deprecated_function( __FUNCTION__, '7.0.0' );
	return DocHooksHelper::is_enabled();
}

/**
 * Creates new View object.
 *
 * @since      6.0.0
 * @deprecated 7.0.0 Use Templates object.
 * @return     bool
 */
function notification_create_view() {
	_deprecated_function( __FUNCTION__, '7.0.0' );
	return false;
}

/**
 * Gets cached value or cache object
 *
 * @since      7.0.0
 * @deprecated 8.0.0
 * @return     null
 */
function notification_cache() {
	_deprecated_function( __FUNCTION__, '8.0.0' );
	return null;
}


/**
 * Checks if the Wizard should be displayed.
 *
 * @since      6.3.0
 * @deprecated 8.0.0
 * @return     bool
 */
function notification_display_wizard() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Admin\\Wizard::should_display' );

	return Wizard::should_display();
}

/**
 * Creates new AJAX Handler object.
 *
 * @since      6.0.0
 * @since      7.0.0 Using Ajax Micropackage.
 * @deprecated 8.0.0
 * @return     BracketSpace\Notification\Dependencies\Micropackage\Ajax\Response
 */
function notification_ajax_handler() {
	_deprecated_function( __FUNCTION__, '8.0.0' );

	return new BracketSpace\Notification\Dependencies\Micropackage\Ajax\Response();
}

/**
 * Gets one of the plugin filesystems
 *
 * @since      7.0.0
 * @deprecated 8.0.0
 * @param      string $deprecated Filesystem name.
 * @return     BracketSpace\Notification\Dependencies\Micropackage\Filesystem\Filesystem
 */
function notification_filesystem( $deprecated ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'Notification::fs()' );

	return \Notification::fs();
}

/**
 * Gets all notification posts with enabled trigger.
 *
 * @todo This function needs to be fixed because we are no longer storing
 *       the Trigger in Notification post meta.
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      mixed $trigger_slug Trigger slug or null if all posts should be returned.
 * @param      bool  $all          If get all posts or just active.
 * @return     array
 */
function notification_get_posts( $trigger_slug = null, $all = false ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Queries\\NotificationQueries::all()' );

	return NotificationQueries::all( $all );
}

/**
 * Gets notification post by its hash.
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      string $hash Notification unique hash.
 * @return     mixed        null or Notification object
 */
function notification_get_post_by_hash( $hash ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Queries\\NotificationQueries::with_hash()' );

	return NotificationQueries::with_hash( $hash );
}

/**
 * Checks if notification post has been just started
 *
 * @since      6.0.0 We are using Notification Post object.
 * @deprecated 8.0.0
 * @param      mixed $post Post ID or WP_Post.
 * @return     boolean     True if notification has been just started
 */
function notification_post_is_new( $post ) {
	_deprecated_function( __FUNCTION__, '8.0.0' );

	/** @var BracketSpace\Notification\Defaults\Adapter\WordPress $notification */
	$notification = notification_adapt_from( 'WordPress', $post );
	return $notification->is_new();
}

/**
 * Prints the template
 * Wrapper for micropackage's template function
 *
 * @since      7.0.0
 * @deprecated 8.0.0
 * @param      string $template_name Template name.
 * @param      array  $vars          Template variables.
 *                                   Default: empty.
 * @return     void
 */
function notification_template( $template_name, $vars = [] ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Templates::render' );

	Templates::render( $template_name, $vars );
}

/**
 * Gets the template
 * Wrapper for micropackage's get_template function
 *
 * @since      7.0.0
 * @deprecated 8.0.0
 * @param      string $template_name Template name.
 * @param      array  $vars          Template variables.
 *                                   Default: empty.
 * @return     string
 */
function notification_get_template( $template_name, $vars = [] ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Templates::get' );

	return Templates::get( $template_name, $vars );
}

/**
 * Enables the notification syncing
 * By default path used is current theme's `notifiations` dir.
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      mixed $path full json directory path or null to use default.
 * @return     void
 */
function notification_sync( $path = null ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Sync::enable' );

	Sync::enable( $path );
}

/**
 * Gets the synchronization path.
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @return     string|null
 */
function notification_get_sync_path() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Sync::get_sync_path' );

	return Sync::get_sync_path();
}

/**
 * Checks if synchronization is active.
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @return     boolean
 */
function notification_is_syncing() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Sync::is_syncing' );

	return Sync::is_syncing();
}

/**
 * Sets the plugin in white label mode.
 *
 * @since      5.0.0
 * @deprecated 8.0.0
 * @param      array $args white label args.
 * @return     void
 */
function notification_whitelabel( $args = [] ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Whitelabel::enable' );

	Whitelabel::enable( $args );
}

/**
 * Checks if the plugin is in white label mode.
 *
 * @since      5.0.0
 * @deprecated 8.0.0
 * @return     bool
 */
function notification_is_whitelabeled() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Whitelabel::is_whitelabeled' );

	return Whitelabel::is_whitelabeled();
}

/**
 * Registers Carrier
 *
 * @since      6.0.0
 * @since      6.3.0 Uses Carrier Store.
 * @deprecated 8.0.0
 * @param      Interfaces\Sendable $carrier Carrier object.
 * @return     void
 */
function notification_register_carrier( Interfaces\Sendable $carrier ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Register::carrier' );

	Register::carrier( $carrier );
}

/**
 * Gets all registered Carriers
 *
 * @since      6.0.0
 * @since      6.3.0 Uses Carrier Store.
 * @deprecated 8.0.0
 * @return     array<string,Interfaces\Sendable>
 */
function notification_get_carriers() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Carrier::all' );

	return Store\Carrier::all();
}

/**
 * Gets single registered Carrier
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      string $carrier_slug Carrier slug.
 * @return     Interfaces\Sendable|null
 */
function notification_get_carrier( $carrier_slug ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Carrier::get' );

	return Store\Carrier::get( $carrier_slug );
}

/**
 * Registers recipient
 *
 * @since      6.0.0
 * @since      6.3.0 Uses Recipient Store
 * @deprecated 8.0.0
 * @param      string                $carrier_slug Carrier slug.
 * @param      Interfaces\Receivable $recipient    Recipient object.
 * @return     void
 */
function notification_register_recipient( $carrier_slug, Interfaces\Receivable $recipient ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Register::recipient' );

	Register::recipient( $carrier_slug, $recipient );
}

/**
 * Gets all registered recipients
 *
 * @since      6.0.0
 * @since      6.3.0 Uses Recipient Store
 * @deprecated 8.0.0
 * @return     array<string,array<string,Interfaces\Receivable>>
 */
function notification_get_recipients() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Recipient::all' );

	return Store\Recipient::all();
}

/**
 * Gets registered recipients for specific Carrier
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      string $carrier_slug Carrier slug.
 * @return     array<string,Interfaces\Receivable>
 */
function notification_get_carrier_recipients( $carrier_slug ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Recipient::all_for_carrier' );

	return Store\Recipient::all_for_carrier( $carrier_slug );
}

/**
 * Gets single registered recipient for specific Carrier
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      string $carrier_slug   Carrier slug.
 * @param      string $recipient_slug Recipient slug.
 * @return     Interfaces\Receivable|null
 */
function notification_get_recipient( $carrier_slug, $recipient_slug ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Recipient::get' );

	return Store\Recipient::get( $carrier_slug, $recipient_slug );
}

/**
 * Parses recipient raw value to values which can be used by notifications
 *
 * @since      5.0.0
 * @since      6.0.0 Changed naming convention from Notification to Carrier.
 * @deprecated 8.0.0
 * @param      string $carrier_slug        Slug of the Carrier.
 * @param      string $recipient_type      Slug of the Recipient.
 * @param      mixed  $recipient_raw_value Raw value.
 * @return     mixed                       Parsed value
 */
function notification_parse_recipient( $carrier_slug, $recipient_type, $recipient_raw_value ) {
	_deprecated_function( __FUNCTION__, '8.0.0' );

	return Store\Recipient::get( $carrier_slug, $recipient_type )->parse_value( $recipient_raw_value ) ?? [];
}

/**
 * Adds Resolver to Store
 *
 * @since      6.0.0
 * @since      6.3.0 Uses Resolver Store.
 * @deprecated 8.0.0
 * @param      Interfaces\Resolvable $resolver Resolver object.
 * @return     void
 */
function notification_register_resolver( Interfaces\Resolvable $resolver ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Register::resolver' );

	Register::resolver( $resolver );
}


/**
 * Resolves the value
 *
 * @since      6.0.0
 * @since      6.3.0 Uses Resolver Store.
 * @deprecated 8.0.0
 * @param      string                 $value   Unresolved string with tags.
 * @param      Interfaces\Triggerable $trigger Trigger object.
 * @return     string                         Resolved value
 */
function notification_resolve( $value, Interfaces\Triggerable $trigger ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Resolver::resolve' );

	return Resolver::resolve( $value, $trigger );
}

/**
 * Clears all Merge Tags
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      string $value Unresolved string with tags.
 * @return     string        Value without any tags
 */
function notification_clear_tags( $value ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Core\\Resolver::clear' );

	return Resolver::clear( $value );
}

/**
 * Adds Trigger to Store
 *
 * @since  6.0.0
 * @since  6.3.0 Uses Trigger Store
 * @param  Interfaces\Triggerable $trigger trigger object.
 * @return void
 */
function notification_register_trigger( Interfaces\Triggerable $trigger ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Register::trigger' );

	Register::trigger( $trigger );
}

/**
 * Gets all registered triggers
 *
 * @since      6.0.0
 * @since      6.3.0 Uses Trigger Store
 * @deprecated 8.0.0
 * @return     array<string,Interfaces\Triggerable>
 */
function notification_get_triggers() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Trigger::all' );

	return Store\Trigger::all();
}

/**
 * Gets single registered trigger
 *
 * @since      6.0.0
 * @deprecated 8.0.0
 * @param      string $trigger_slug trigger slug.
 * @return     Interfaces\Triggerable|null
 */
function notification_get_trigger( $trigger_slug ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Trigger::get' );

	return Store\Trigger::get( $trigger_slug );
}

/**
 * Gets all registered triggers in a grouped array
 *
 * @since      5.0.0
 * @deprecated 8.0.0
 * @return     array<string,array<string, Interfaces\Triggerable>>
 */
function notification_get_triggers_grouped() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\Trigger::grouped' );

	return Store\Trigger::grouped();
}

/**
 * Adds global Merge Tags for all Triggers
 *
 * @since      5.1.3
 * @deprecated 8.0.0
 * @param      Interfaces\Taggable $merge_tag Merge Tag object.
 * @return     Interfaces\Taggable
 */
function notification_add_global_merge_tag( Interfaces\Taggable $merge_tag ) {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Register::global_merge_tag' );

	return Register::global_merge_tag( $merge_tag );
}

/**
 * Gets all global Merge Tags
 *
 * @since      5.1.3
 * @deprecated 8.0.0
 * @return     array<string,Interfaces\Taggable>
 */
function notification_get_global_merge_tags() {
	_deprecated_function( __FUNCTION__, '8.0.0', 'BracketSpace\\Notification\\Store\\GlobalMergeTag::all' );

	return Store\GlobalMergeTag::all();
}