PHP Класс RCP_Levels, restrict-content-pro

This class handles querying, inserting, updating, and removing subscription levels Also includes other discount helper functions
С версии: 1.5
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$db_name Holds the name of our levels database table
$db_version Holds the version number of our levels database table
$meta_db_name Holds the name of our level meta database table

Открытые методы

Метод Описание
__construct ( ) Get things started
add_meta ( integer $level_id, string $meta_key = '', mixed $meta_value, boolean $unique = false ) : boolean Add meta data field to a subscription level.
delete_meta ( integer $level_id, string $meta_key = '', mixed $meta_value = '' ) : boolean Remove metadata matching criteria from a subscription level.
get_level ( $level_id ) Retrieve a specific subscription level from the database
get_level_by ( $field = 'name', $value = '' ) Retrieve a specific subscription level from the database
get_level_field ( $level_id, $field = '' ) Retrieve a field for a subscription level
get_levels ( $args = [] ) Retrieve all subscription levels from the database
get_meta ( integer $level_id, string $meta_key = '', boolean $single = false ) : mixed Retrieve level meta field for a subscription level.
insert ( $args = [] ) Insert a subscription level into the database
remove ( $level_id ) Delete a subscription level
remove_all_meta_for_level_id ( integer $level_id ) : integer | false Removes all metadata for the specified subscription level.
update ( $level_id, $args = [] ) Update an existing subscription level
update_meta ( integer $level_id, string $meta_key = '', mixed $meta_value, mixed $prev_value = '' ) : boolean Update level meta field based on Subscription level ID.

Приватные методы

Метод Описание
valid_amount ( $amount ) : boolean Validates that the amount is a valid format.

Описание методов

__construct() публичный Метод

Get things started
С версии: 1.5
public __construct ( )

add_meta() публичный Метод

Add meta data field to a subscription level.
С версии: 2.6
public add_meta ( integer $level_id, string $meta_key = '', mixed $meta_value, boolean $unique = false ) : boolean
$level_id integer Subscription level ID.
$meta_key string Metadata name.
$meta_value mixed Metadata value.
$unique boolean Optional, default is false. Whether the same key should not be added.
Результат boolean False for failure. True for success.

delete_meta() публичный Метод

You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.
С версии: 2.6
public delete_meta ( integer $level_id, string $meta_key = '', mixed $meta_value = '' ) : boolean
$level_id integer Subscription level ID.
$meta_key string Metadata name.
$meta_value mixed Optional. Metadata value.
Результат boolean False for failure. True for success.

get_level() публичный Метод

Retrieve a specific subscription level from the database
С версии: 1.5
public get_level ( $level_id )

get_level_by() публичный Метод

Retrieve a specific subscription level from the database
С версии: 1.8.2
public get_level_by ( $field = 'name', $value = '' )

get_level_field() публичный Метод

Retrieve a field for a subscription level
С версии: 1.5
public get_level_field ( $level_id, $field = '' )

get_levels() публичный Метод

Retrieve all subscription levels from the database
С версии: 1.5
public get_levels ( $args = [] )

get_meta() публичный Метод

Retrieve level meta field for a subscription level.
С версии: 2.6
public get_meta ( integer $level_id, string $meta_key = '', boolean $single = false ) : mixed
$level_id integer Subscription level ID.
$meta_key string The meta key to retrieve.
$single boolean Whether to return a single value.
Результат mixed Will be an array if $single is false. Will be value of meta data field if $single is true.

insert() публичный Метод

Insert a subscription level into the database
С версии: 1.5
public insert ( $args = [] )

remove() публичный Метод

Delete a subscription level
С версии: 1.5
public remove ( $level_id )

remove_all_meta_for_level_id() публичный Метод

Removes all metadata for the specified subscription level.
С версии: 2.6.6
public remove_all_meta_for_level_id ( integer $level_id ) : integer | false
$level_id integer Subscription level ID.
Результат integer | false Number of rows affected/selected or false on error.

update() публичный Метод

Update an existing subscription level
С версии: 1.5
public update ( $level_id, $args = [] )

update_meta() публичный Метод

Use the $prev_value parameter to differentiate between meta fields with the same key and Subscription level ID. If the meta field for the subscription level does not exist, it will be added.
С версии: 2.6
public update_meta ( integer $level_id, string $meta_key = '', mixed $meta_value, mixed $prev_value = '' ) : boolean
$level_id integer Subscription level ID.
$meta_key string Metadata key.
$meta_value mixed Metadata value.
$prev_value mixed Optional. Previous value to check before removing.
Результат boolean False on failure, true if success.

Описание свойств

$db_name публичное свойство

Holds the name of our levels database table
С версии: 1.5
public $db_name

$db_version публичное свойство

Holds the version number of our levels database table
С версии: 1.5
public $db_version

$meta_db_name публичное свойство

Holds the name of our level meta database table
С версии: 2.6
public $meta_db_name