API Documentation
\
Barn2
Plugin
WC_Private_Store
Admin
WPS_Lib
Admin
Plugin
Admin
License
Admin
WPTRT
AdminNotices

\Barn2\Plugin\WC_Private_StorePlugin

The main plugin class. Responsible for setting up to core plugin services.

Summary

Methods
Properties
Constants
__construct()
register()
get_item_id()
get_license()
get_license_setting()
has_valid_license()
get_license_page_url()
get_legacy_db_prefix()
get_name()
get_version()
get_file()
get_slug()
get_basename()
get_dir_path()
get_dir_url()
is_woocommerce()
get_documentation_url()
get_support_url()
get_settings_page_url()
load_services()
get_service()
get_services()
load_textdomain()
No public properties found
NAME
ITEM_ID
No protected methods found
$file
$data
N/A
define_constants()
add_missing_woocommerce_notice()
$services
$basename
$dir_path
$dir_url
N/A

Constants

NAME

NAME

ITEM_ID

ITEM_ID

Properties

$file

$file :

Type

$data

$data :

Type

$services

$services :

Type

$basename

$basename :

Type

$dir_path

$dir_path :

Type

$dir_url

$dir_url :

Type

Methods

__construct()

__construct(string  $file = null,string  $version = '1.0')

Constructs and initalizes the main plugin class.

Parameters

string $file

The main plugin file.
string $version

The current plugin version.

register()

register()

Registers the plugin with WordPress.

get_item_id()

get_item_id(): integer

Get the item ID of this plugin.

Returns

integer —

The item ID

get_license()

get_license(): \Barn2\WPS_Lib\Plugin\Barn2\WPS_Lib\Plugin\License\License

Get the plugin license object.

Returns

\Barn2\WPS_Lib\Plugin\Barn2\WPS_Lib\Plugin\License\License

get_license_setting()

get_license_setting(): \Barn2\WPS_Lib\Plugin\Barn2\WPS_Lib\Plugin\License\Admin\License_Setting

Get the license setting for the plugin.

Returns

\Barn2\WPS_Lib\Plugin\Barn2\WPS_Lib\Plugin\License\Admin\License_Setting

has_valid_license()

has_valid_license(): boolean

Does this plugin have a valid license?

Returns

boolean —

true if valid.

get_license_page_url()

get_license_page_url(): string

Get the URL of the page where license settings are managed.

Returns

string —

The license setting URL

get_legacy_db_prefix()

get_legacy_db_prefix(): string

Get the legacy database prefix for the old license system.

Returns

string —

The prefix or an empty string if not applicable

get_name()

get_name(): string

Gets the name of this plugin.

Returns

string —

The plugin name.

get_version()

get_version(): string

Gets the plugin version number (e.g. 1.3.2).

Returns

string —

The version number.

get_file()

get_file(): string

Gets the full path to the main plugin file.

Returns

string —

The plugin file.

get_slug()

get_slug(): string

Gets the slug for this plugin (e.g. my-plugin).

Returns

string —

The plugin slug.

get_basename()

get_basename(): string

Gets the 'basename' for the plugin (e.g. my-plugin/my-plugin.php).

Returns

string —

The plugin basename.

get_dir_path()

get_dir_path(): string

Get the full directory path to the plugin folder, with trailing slash (e.g. /wp-content/plugins/my-plugin/).

Returns

string —

The plugin directory path.

get_dir_url()

get_dir_url(): string

Get the URL to the plugin folder.

Returns

string —

(URL)

is_woocommerce()

is_woocommerce(): boolean

Is this a WooCommerce plugin?

Returns

boolean —

true if WooCommerce.

get_documentation_url()

get_documentation_url(): string

Get the documentation URL for this plugin.

Returns

string —

(URL)

get_support_url()

get_support_url(): string

Get the support URL for this plugin.

Returns

string —

(URL)

get_settings_page_url()

get_settings_page_url(): string

Get the settings page URL in the WordPress admin.

Returns

string —

(URL)

load_services()

load_services()

get_service()

get_service(string  $id): \Barn2\WPS_Lib\Service

Get the service for the specified ID.

Parameters

string $id

The service ID

Returns

\Barn2\WPS_Lib\Service —

The service object

get_services()

get_services(): array

Get the list of services provided.

Returns

array —

The list of service objects.

load_textdomain()

load_textdomain()

define_constants()

define_constants()

add_missing_woocommerce_notice()

add_missing_woocommerce_notice()