Kocuj Sitemap - WordPress plugin
Back to top  

Backend class

access public
package kocuj_sitemap

 Methods

Action for initialization of settings pages

actionInitSettingsPages() : void
access public

Additional callback for controllers for save and restore options

controllerSaveOrRestore(object $componentObj, string $formId, boolean $isDataSet, integer $dataSetElementId, $outputText) : boolean
access public

Parameters

$componentObj

object

Component object

$formId

string

Form identifier

$isDataSet

boolean

Container is for data set

$dataSetElementId

integer

Data set element identifier if $isDataSet is set to true

$outputText

Returns

booleanController has been executed correctly (true) or not (false)

Get field - sitemap element

fieldSitemapElement(object $componentObj, string $fieldHtmlId, string $fieldHtmlName, string $fieldValue, string $fieldAttrs, string $tipText, array $classAndStyle, integer $fieldForWidget, integer $optionArray, integer $orderInWidget, array $additional) : string
access public

Parameters

$componentObj

object

Component object

$fieldHtmlId

string

Field HTML id

$fieldHtmlName

string

Field HTML name

$fieldValue

string

Field value

$fieldAttrs

string

Prepared text with field attributes "id", "name" and "title" and with space at beginning

$tipText

string

Tooltip text

$classAndStyle

array

Class and style for element; class and style data must have the following fields: "all" (string type; HTML classes with "class" tag and HTML styles with "style" tag and space before), "class" (string type; HTML classes), "classwithtag" (string type; HTML classes with "class" tag and space before), "style" (string type; HTML styles), "stylewithtag" (string type; HTML styles with "style" tag and space before)

$fieldForWidget

integer

This field is for widget or not; must be one of the following constants from KocujIL\Enums\Project\Components\Backend\SettingsFields\FieldForWidget: NO (when field is not for widget) or YES (when field is for widget)

$optionArray

integer

Option is array or standard; must be one of the following constants from KocujIL\Enums\Project\Components\Backend\SettingsFields\OptionArray: NO (when it is standard option) or YES (when it is array option)

$orderInWidget

integer

Label and HTML element order in widget; must be one of the following constants from KocujIL\Enums\Project\Components\Backend\SettingsFields\OrderInWidget: FIRST_LABEL (first label, then element), FIRST_ELEMENT (first element, then label)

$additional

array

Additional settings

Returns

stringField

Get singleton instance

getInstance() : object
Static
access public

Returns

objectSingleton instance

Display plugin form

pluginForm() : void
access public

Disable cloning of object

__clone() : void
access private

Constructor

__construct() : void
access private

 Properties

 

Administration pages data

$adminPagesData : array

Default

array()
access private
 

Singleton instance

$instance : object

Default

NULL
Static
access private