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

Docblocks for order/product

This commit is contained in:
Mike Jolley 2015-02-03 12:57:08 +00:00
parent dc5b8d9710
commit c038001eab
2 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
includes/abstracts/abstract-wc-order.php
View File

@ -35,6 +35,15 @@
* @property string $order_shipping Total amoount of shipping * @property string $order_shipping Total amoount of shipping
* @property string $order_shipping_tax Total amoount of shipping tax * @property string $order_shipping_tax Total amoount of shipping tax
* @property string $shipping_method_title < 2.1 was used for shipping method title. Now @deprecated. * @property string $shipping_method_title < 2.1 was used for shipping method title. Now @deprecated.
* @property int $customer_user User ID who the order belongs to. 0 for guests.
* @property string $order_key Random key/password unqique to each order.
* @property string $order_discount. Stored after tax discounts pre-2.3. Now @deprecated.
* @property string $order_tax Stores order tax total.
* @property string $order_shipping_tax Stores shipping tax total.
* @property string $order_shipping Stores shipping total.
* @property string $order_total Stores order total.
* @property string $order_currency Stores currency code used for the order.
* @property string $payment_method_title Name of the payment method used.
*/ */
abstract class WC_Abstract_Order { abstract class WC_Abstract_Order {
@ -99,6 +108,7 @@ abstract class WC_Abstract_Order {
/** /**
* Init/load the order object. Called from the constructor. * Init/load the order object. Called from the constructor.
* *
* @var WP_Post
* @param int|WP_Post|WC_Order $order Order to init * @param int|WP_Post|WC_Order $order Order to init
*/ */
protected function init( $order ) { protected function init( $order ) {
@ -1650,7 +1660,7 @@ abstract class WC_Abstract_Order {
/** /**
* Get the discount amount (formatted). * Get the discount amount (formatted).
* @since 2.3.0 * @since 2.3.0
* @return string. * @return string
*/ */
public function get_discount_to_display( $tax_display = '' ) { public function get_discount_to_display( $tax_display = '' ) {
if ( ! $tax_display ) { if ( ! $tax_display ) {
@ -1662,11 +1672,11 @@ abstract class WC_Abstract_Order {
/** /**
* Get cart discount (formatted). * Get cart discount (formatted).
* @deprecated * @deprecated
* @return string. * @return string
*/ */
public function get_cart_discount_to_display( $tax_display = '' ) { public function get_cart_discount_to_display( $tax_display = '' ) {
_deprecated_function( 'get_cart_discount_to_display', '2.3', 'get_discount_to_display' ); _deprecated_function( 'get_cart_discount_to_display', '2.3', 'get_discount_to_display' );
return apply_filters( 'woocommerce_order_cart_discount_to_display', $this->get_discount_to_display(), $this ); return apply_filters( 'woocommerce_order_cart_discount_to_display', $this->get_discount_to_display( $tax_display ), $this );
} }
/** /**
@ -2110,9 +2120,7 @@ abstract class WC_Abstract_Order {
* @param string $note (default: '') Optional note to add * @param string $note (default: '') Optional note to add
*/ */
public function cancel_order( $note = '' ) { public function cancel_order( $note = '' ) {
WC()->session->set( 'order_awaiting_payment', false );
unset( WC()->session->order_awaiting_payment );
$this->update_status( 'cancelled', $note ); $this->update_status( 'cancelled', $note );
} }
@ -2131,9 +2139,7 @@ abstract class WC_Abstract_Order {
do_action( 'woocommerce_pre_payment_complete', $this->id ); do_action( 'woocommerce_pre_payment_complete', $this->id );
if ( ! empty( WC()->session->order_awaiting_payment ) ) { WC()->session->set( 'order_awaiting_payment', false );
unset( WC()->session->order_awaiting_payment );
}
$valid_order_statuses = apply_filters( 'woocommerce_valid_order_statuses_for_payment_complete', array( 'on-hold', 'pending', 'failed', 'cancelled' ), $this ); $valid_order_statuses = apply_filters( 'woocommerce_valid_order_statuses_for_payment_complete', array( 'on-hold', 'pending', 'failed', 'cancelled' ), $this );

3
includes/abstracts/abstract-wc-product.php
View File

@ -31,6 +31,7 @@
* @property string $backorders Whether or not backorders are allowed * @property string $backorders Whether or not backorders are allowed
* @property string $featured Featured product * @property string $featured Featured product
* @property string $visibility Product visibility * @property string $visibility Product visibility
* @property string $variation_id Variation ID when dealing with variations
*/ */
class WC_Product { class WC_Product {
@ -39,7 +40,7 @@ class WC_Product {
/** /**
* @public $post Stores post data * @public $post Stores post data
* @var WP_Post * @var $post WP_Post
*/ */
public $post = null; public $post = null;