Kocuj Sitemap - WordPress plugin
Back to top  

Project helper 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

Apply filters

applyFilters(string $filterName, string $additionalFilterName = '', string $filterSuffix = '', array|boolean|float|integer|string $value = '') : string
access public

Parameters

$filterName

string

Filter name

$additionalFilterName

string

Additional filter name - default: empty

$filterSuffix

string

Filter suffix - default: empty

$value

arraybooleanfloatintegerstring

Default value for filter - default: empty string

Returns

stringOutput for filters

Apply filters for HTML style and class

applyFiltersForHTMLStyleAndClass(string $filterName, string $additionalFilterName = '', array $attr = array()) : string
access public

Parameters

$filterName

string

Filter name; it will be used for applying filters "kocujilv12a_PROJECT_INTERNALNAME$filterName_class" (CSS class) and "kocujilv12a_PROJECT_INTERNALNAME$filterName_style" (CSS style)

$additionalFilterName

string

Additional filter name; it will be used for applying additional filters "kocujilv12a_PROJECT_INTERNALNAME$additionalFilterName_class" (CSS class) and "kocujilv12a_PROJECT_INTERNALNAME$additionalFilterName_style" (CSS style) - default: empty

$attr

array

Additional attributes; there are available the following attributes: "defaultclass" (string type; default value for class filter), "defaultstyle" (string type; default value for style filter)

Returns

stringOutput for filters

Do actions

doAction(string $actionName, string $additionalActionName = '', array $attr = array()) : void
access public

Parameters

$actionName

string

Action name

$additionalActionName

string

Additional action name - default: empty

$attr

array

Additional attributes; there are available the following attributes: "actionsuffix" (string type; suffix for actions) - default: empty

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 prefix with project internal name for some names in library

getPrefix() : string
access public

Returns

stringPrefix

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

Get filter or action name

getFilterOrActionName(string $filterOrActionName, string $filterOrActionSuffix = '') : string
access private

Parameters

$filterOrActionName

string

Filter or action name

$filterOrActionSuffix

string

Filter suffix - default: empty

Returns

stringFilter or action name

 Properties

 

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

$projectObj : object

Default

NULL
access private