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
-
AdminPageFramework_Factory_Model
-
AdminPageFramework_Factory_View
-
AdminPageFramework_Factory_Controller
-
AdminPageFramework_Factory
-
AdminPageFramework_Router
-
AdminPageFramework_Form_Model_Port
-
AdminPageFramework_Form_Model_Validation
-
AdminPageFramework_Form_Model
-
AdminPageFramework_Form_View
-
AdminPageFramework_Form_Controller
-
AdminPageFramework_Page_Model
-
AdminPageFramework_Page_View_MetaBox
-
AdminPageFramework_Page_View
-
AdminPageFramework_Page_Controller
-
AdminPageFramework_Menu_Model
-
AdminPageFramework_Menu_View
-
AdminPageFramework_Menu_Controller
-
AdminPageFramework_Model
-
AdminPageFramework_View
-
AdminPageFramework_Controller
-
AdminPageFramework
Direct known subclasses
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. Exampleif ( is_admin() ) { new MyAdminPageClass( 'my_custom_option_key', __FILE__ ); } Parameters
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 |
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()
,
_replyToRemoveConfirmationQueryKey()
,
_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