Kocuj Sitemap - WordPress plugin
Back to top  

Meta class

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

 Methods

Constructor

__construct(object $projectObj) : void
access public
inherited_from \KocujIL\V12a\Classes\ComponentObject::__construct()

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

Destructor

__destruct() : void
access public

Add or update meta

addOrUpdate(string $name, array|boolean|float|integer|string $value, integer $type = \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO) : void
access public

Parameters

$name

string

Meta name

$value

arraybooleanfloatintegerstring

Meta value

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type) - default: \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO

Clear meta

clear(integer $type = \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO) : void
access public

Parameters

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type) - default: \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO

Delete meta

delete(string $name, integer $type = \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO) : void
access public

Parameters

$name

string

Meta name

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type) - default: \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO

Force real clear entire meta data now

forceRealClearDataNow(integer $type = \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO) : void
access public

Parameters

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type) - default: \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO

Force real update of the entire meta data now

forceRealUpdateNow(integer $type = \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO) : void
access public

Parameters

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type) - default: \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO

Get meta value

get(string $name, array|boolean|float|integer|string $defaultValue = false, integer $type = \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO) : array | boolean | float | integer | string
access public

Parameters

$name

string

Meta name

$defaultValue

arraybooleanfloatintegerstring

Default meta value - default: false

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type) - default: \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO

Returns

arraybooleanfloatintegerstringMeta value

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 meta option name

getName(integer $type = \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO) : string
access public

Parameters

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type) - default: \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type::AUTO

Returns

stringMeta option name

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

Change meta type to area

changeMetaTypeToArea(integer $type) : integer
access private

Parameters

$type

integer

Meta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type)

Returns

integerArea

Get list of meta types

getMetaTypes() : array
access private

Returns

arrayMeta types list

 Properties

 

Clear meta data (true) or not (false)

$clear : boolean

Default

false
access private
 

Meta data

$data : array

Default

array()
access private
 

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

$projectObj : object

Default

NULL
access private