Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

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

Classes

  • AdminPageFramework_MetaBox_Page
  • AdminPageFramework_MetaBox_Page_Controller

Class AdminPageFramework_MetaBox_Page_Controller

Provides controller methods for creating meta boxes in pages added by the framework.

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_MetaBox_Router
Extended by AdminPageFramework_MetaBox_Model
Extended by AdminPageFramework_MetaBox_View
Extended by AdminPageFramework_MetaBox_Page_Router
Extended by AdminPageFramework_MetaBox_Page_Model
Extended by AdminPageFramework_MetaBox_Page_View
Extended by AdminPageFramework_MetaBox_Page_Controller

Direct known subclasses

AdminPageFramework_MetaBox_Page

Abstract
Package: AdminPageFramework\PageMetaBox
Since: 3.0.4
Located at factory/AdminPageFramework_MetaBox_Page/AdminPageFramework_MetaBox_Page_Controller.php

Methods summary

public array
# enqueueStyles( array $aSRCs, array $sPageSlug = '', mixed $sTabSlug = '', mixed $aCustomArgs = array() )

Enqueues styles by page slug and tab slug.

Parameters

$aSRCs
array
The sources of the stylesheet to enqueue: the url, the absolute file path, or the relative path to the root directory of WordPress. Example: array( '/css/mystyle.css', '/css/mystyle2.css' )
$sPageSlug
array
(optional) The another source argument array.
$sTabSlug
$aCustomArgs

Returns

array
The array holing the queued items.

Since

3.0.0

Overrides

AdminPageFramework_Factory_Controller::enqueueStyles
public string
# enqueueStyle( string $sSRC, string $sPageSlug = '', string $sTabSlug = '', array $aCustomArgs = array() )

Enqueues a style by page slug and tab slug.

Parameters

$sSRC
string
The URL of the stylesheet to enqueue, the absolute file path, or the relative path to the root directory of WordPress. Example: '/css/mystyle.css'.
$sPageSlug
string
(optional) The page slug that the stylesheet should be added to. If not set, it applies to all the pages created by the framework.
$sTabSlug
string
(optional) The tab slug that the stylesheet should be added to. If not set, it applies to all the in-page tabs in the page.
$aCustomArgs
array
(optional) The argument array for more advanced parameters.

Returns

string
The script handle ID. If the passed url is not a valid url string, an empty string will be returned.

Since

3.0.0

See

http://codex.wordpress.org/Function_Reference/wp_enqueue_style

Overrides

AdminPageFramework_Factory_Controller::enqueueStyle
public array
# enqueueScripts( array $aSRCs, array $sPageSlug = '', mixed $sTabSlug = '', mixed $aCustomArgs = array() )

Enqueues scripts by page slug and tab slug.

Parameters

$aSRCs
array
The sources of the stylesheets to enqueue: the URL, the absolute file path, or the relative path to the root directory of WordPress. Example: '/js/myscript.js'.
$sPageSlug
array
(optional) Ad additional source list array.
$sTabSlug
$aCustomArgs

Returns

array
The array holding the queued items.

Since

2.1.5

Overrides

AdminPageFramework_Factory_Controller::enqueueScripts
public string
# enqueueScript( string $sSRC, string $sPageSlug = '', string $sTabSlug = '', array $aCustomArgs = array() )

Enqueues a script by page slug and tab slug.

Parameters

$sSRC
string
The URL of the stylesheet to enqueue, the absolute file path, or the relative path to the root directory of WordPress. Example: '/js/myscript.js'.
$sPageSlug
string
(optional) The page slug that the script should be added to. If not set, it applies to all the pages created by the framework.
$sTabSlug
string
(optional) The tab slug that the script should be added to. If not set, it applies to all the in-page tabs in the page.
$aCustomArgs
array
(optional) The argument array for more advanced parameters.

Returns

string
The script handle ID. If the passed url is not a valid url string, an empty string will be returned.

Since

3.0.0

See

http://codex.wordpress.org/Function_Reference/wp_enqueue_script

Overrides

AdminPageFramework_Factory_Controller::enqueueScript

Methods inherited from AdminPageFramework_MetaBox_Page_Model

__construct(), _registerFormElements(), _replyToAddMetaBox(), _replyToFilterPageOptions(), _replyToFilterPageOptionsWODynamicElements(), _replyToModifyOptionsUpdateStatus(), _replyToValidateOptions(), _setOptionArray(), _setUpValidationHooks(), getFieldOutput()

Methods inherited from AdminPageFramework_MetaBox_Page_Router

_isInThePage(), _isInstantiatable()

Methods inherited from AdminPageFramework_MetaBox_View

content()

Methods inherited from AdminPageFramework_MetaBox_Model

_replyToFilterSavingData(), _replyToModifyRedirectPostLocation()

Methods inherited from AdminPageFramework_Factory_Controller

addHelpText(), addSettingField(), addSettingFields(), addSettingSection(), addSettingSections(), hasFieldError(), hasSettingNotice(), setFieldErrors(), setSettingNotice(), setUp()

Methods inherited from AdminPageFramework_Factory_View

_replyToGetFieldOutput(), _replyToPrintSettingNotice()

Methods inherited from AdminPageFramework_Factory_Model

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

Methods inherited from AdminPageFramework_Factory_Router

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

Magic methods summary

Properties summary

Properties inherited from AdminPageFramework_MetaBox_Page_Model

$_sFieldsType

Properties inherited from AdminPageFramework_Factory_Router

$oProp

Admin Page Framework Documentation generated by ApiGen 2.8.0