Skip to content

icms_config_item_Object

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_config_item_Object

Config item

  • Class name: icms_config_item_Object
  • Namespace:
  • Parent class: icms_ipf_Object

Properties

$_confOptions

public array $_confOptions = array()

Config options

  • Visibility: public

$_isNewConfig

protected bool $_isNewConfig = \false

is it a newly created config object?

  • Visibility: protected

conf_id

public int conf_id

Item ID

  • Visibility: public

conf_modid

public int conf_modid

Module ID

  • Visibility: public

conf_catid

public int conf_catid

Category ID

  • Visibility: public

conf_name

public string conf_name

Name (used for programmers)

  • Visibility: public

conf_title

public string conf_title

Title (shown on forms)

  • Visibility: public

conf_value

public string conf_value

Value

  • Visibility: public

conf_desc

public string conf_desc

Description (shown on forms)

  • Visibility: public

conf_formtype

public string conf_formtype

What control use for displaying field on form?

  • Visibility: public

conf_valuetype

public string conf_valuetype

Type of value

  • Visibility: public

conf_order

public int conf_order

Order (used to sorting fields before displaying on form)

  • Visibility: public

Methods

__construct

mixed icms_config_item_Object::__construct(mixed handler, mixed data)

Constructor

  • Visibility: public

Arguments

  • handler mixed
  • data mixed

setNewConfig

mixed icms_config_item_Object::setNewConfig()

used for new config objects when installing/updating module(s)

  • Visibility: public

unsetNewConfig

mixed icms_config_item_Object::unsetNewConfig()
  • Visibility: public

isNewConfig

mixed icms_config_item_Object::isNewConfig()
  • Visibility: public

getConfValueForOutput

mixed icms_config_item_Object::getConfValueForOutput()
  • Visibility: public

setConfValueForInput

mixed icms_config_item_Object::setConfValueForInput(mixed value, bool force_slash)

Set a config value

  • Visibility: public

Arguments

  • value mixed
  • force_slash bool

setConfOptions

mixed icms_config_item_Object::setConfOptions(mixed option)

Assign one or more

  • Visibility: public

Arguments

  • option mixed

getConfOptions

\icms_config_Item_ObjectOption[] icms_config_item_Object::getConfOptions()

Get the options of this Config

  • Visibility: public

setType

void icms_config_item_Object::setType(string newType, mixed dummy)

This function will properly set the data type for each config item, overriding the default in the __construct method

  • Visibility: public

Arguments

  • newType string - <p>data type of the config item</p>
  • dummy mixed
Clone this wiki locally