PHP 클래스 RCP_Levels, restrict-content-pro

This class handles querying, inserting, updating, and removing subscription levels Also includes other discount helper functions
부터: 1.5
파일 보기 프로젝트 열기: restrictcontentpro/restrict-content-pro 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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