Kocuj Sitemap - WordPress plugin
Back to top  

Settings help class

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

 Methods

Constructor

__construct(object $projectObj) : void
Inherited
access public

Parameters

$projectObj

object

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

Action for adding help

actionAddHelp() : void
access public

Add help topic for settings menu

addHelpTopic(string $settingsMenuId, string $helpTopicId, string $title, string $content) : void
access public

Parameters

$settingsMenuId

string

Settings menu identifier

$helpTopicId

string

Help data identifier; must be unique

$title

string

Help title

$content

string

Help content

Check if help topic for settings menu exists

checkHelpTopic(string $settingsMenuId, string $helpTopicId) : boolean
access public

Parameters

$settingsMenuId

string

Settings menu identifier

$helpTopicId

string

Help data identifier

Returns

booleanHelp topic for settings menu exists (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 help topic for settings menu data by id

getHelpTopic(string $settingsMenuId, string $helpTopicId) : array | boolean
access public

Parameters

$settingsMenuId

string

Settings menu identifier

$helpTopicId

string

Help data identifier

Returns

arraybooleanHelp topic for settings menu data or false if not exists; help topic for settings menu data have the following fields: "content" (string type; help content), "title" (string type; help title)

Get help topics for settings menu data

getHelpTopics(string $settingsMenuId) : array
access public

Parameters

$settingsMenuId

string

Settings menu identifier

Returns

arrayHelp topics for settings menu data; each help topic for settings menu data has the following fields: "content" (string type; help content), "title" (string type; help title)

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

getProjectObj() : object
Inherited
access public

Returns

objectObject of type \KocujIL\V12a\Classes\Project

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

Remove help topic for settings menu

removeHelpTopic(string $settingsMenuId, string $helpTopicId) : void
access public

Parameters

$settingsMenuId

string

Settings menu identifier

$helpTopicId

string

Help data identifier

 Properties

 

Action for help has been added (true) or not (false)

$actionAdded : boolean

Default

false
access private
 

Help topics

$helpTopics : array

Default

array()
access private
 

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

$projectObj : object

Default

NULL
access private