Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

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

Classes

  • AdminPageFramework_Widget
  • AdminPageFramework_Widget_Controller
  • AdminPageFramework_Widget_Factory
  • AdminPageFramework_Widget_Model
  • AdminPageFramework_Widget_Router
  • AdminPageFramework_Widget_View

Class AdminPageFramework_Widget_Controller

Provides methods of views for the widget factory class.

Those methods are public and provides means for users to set property values.

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_Widget_Router
Extended by AdminPageFramework_Widget_Model
Extended by AdminPageFramework_Widget_View
Extended by AdminPageFramework_Widget_Controller

Direct known subclasses

AdminPageFramework_Widget

Abstract
Package: AdminPageFramework\Widget
Since: 3.2.0
Located at factory/AdminPageFramework_Widget/AdminPageFramework_Widget_Controller.php

Methods summary

public
# setUp( )

The method for all necessary set-ups.

The method for all necessary set-ups.

Since

3.2.0

Overrides

AdminPageFramework_Factory_Controller::setUp
public
# load( mixed $oAdminWidget )

The method for setting up form elements.

The method for setting up form elements.

Since

3.2.0
public array
# enqueueStyles( mixed $aSRCs, mixed $aCustomArgs = array() )

Enqueues styles by page slug and tab slug.

Enqueues styles by page slug and tab slug.

Returns

array
An array holding the handle IDs of queued items.

Since

3.2.0
public string
# enqueueStyle( string $sSRC, array $aCustomArgs = array() )

Enqueues a style by page slug and tab slug.

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'.
$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.2.0

See

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

Overrides

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

Enqueues scripts by page slug and tab slug.

Enqueues scripts by page slug and tab slug.

Returns

array
An array holding the handle IDs of queued items.

Since

3.2.0

Overrides

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

Enqueues a script by page slug and tab slug.

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'.
$aCustomArgs
array
(optional) The argument array for more advanced parameters.

Custom Argument Array

  • handle_id - ( optional, string ) The handle ID of the script.
  • dependencies - ( optional, array ) The dependency array. For more information, see codex.
  • version - ( optional, string ) The stylesheet version number.
  • translation - ( optional, array ) The translation array. The handle ID will be used for the object name.
  • in_footer - ( optional, boolean ) Whether to enqueue the script before </head > or before </body> Default: false.

Returns

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

Since

3.2.0

See

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

Overrides

AdminPageFramework_Factory_Controller::enqueueScript
protected
# setArguments( array $aArguments = array() )

Sets the widget arguments.

Sets the widget arguments.

This is only necessary if it is not set in the constructor.

Since

3.2.0

Methods inherited from AdminPageFramework_Widget_View

_replyToGetSectionHeaderOutput(), content()

Methods inherited from AdminPageFramework_Widget_Model

_isInThePage(), validate()

Methods inherited from AdminPageFramework_Factory_Controller

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

Methods inherited from AdminPageFramework_Factory_View

__construct(), _replyToGetFieldOutput(), _replyToPrintSettingNotice()

Methods inherited from AdminPageFramework_Factory_Model

_setUp()

Methods inherited from AdminPageFramework_Factory_Router

__call(), __get(), _getFormInstance(), _getHeadTagInstance(), _getHelpPaneInstance(), _getLinkInstancce(), _getPageLoadInfoInstance(), _isInstantiatable(), _replyToLoadComponents()

Magic methods summary

Properties summary

Properties inherited from AdminPageFramework_Factory_Router

$oProp

Admin Page Framework Documentation API documentation generated by ApiGen 2.8.0