WooCommerce Code Reference

WC_Customer_Download_Log extends WC_Data
in package

WooCommerce

Classes

Customer download log class.

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

$cache_group : string: Stores meta in cache for future reads.
$changes : array: Core data changes for this object.
$data : array: Download Log Data array.
$data_store : object: Contains a reference to the data store for this class.
$default_data : array: Set to _data on construct so we can track and reset data if needed.
$extra_data : array: Extra data for this object. Name value pairs (name + default value).
$id : int: ID for this object.
$meta_data : array: Stores additional meta data.
$object_read : bool: This is false until the object is read from the DB.
$object_type : string: This is the name of this object type.
__clone() : mixed: When the object is cloned, make sure meta is duplicated correctly.
__construct() : mixed: Constructor.
__sleep() : array: Only store the object ID to avoid serializing the data object instance.
__toString() : string: Change data to JSON format.
__wakeup() : mixed: Re-run the constructor with the object ID.
add_meta_data() : mixed: Add meta data.
apply_changes() : mixed: Merge changes with data and clear.
delete() : bool: Delete an object, set the ID to 0, and return result.
delete_meta_data() : mixed: Delete meta data.
delete_meta_data_by_mid() : mixed: Delete meta data.
get_changes() : array: Return data changes only.
get_data() : array: Returns all data for this object.
get_data_keys() : array: Returns array of expected data keys for this object.
get_data_store() : object: Get the data store.
get_extra_data_keys() : array: Returns all "extra" data keys for an object (for sub objects like product types).
get_id() : int: Returns the unique ID for this object.
get_meta() : mixed: Get Meta Data by Key.
get_meta_data() : array: Get All Meta Data.
get_object_read() : bool: Get object read property.
get_permission_id() : int: Get permission id.
get_timestamp() : WC_DateTime|null: Get timestamp.
get_user_id() : int: Get user id.
get_user_ip_address() : string: Get user ip address.
meta_exists() : bool: See if meta data exists, since get_meta always returns a '' or array().
read_meta_data() : mixed: Read Meta Data from the database. Ignore any internal properties.
save() : int: Save should create or update based on object existence.
save_meta_data() : mixed: Update Meta Data in the database.
set_defaults() : mixed: Set all props to default values.
set_id() : mixed: Set ID.
set_meta_data() : mixed: Set all meta data from array.
set_object_read() : mixed: Set object read property.
set_permission_id() : mixed: Set permission id.
set_props() : bool|WP_Error: Set a collection of props in one go, collect any errors, and return the result.
set_timestamp() : mixed: Set timestamp.
set_user_id() : mixed: Set user id.
set_user_ip_address() : mixed: Set user ip address.
update_meta_data() : mixed: Update meta data by key or ID, if provided.
error() : mixed: When invalid data is found, throw an exception unless reading from the DB.
filter_null_meta() : bool: Filter null meta values from array.
get_hook_prefix() : string: Prefix for action and filter hooks on data.
get_prop() : mixed: Gets a prop for a getter method.
is_internal_meta_key() : bool: Check if the key is an internal one.
maybe_read_meta_data() : mixed: Read meta data if null.
set_date_prop() : mixed: Sets a date prop whilst handling formatting and datetime objects.
set_prop() : mixed: Sets a prop for a setter method.

$cache_group

Stores meta in cache for future reads.


    protected
        string
    $cache_group
     = ''

A group must be set to to enable caching.

$changes

Core data changes for this object.


    protected
        array
    $changes
     = array()

$data

Download Log Data array.


    protected
        array
    $data
     = array('timestamp' => 
ull, 'permission_id' => 0, 'user_id' => 
ull, 'user_ip_address' => 
ull)

$data_store

Contains a reference to the data store for this class.


    protected
        object
    $data_store

$default_data

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


    protected
        array
    $default_data
     = array()

$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.

$id

ID for this object.


    protected
        int
    $id
     = 0

$meta_data

Stores additional meta data.


    protected
        array
    $meta_data
     = 
ull

$object_read

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


    protected
        bool
    $object_read
     = alse

$object_type

This is the name of this object type.


    protected
        string
    $object_type
     = 'customer_download_log'

__clone()

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


    public
                __clone() : mixed

Return values

mixed

__construct()

Constructor.


    public
                __construct(int|object|array $download_log) : mixed

Parameters

$download_log : int|object|array: Download log ID.

Return values

mixed

__sleep()

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


    public
                __sleep() : array

Return values

array

__toString()

Change data to JSON format.


    public
                __toString() : string

Return values

string — Data in JSON format.

__wakeup()

Re-run the constructor with the object ID.


    public
                __wakeup() : mixed

If the object no longer exists, remove the ID.

Return values

mixed

add_meta_data()

Add meta data.


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

Parameters

$key : string: Meta key.
$value : string|array: Meta value.
$unique : bool = false: Should this be a unique key?.

Return values

mixed

apply_changes()

Merge changes with data and clear.


    public
                apply_changes() : mixed

Return values

mixed

delete()

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


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

Parameters

$force_delete : bool = false: Should the date be deleted permanently.

Return values

bool — result

delete_meta_data()

Delete meta data.


    public
                delete_meta_data(string $key) : mixed

Parameters

$key : string: Meta key.

Return values

mixed

delete_meta_data_by_mid()

Delete meta data.


    public
                delete_meta_data_by_mid(int $mid) : mixed

Parameters

$mid : int: Meta ID.

Return values

mixed

get_changes()

Return data changes only.


    public
                get_changes() : array

Return values

array

get_data()

Returns all data for this object.


    public
                get_data() : array

Return values

array

get_data_keys()

Returns array of expected data keys for this object.


    public
                get_data_keys() : array

Return values

array

get_data_store()

Get the data store.


    public
                get_data_store() : object

Return values

object

get_extra_data_keys()

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


    public
                get_extra_data_keys() : array

Return values

array

get_id()

Returns the unique ID for this object.


    public
                get_id() : int

Return values

int

get_meta()

Get Meta Data by Key.


    public
                get_meta([string $key = '' ][, bool $single = true ][, string $context = '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.

Return values

mixed

get_meta_data()

Get All Meta Data.


    public
                get_meta_data() : array

Return values

array — of objects.

get_object_read()

Get object read property.


    public
                get_object_read() : bool

Return values

bool

get_permission_id()

Get permission id.


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

Parameters

$context : string = 'view': Get context.

Return values

int

get_timestamp()

Get timestamp.


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

Parameters

$context : string = 'view': Get context.

Return values

WC_DateTime|null — Object if the date is set or null if there is no date.

get_user_id()

Get user id.


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

Parameters

$context : string = 'view': Get context.

Return values

int

get_user_ip_address()

Get user ip address.


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

Parameters

$context : string = 'view': Get context.

Return values

string

meta_exists()

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


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

Parameters

$key : string = '': Meta Key.

Return values

bool

read_meta_data()

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


    public
                read_meta_data([bool $force_read = 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).

Return values

mixed

save()

Save should create or update based on object existence.


    public
                save() : int

Return values

int

save_meta_data()

Update Meta Data in the database.


    public
                save_meta_data() : mixed

Return values

mixed

set_defaults()

Set all props to default values.


    public
                set_defaults() : mixed

Return values

mixed

set_id()

Set ID.


    public
                set_id(int $id) : mixed

Parameters

$id : int: ID.

Return values

mixed

set_meta_data()

Set all meta data from array.


    public
                set_meta_data(array $data) : mixed

Parameters

$data : array: Key/Value pairs.

Return values

mixed

set_object_read()

Set object read property.


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

Parameters

$read : bool = true: Should read?.

Return values

mixed

set_permission_id()

Set permission id.


    public
                set_permission_id(int $value) : mixed

Parameters

$value : int: Value to set.

Return values

mixed

set_props()

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


    public
                set_props(array $props[, string $context = '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.

Return values

bool|WP_Error

set_timestamp()

Set timestamp.


    public
                set_timestamp([string|int|null $date = 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_user_id()

Set user id.


    public
                set_user_id(int $value) : mixed

Parameters

$value : int: Value to set.

Return values

mixed

set_user_ip_address()

Set user ip address.


    public
                set_user_ip_address(string $value) : mixed

Parameters

$value : string: Value to set.

Return values

mixed

update_meta_data()

Update meta data by key or ID, if provided.


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

Parameters

$key : string: Meta key.
$value : string|array: Meta value.
$meta_id : int: Meta ID.

Return values

mixed

error()

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


    protected
                error(string $code, string $message[, int $http_status_code = 400 ][, array $data = 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.

Return values

mixed

filter_null_meta()

Filter null meta values from array.


    protected
                filter_null_meta(mixed $meta) : bool

Parameters

$meta : mixed: Meta value to check.

Return values

bool

get_hook_prefix()

Prefix for action and filter hooks on data.


    protected
                get_hook_prefix() : string

Return values

string

get_prop()

Gets a prop for a getter method.


    protected
                get_prop(string $prop[, string $context = '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.

Return values

mixed

is_internal_meta_key()

Check if the key is an internal one.


    protected
                is_internal_meta_key(string $key) : bool

Parameters

$key : string: Key to check.

Return values

bool — true if it's an internal key, false otherwise

maybe_read_meta_data()

Read meta data if null.


    protected
                maybe_read_meta_data() : mixed

Return values

mixed

set_date_prop()

Sets a date prop whilst handling formatting and datetime objects.


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

Parameters

$prop : string: Name of prop to set.
$value : string|int: Value of the prop.

Return values

mixed

set_prop()

Sets a prop for a setter method.


    protected
                set_prop(string $prop, mixed $value) : 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.

Return values

mixed

WooCommerce Code Reference

WC_Customer_Download_Log extends WC_Data in package WooCommerce Classes

Table of Contents

Properties

$cache_group

Tags

$changes

Tags

$data

$data_store

Tags

$default_data

Tags

$extra_data

Tags

$id

Tags

$meta_data

Tags

$object_read

Tags

$object_type

Methods

__clone()

Tags

Return values

__construct()

Parameters

Return values

__sleep()

Return values

__toString()

Tags

Return values

__wakeup()

Return values

add_meta_data()

Parameters

Tags

Return values

apply_changes()

Tags

Return values

delete()

Parameters

Tags

Return values

delete_meta_data()

Parameters

Tags

Return values

delete_meta_data_by_mid()

Parameters

Tags

Return values

get_changes()

Tags

Return values

get_data()

Tags

Return values

get_data_keys()

Tags

Return values

get_data_store()

Tags

Return values

get_extra_data_keys()

Tags

Return values

get_id()

Tags

Return values

get_meta()

Parameters

Tags

Return values

get_meta_data()

Tags

Return values

WC_Customer_Download_Log extends WC_Data
in package

WooCommerce

Classes