ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / carbonbullion.net / wp-content / plugins / woocommerce / includes

<?php
/**
 * Order refund. Refunds are based on orders (essentially negative orders) and
 * contain much of the same data.
 *
 * @version 3.0.0
 * @package WooCommerce\Classes
 */

defined( 'ABSPATH' ) || exit;

/**
 * Order refund class.
 */
class WC_Order_Refund extends WC_Abstract_Order {

/**
	 * Which data store to load.
	 *
	 * @var string
	 */
	protected $data_store_name = 'order-refund';

/**
	 * This is the name of this object type.
	 *
	 * @var string
	 */
	protected $object_type = 'order_refund';

/**
	 * Stores product data.
	 *
	 * @var array
	 */
	protected $extra_data = array(
		'amount'           => '',
		'reason'           => '',
		'refunded_by'      => 0,
		'refunded_payment' => false,
	);

/**
	 * Get internal type (post type.)
	 *
	 * @return string
	 */
	public function get_type() {
		return 'shop_order_refund';
	}

/**
	 * Get status - always completed for refunds.
	 *
	 * @param  string $context What the value is for. Valid values are view and edit.
	 * @return string
	 */
	public function get_status( $context = 'view' ) {
		return 'completed';
	}

/**
	 * Get a title for the new post type.
	 */
	public function get_post_title() {
		// @codingStandardsIgnoreStart
		return sprintf( __( 'Refund &ndash; %s', 'woocommerce' ), strftime( _x( '%b %d, %Y @ %I:%M %p', 'Order date parsed by strftime', 'woocommerce' ) ) );
		// @codingStandardsIgnoreEnd
	}

/**
	 * Get refunded amount.
	 *
	 * @param  string $context What the value is for. Valid values are view and edit.
	 * @return int|float
	 */
	public function get_amount( $context = 'view' ) {
		return $this->get_prop( 'amount', $context );
	}

/**
	 * Get refund reason.
	 *
	 * @since 2.2
	 * @param  string $context What the value is for. Valid values are view and edit.
	 * @return string
	 */
	public function get_reason( $context = 'view' ) {
		return $this->get_prop( 'reason', $context );
	}

/**
	 * Get ID of user who did the refund.
	 *
	 * @since 3.0
	 * @param  string $context What the value is for. Valid values are view and edit.
	 * @return int
	 */
	public function get_refunded_by( $context = 'view' ) {
		return $this->get_prop( 'refunded_by', $context );
	}

/**
	 * Return if the payment was refunded via API.
	 *
	 * @since  3.3
	 * @param  string $context What the value is for. Valid values are view and edit.
	 * @return bool
	 */
	public function get_refunded_payment( $context = 'view' ) {
		return $this->get_prop( 'refunded_payment', $context );
	}

/**
	 * Get formatted refunded amount.
	 *
	 * @since 2.4
	 * @return string
	 */
	public function get_formatted_refund_amount() {
		return apply_filters( 'woocommerce_formatted_refund_amount', wc_price( $this->get_amount(), array( 'currency' => $this->get_currency() ) ), $this );
	}

/**
	 * Set refunded amount.
	 *
	 * @param string $value Value to set.
	 * @throws WC_Data_Exception Exception if the amount is invalid.
	 */
	public function set_amount( $value ) {
		$this->set_prop( 'amount', wc_format_decimal( $value ) );
	}

/**
	 * Set refund reason.
	 *
	 * @param string $value Value to set.
	 * @throws WC_Data_Exception Exception if the amount is invalid.
	 */
	public function set_reason( $value ) {
		$this->set_prop( 'reason', $value );
	}

/**
	 * Set refunded by.
	 *
	 * @param int $value Value to set.
	 * @throws WC_Data_Exception Exception if the amount is invalid.
	 */
	public function set_refunded_by( $value ) {
		$this->set_prop( 'refunded_by', absint( $value ) );
	}

/**
	 * Set if the payment was refunded via API.
	 *
	 * @since 3.3
	 * @param bool $value Value to set.
	 */
	public function set_refunded_payment( $value ) {
		$this->set_prop( 'refunded_payment', (bool) $value );
	}

/**
	 * Magic __get method for backwards compatibility.
	 *
	 * @param string $key Value to get.
	 * @return mixed
	 */
	public function __get( $key ) {
		wc_doing_it_wrong( $key, 'Refund properties should not be accessed directly.', '3.0' );
		/**
		 * Maps legacy vars to new getters.
		 */
		if ( 'reason' === $key ) {
			return $this->get_reason();
		} elseif ( 'refund_amount' === $key ) {
			return $this->get_amount();
		}
		return parent::__get( $key );
	}

/**
	 * Gets an refund from the database.
	 *
	 * @deprecated 3.0
	 * @param int $id (default: 0).
	 * @return bool
	 */
	public function get_refund( $id = 0 ) {
		wc_deprecated_function( 'get_refund', '3.0', 'read' );

if ( ! $id ) {
			return false;
		}

$result = get_post( $id );

if ( $result ) {
			$this->populate( $result );
			return true;
		}

return false;
	}

/**
	 * Get refund amount.
	 *
	 * @deprecated 3.0
	 * @return int|float
	 */
	public function get_refund_amount() {
		wc_deprecated_function( 'get_refund_amount', '3.0', 'get_amount' );
		return $this->get_amount();
	}

/**
	 * Get refund reason.
	 *
	 * @deprecated 3.0
	 * @return string
	 */
	public function get_refund_reason() {
		wc_deprecated_function( 'get_refund_reason', '3.0', 'get_reason' );
		return $this->get_reason();
	}
}

[+] ..
[-] wc-page-functions.php [edit]
[-] class-wc-countries.php [edit]
[-] class-wc-ajax.php [edit]
[-] class-wc-privacy.php [edit]
[+] customizer
[+] gateways
[-] class-wc-order-refund.php [edit]
[-] wc-stock-functions.php [edit]
[-] class-wc-cart.php [edit]
[-] class-wc-tracker.php [edit]
[-] class-wc-frontend-scripts.php [edit]
[-] class-wc-product-download.php [edit]
[+] widgets
[+] admin
[-] class-wc-auth.php [edit]
[-] class-wc-rest-authentication.php [edit]
[-] class-wc-data-exception.php [edit]
[-] class-wc-log-levels.php [edit]
[-] wc-coupon-functions.php [edit]
[-] class-wc-order-item-shipping.php [edit]
[+] integrations
[-] class-wc-payment-gateways.php [edit]
[-] wc-order-functions.php [edit]
[+] shipping
[-] class-wc-order-item-coupon.php [edit]
[-] class-wc-payment-tokens.php [edit]
[-] wc-deprecated-functions.php [edit]
[-] class-wc-product-grouped.php [edit]
[+] tracks
[-] wc-product-functions.php [edit]
[-] class-wc-datetime.php [edit]
[-] wc-user-functions.php [edit]
[-] wc-widget-functions.php [edit]
[-] class-wc-breadcrumb.php [edit]
[-] class-wc-customer-download-log.php [edit]
[-] class-wc-order-query.php [edit]
[-] wc-template-hooks.php [edit]
[-] class-wc-https.php [edit]
[-] class-wc-order.php [edit]
[-] wc-attribute-functions.php [edit]
[-] class-wc-session-handler.php [edit]
[-] class-wc-product-variation.php [edit]
[-] class-wc-query.php [edit]
[-] class-wc-coupon.php [edit]
[-] class-wc-shipping-zone.php [edit]
[-] wc-account-functions.php [edit]
[-] wc-formatting-functions.php [edit]
[-] class-wc-integrations.php [edit]
[-] class-wc-validation.php [edit]
[-] class-wc-webhook.php [edit]
[+] traits
[-] class-wc-checkout.php [edit]
[-] wc-core-functions.php [edit]
[+] emails
[-] wc-cart-functions.php [edit]
[-] class-wc-shipping.php [edit]
[-] class-wc-customer-download.php [edit]
[-] class-wc-geolite-integration.php [edit]
[-] class-wc-data-store.php [edit]
[-] class-wc-order-item-tax.php [edit]
[-] class-wc-customer.php [edit]
[-] class-wc-product-attribute.php [edit]
[+] legacy
[+] import
[-] class-wc-cli.php [edit]
[+] wccom-site
[-] class-wc-form-handler.php [edit]
[-] class-wc-tax.php [edit]
[-] wc-order-item-functions.php [edit]
[+] blocks
[-] class-wc-cache-helper.php [edit]
[-] class-wc-cart-totals.php [edit]
[-] class-wc-emails.php [edit]
[-] class-wc-product-query.php [edit]
[-] class-wc-download-handler.php [edit]
[-] class-wc-product-external.php [edit]
[-] class-woocommerce.php [edit]
[-] class-wc-logger.php [edit]
[-] class-wc-shipping-zones.php [edit]
[-] class-wc-order-item-meta.php [edit]
[+] walkers
[+] shortcodes
[-] class-wc-cart-session.php [edit]
[+] rest-api
[-] class-wc-autoloader.php [edit]
[-] class-wc-meta-data.php [edit]
[-] wc-notice-functions.php [edit]
[+] queue
[+] react-admin
[-] class-wc-order-item.php [edit]
[-] class-wc-shortcodes.php [edit]
[-] wc-term-functions.php [edit]
[-] wc-webhook-functions.php [edit]
[-] class-wc-privacy-exporters.php [edit]
[-] class-wc-privacy-background-process.php [edit]
[-] class-wc-regenerate-images-request.php [edit]
[-] class-wc-deprecated-filter-hooks.php [edit]
[+] interfaces
[-] class-wc-background-emailer.php [edit]
[-] class-wc-geo-ip.php [edit]
[+] data-stores
[-] class-wc-comments.php [edit]
[-] wc-conditional-functions.php [edit]
[-] class-wc-product-factory.php [edit]
[+] theme-support
[+] libraries
[-] class-wc-structured-data.php [edit]
[-] class-wc-order-factory.php [edit]
[-] class-wc-cart-fees.php [edit]
[-] class-wc-deprecated-action-hooks.php [edit]
[-] class-wc-order-item-fee.php [edit]
[+] cli
[-] class-wc-background-updater.php [edit]
[-] class-wc-discounts.php [edit]
[-] class-wc-rate-limiter.php [edit]
[-] class-wc-geolocation.php [edit]
[-] class-wc-privacy-erasers.php [edit]
[-] class-wc-post-types.php [edit]
[+] export
[+] log-handlers
[-] class-wc-regenerate-images.php [edit]
[+] abstracts
[-] class-wc-rest-exception.php [edit]
[-] class-wc-order-item-product.php [edit]
[-] class-wc-product-simple.php [edit]
[-] wc-rest-functions.php [edit]
[-] class-wc-post-data.php [edit]
[-] class-wc-embed.php [edit]
[+] payment-tokens
[-] class-wc-template-loader.php [edit]
[-] class-wc-product-variable.php [edit]
[-] class-wc-install.php [edit]
[-] class-wc-shipping-rate.php [edit]
[-] class-wc-api.php [edit]
[-] wc-template-functions.php [edit]
[-] wc-update-functions.php [edit]
[-] class-wc-register-wp-admin-settings.php [edit]