PHP Класс WC_Order_Refund

Автор: WooThemes
Наследование: extends WC_Abstract_Order
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$data_store_name string Which data store to load.
$extra_data array Stores product data.

Открытые методы

Метод Описание
__construct ( integer | object | WC_Order $read ) Extend the abstract _data properties and then read the order object.
__get ( string $key ) : mixed Magic __get method for backwards compatibility.
get_amount ( string $context = 'view' ) : integer | float Get refunded amount.
get_formatted_refund_amount ( ) : string Get formatted refunded amount.
get_post_title ( ) Get a title for the new post type.
get_reason ( string $context = 'view' ) : integer | float Get refund reason.
get_refund ( integer $id ) : boolean Gets an refund from the database.
get_refund_amount ( ) : integer | float Get refund amount.
get_refund_reason ( ) : integer | float Get refund reason.
get_refunded_by ( string $context = 'view' ) : integer Get ID of user who did the refund.
get_status ( string $context = 'view' ) : string Get status - always completed for refunds.
get_type ( ) : string Get internal type (post type.)
set_amount ( string $value ) Set refunded amount.
set_reason ( string $value ) Set refund reason.
set_refunded_by ( integer $value ) Set refunded by.

Защищенные методы

Метод Описание
get_hook_prefix ( ) : string Prefix for action and filter hooks on data.

Описание методов

__construct() публичный Метод

Extend the abstract _data properties and then read the order object.
public __construct ( integer | object | WC_Order $read )
$read integer | object | WC_Order Order to init.

__get() публичный Метод

Magic __get method for backwards compatibility.
public __get ( string $key ) : mixed
$key string
Результат mixed

get_amount() публичный Метод

Get refunded amount.
public get_amount ( string $context = 'view' ) : integer | float
$context string
Результат integer | float

get_formatted_refund_amount() публичный Метод

Get formatted refunded amount.
С версии: 2.4
public get_formatted_refund_amount ( ) : string
Результат string

get_hook_prefix() защищенный Метод

Prefix for action and filter hooks on data.
С версии: 2.7.0
protected get_hook_prefix ( ) : string
Результат string

get_post_title() публичный Метод

Get a title for the new post type.
public get_post_title ( )

get_reason() публичный Метод

Get refund reason.
С версии: 2.2
public get_reason ( string $context = 'view' ) : integer | float
$context string
Результат integer | float

get_refund() публичный Метод

Gets an refund from the database.
Устаревший: 2.7
public get_refund ( integer $id ) : boolean
$id integer (default: 0).
Результат boolean

get_refund_amount() публичный Метод

Get refund amount.
Устаревший: 2.7
public get_refund_amount ( ) : integer | float
Результат integer | float

get_refund_reason() публичный Метод

Get refund reason.
Устаревший: 2.7
public get_refund_reason ( ) : integer | float
Результат integer | float

get_refunded_by() публичный Метод

Get ID of user who did the refund.
С версии: 2.7
public get_refunded_by ( string $context = 'view' ) : integer
$context string
Результат integer

get_status() публичный Метод

Get status - always completed for refunds.
public get_status ( string $context = 'view' ) : string
$context string
Результат string

get_type() публичный Метод

Get internal type (post type.)
public get_type ( ) : string
Результат string

set_amount() публичный Метод

Set refunded amount.
public set_amount ( string $value )
$value string

set_reason() публичный Метод

Set refund reason.
public set_reason ( string $value )
$value string

set_refunded_by() публичный Метод

Set refunded by.
public set_refunded_by ( integer $value )
$value integer

Описание свойств

$data_store_name защищенное свойство

Which data store to load.
protected string $data_store_name
Результат string

$extra_data защищенное свойство

Stores product data.
protected array $extra_data
Результат array