\AdminPageFramework_MetaBox_Properties

Provides the space to store the shared properties for meta boxes.

This class stores various types of values. This is used to encapsulate properties so that it helps to avoid naming conflicts.

Summary

Methods
Properties
Constants
__construct()
sortByOrder()
$strMetaBoxID
$strTitle
$arrPostTypes
$strContext
$strPriority
$strClassName
$strCapability
$arrHelpTabText
$arrHelpTabTextSide
$strDefaultStyleIE
$arrStructure_EnqueuingScriptsAndStyles
$arrEnqueuingScripts
$arrEnqueuingStyles
$intEnqueuedScriptIndex
$intEnqueuedStyleIndex
No constants found
No protected methods found
$oCaller
N/A
No private methods found
No private properties found
N/A

Properties

$strMetaBoxID

$strMetaBoxID : string

Stores the meta box id(slug).

Type

string

$strTitle

$strTitle : string

Stores the meta box title.

Type

string

$arrPostTypes

$arrPostTypes : array

Stores the post type slugs associated with the meta box.

Type

array

$strContext

$strContext : string

Stores the parameter value, context, for the add_meta_box() function.

Type

string

$strPriority

$strPriority : string

Stores the parameter value, priority, for the add_meta_box() function.

Type

string

$strClassName

$strClassName

Stores the extended class name.

$strCapability

$strCapability

Stores the capability for displayable elements.

$arrHelpTabText

$arrHelpTabText

Stores text to insert into the contextual help tab.

$arrHelpTabTextSide

$arrHelpTabTextSide

Stores text to insert into the sidebar of a contextual help tab.

$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

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