Docs For Class ShrimpTest

Description

ShrimpTest Interface class

Implements the default ShrimpTest UI

usedby: ShrimpTest::load_model_and_interface()

Located in /classes/interface.php (line 16)

Variable Summary

int $message_activated

int $message_concluded

int $message_deleted

int $message_fail

int $message_save

ShrimpTest_Model $model

ShrimpTest $shrimp

string $slug

Method Summary

ShrimpTest_Interface ShrimpTest_Interface ()

void admin_experiments ()

void admin_header ()

void admin_menu ()

void admin_new_experiment_redirect ()

void admin_settings ()

void do_adminbar ()

void filter_adminbar ( $menus)

array get_menus ()

void init (ShrimpTest &$shrimptest_instance)

void print_shrimptest_widget ()

Variables

int $message_activated = 3 (line 44)

message ID's

int $message_concluded = 4 (line 45)

message ID's

int $message_deleted = 5 (line 46)

message ID's

int $message_fail = 2 (line 43)

message ID's

int $message_save = 1 (line 42)

message ID's

ShrimpTest_Model $model (line 27)

Reference to the local ShrimpTest_Model instance

ShrimpTest $shrimp (line 22)

Reference to the local ShrimpTest Core instance

string $slug (line 36)

The interface slug

This is the prefix on all ShrimpTest page names in wp-admin

usedby: ShrimpTest_Interface::admin_new_experiment_redirect()

Methods

Constructor ShrimpTest_Interface (line 54)

Dummy constructor.

Hint: run init()

ShrimpTest_Interface ShrimpTest_Interface ()

admin_experiments (line 218)

Include the experiments display page

void admin_experiments ()

admin_header (line 96)

Print some styles and JavaScript for all ShrimpTest admin pages

void admin_header ()

admin_menu (line 81)

Register the ShrimpTest admin pages

void admin_menu ()

admin_new_experiment_redirect (line 147)

Redirect the user to, or include the PHP for, the appropriate ShrimpTest "experiment" page, depending on whether we're viewing multiple experiments, saving an experiment, creating a new experiment, etc.

uses: ShrimpTest_Model::update_experiment_status()
uses: ShrimpTest_Model::get_reserved_experiment_id()
uses: ShrimpTest_Model::get_experiment_status()
uses: ShrimpTest_Model::delete_experiment()
uses: ShrimpTest_Interface::$slug

void admin_new_experiment_redirect ()

admin_settings (line 211)

Include the settings page

void admin_settings ()

do_adminbar (line 234)

Handler for adding the variant preview feature.

Checks to see if the WP Admin Bar plugin is installed. If not, we run print_shrimptest_widget().

global: wpdb $wpdb:
global: WPAdminBar $WPAdminBar:
link: http://www.viper007bond.com/wordpress-plugins/wordpress-admin-bar/
uses: ShrimpTest::has_been_touched()
uses: ShrimpTest_Interface::print_shrimptest_widget()

void do_adminbar ()

filter_adminbar (line 430)

If WP Admin Bar is installed, filter the Admin Bar info, splicing our menu items in for the variant preview feature.

uses: ShrimpTest_Interface::get_menus()

void filter_adminbar ( $menus)

$menus

get_menus (line 365)

Get the "menu items" array for use by WP Admin Bar.

If WP Admin Bar is not loaded, print_shrimptest_widget() can also use this output, though.

todo: display metric name in the metric menu
usedby: ShrimpTest_Interface::print_shrimptest_widget()
usedby: ShrimpTest_Interface::filter_adminbar()
uses: ShrimpTest_Model::get_experiment_variants()
uses: ShrimpTest_Model::get_experiment()
uses: ShrimpTest::get_touched_experiments()
uses: ShrimpTest::get_touched_metrics()

array get_menus ()

init (line 67)

Initialization

Sets $slug to be, by default, 'shrimptest' and registers some actions.

todo: include the delimiter _ in the slug:
usedby: ShrimpTest::load_model_and_interface()

void init (ShrimpTest &$shrimptest_instance)

ShrimpTest &$shrimptest_instance

print_shrimptest_widget (line 247)

Adds the ShrimpTest variant preview widget

usedby: ShrimpTest_Interface::do_adminbar()
uses: ShrimpTest_Interface::get_menus()

void print_shrimptest_widget ()

Class ShrimpTest_Interface