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
-
AdminPageFramework_Factory_Model
-
AdminPageFramework_Factory_View
-
AdminPageFramework_Factory_Controller
-
AdminPageFramework_Factory
-
AdminPageFramework_Widget_Router
-
AdminPageFramework_Widget_Model
-
AdminPageFramework_Widget_View
-
AdminPageFramework_Widget_Controller
Direct known subclasses
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. Examplepublic function setUp() { $this->setArguments( array( 'description' => __( 'This is a sample widget with built-in field types created by Admin Page Framework.', 'admin-page-framework-demo' ), ) ); } Since
3.2.0
Overrides |
public
|
|
public
array
|
#
enqueueStyles( array $aSRCs, array $aCustomArgs = array() )
Enqueues styles of the given sources. Parameters
Returnsarray The array holing the queued items. Since
3.2.0
|
public
string
|
#
enqueueStyle( string $sSRC, array $aCustomArgs = array() )
Enqueues a style of the given source. Parameters
Returnsstring The style handle ID. If the passed url is not a valid url string, an empty string will be returned. Since
3.2.0
|
public
array
|
#
enqueueScripts( array $aSRCs, array $aCustomArgs = array() )
Enqueues scripts by the given sources. Example$this->enqueueScripts( array( plugins_url( 'asset/js/test.js' , __FILE__ ), // source url or path plugins_url( 'asset/js/test2.js' , __FILE__ ), ) ); Parameters
Returnsarray The array holding the queued items. Since
3.2.0
|
public
string
|
#
enqueueScript( string $sSRC, array $aCustomArgs = array() )
Enqueues a script by the given source. Example$this->enqueueScript( plugins_url( 'asset/js/test.js' , __FILE__ ), // source url or path array( 'handle_id' => 'my_script', // this handle ID also is used as the object name for the translation array below. 'translation' => array( 'a' => 'hello world!', 'style_handle_id' => $sStyleHandle, // check the enqueued style handle ID here. ), ) ); Parameters
Returnsstring The script handle ID. If the passed url is not a valid url string, an empty string will be returned. Since
3.2.0
|
protected
|
#
setArguments( array $aArguments = array() )
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
Methods inherited from AdminPageFramework_Widget_Model
Methods inherited from AdminPageFramework_Widget_Router
__call()
Methods inherited from AdminPageFramework_Factory_Controller
addHelpText()
,
addSettingField()
,
addSettingFields()
,
addSettingSection()
,
addSettingSections()
,
hasFieldError()
,
hasSettingNotice()
,
setFieldErrors()
,
setSettingNotice()
Methods inherited from AdminPageFramework_Factory_View
__construct()
,
_replyToGetFieldOutput()
,
_replyToPrintSettingNotice()
Methods inherited from AdminPageFramework_Factory_Model
_getFieldErrors()
,
_isValidationErrors()
,
_loadDefaultFieldTypeDefinitions()
,
_registerFields()
,
_replyToDeleteFieldErrors()
,
_replyToSaveFieldErrors()
,
_replyToSaveNotices()
,
_setLastInput()
,
_setUp()
,
getFieldErrors()
,
getSavedOptions()
Methods inherited from AdminPageFramework_Factory_Router
__get()
,
__toString()
,
_getFormInstance()
,
_getHelpPaneInstance()
,
_getLinkInstancce()
,
_getPageLoadInfoInstance()
,
_getResourceInstance()
,
_isInThePage()
,
_isInstantiatable()
,
_replyToLoadComponents()
Magic methods summary
Properties summary
Properties inherited from AdminPageFramework_Factory_Router
$oProp