PHP Класс WC_Order_Item

A class which represents an item within an order and handles CRUD. Uses ArrayAccess to be BW compatible with WC_Orders::get_items().
С версии: 2.7.0
Автор: WooThemes
Наследование: extends WC_Data, implements ArrayAccess
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$cache_group string A group must be set to to enable caching.
$data array Order Data array. This is the core order data exposed in APIs since 2.7.0.
$meta_type WP defines 'post', 'user', 'comment', and 'term'.
$order object May store an order to prevent retriving it multiple times.

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

Метод Описание
__construct ( integer | object | array $item ) Constructor.
get_formatted_meta_data ( string $hideprefix = '_' ) : array Expands things like term slugs before return.
get_name ( string $context = 'view' ) : string Get order item name.
get_order ( ) : integer Get parent order object.
get_order_id ( string $context = 'view' ) : integer Get order ID this meta belongs to.
get_quantity ( ) : integer Get quantity.
get_type ( ) : string Get order item type. Overridden by child classes.
is_type ( $type ) : boolean Type checking
offsetExists ( string $offset ) : boolean offsetExists for ArrayAccess
offsetGet ( string $offset ) : mixed offsetGet for ArrayAccess
offsetSet ( string $offset, mixed $value ) offsetSet for ArrayAccess
offsetUnset ( string $offset ) offsetUnset for ArrayAccess
set_name ( string $value ) Set order item name.
set_order_id ( integer $value ) Set order ID.

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

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

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

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

Constructor.
public __construct ( integer | object | array $item )
$item integer | object | array ID to load from the DB, or WC_Order_Item Object

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

Expands things like term slugs before return.
public get_formatted_meta_data ( string $hideprefix = '_' ) : array
$hideprefix string (default: _)
Результат array

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

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

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

Get order item name.
public get_name ( string $context = 'view' ) : string
$context string
Результат string

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

Get parent order object.
public get_order ( ) : integer
Результат integer

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

Get order ID this meta belongs to.
public get_order_id ( string $context = 'view' ) : integer
$context string
Результат integer

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

Get quantity.
public get_quantity ( ) : integer
Результат integer

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

Get order item type. Overridden by child classes.
public get_type ( ) : string
Результат string

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

Type checking
public is_type ( $type ) : boolean
Результат boolean

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

offsetExists for ArrayAccess
public offsetExists ( string $offset ) : boolean
$offset string
Результат boolean

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

offsetGet for ArrayAccess
public offsetGet ( string $offset ) : mixed
$offset string
Результат mixed

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

offsetSet for ArrayAccess
public offsetSet ( string $offset, mixed $value )
$offset string
$value mixed

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

offsetUnset for ArrayAccess
public offsetUnset ( string $offset )
$offset string

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

Set order item name.
public set_name ( string $value )
$value string

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

Set order ID.
public set_order_id ( integer $value )
$value integer

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

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

A group must be set to to enable caching.
protected string $cache_group
Результат string

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

Order Data array. This is the core order data exposed in APIs since 2.7.0.
С версии: 2.7.0
protected array $data
Результат array

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

WP defines 'post', 'user', 'comment', and 'term'.
protected $meta_type

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

May store an order to prevent retriving it multiple times.
protected object $order
Результат object