<?php
/**
 * Metadata filter.
 *
 * @package PaczkomatyInpost
 */

/**
 * Filter shipment metadata values on checkout.
 */
trait WPDesk_Flexible_Shipping_Shipment_Paczkomaty_Filtered_Meta {

	/**
	 * Returns meta value processed by filter.
	 *
	 * @param string           $meta_key Meta key.
	 * @param string|int|float $meta_value Meta value.
	 * @param array            $fs_method Flexible shipping method settings.
	 * @param array            $package WooCommerce shipping package.
	 * @param WC_Order         $order WooCommerce order.
	 *
	 * @return string|int|float
	 */
	protected function get_meta_filtered_value( $meta_key, $meta_value, $fs_method, $package, $order ) {
		if ( 0 !== strpos( $meta_key, '_' ) ) {
			$meta_key = '_' . $meta_key;
		}

		/**
		 * Filters shipment metadata.
		 *
		 * The dynamic portion of the hook name, `$meta_key`, refers to the meta key name.
		 * All possible hook names:
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_size
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_sending_method
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_dropoff_parcel_machine
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_dropoff_pop
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_dropoff_dispatch_point
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_ubezpieczenie
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_ubezpieczenie_amount
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_cod
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_cod_amount
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_customer_ref
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomat_weight
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomaty_end_of_week_collection
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomaty_sms_notification
		 *     woocommerce_paczkomaty_inpost_checkout_paczkomaty_email_notification
		 *
		 * @param string|int|float  $meta_value Meta value.
		 * @param array             $fs_method Flexible Shipping method settings.
		 * @param array             $package WooCommerce package.
		 * @param WC_Order          $order WooCommerce order.
		 *
		 * @return string|int|float
		 */
		return apply_filters( 'woocommerce_paczkomaty_inpost_checkout' . $meta_key, $meta_value, $fs_method, $package, $order );
	}

}