Kocuj Sitemap - WordPress plugin
Back to top  

Settings form (component initialization) class

access public
package kocuj_internal_lib
inherited_from \KocujIL\V12a\Classes\ComponentInitObject

 Methods

Constructor

__construct(object $projectObj) : void
access public

Parameters

$projectObj

object

\KocujIL\V12a\Classes\Project object for current project

Constructor

__construct(object $projectObj) : void
Inherited
access public

Parameters

$projectObj

object

\KocujIL\V12a\Classes\Project object for current project

Initialize actions and filters

actionsAndFilters() : void
access public
inherited_from \KocujIL\V12a\Classes\ComponentInitObject::actionsAndFilters()

Initialize actions and filters

actionsAndFilters() : void
Inherited
access public

Get if allow actions and filters in "customizer"

getAllowActionsAndFiltersInCustomizer() : boolean
Inherited
access public

Returns

booleanAllow actions and filters in "customizer" (true) or not (false)

Get object of class type from component

getComponent(string $type, integer $projectCategory = \KocujIL\V12a\Enums\ProjectCategory::CORE, string $fragment = '') : object
Inherited
access public

Parameters

$type

string

Component type

$projectCategory

integer

Component category; must be one of the following constants from \KocujIL\V12a\Enums\ProjectCategory: CORE (for "core" category), ALL (for "all" category), FRONTEND (for "frontend" category) or BACKEND (for "backend" category) - default: \KocujIL\V12a\Enums\ProjectCategory::CORE

$fragment

string

Component fragment - default: empty

Returns

objectObject of class type from component

Get errors

getErrors() : array
Inherited
access public

Returns

arrayErrors

Get object of type \KocujIL\V12a\Classes\Project

getProjectObj() : object
Inherited
access public

Returns

objectObject of type \KocujIL\V12a\Classes\Project

Get required components

getRequiredComponents() : array
Inherited
access public

Returns

arrayRequired components

Get object of class type for strings from component

getStrings(string $type, integer $projectCategory = \KocujIL\V12a\Enums\ProjectCategory::CORE) : object
Inherited
access public

Parameters

$type

string

Component type

$projectCategory

integer

Component category; must be one of the following constants from \KocujIL\V12a\Enums\ProjectCategory: CORE (for "core" category), ALL (for "all" category), FRONTEND (for "frontend" category) or BACKEND (for "backend" category) - default: \KocujIL\V12a\Enums\ProjectCategory::CORE

Returns

objectObject of class type for strings from component

 Properties

 

Allow actions and filters in "customizer" (true) or not (false)

$allowActionsAndFiltersInCustomizer : boolean

Default

false
access protected
inherited_from \KocujIL\V12a\Classes\ComponentInitObject::allowActionsAndFiltersInCustomizer
 

Allow actions and filters in "customizer" (true) or not (false)

$allowActionsAndFiltersInCustomizer : boolean

Default

true
access protected
 

Errors

$errors : array

Default

array()
access protected
 

Required components

$requiredComponents : array

Default

array('' => array(\KocujIL\V12a\Enums\ProjectCategory::ALL => array('options'), \KocujIL\V12a\Enums\ProjectCategory::BACKEND => array('message', 'settings-fields', 'settings-menu')))
access protected
inherited_from \KocujIL\V12a\Classes\ComponentInitObject::requiredComponents
 

Required components

$requiredComponents : array

Default

array()
access protected
 

\KocujIL\V12a\Classes\Project object for current project

$projectObj : object

Default

NULL
access private