Kocuj Sitemap - WordPress plugin
Back to top  

Home type class

access public
package kocuj_sitemap
inherited_from \KocujSitemapPlugin\Classes\ElementTypeFrontendParent

 Methods

Check if this type is configurable in order

checkConfigurableOrder() : boolean
access public
inherited_from \KocujSitemapPlugin\Classes\ElementTypeFrontendParent::checkConfigurableOrder()

Returns

booleanThis type is configurable in order (true) or not (false)

Check if this type is configurable in order

checkConfigurableOrder() : boolean
Inherited
access public

Returns

booleanThis type is configurable in order (true) or not (false)

Check if there are exclude parameters (true) or not (false)

checkExcludeParameters() : boolean
access public
inherited_from \KocujSitemapPlugin\Classes\ElementTypeFrontendParent::checkExcludeParameters()

Returns

booleanThere are exclude parameters (true) or not (false)

Check if there are exclude parameters (true) or not (false)

checkExcludeParameters() : boolean
Inherited
access public

Returns

booleanThere are exclude parameters (true) or not (false)

Check if this type exists

checkExists() : boolean
Inherited
access public

Returns

booleanThis type exists (true) or not (false)

Check if this type should be displayed for this display type

checkForDisplay(integer $display) : boolean
Inherited
access public

Parameters

$display

integer

Display type; must be one of the following constants from \KocujSitemapPlugin\Enums\DisplayType: STANDARD (when it is standard display) or DROPDOWN (when it is drop-down list display)

Returns

booleanThis type should be displayed (true) or not (false)

Check if there should be an "ul" list tag

checkListTag() : boolean
Inherited
access public

Returns

booleanThere should be an "ul" list tag (true) or not (false)

Check section name

checkSectionName() : boolean
access public
inherited_from \KocujSitemapPlugin\Classes\ElementTypeFrontendParent::checkSectionName()

Returns

booleanSection name exists (true) or not (false)

Check section name

checkSectionName() : boolean
Inherited
access public

Returns

booleanSection name exists (true) or not (false)

Get text after element

getAfterElement(array $element, integer $widget = \KocujSitemapPlugin\Enums\Widget::NO, string $locale = '') : array
Inherited
access public

Parameters

$element

array

Element

$widget

integer

It is widget or not; must be one of the following constants from \KocujSitemapPlugin\Enums\Widget: NO (when it is not widget) or YES (when it is widget) - default: \KocujSitemapPlugin\Enums\Widget::NO

$locale

string

Language locale - default: empty

Returns

arrayText after element

Get text before element

getBeforeElement(array $element, integer $widget = \KocujSitemapPlugin\Enums\Widget::NO, string $locale = '') : array
Inherited
access public

Parameters

$element

array

Element

$widget

integer

It is widget or not; must be one of the following constants from \KocujSitemapPlugin\Enums\Widget: NO (when it is not widget) or YES (when it is widget) - default: \KocujSitemapPlugin\Enums\Widget::NO

$locale

string

Language locale - default: empty

Returns

arrayText before element

Get configuration options

getConfigOptions() : array
Inherited
access public

Returns

arrayConfiguration options

Get exclude parameters suffixes

getExcludeParametersSuffixes() : array
Inherited
access public

Returns

arrayExclude parameters suffixes

Get hide type parameters description

getHideTypeParameterDescription() : string
access public
inherited_from \KocujSitemapPlugin\Classes\ElementTypeFrontendParent::getHideTypeParameterDescription()

Returns

stringHide parameters type description

Get hide type parameters description

getHideTypeParameterDescription() : string
Inherited
access public

Returns

stringHide parameters type description

Get hide type parameters value

getHideTypeParameterValue() : string
access public
inherited_from \KocujSitemapPlugin\Classes\ElementTypeFrontendParent::getHideTypeParameterValue()

Returns

stringHide parameters type value

Get hide type parameters value

getHideTypeParameterValue() : string
Inherited
access public

Returns

stringHide parameters type value

Get ID to check

getIDToCheck(array $element, string $section) : integer
Inherited
access public

Parameters

$element

array

Element

$section

string

Section name

Returns

integerID to check

Get section name

getSectionName() : string
Inherited
access public

Returns

stringSection name

Get sections to check

getSectionsToCheck(array $element) : array
Inherited
access public

Parameters

$element

array

Element

Returns

arraySections to check

Get type letter

getTypeLetter() : string
access public
inherited_from \KocujSitemapPlugin\Classes\ElementTypeFrontendParent::getTypeLetter()

Returns

stringType letter

Get type letter

getTypeLetter() : string
Inherited
access public

Returns

stringType letter

Get types which should be removed when they have no children

getTypesRequiresChildren() : array
Inherited
access public

Returns

arrayTypes which should be removed when they have no children