Properties

$strClassName

$strClassName

Stores framework's instantiated object name.

$strClassHash

$strClassHash

Stores the md5 hash string of framework's instantiated object name.

$strCapability

$strCapability

Stores the access level to the root page.

When sub pages are added and the capability value is not provided, this will be applied.

$strPageHeadingTabTag

$strPageHeadingTabTag

Stores the tag for the page heading navigation bar.

$strInPageTabTag

$strInPageTabTag

Stores the tag for the in-page tab navigation bar.

$strDefaultPageSlug

$strDefaultPageSlug

Stores the default page slug.

$arrPages

$arrPages

A two-dimensional array storing registering sub-menu(page) item information with keys of the page slug.

$arrHiddenPages

$arrHiddenPages

Stores the hidden page slugs.

$arrRegisteredSubMenuPages

$arrRegisteredSubMenuPages

Stores the registered sub menu pages.

Unlike the above $arrPages that holds the pages to be added, this stores the added pages. This is referred when adding a help section.

$arrRootMenu

$arrRootMenu

Stores the root menu item information for one set root menu item.

$arrInPageTabs

$arrInPageTabs

Stores in-page tabs.

$arrDefaultInPageTabs

$arrDefaultInPageTabs

Stores the default in-page tab.

$arrPluginDescriptionLinks

$arrPluginDescriptionLinks

Stores link text that is scheduled to be embedded in the plugin listing table's description column cell.

$arrPluginTitleLinks

$arrPluginTitleLinks

Stores link text that is scheduled to be embedded in the plugin listing table's title column cell.

$arrFooterInfo

$arrFooterInfo

Stores the information to insert into the page footer.

$strOptionKey

$strOptionKey

The instantiated class name will be assigned in the constructor if the first parameter is not set.

$arrSections

$arrSections

Stores form sections.

$arrFields

$arrFields

Stores form fields

$arrHelpTabs

$arrHelpTabs

Stores contextual help tabs.

$strFormEncType

$strFormEncType

Set one of the followings: application/x-www-form-urlencoded, multipart/form-data, text/plain

$fEnableForm

$fEnableForm

Decides whether the setting form tag is rendered or not.

This will be enabled when a settings section and a field is added.

$fShowPageTitle

$fShowPageTitle

Indicates whether the page title should be displayed.

$fShowPageHeadingTabs

$fShowPageHeadingTabs

Indicates whether the page heading tabs should be displayed.

$fShowInPageTabs

$fShowInPageTabs

Indicates whether the in-page tabs should be displayed.

This sets globally among the script using the framework.

$arrAdminNotices

$arrAdminNotices

Stores the set administration notices.

The index number will be incremented as a script is enqueued regardless a previously added enqueue item has been removed or not. This is because this index number will be used for the style handle ID which is automatically generated.

$arrDisallowedQueryKeys

$arrDisallowedQueryKeys

Stores the disallowed query keys in the links generated by the main class of the framework.

$strDefaultStyleIE

$strDefaultStyleIE

The default CSS rules for IE loaded in the head tag of the created admin pages.

$arrStructure_EnqueuingScriptsAndStyles

$arrStructure_EnqueuingScriptsAndStyles

Represents the structure of the array for enqueuing scripts and styles.

$arrEnqueuingScripts

$arrEnqueuingScripts

Stores enqueuing script URLs and their criteria.

$arrEnqueuingStyles

$arrEnqueuingStyles

Stores enqueuing style URLs and their criteria.

$intEnqueuedScriptIndex

$intEnqueuedScriptIndex

Stores the index of enqueued scripts.

$intEnqueuedStyleIndex

$intEnqueuedStyleIndex

Stores the index of enqueued styles.

The index number will be incremented as a script is enqueued regardless a previously added enqueue item has been removed or not. This is because this index number will be used for the script handle ID which is automatically generated.

$oCaller

$oCaller

Stores the main (caller) object.

Methods

__construct()

__construct( $oCaller)

Parameters

$oCaller

__get()

__get( $strName)

Parameters

$strName

isPageAdded()

isPageAdded( $strPageSlug) : boolean

Checks if the given page slug is one of the pages added by the framework.

Parameters

$strPageSlug

Returns

boolean —

Returns true if it is of framework's added page; otherwise, false.

getOptions()

getOptions()

getCapability()

getCapability()

sortByOrder()

sortByOrder( $a,  $b) : integer

Calculates the subtraction of two values with the array key of <em>numOrder</em>

This is used to sort arrays.

Parameters

$a
$b

Returns

integer