SettingsUserConfig
class SettingsUserConfig extends UserAdminConfig
Class SettingsHook
Properties
| SystemNotificationController | $mod | ||
| array | $_hook_info | Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => "" |
from BaseHook |
| protected string | $formName | from UserAdminConfig | |
| protected bool | $adminContext | If hook is used in administration this var is set to true |
from UserAdminConfig |
| protected string | $title | Title of the tab |
from UserAdminConfig |
| protected string | $iconClass | Icon Class |
from UserAdminConfig |
| protected ?int | $userId | User ID |
from UserAdminConfig |
| protected int | $tabId | Tab ID |
from UserAdminConfig |
| protected bool | $processResult | from UserAdminConfig | |
| protected array | $processMessage | from UserAdminConfig | |
| protected bool | $showInAdminContext | from UserAdminConfig |
Methods
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
Returns true if this config should be shown in admin mode
No description
No description
No description
No description
Can be used for saving/processing data. Wraps process for additional flash messages
Details
in
UserAdminConfig at line 161
protected array|mixed
getData()
No description
in
UserAdminConfig at line 22
string
getFormName()
No description
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
in
UserAdminConfig at line 72
string
getIconClass()
No description
in
BaseHook at line 88
getObject()
No description
in
BaseHook at line 97
mixed
getOption(string $key)
Returns the option with $key set in the config.yml
in
UserAdminConfig at line 154
bool
getShowInAdminContext()
Returns true if this config should be shown in admin mode
in
UserAdminConfig at line 59
string
getTitle()
No description
in
UserAdminConfig at line 137
bool
hidden()
Is Tab hidden?
at line 24
init()
No description
in
UserAdminConfig at line 37
bool
isAdminContext()
Is tab called from administration?
at line 143
bool
isAvailable()
No description
at line 33
void
process()
No description
at line 41
string
render()
No description
in
UserAdminConfig at line 124
final array|null
saveData()
Can be used for saving/processing data. Wraps process for additional flash messages
in
UserAdminConfig at line 46
void
setAdminContext(bool $adminContext)
Set if tab called from admin
in
UserAdminConfig at line 98
void
setTabId(int $tabId)
No description
in
UserAdminConfig at line 85
void
setUserId(int $userId)
No description
in
UserAdminConfig at line 141
bool
showInSidebar()
No description