UserAdminConfig
abstract class UserAdminConfig extends BaseHook implements UserAdminConfigInterface
Class UserAdminConfig
Properties
| Controller | $mod | Instance providing the hook |
from BaseHook |
| 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 | ||
| protected bool | $adminContext | If hook is used in administration this var is set to true |
|
| protected string | $title | Title of the tab |
|
| protected string | $iconClass | Icon Class |
|
| protected ?int | $userId | User ID |
|
| protected int | $tabId | Tab ID |
|
| protected bool | $processResult | ||
| protected array | $processMessage | ||
| protected bool | $showInAdminContext |
Methods
No description
No description
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, ...)
No description
Returns true if this config should be shown in admin mode
No description
Is Tab hidden?
Is tab called from administration?
Should tab be loaded and shown?
Can be used for saving/processing data. Wraps process for additional flash messages
Set if tab called from admin
No description
No description
No description
Details
at line 161
protected array|mixed
getData()
No description
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
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
at line 154
bool
getShowInAdminContext()
Returns true if this config should be shown in admin mode
at line 59
string
getTitle()
No description
at line 137
bool
hidden()
Is Tab hidden?
at line 37
bool
isAdminContext()
Is tab called from administration?
at line 116
bool
isAvailable()
Should tab be loaded and shown?
at line 124
final array|null
saveData()
Can be used for saving/processing data. Wraps process for additional flash messages
at line 46
void
setAdminContext(bool $adminContext)
Set if tab called from admin
at line 98
void
setTabId(int $tabId)
No description
at line 85
void
setUserId(int $userId)
No description
at line 141
bool
showInSidebar()
No description