FulfillmentsDataStore
extends WC_Data_Store_WP
in package
implements
WC_Object_Data_Store_Interface, FulfillmentsDataStoreInterface
WC Order Item Product Data Store
Tags
Interfaces, Classes and Traits
- WC_Object_Data_Store_Interface
- WC Data Store Interface
- FulfillmentsDataStoreInterface
- Interface FulfillmentsDataStoreInterface
Table of Contents
- $internal_meta_keys : array<string|int, mixed>
- Data stored in meta keys, but not considered "meta" for an object.
- $meta_type : string
- Meta type. This should match up with the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
- $must_exist_meta_keys : array<string|int, mixed>
- Meta data which should exist in the DB, even if empty.
- $object_id_field_for_meta : string
- This only needs set if you are using a custom metadata type (for example payment tokens.
- add_meta() : int
- Method to add metadata for a fulfillment.
- create() : void
- Method to create a new fulfillment in the database.
- delete() : void
- Method to delete a fulfillment from the database.
- delete_by_entity() : int
- Hard-delete all fulfillment records (and their metadata) for a given entity.
- delete_from_lookup_table() : mixed
- Delete lookup table data for an ID.
- delete_meta() : void
- Method to delete the metadata for a fulfillment.
- filter_raw_meta_data() : mixed|void
- Helper method to filter internal meta keys from all meta data rows for the object.
- get_internal_meta_keys() : array<string|int, mixed>
- Return list of internal meta keys.
- parse_date_for_wp_query() : array<string|int, mixed>
- Map a valid date query var to WP_Query arguments.
- read() : void
- Method to read a fulfillment from the database.
- read_fulfillments() : array<string|int, Fulfillment>
- Method to read the fulfillment data.
- read_meta() : array<string|int, mixed>
- Method to read the metadata for a fulfillment.
- update() : void
- Method to update an existing fulfillment in the database.
- update_meta() : int
- Method to save the metadata for a fulfillment.
- exclude_internal_meta_keys() : bool
- Callback to remove unwanted meta data.
- get_data_for_lookup_table() : array<string|int, mixed>
- Get data to save to a lookup table.
- get_db_info() : array<string|int, mixed>
- Table structure is slightly different between meta types, this function will return what we need to know.
- get_primary_key_for_lookup_table() : string
- Get primary key name for lookup table.
- get_props_to_update() : array<string|int, mixed>
- Gets a list of props and meta keys that need updated based on change state or if they are present in the database or not.
- get_search_stopwords() : array<string|int, mixed>
- Retrieve stopwords used when parsing search terms.
- get_term_ids() : array<string|int, mixed>
- Get and store terms from a taxonomy.
- get_valid_search_terms() : array<string|int, mixed>
- Check if the terms are suitable for searching.
- get_wp_query_args() : array<string|int, mixed>
- Get valid WP_Query args from a WC_Object_Query's query variables.
- prefix_key() : string
- Internal meta keys we don't want exposed as part of meta_data. This is in addition to all data props with _ prefix.
- string_to_timestamp() : int|null
- Converts a WP post date string into a timestamp.
- update_lookup_table() : null
- Update a lookup table for an object.
- update_or_delete_post_meta() : bool
- Update meta data in, or delete it from, the database.
- validate_items() : void
- Method to validate the items in a fulfillment.
Properties
$internal_meta_keys
Data stored in meta keys, but not considered "meta" for an object.
protected
array<string|int, mixed>
$internal_meta_keys
= array()
Tags
$meta_type
Meta type. This should match up with the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
protected
string
$meta_type
= 'post'
WP defines 'post', 'user', 'comment', and 'term'.
$must_exist_meta_keys
Meta data which should exist in the DB, even if empty.
protected
array<string|int, mixed>
$must_exist_meta_keys
= array()
Tags
$object_id_field_for_meta
This only needs set if you are using a custom metadata type (for example payment tokens.
protected
string
$object_id_field_for_meta
= ''
This should be the name of the field your table uses for associating meta with objects. For example, in payment_tokenmeta, this would be payment_token_id.
Methods
add_meta()
Method to add metadata for a fulfillment.
public
add_meta(Fulfillment &$data, WC_Meta_Data $meta) : int
Parameters
- $data : Fulfillment
-
The fulfillment object to save.
- $meta : WC_Meta_Data
-
Meta object (containing at least ->id).
Tags
Return values
int — meta ID or WP_Error on failure.create()
Method to create a new fulfillment in the database.
public
create(Fulfillment &$data) : void
Parameters
- $data : Fulfillment
-
The fulfillment object to create.
Tags
Return values
void —delete()
Method to delete a fulfillment from the database.
public
delete(Fulfillment &$data[, array<string|int, mixed> $args = array() ]) : void
Parameters
- $data : Fulfillment
-
The fulfillment object to delete.
- $args : array<string|int, mixed> = array()
-
Optional arguments to pass to the delete method.
Tags
Return values
void —delete_by_entity()
Hard-delete all fulfillment records (and their metadata) for a given entity.
public
delete_by_entity(string $entity_type, string $entity_id) : int
This is used when an order is permanently deleted to prevent orphaned rows.
Parameters
- $entity_type : string
-
The entity type (e.g. 'WC_Order').
- $entity_id : string
-
The entity ID.
Tags
Return values
int — The number of fulfillment records deleted.delete_from_lookup_table()
Delete lookup table data for an ID.
public
delete_from_lookup_table(int $id, string $table) : mixed
Parameters
- $id : int
-
ID of object to update.
- $table : string
-
Lookup table name.
Tags
Return values
mixed —delete_meta()
Method to delete the metadata for a fulfillment.
public
delete_meta(Fulfillment &$data, WC_Meta_Data $meta) : void
Parameters
- $data : Fulfillment
-
The fulfillment object to delete.
- $meta : WC_Meta_Data
-
Meta object (containing at least ->id).
Tags
Return values
void —filter_raw_meta_data()
Helper method to filter internal meta keys from all meta data rows for the object.
public
filter_raw_meta_data(WC_Data &$object, array<string|int, mixed> $raw_meta_data) : mixed|void
Parameters
- $object : WC_Data
-
WC_Data object.
- $raw_meta_data : array<string|int, mixed>
-
Array of std object of meta data to be filtered.
Tags
Return values
mixed|void —get_internal_meta_keys()
Return list of internal meta keys.
public
get_internal_meta_keys() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —parse_date_for_wp_query()
Map a valid date query var to WP_Query arguments.
public
parse_date_for_wp_query(mixed $query_var, string $key[, array<string|int, mixed> $wp_query_args = array() ]) : array<string|int, mixed>
Valid date formats: YYYY-MM-DD or timestamp, possibly combined with an operator from $valid_operators. Also accepts a WC_DateTime object.
Parameters
- $query_var : mixed
-
A valid date format.
- $key : string
-
meta or db column key.
- $wp_query_args : array<string|int, mixed> = array()
-
WP_Query args.
Tags
Return values
array<string|int, mixed> — Modified $wp_query_argsread()
Method to read a fulfillment from the database.
public
read(Fulfillment &$data) : void
Parameters
- $data : Fulfillment
-
The fulfillment object to read.
Tags
Return values
void —read_fulfillments()
Method to read the fulfillment data.
public
read_fulfillments(string $entity_type, string $entity_id[, bool $with_deleted = false ]) : array<string|int, Fulfillment>
Parameters
- $entity_type : string
-
The entity type.
- $entity_id : string
-
The entity ID.
- $with_deleted : bool = false
-
Whether to include deleted fulfillments in the results.
Tags
Return values
array<string|int, Fulfillment> — Fulfillment object.read_meta()
Method to read the metadata for a fulfillment.
public
read_meta(Fulfillment &$data) : array<string|int, mixed>
Parameters
- $data : Fulfillment
-
The fulfillment object to read.
Tags
Return values
array<string|int, mixed> —update()
Method to update an existing fulfillment in the database.
public
update(Fulfillment &$data) : void
Parameters
- $data : Fulfillment
-
The fulfillment object to update.
Tags
Return values
void —update_meta()
Method to save the metadata for a fulfillment.
public
update_meta(Fulfillment &$data, WC_Meta_Data $meta) : int
Parameters
- $data : Fulfillment
-
The fulfillment object to save.
- $meta : WC_Meta_Data
-
Meta object (containing at least ->id).
Tags
Return values
int — Number of rows updated.exclude_internal_meta_keys()
Callback to remove unwanted meta data.
protected
exclude_internal_meta_keys(object $meta) : bool
Parameters
- $meta : object
-
Meta object to check if it should be excluded or not.
Return values
bool —get_data_for_lookup_table()
Get data to save to a lookup table.
protected
get_data_for_lookup_table(int $id, string $table) : array<string|int, mixed>
Parameters
- $id : int
-
ID of object to update.
- $table : string
-
Lookup table name.
Tags
Return values
array<string|int, mixed> —get_db_info()
Table structure is slightly different between meta types, this function will return what we need to know.
protected
get_db_info() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> — Array elements: table, object_id_field, meta_id_fieldget_primary_key_for_lookup_table()
Get primary key name for lookup table.
protected
get_primary_key_for_lookup_table(string $table) : string
Parameters
- $table : string
-
Lookup table name.
Tags
Return values
string —get_props_to_update()
Gets a list of props and meta keys that need updated based on change state or if they are present in the database or not.
protected
get_props_to_update(WC_Data $object, array<string|int, mixed> $meta_key_to_props[, string $meta_type = 'post' ]) : array<string|int, mixed>
Parameters
- $object : WC_Data
-
The WP_Data object (WC_Coupon for coupons, etc).
- $meta_key_to_props : array<string|int, mixed>
-
A mapping of meta keys => prop names.
- $meta_type : string = 'post'
-
The internal WP meta type (post, user, etc).
Return values
array<string|int, mixed> — A mapping of meta keys => prop names, filtered by ones that should be updated.get_search_stopwords()
Retrieve stopwords used when parsing search terms.
protected
get_search_stopwords() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> — Stopwords.get_term_ids()
Get and store terms from a taxonomy.
protected
get_term_ids(WC_Data|int $object, string $taxonomy) : array<string|int, mixed>
Parameters
- $object : WC_Data|int
-
WC_Data object or object ID.
- $taxonomy : string
-
Taxonomy name e.g. product_cat.
Tags
Return values
array<string|int, mixed> — of termsget_valid_search_terms()
Check if the terms are suitable for searching.
protected
get_valid_search_terms(array<string|int, mixed> $terms) : array<string|int, mixed>
Uses an array of stopwords (terms) that are excluded from the separate term matching when searching for posts. The list of English stopwords is the approximate search engines list, and is translatable.
Parameters
- $terms : array<string|int, mixed>
-
Terms to check.
Tags
Return values
array<string|int, mixed> — Terms that are not stopwords.get_wp_query_args()
Get valid WP_Query args from a WC_Object_Query's query variables.
protected
get_wp_query_args(array<string|int, mixed> $query_vars) : array<string|int, mixed>
Parameters
- $query_vars : array<string|int, mixed>
-
query vars from a WC_Object_Query.
Tags
Return values
array<string|int, mixed> —prefix_key()
Internal meta keys we don't want exposed as part of meta_data. This is in addition to all data props with _ prefix.
protected
prefix_key(string $key) : string
Parameters
- $key : string
-
Prefix to be added to meta keys.
Tags
Return values
string —string_to_timestamp()
Converts a WP post date string into a timestamp.
protected
string_to_timestamp(string $time_string) : int|null
Parameters
- $time_string : string
-
The WP post date string.
Tags
Return values
int|null — The date string converted to a timestamp or null.update_lookup_table()
Update a lookup table for an object.
protected
update_lookup_table(int $id, string $table) : null
Parameters
- $id : int
-
ID of object to update.
- $table : string
-
Lookup table name.
Tags
Return values
null —update_or_delete_post_meta()
Update meta data in, or delete it from, the database.
protected
update_or_delete_post_meta(WC_Data $object, string $meta_key, mixed $meta_value) : bool
Avoids storing meta when it's either an empty string or empty array.
Other empty values such as numeric 0 and null should still be stored.
Data-stores can force meta to exist using must_exist_meta_keys.
Note: WordPress get_metadata function returns an empty string when meta data does not exist.
Parameters
- $object : WC_Data
-
The WP_Data object (WC_Coupon for coupons, etc).
- $meta_key : string
-
Meta key to update.
- $meta_value : mixed
-
Value to save.
Tags
Return values
bool — True if updated/deleted.validate_items()
Method to validate the items in a fulfillment.
private
validate_items(Fulfillment $data) : void
Parameters
- $data : Fulfillment
-
The fulfillment object to validate.