WooCommerce Code Reference

WC_Payment_Token extends WC_Legacy_Payment_Token
in package

WooCommerce

Abstracts

WooCommerce Payment Token.

Representation of a general payment token to be extended by individuals types of tokens examples: Credit Card, eCheck.

$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<string|int, mixed>
    $changes
     = array()

$data

Token Data (stored in the payment_tokens table).


    protected
        array<string|int, mixed>
    $data
     = array('gateway_id' => '', 'token' => '', 'is_default' => alse, 'user_id' => 0, 'type' => '')

$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<string|int, mixed>
    $default_data
     = array()

$extra_data

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


    protected
        array<string|int, mixed>
    $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

$legacy_datastore_props

List of properties that were earlier managed by data store. However, since DataStore is a not a stored entity in itself, they used to store data in metadata of the data object.


    protected
        array<string|int, mixed>
    $legacy_datastore_props
     = array()

With custom tables, some of these are moved from metadata to their own columns, but existing code will still try to add them to metadata. This array is used to keep track of such properties.

Only reason to add a property here is that you are moving properties from DataStore instance to data object. If you are adding a new property, consider adding it to to $data array instead.

$meta_data

Stores additional meta data.


    protected
        array<string|int, mixed>
    $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
     = 'data'

$type

Token Type (CC, eCheck, or a custom type added by an extension).


    protected
        string
    $type
     = ''

Set by child classes.

__clone()

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


    public
                __clone() : mixed

Return values

mixed —

__construct()

Initialize a payment token.


    public
                __construct([mixed $token = '' ]) : mixed

These fields are accepted by all payment tokens: is_default - boolean Optional - Indicates this is the default payment token for a user token - string Required - The actual token to store gateway_id - string Required - Identifier for the gateway this token is associated with user_id - int Optional - ID for the user this token is associated with. 0 if this token is not associated with a user

Parameters

$token : mixed = '': Token.

Return values

mixed —

__sleep()

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


    public
                __sleep() : array<string|int, mixed>

Return values

array<string|int, mixed> —

__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<string|int, mixed> $value[, bool $unique = false ]) : mixed

Parameters

$key : string: Meta key.
$value : string|array<string|int, mixed>: 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 —

create()

Create a token.


    public
                create() : 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 —

delete_meta_data_value()

Delete meta data with a matching value.


    public
                delete_meta_data_value(string $key, mixed $value) : mixed

Parameters

$key : string: Meta key.
$value : mixed: Meta value. Entries will only be removed that match the value.

Return values

mixed —

generate_meta_cache_key()

Generate cache key from id and group.


    public
            static    generate_meta_cache_key(int|string $id, string $cache_group) : string

Parameters

$id : int|string: Object ID.
$cache_group : string: Group name use to store cache. Whole group cache can be invalidated in one go.

Return values

string — Meta cache key.

get_changes()

Return data changes only.


    public
                get_changes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_data()

Returns all data for this object.


    public
                get_data() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_data_keys()

Returns array of expected data keys for this object.


    public
                get_data_keys() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_data_store()

Get the data store.


    public
                get_data_store() : object

Return values

object —

get_display_name()

Get type to display to user.


    public
                get_display_name([string $deprecated = '' ]) : string

Get's overwritten by child classes.

Parameters

$deprecated : string = '': Deprecated since WooCommerce 3.0.

Return values

string —

get_extra_data_keys()

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


    public
                get_extra_data_keys() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_gateway_id()

Returns the ID of the gateway associated with this payment token.


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

Parameters

$context : string = 'view': In what context to execute this.

Return values

string — Gateway ID

get_id()

Returns the unique ID for this object.


    public
                get_id() : int

Return values

int —

get_is_default()

Returns the ID of the gateway associated with this payment token.


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

Parameters

$context : string = 'view': In what context to execute this.

Return values

string — Gateway ID

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_cache_key()

Helper method to compute meta cache key. Different from WP Meta cache key in that meta data cached using this key also contains meta_id column.


    public
                get_meta_cache_key() : string

Return values

string —

get_meta_data()

Get All Meta Data.


    public
                get_meta_data() : array<string|int, mixed>

Return values

array<string|int, mixed> — of objects.

get_object_read()

Get object read property.


    public
                get_object_read() : bool

Return values

bool —

get_token()

Returns the raw payment token.


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

Parameters

$context : string = 'view': Context in which to call this.

Return values

string — Raw token

get_type()

Returns the type of this payment token (CC, eCheck, or something else).


    public
                get_type([string $deprecated = '' ]) : string

Overwritten by child classes.

Parameters

$deprecated : string = '': Deprecated since WooCommerce 3.0.

Return values

string — Payment Token Type (CC, eCheck)

get_user_id()

Returns the user ID associated with the token or false if this token is not associated.


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

Parameters

$context : string = 'view': In what context to execute this.

Return values

int — User ID if this token is associated with a user or 0 if no user is associated

init_meta_data()

Helper function to initialize metadata entries from filtered raw meta data.


    public
                init_meta_data([array<string|int, mixed> $filtered_meta_data = array() ]) : mixed

Parameters

$filtered_meta_data : array<string|int, mixed> = array(): Filtered metadata fetched from DB.

Return values

mixed —

is_default()

Returns if the token is marked as default.


    public
                is_default() : bool

Return values

bool — True if the token is default

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 —

prime_raw_meta_data_cache()

Prime caches for raw meta data. This includes meta_id column as well, which is not included by default in WP meta data.


    public
            static    prime_raw_meta_data_cache(array<string|int, mixed> $raw_meta_data_collection, string $cache_group) : mixed

Parameters

$raw_meta_data_collection : array<string|int, mixed>: Array of objects of { object_id => array( meta_row_1, meta_row_2, ... }.
$cache_group : string: Name of cache group.

Return values

mixed —

read()

Read a token by ID.


    public
                read(int $token_id) : mixed

Parameters

$token_id : int

Return values

mixed —

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_default()

Marks the payment as default or non-default.


    public
                set_default(bool $is_default) : mixed

Parameters

$is_default : bool: True or false.

Return values

mixed —

set_defaults()

Set all props to default values.


    public
                set_defaults() : mixed

Return values

mixed —

set_gateway_id()

Set the gateway ID.


    public
                set_gateway_id(string $gateway_id) : mixed

Parameters

$gateway_id : string: Gateway ID.

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<string|int, mixed> $data) : mixed

Parameters

$data : array<string|int, mixed>: 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_props()

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


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

Only sets using public methods.

Parameters

$props : array<string|int, mixed>: 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_token()

Set the raw payment token.


    public
                set_token(string $token) : mixed

Parameters

$token : string: Payment token.

Return values

mixed —

set_type()

Sets the type of this payment token (CC, eCheck, or something else).


    public
                set_type(mixed $type) : mixed

Parameters

$type : mixed

Return values

mixed —

set_user_id()

Set the user ID for the user associated with this order.


    public
                set_user_id(int $user_id) : mixed

Parameters

$user_id : int: User ID.

Return values

mixed —

update()

Update a token.


    public
                update() : mixed

Return values

mixed —

update_meta_data()

Update meta data by key or ID, if provided.


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

Parameters

$key : string: Meta key.
$value : string|array<string|int, mixed>: Meta value.
$meta_id : int: Meta ID.

Return values

mixed —

validate()

Validate basic token info (token and type are required).


    public
                validate() : bool

Return values

bool — True if the passed data is valid

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<string|int, mixed> $data = array() ]) : mixed

Parameters

$code : string: Error code.
$message : string: Error message.
$http_status_code : int = 400: HTTP status code.
$data : array<string|int, mixed> = 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 DB later.

Parameters

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

Return values

mixed —

WooCommerce Code Reference

WC_Payment_Token extends WC_Legacy_Payment_Token in package WooCommerce Abstracts

Tags

Table of Contents

Properties

$cache_group

Tags

$changes

Tags

$data

$data_store

Tags

$default_data

Tags

$extra_data

Tags

$id

Tags

$legacy_datastore_props

$meta_data

Tags

$object_read

Tags

$object_type

Tags

$type

Methods

__clone()

Tags

Return values

__construct()

Parameters

Tags

Return values

__sleep()

Return values

__toString()

Tags

Return values

__wakeup()

Return values

add_meta_data()

Parameters

Tags

Return values

apply_changes()

Tags

Return values

create()

Tags

Return values

delete()

Parameters

Tags

Return values

delete_meta_data()

Parameters

Tags

Return values

delete_meta_data_by_mid()

Parameters

Tags

Return values

delete_meta_data_value()

Parameters

Tags

Return values

generate_meta_cache_key()

Parameters

Tags

Return values

get_changes()

Tags

Return values

get_data()

Tags

Return values

get_data_keys()

Tags

Return values

WC_Payment_Token extends WC_Legacy_Payment_Token
in package

WooCommerce

Abstracts