Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

phpcs

This commit is contained in:
Mike Jolley 2018-03-19 18:09:13 +00:00
parent 6539b7913e
commit f6dc960e46
1 changed files with 32 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
includes/class-wc-order-refund.php
View File

@ -1,16 +1,16 @@
<?php <?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/** /**
* Order refund. Refunds are based on orders (essentially negative orders) and * Order refund. Refunds are based on orders (essentially negative orders) and
* contain much of the same data. * contain much of the same data.
* *
* @version 3.0.0 * @version 3.0.0
* @package WooCommerce/Classes * @package WooCommerce/Classes
* @category Class */
* @author WooThemes
defined( 'ABSPATH' ) || exit;
/**
* WC_Order_Refund class.
*/ */
class WC_Order_Refund extends WC_Abstract_Order { class WC_Order_Refund extends WC_Abstract_Order {
@ -23,6 +23,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* This is the name of this object type. * This is the name of this object type.
*
* @var string * @var string
*/ */
protected $object_type = 'order_refund'; protected $object_type = 'order_refund';
@ -41,6 +42,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Get internal type (post type.) * Get internal type (post type.)
*
* @return string * @return string
*/ */
public function get_type() { public function get_type() {
@ -50,7 +52,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Get status - always completed for refunds. * Get status - always completed for refunds.
* *
* @param string $context * @param string $context What the value is for. Valid values are view and edit.
* @return string * @return string
*/ */
public function get_status( $context = 'view' ) { public function get_status( $context = 'view' ) {
@ -69,7 +71,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Get refunded amount. * Get refunded amount.
* *
* @param string $context * @param string $context What the value is for. Valid values are view and edit.
* @return int|float * @return int|float
*/ */
public function get_amount( $context = 'view' ) { public function get_amount( $context = 'view' ) {
@ -80,7 +82,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
* Get refund reason. * Get refund reason.
* *
* @since 2.2 * @since 2.2
* @param string $context * @param string $context What the value is for. Valid values are view and edit.
* @return int|float * @return int|float
*/ */
public function get_reason( $context = 'view' ) { public function get_reason( $context = 'view' ) {
@ -91,7 +93,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
* Get ID of user who did the refund. * Get ID of user who did the refund.
* *
* @since 3.0 * @since 3.0
* @param string $context * @param string $context What the value is for. Valid values are view and edit.
* @return int * @return int
*/ */
public function get_refunded_by( $context = 'view' ) { public function get_refunded_by( $context = 'view' ) {
@ -102,7 +104,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
* Return if the payment was refunded via API. * Return if the payment was refunded via API.
* *
* @since 3.3 * @since 3.3
* @param string $context * @param string $context What the value is for. Valid values are view and edit.
* @return bool * @return bool
*/ */
public function get_refunded_payment( $context = 'view' ) { public function get_refunded_payment( $context = 'view' ) {
@ -122,8 +124,8 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Set refunded amount. * Set refunded amount.
* *
* @param string $value * @param string $value Value to set.
* @throws WC_Data_Exception * @throws WC_Data_Exception Exception if the amount is invalid.
*/ */
public function set_amount( $value ) { public function set_amount( $value ) {
$this->set_prop( 'amount', wc_format_decimal( $value ) ); $this->set_prop( 'amount', wc_format_decimal( $value ) );
@ -132,8 +134,8 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Set refund reason. * Set refund reason.
* *
* @param string $value * @param string $value Value to set.
* @throws WC_Data_Exception * @throws WC_Data_Exception Exception if the amount is invalid.
*/ */
public function set_reason( $value ) { public function set_reason( $value ) {
$this->set_prop( 'reason', $value ); $this->set_prop( 'reason', $value );
@ -142,8 +144,8 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Set refunded by. * Set refunded by.
* *
* @param int $value * @param int $value Value to set.
* @throws WC_Data_Exception * @throws WC_Data_Exception Exception if the amount is invalid.
*/ */
public function set_refunded_by( $value ) { public function set_refunded_by( $value ) {
$this->set_prop( 'refunded_by', absint( $value ) ); $this->set_prop( 'refunded_by', absint( $value ) );
@ -153,7 +155,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
* Set if the payment was refunded via API. * Set if the payment was refunded via API.
* *
* @since 3.3 * @since 3.3
* @param bool $value * @param bool $value Value to set.
*/ */
public function set_refunded_payment( $value ) { public function set_refunded_payment( $value ) {
$this->set_prop( 'refunded_payment', (bool) $value ); $this->set_prop( 'refunded_payment', (bool) $value );
@ -162,7 +164,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Magic __get method for backwards compatibility. * Magic __get method for backwards compatibility.
* *
* @param string $key * @param string $key Value to get.
* @return mixed * @return mixed
*/ */
public function __get( $key ) { public function __get( $key ) {
@ -180,24 +182,31 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Gets an refund from the database. * Gets an refund from the database.
*
* @deprecated 3.0 * @deprecated 3.0
* @param int $id (default: 0). * @param int $id (default: 0).
* @return bool * @return bool
*/ */
public function get_refund( $id = 0 ) { public function get_refund( $id = 0 ) {
wc_deprecated_function( 'get_refund', '3.0', 'read' ); wc_deprecated_function( 'get_refund', '3.0', 'read' );
if ( ! $id ) { if ( ! $id ) {
return false; return false;
} }
if ( $result = get_post( $id ) ) {
$result = get_post( $id );
if ( $result ) {
$this->populate( $result ); $this->populate( $result );
return true; return true;
} }
return false; return false;
} }
/** /**
* Get refund amount. * Get refund amount.
*
* @deprecated 3.0 * @deprecated 3.0
* @return int|float * @return int|float
*/ */
@ -208,6 +217,7 @@ class WC_Order_Refund extends WC_Abstract_Order {
/** /**
* Get refund reason. * Get refund reason.
*
* @deprecated 3.0 * @deprecated 3.0
* @return int|float * @return int|float
*/ */