2016-11-08 09:39:47 +00:00
|
|
|
<?php
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* WC Data Store Interface
|
|
|
|
*
|
2017-03-15 16:36:53 +00:00
|
|
|
* @version 3.0.0
|
2016-11-08 09:39:47 +00:00
|
|
|
* @category Interface
|
|
|
|
* @author WooThemes
|
|
|
|
*/
|
2016-11-22 13:54:51 +00:00
|
|
|
interface WC_Object_Data_Store_Interface {
|
2016-11-08 09:39:47 +00:00
|
|
|
/**
|
|
|
|
* Method to create a new record of a WC_Data based object.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
2016-11-08 09:39:47 +00:00
|
|
|
*/
|
|
|
|
public function create( &$data );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Method to read a record. Creates a new WC_Data based object.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
2016-11-08 09:39:47 +00:00
|
|
|
*/
|
|
|
|
public function read( &$data );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Updates a record in the database.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
2016-11-08 09:39:47 +00:00
|
|
|
*/
|
|
|
|
public function update( &$data );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deletes a record from the database.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
2016-11-15 19:35:10 +00:00
|
|
|
* @param array $args Array of args to pass to the delete method.
|
2016-11-15 18:11:25 +00:00
|
|
|
* @return bool result
|
2016-11-08 09:39:47 +00:00
|
|
|
*/
|
2016-11-15 19:35:10 +00:00
|
|
|
public function delete( &$data, $args = array() );
|
2016-11-21 23:48:49 +00:00
|
|
|
|
2016-11-22 11:34:14 +00:00
|
|
|
/**
|
|
|
|
* Returns an array of meta for an object.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
2016-11-22 11:34:14 +00:00
|
|
|
* @return array
|
|
|
|
*/
|
2016-11-21 23:48:49 +00:00
|
|
|
public function read_meta( &$data );
|
|
|
|
|
2016-11-22 11:34:14 +00:00
|
|
|
/**
|
|
|
|
* Deletes meta based on meta ID.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
|
|
|
* @param object $meta (containing at least ->id)
|
2016-11-22 11:34:14 +00:00
|
|
|
* @return array
|
|
|
|
*/
|
2016-11-21 23:48:49 +00:00
|
|
|
public function delete_meta( &$data, $meta );
|
|
|
|
|
2016-11-22 11:34:14 +00:00
|
|
|
/**
|
|
|
|
* Add new piece of meta.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
|
|
|
* @param object $meta (containing ->key and ->value)
|
|
|
|
* @return int meta ID
|
2016-11-22 11:34:14 +00:00
|
|
|
*/
|
2016-11-21 23:48:49 +00:00
|
|
|
public function add_meta( &$data, $meta );
|
|
|
|
|
2016-11-22 11:34:14 +00:00
|
|
|
/**
|
|
|
|
* Update meta.
|
2017-03-28 17:52:32 +00:00
|
|
|
* @param WC_Data &$data
|
|
|
|
* @param object $meta (containing ->id, ->key and ->value)
|
2016-11-22 11:34:14 +00:00
|
|
|
*/
|
2016-11-21 23:48:49 +00:00
|
|
|
public function update_meta( &$data, $meta );
|
2016-11-08 09:39:47 +00:00
|
|
|
}
|