Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

  • AdminPageFramework
    • AdminPage
    • Factory
    • FieldType
    • MetaBox
    • NetworkAdmin
    • PageMetaBox
    • PostType
    • TaxonomyField
    • Widget

Classes

  • AdminPageFramework
  • AdminPageFramework_Form_Controller
  • AdminPageFramework_Menu_Controller
  • AdminPageFramework_Menu_Model
  • AdminPageFramework_Menu_View
  • AdminPageFramework_Page_Controller
  • AdminPageFramework_Page_Model
  • AdminPageFramework_Page_View

Class AdminPageFramework

The main class of the framework to create admin pages and forms.

This class should be extended and the setUp() method should be overridden to define how pages are composed. Most of the internal methods are prefixed with the underscore like _getSomething() and callback methods are prefixed with _reply. The methods for the users are public and do not have those prefixes.

AdminPageFramework_Factory_Router
Extended by AdminPageFramework_Factory_Model
Extended by AdminPageFramework_Factory_View
Extended by AdminPageFramework_Factory_Controller
Extended by AdminPageFramework_Factory
Extended by AdminPageFramework_Router
Extended by AdminPageFramework_Form_Model_Port
Extended by AdminPageFramework_Form_Model_Validation
Extended by AdminPageFramework_Form_Model
Extended by AdminPageFramework_Form_View
Extended by AdminPageFramework_Form_Controller
Extended by AdminPageFramework_Page_Model
Extended by AdminPageFramework_Page_View_MetaBox
Extended by AdminPageFramework_Page_View
Extended by AdminPageFramework_Page_Controller
Extended by AdminPageFramework_Menu_Model
Extended by AdminPageFramework_Menu_View
Extended by AdminPageFramework_Menu_Controller
Extended by AdminPageFramework_Model
Extended by AdminPageFramework_View
Extended by AdminPageFramework_Controller
Extended by AdminPageFramework

Direct known subclasses

AdminPageFramework_NetworkAdmin

Abstract
Package: AdminPageFramework\AdminPage
Since: 2.0.0
Extends: AdminPageFramework_Controller
Located at factory/AdminPageFramework/AdminPageFramework.php

Methods summary

public
# __construct( string $sOptionKey = null, string $sCallerPath = null, string $sCapability = 'manage_options', string $sTextDomain = 'admin-page-framework' )

Registers necessary callbacks ans sets up internal components including properties.

Example

if ( is_admin() ) {
    new MyAdminPageClass( 'my_custom_option_key', __FILE__ );
}

Parameters

$sOptionKey
string
$sOptionKey (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used.
$sCallerPath
string
$sCallerPath (optional) used to retrieve the plugin/theme details to auto-insert the information into the page footer.
$sCapability
string
$sCapability (optional) sets the overall access level to the admin pages created by the framework. The used capabilities are listed here. The capability can be set per page, tab, setting section, setting field. Default: manage_options
$sTextDomain
string
$sTextDomain (optional) the text domain used for the framework's system messages. Default: admin-page-framework.

Returns


returns nothing.

Since

2.0.0

See

http://codex.wordpress.org/Roles_and_Capabilities
http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains

Overrides

AdminPageFramework_Menu_Controller::__construct

Methods inherited from AdminPageFramework_Controller

addHelpTab(), addLinkToPluginDescription(), addLinkToPluginTitle(), enqueueScript(), enqueueScripts(), enqueueStyle(), enqueueStyles(), getOption(), setAdminNotice(), setCapability(), setDisallowedQueryKeys(), setFooterInfoLeft(), setFooterInfoRight(), setPluginSettingsLinkLabel(), setUp()

Methods inherited from AdminPageFramework_View

_replyToPrintAdminNotices(), content()

Methods inherited from AdminPageFramework_Menu_Controller

addSubMenuItem(), addSubMenuItems(), setRootMenuPage(), setRootMenuPageBySlug()

Methods inherited from AdminPageFramework_Page_Controller

addInPageTab(), addInPageTabs(), setInPageTabTag(), setInPageTabsVisibility(), setPageHeadingTabTag(), setPageHeadingTabsVisibility(), setPageTitleVisibility()

Methods inherited from AdminPageFramework_Page_View_MetaBox

_getNumberOfColumns(), _printMetaBox(), _replyToAddMetaboxScript(), _replyToEnableMetaBox(), _replyToReturnDefaultNumberOfScreenColumns(), _replyToSetNumberOfScreenLayoutColumns()

Methods inherited from AdminPageFramework_Form_Controller

addSettingField(), addSettingFields(), addSettingSection(), addSettingSections(), getValue(), removeSettingFields(), removeSettingSections()

Methods inherited from AdminPageFramework_Form_View

_replyToGetFieldOutput(), _replyToGetSectionHeaderOutput()

Methods inherited from AdminPageFramework_Form_Model

_replyToCheckRedirects(), _replyToRegisterSettings(), _replyToSendFormEmail(), getSavedOptions()

Methods inherited from AdminPageFramework_Form_Model_Validation

_handleSubmittedData(), _validateSubmittedData()

Methods inherited from AdminPageFramework_Form_Model_Port

_exportOptions(), _importOptions()

Methods inherited from AdminPageFramework_Router

__call(), _doPageLoadCall(), _isInThePage(), _isInstantiatable(), _sortByOrder()

Methods inherited from AdminPageFramework_Factory_Controller

addHelpText(), hasFieldError(), hasSettingNotice(), setFieldErrors(), setSettingNotice()

Methods inherited from AdminPageFramework_Factory_View

_replyToPrintSettingNotice()

Methods inherited from AdminPageFramework_Factory_Model

_getFieldErrors(), _isValidationErrors(), _loadDefaultFieldTypeDefinitions(), _registerFields(), _replyToDeleteFieldErrors(), _replyToSaveFieldErrors(), _replyToSaveNotices(), _setLastInput(), _setUp(), getFieldErrors(), validate()

Methods inherited from AdminPageFramework_Factory_Router

__get(), __toString(), _getFormInstance(), _getHelpPaneInstance(), _getLinkInstancce(), _getPageLoadInfoInstance(), _getResourceInstance(), _replyToLoadComponents()

Magic methods summary

Properties summary

Properties inherited from AdminPageFramework_Form_Model

$_bDoneEmail, $_sFieldsType, $_sTargetPageSlug, $_sTargetSectionTabSlug, $_sTargetTabSlug, $aFieldErrors

Properties inherited from AdminPageFramework_Router

$_aHookPrefixes

Properties inherited from AdminPageFramework_Factory_Router

$oProp

Admin Page Framework Documentation generated by ApiGen 2.8.0