Full index

Package indexes

a

top

add_to_menu: KB_Admin::add_to_menu() in kb-admin.php

Add menus and determine the hook.
available: PT_Tests::available() in pt-tests.php

Whether this plugin has any Tests.

b

top

body: KB_Admin::body() in kb-admin.php

Extend this function to actually display the contents of the page. Should echo the data to be displayed.
body: PT_Admin::body() in pt-admin.php

The content of the page. Loads and runs the available tests and displays the results.
body_wrapper: KB_Admin::body_wrapper() in kb-admin.php

Output minimal boiler-plate HTML to make the page behave.
bulk_actions: PT_Plugin::bulk_actions() in pt-plugin.php

Change the bulk actions behaviour

c

top

$capability: KB_Admin::$capability in kb-admin.php

Capability at which this page can be shown.
constants.php: constants.php in constants.php
core.php: core.php in core.php
current_page: KB_Admin::current_page() in kb-admin.php

Returns true if the current page is the one added by this class.
customize_screen: KB_Admin::customize_screen() in kb-admin.php

Override to customize the screen--screen options, etc.

h

top

help: KB_Admin::help() in kb-admin.php

Override to modify the help message.
help: PT_Plugin::help() in pt-plugin.php

Modify the help text for this plugin
hook_page: KB_Admin::hook_page() in kb-admin.php

Add a page to be loaded for the specified slug. Do not over-ride.
hook_page_title: KB_Admin::hook_page_title() in kb-admin.php

Set the title of a page defined without any entry in the menu.

i

top

$icon: KB_Admin::$icon in kb-admin.php

Icon to be added in the menu.
$instance: KB_Singleton::$instance in kb-singleton.php

Storing the instance
init: PT_Plugin::init() in pt-plugin.php

Run this at the right time
init: KB_Admin::init() in kb-admin.php

Wrapper for conditionally loading resources

k

top

kb-admin.php: kb-admin.php in kb-admin.php
kb-at.php: kb-at.php in kb-at.php
kb-cpt.php: kb-cpt.php in kb-cpt.php
kb-plugin.php: kb-plugin.php in kb-plugin.php
kb-singleton.php: kb-singleton.php in kb-singleton.php
KB_Admin: KB_Admin in kb-admin.php

Generic Class that can be extended for creating admin screens for plugins.
KB_At: KB_At in kb-at.php

Automates adding functions to actions/filters.
KB_Cpt: KB_Cpt in kb-cpt.php

Generic class to handle common CPT functionality.
KB_Plugin: KB_Plugin in kb-plugin.php

Base class for plugins.
KB_Singleton: KB_Singleton in kb-singleton.php

Singleton abstract class.

l

top

links: PT_Tests::links() in pt-tests.php

The link to running a specific set of tests from this plugin.
load_resources: KB_Admin::load_resources() in kb-admin.php

Override to load resources as required
load_resources: PT_Plugin::load_resources() in pt-plugin.php

Load scripts and styles required for PressTest
load_resources: PT_Admin::load_resources() in pt-admin.php

Conditionally initialize based on page being called.
load_tests: PT_Tests::load_tests() in pt-tests.php

Load all available tests into qUnit and phpUnit tests based on file extension.

m

top

$menu_title: KB_Admin::$menu_title in kb-admin.php

Menu title

p

top

$page_title: KB_Admin::$page_title in kb-admin.php

Page title
$page_title: PT_Admin::$page_title in pt-admin.php
$parent: KB_Admin::$parent in kb-admin.php

Parent Menu
$position: KB_Admin::$position in kb-admin.php

Position in the menu
PHPUnit_MAIN_METHOD: PHPUnit_MAIN_METHOD in pt-phpUnit.php
PressTest: PressTest in core.php

Attaches functions to all the required actions; singleton.
PressTest.php: PressTest.php in PressTest.php
pt-admin.php: pt-admin.php in pt-admin.php
pt-phpUnit.php: pt-phpUnit.php in pt-phpUnit.php
pt-plugin.php: pt-plugin.php in pt-plugin.php
pt-tests.php: pt-tests.php in pt-tests.php
PT_Admin: PT_Admin in pt-admin.php

Generates the test results page.
PT_ADMIN_URL: PT_ADMIN_URL in constants.php

PressTest Admin Page URL
PT_COL: PT_COL in constants.php

PressTest Column identifier
PT_DIR: PT_DIR in constants.php

Plugin Directory
PT_HOME: PT_HOME in constants.php

Plugin Homepage
PT_IMAGES_URL: PT_IMAGES_URL in constants.php

Images folder
PT_PHPUNIT_DIR: PT_PHPUNIT_DIR in constants.php

phpUnit Directory
PT_Plugin: PT_Plugin in pt-plugin.php

The plugin page modifier for PressTest
PT_PLUGINS_SCREEN: PT_PLUGINS_SCREEN in constants.php

PressTest Screen modified
PT_QUNIT_URL: PT_QUNIT_URL in constants.php

qUnit Directory
PT_SCRIPTS_URL: PT_SCRIPTS_URL in constants.php

Scripts folder
PT_SLUG: PT_SLUG in constants.php

PressTest Admin Slug
PT_STYLES_URL: PT_STYLES_URL in constants.php

Styles folder
PT_Tests: PT_Tests in pt-tests.php

Tests available for hplugins.
PT_URL: PT_URL in constants.php

Plugin URL

r

top

register: KB_Cpt::register() in kb-cpt.php
row_meta: PT_Plugin::row_meta() in pt-plugin.php

Modify the meta actions available for the plugin
run_tests: PT_Tests::run_tests() in pt-tests.php

Routes function to set up actual markup to display the test.

s

top

$slug: KB_Admin::$slug in kb-admin.php

Store slug used for the page.
$slug: PT_Admin::$slug in pt-admin.php
sampleTest.php: sampleTest.php in sampleTest.php
SampleTest: SampleTest in sampleTest.php

Sample test for PressTest.
setup_tests: PT_Tests::setup_tests() in pt-tests.php

Routes function to set up resources based on test type.
set_current_page: KB_Admin::set_current_page() in kb-admin.php

Runs only if the page corresponding to this class is called.
singleton: KB_Singleton::singleton() in kb-singleton.php

The singleton function must control access

t

top

testable: PT_Tests::testable() in pt-tests.php

Whether this plugin has any tests at all.
test_correct: SampleTest::test_correct() in sampleTest.php
test_incorrect: SampleTest::test_incorrect() in sampleTest.php

_

top

__construct: PT_Admin::__construct() in pt-admin.php
__construct: PT_Plugin::__construct() in pt-plugin.php

Set up hooks for modifying the plugin screen
__construct: PT_Tests::__construct() in pt-tests.php

Constructor. Extracts path data.
__construct: KB_Singleton::__construct() in kb-singleton.php

The constructor must be hidden.
__construct: KB_Plugin::__construct() in kb-plugin.php
__construct: KB_Admin::__construct() in kb-admin.php

The constructor, conditionally initializes the requirements for the plugin.
__construct: KB_At::__construct() in kb-at.php
__construct: KB_Cpt::__construct() in kb-cpt.php

Constructor -- check if the 'init' action has run and accordingly register the post type.
__construct: PressTest::__construct() in core.php

Initialize the plugin.