1. class
  2. Civi
  3. \
  4. Api4
  5. \
  6. Setting

Setting

class Setting extends AbstractEntity

CiviCRM settings api.

Used to read/write persistent setting data from CiviCRM.

Methods

static GetActions
getActions()

No description

from AbstractEntity
static 
getFields()

Should return \Civi\Api4\Generic\BasicGetFieldsAction

static array
permissions()

Returns a list of permissions needed to access the various actions in this api.

from AbstractEntity
static string
getEntityName()

Get entity name from called class

from AbstractEntity
static AbstractAction
__callStatic(string $action, null $args)

Magic method to return the action object for an api.

from AbstractEntity
static 
get()

No description

static 
set()

No description

static 
revert()

No description

Details

in AbstractEntity at line 66
static GetActions getActions()

Return Value

GetActions

at line 61
static getFields()

Should return \Civi\Api4\Generic\BasicGetFieldsAction

Exceptions

NotImplementedException

in AbstractEntity at line 84
static array permissions()

Returns a list of permissions needed to access the various actions in this api.

Return Value

array

in AbstractEntity at line 99
static protected string getEntityName()

Get entity name from called class

Return Value

string

in AbstractEntity at line 111
static AbstractAction __callStatic(string $action, null $args)

Magic method to return the action object for an api.

Parameters

string $action
null $args

Return Value

AbstractAction

Exceptions

NotImplementedException

at line 49
static get()

at line 53
static set()

at line 57
static revert()