WooCommerce Code Reference

Search results

WC_Customer_Download extends WC_Data implements ArrayAccess

Customer download class.

Implemented by classes using the same CRUD(s) pattern.

Table of Contents

$object_type This is the name of this object type. string
$data Download Data array. array
$id ID for this object. int
$data Core data for this object. Name value pairs (name + default value). array
$changes Core data changes for this object. array
$object_read This is false until the object is read from the DB. bool
$object_type This is the name of this object type. string
$extra_data Extra data for this object. Name value pairs (name + default value). array
$default_data Set to _data on construct so we can track and reset data if needed. array
$data_store Contains a reference to the data store for this class. object
$cache_group Stores meta in cache for future reads. string
$meta_data Stores additional meta data. array
__construct() Constructor. mixed
get_download_id() Get download id. string
get_product_id() Get product id. int
get_user_id() Get user id. int
get_user_email() Get user_email. string
get_order_id() Get order_id. int
get_order_key() Get order_key. string
get_downloads_remaining() Get downloads_remaining. int|string
get_access_granted() Get access_granted. WC_DateTime|null
get_access_expires() Get access_expires. WC_DateTime|null
get_download_count() Get download_count. int
set_download_id() Set download id. mixed
set_product_id() Set product id. mixed
set_user_id() Set user id. mixed
set_user_email() Set user_email. mixed
set_order_id() Set order_id. mixed
set_order_key() Set order_key. mixed
set_downloads_remaining() Set downloads_remaining. mixed
set_access_granted() Set access_granted. mixed
set_access_expires() Set access_expires. mixed
set_download_count() Set download_count. mixed
track_download() Track a download on this permission. mixed
offsetGet() OffsetGet. mixed
offsetSet() OffsetSet. mixed
offsetUnset() OffsetUnset mixed
offsetExists() OffsetExists. bool
__isset() Magic __isset method for backwards compatibility. Legacy properties which could be accessed directly in the past. bool
__get() Magic __get method for backwards compatibility. Maps legacy vars to new getters. mixed
__construct() Default constructor. mixed
__sleep() Only store the object ID to avoid serializing the data object instance. array
__wakeup() Re-run the constructor with the object ID. mixed
__clone() When the object is cloned, make sure meta is duplicated correctly. mixed
get_data_store() Get the data store. object
get_id() Returns the unique ID for this object. int
delete() Delete an object, set the ID to 0, and return result. bool
save() Save should create or update based on object existence. int
__toString() Change data to JSON format. string
get_data() Returns all data for this object. array
get_data_keys() Returns array of expected data keys for this object. array
get_extra_data_keys() Returns all "extra" data keys for an object (for sub objects like product types). array
filter_null_meta() Filter null meta values from array. bool
get_meta_data() Get All Meta Data. array
is_internal_meta_key() Check if the key is an internal one. bool
get_meta() Get Meta Data by Key. mixed
meta_exists() See if meta data exists, since get_meta always returns a '' or array(). bool
set_meta_data() Set all meta data from array. mixed
add_meta_data() Add meta data. mixed
update_meta_data() Update meta data by key or ID, if provided. mixed
delete_meta_data() Delete meta data. mixed
delete_meta_data_by_mid() Delete meta data. mixed
maybe_read_meta_data() Read meta data if null. mixed
read_meta_data() Read Meta Data from the database. Ignore any internal properties. mixed
save_meta_data() Update Meta Data in the database. mixed
set_id() Set ID. mixed
set_defaults() Set all props to default values. mixed
set_object_read() Set object read property. mixed
get_object_read() Get object read property. bool
set_props() Set a collection of props in one go, collect any errors, and return the result. bool|WP_Error
set_prop() Sets a prop for a setter method. mixed
get_changes() Return data changes only. array
apply_changes() Merge changes with data and clear. mixed
get_hook_prefix() Prefix for action and filter hooks on data. string
get_prop() Gets a prop for a getter method. mixed
set_date_prop() Sets a date prop whilst handling formatting and datetime objects. mixed
error() When invalid data is found, throw an exception unless reading from the DB. mixed

Properties

$data

Download Data array.

protected array $data = array('download_id' => '', 'product_id' => 0, 'user_id' => 0, 'user_email' => '', 'order_id' => 0, 'order_key' => '', 'downloads_remaining' => '', 'access_granted' => \null, 'access_expires' => \null, 'download_count' => 0)

$data

Core data for this object. Name value pairs (name + default value).

protected array $data = array()

$changes

Core data changes for this object.

protected array $changes = array()

$object_read

This is false until the object is read from the DB.

protected bool $object_read = \false

$object_type

This is the name of this object type.

protected string $object_type = 'data'

$extra_data

Extra data for this object. Name value pairs (name + default value).

protected array $extra_data = array()
Used as a standard way for sub classes (like product types) to add additional information to an inherited class.

$default_data

Set to _data on construct so we can track and reset data if needed.

protected array $default_data = array()

$data_store

Contains a reference to the data store for this class.

protected object $data_store

$cache_group

Stores meta in cache for future reads.

protected string $cache_group = ''
A group must be set to to enable caching.

$meta_data

Stores additional meta data.

protected array $meta_data = \null

Methods

__construct()

Constructor.

public __construct( $download : int|object|array ) : mixed
Parameters
$download : int|object|array

Download ID, instance or data.

Return values
mixed

get_download_id()

Get download id.

public get_download_id( [ $context : string = 'view' ] ) : string
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
string

get_product_id()

Get product id.

public get_product_id( [ $context : string = 'view' ] ) : int
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
int

get_user_id()

Get user id.

public get_user_id( [ $context : string = 'view' ] ) : int
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
int

get_user_email()

Get user_email.

public get_user_email( [ $context : string = 'view' ] ) : string
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
string

get_order_id()

Get order_id.

public get_order_id( [ $context : string = 'view' ] ) : int
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
int

get_order_key()

Get order_key.

public get_order_key( [ $context : string = 'view' ] ) : string
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
string

get_downloads_remaining()

Get downloads_remaining.

public get_downloads_remaining( [ $context : string = 'view' ] ) : int|string
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
int|string

get_access_granted()

Get access_granted.

public get_access_granted( [ $context : string = 'view' ] ) : WC_DateTime|null
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
WC_DateTime|null

Object if the date is set or null if there is no date.

get_access_expires()

Get access_expires.

public get_access_expires( [ $context : string = 'view' ] ) : WC_DateTime|null
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
WC_DateTime|null

Object if the date is set or null if there is no date.

get_download_count()

Get download_count.

public get_download_count( [ $context : string = 'view' ] ) : int
Parameters
$context : string = 'view'

What the value is for. Valid values are 'view' and 'edit'.

Return values
int

set_download_id()

Set download id.

public set_download_id( $value : string ) : mixed
Parameters
$value : string

Download ID.

Return values
mixed

set_product_id()

Set product id.

public set_product_id( $value : int ) : mixed
Parameters
$value : int

Product ID.

Return values
mixed

set_user_id()

Set user id.

public set_user_id( $value : int ) : mixed
Parameters
$value : int

User ID.

Return values
mixed

set_user_email()

Set user_email.

public set_user_email( $value : int ) : mixed
Parameters
$value : int

User email.

Return values
mixed

set_order_id()

Set order_id.

public set_order_id( $value : int ) : mixed
Parameters
$value : int

Order ID.

Return values
mixed

set_order_key()

Set order_key.

public set_order_key( $value : string ) : mixed
Parameters
$value : string

Order key.

Return values
mixed

set_downloads_remaining()

Set downloads_remaining.

public set_downloads_remaining( $value : int|string ) : mixed
Parameters
$value : int|string

Amount of downloads remaining.

Return values
mixed

set_access_granted()

Set access_granted.

public set_access_granted( [ $date : string|int|null = null ] ) : mixed
Parameters
$date : string|int|null = null

UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.

Return values
mixed

set_access_expires()

Set access_expires.

public set_access_expires( [ $date : string|int|null = null ] ) : mixed
Parameters
$date : string|int|null = null

UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.

Return values
mixed

set_download_count()

Set download_count.

public set_download_count( $value : int ) : mixed
Parameters
$value : int

Download count.

Return values
mixed

track_download()

Track a download on this permission.

public track_download( [ $user_id : int = null ] [, $user_ip_address : string = null ] ) : mixed
Parameters
$user_id : int = null

Id of the user performing the download.

$user_ip_address : string = null

IP Address of the user performing the download.

Tags
since
throws

When permission ID is invalid.

Return values
mixed

offsetGet()

OffsetGet.

public offsetGet( $offset : string ) : mixed
Parameters
$offset : string

Offset.

Return values
mixed

offsetSet()

OffsetSet.

public offsetSet( $offset : string , $value : mixed ) : mixed
Parameters
$offset : string

Offset.

$value : mixed

Value.

Return values
mixed

offsetUnset()

OffsetUnset

public offsetUnset( $offset : string ) : mixed
Parameters
$offset : string

Offset.

Return values
mixed

offsetExists()

OffsetExists.

public offsetExists( $offset : string ) : bool
Parameters
$offset : string

Offset.

Return values
bool

__isset()

Magic __isset method for backwards compatibility. Legacy properties which could be accessed directly in the past.

public __isset( $key : string ) : bool
Parameters
$key : string

Key name.

Return values
bool

__get()

Magic __get method for backwards compatibility. Maps legacy vars to new getters.

public __get( $key : string ) : mixed
Parameters
$key : string

Key name.

Return values
mixed

__construct()

Default constructor.

public __construct( $read : int|object|array ) : mixed
Parameters
$read : int|object|array

ID to load from the DB (optional) or already queried data.

Return values
mixed

__sleep()

Only store the object ID to avoid serializing the data object instance.

public __sleep( ) : array
Return values
array

__wakeup()

Re-run the constructor with the object ID.

public __wakeup( ) : mixed

If the object no longer exists, remove the ID.

Return values
mixed

__clone()

When the object is cloned, make sure meta is duplicated correctly.

public __clone( ) : mixed
Tags
since
Return values
mixed

get_data_store()

Get the data store.

public get_data_store( ) : object
Tags
since
Return values
object

get_id()

Returns the unique ID for this object.

public get_id( ) : int
Tags
since
Return values
int

delete()

Delete an object, set the ID to 0, and return result.

public delete( [ $force_delete : bool = false ] ) : bool
Parameters
$force_delete : bool = false

Should the date be deleted permanently.

Tags
since
Return values
bool

result

save()

Save should create or update based on object existence.

public save( ) : int
Tags
since
Return values
int

__toString()

Change data to JSON format.

public __toString( ) : string
Tags
since
Return values
string

Data in JSON format.

get_data()

Returns all data for this object.

public get_data( ) : array
Tags
since
Return values
array

get_data_keys()

Returns array of expected data keys for this object.

public get_data_keys( ) : array
Tags
since
Return values
array

get_extra_data_keys()

Returns all "extra" data keys for an object (for sub objects like product types).

public get_extra_data_keys( ) : array
Tags
since
Return values
array

filter_null_meta()

Filter null meta values from array.

protected filter_null_meta( $meta : mixed ) : bool
Parameters
$meta : mixed

Meta value to check.

Tags
since
Return values
bool

get_meta_data()

Get All Meta Data.

public get_meta_data( ) : array
Tags
since
Return values
array

of objects.

is_internal_meta_key()

Check if the key is an internal one.

protected is_internal_meta_key( $key : string ) : bool
Parameters
$key : string

Key to check.

Tags
since
Return values
bool

true if it's an internal key, false otherwise

get_meta()

Get Meta Data by Key.

public get_meta( [ $key : string = '' ] [, $single : bool = true ] [, $context : string = 'view' ] ) : mixed
Parameters
$key : string = ''

Meta Key.

$single : bool = true

return first found meta with key, or all with $key.

$context : string = 'view'

What the value is for. Valid values are view and edit.

Tags
since
Return values
mixed

meta_exists()

See if meta data exists, since get_meta always returns a '' or array().

public meta_exists( [ $key : string = '' ] ) : bool
Parameters
$key : string = ''

Meta Key.

Tags
since
Return values
bool

set_meta_data()

Set all meta data from array.

public set_meta_data( $data : array ) : mixed
Parameters
$data : array

Key/Value pairs.

Tags
since
Return values
mixed

add_meta_data()

Add meta data.

public add_meta_data( $key : string , $value : string|array [, $unique : bool = false ] ) : mixed
Parameters
$key : string

Meta key.

$value : string|array

Meta value.

$unique : bool = false

Should this be a unique key?.

Tags
since
Return values
mixed

update_meta_data()

Update meta data by key or ID, if provided.

public update_meta_data( $key : string , $value : string|array , $meta_id : int ) : mixed
Parameters
$key : string

Meta key.

$value : string|array

Meta value.

$meta_id : int

Meta ID.

Tags
since
Return values
mixed

delete_meta_data()

Delete meta data.

public delete_meta_data( $key : string ) : mixed
Parameters
$key : string

Meta key.

Tags
since
Return values
mixed

delete_meta_data_by_mid()

Delete meta data.

public delete_meta_data_by_mid( $mid : int ) : mixed
Parameters
$mid : int

Meta ID.

Tags
since
Return values
mixed

maybe_read_meta_data()

Read meta data if null.

protected maybe_read_meta_data( ) : mixed
Tags
since
Return values
mixed

read_meta_data()

Read Meta Data from the database. Ignore any internal properties.

public read_meta_data( [ $force_read : bool = false ] ) : mixed

Uses it's own caches because get_metadata does not provide meta_ids.

Parameters
$force_read : bool = false

True to force a new DB read (and update cache).

Tags
since
Return values
mixed

save_meta_data()

Update Meta Data in the database.

public save_meta_data( ) : mixed
Tags
since
Return values
mixed

set_id()

Set ID.

public set_id( $id : int ) : mixed
Parameters
$id : int

ID.

Tags
since
Return values
mixed

set_defaults()

Set all props to default values.

public set_defaults( ) : mixed
Tags
since
Return values
mixed

set_object_read()

Set object read property.

public set_object_read( [ $read : bool = true ] ) : mixed
Parameters
$read : bool = true

Should read?.

Tags
since
Return values
mixed

get_object_read()

Get object read property.

public get_object_read( ) : bool
Tags
since
Return values
bool

set_props()

Set a collection of props in one go, collect any errors, and return the result.

public set_props( $props : array [, $context : string = 'set' ] ) : bool|WP_Error

Only sets using public methods.

Parameters
$props : array

Key value pairs to set. Key is the prop and should map to a setter function name.

$context : string = 'set'

In what context to run this.

Tags
since
Return values
bool|WP_Error

set_prop()

Sets a prop for a setter method.

protected set_prop( $prop : string , $value : mixed ) : mixed

This stores changes in a special array so we can track what needs saving the the DB later.

Parameters
$prop : string

Name of prop to set.

$value : mixed

Value of the prop.

Tags
since
Return values
mixed

get_changes()

Return data changes only.

public get_changes( ) : array
Tags
since
Return values
array

apply_changes()

Merge changes with data and clear.

public apply_changes( ) : mixed
Tags
since
Return values
mixed

get_hook_prefix()

Prefix for action and filter hooks on data.

protected get_hook_prefix( ) : string
Tags
since
Return values
string

get_prop()

Gets a prop for a getter method.

protected get_prop( $prop : string [, $context : string = 'view' ] ) : mixed

Gets the value from either current pending changes, or the data itself. Context controls what happens to the value before it's returned.

Parameters
$prop : string

Name of prop to get.

$context : string = 'view'

What the value is for. Valid values are view and edit.

Tags
since
Return values
mixed

set_date_prop()

Sets a date prop whilst handling formatting and datetime objects.

protected set_date_prop( $prop : string , $value : string|int ) : mixed
Parameters
$prop : string

Name of prop to set.

$value : string|int

Value of the prop.

Tags
since
Return values
mixed

error()

When invalid data is found, throw an exception unless reading from the DB.

protected error( $code : string , $message : string [, $http_status_code : int = 400 ] [, $data : array = array() ] ) : mixed
Parameters
$code : string

Error code.

$message : string

Error message.

$http_status_code : int = 400

HTTP status code.

$data : array = array()

Extra error data.

Tags
throws

Data Exception.

since
Return values
mixed
Back to the top