ScopeService
FinalYes
Table of Contents
Constants
- BIC_SCOPE_AUTOMATED_SOLUTION_PREFIX = 'automated_solution_'
- BIC_SCOPE_BIZPROC = 'bizproc'
- BIC_SCOPE_CRM = 'crm'
- BIC_SCOPE_PROFILE = 'profile'
- BIC_SCOPE_SHOP = 'shop'
- BIC_SCOPE_STORE = 'store'
- BIC_SCOPE_TASKS = 'tasks'
- BIC_SCOPE_TASKS_EFFICIENCY = 'tasks_efficiency'
- BIC_SCOPE_TASKS_FLOWS = 'tasks_flows'
- BIC_SCOPE_TASKS_FLOWS_FLOW = 'tasks_flows_flow'
- BIC_SCOPE_WORKFLOW_TEMPLATE = 'workflow_template'
Methods
- deleteAutomatedSolutionBinding() : void
- Event crm onAfterAutomatedSolutionDelete handler.
- getAutomationSolutionsTitle() : string
- Returns entity selector's item title of automation solutions.
- getDashboardListByScope() : EO_SupersetDashboard_Collection
- Returns ORM Dashboard collection by scope code.
- getDashboardScopes() : array<string|int, string>
- Get array of dashboard scopes.
- getInstance() : ScopeService
- getScopeList() : array<string|int, string>
- Get available scopes.
- getScopeName() : string
- Gets readable scope name by code.
- getScopeNameList() : array<string|int, mixed>
- Converts array of scope codes to array of readable names.
- prepareAutomatedSolutionMenuItem() : array<string|int, mixed>
- Get array of menu items to embed in top menu.
- prepareScopeMenuItem() : array<string|int, mixed>
- Get array of menu items to embed in zone top menu.
- saveDashboardScopes() : Result
- Saves scope codes of dashboard given by id.
Constants
BIC_SCOPE_AUTOMATED_SOLUTION_PREFIX
public
mixed
BIC_SCOPE_AUTOMATED_SOLUTION_PREFIX
= 'automated_solution_'
BIC_SCOPE_BIZPROC
public
mixed
BIC_SCOPE_BIZPROC
= 'bizproc'
BIC_SCOPE_CRM
public
mixed
BIC_SCOPE_CRM
= 'crm'
BIC_SCOPE_PROFILE
public
mixed
BIC_SCOPE_PROFILE
= 'profile'
BIC_SCOPE_SHOP
public
mixed
BIC_SCOPE_SHOP
= 'shop'
BIC_SCOPE_STORE
public
mixed
BIC_SCOPE_STORE
= 'store'
BIC_SCOPE_TASKS
public
mixed
BIC_SCOPE_TASKS
= 'tasks'
BIC_SCOPE_TASKS_EFFICIENCY
public
mixed
BIC_SCOPE_TASKS_EFFICIENCY
= 'tasks_efficiency'
BIC_SCOPE_TASKS_FLOWS
public
mixed
BIC_SCOPE_TASKS_FLOWS
= 'tasks_flows'
BIC_SCOPE_TASKS_FLOWS_FLOW
public
mixed
BIC_SCOPE_TASKS_FLOWS_FLOW
= 'tasks_flows_flow'
BIC_SCOPE_WORKFLOW_TEMPLATE
public
mixed
BIC_SCOPE_WORKFLOW_TEMPLATE
= 'workflow_template'
Methods
deleteAutomatedSolutionBinding()
Event crm onAfterAutomatedSolutionDelete handler.
public
static deleteAutomatedSolutionBinding(Event $event) : void
Parameters
- $event : Event
-
Event with id of automated solution that was deleted.
getAutomationSolutionsTitle()
Returns entity selector's item title of automation solutions.
public
getAutomationSolutionsTitle() : string
Return values
stringgetDashboardListByScope()
Returns ORM Dashboard collection by scope code.
public
getDashboardListByScope(string $scopeCode) : EO_SupersetDashboard_Collection
Parameters
- $scopeCode : string
-
Code of scope.
Return values
EO_SupersetDashboard_CollectiongetDashboardScopes()
Get array of dashboard scopes.
public
getDashboardScopes(int $dashboardId) : array<string|int, string>
Parameters
- $dashboardId : int
-
Dashboard id.
Return values
array<string|int, string>getInstance()
public
static getInstance() : ScopeService
Return values
ScopeServicegetScopeList()
Get available scopes.
public
getScopeList([bool $checkPermissions = true ]) : array<string|int, string>
Parameters
- $checkPermissions : bool = true
Return values
array<string|int, string>getScopeName()
Gets readable scope name by code.
public
getScopeName(string $scopeCode) : string
Parameters
- $scopeCode : string
-
Scope code.
Return values
stringgetScopeNameList()
Converts array of scope codes to array of readable names.
public
getScopeNameList(array<string|int, string> $scopeCodes) : array<string|int, mixed>
With checking automated solutions permissions. Doesn't contain scope name if user doesn't have permission to view this automated solution.
Parameters
- $scopeCodes : array<string|int, string>
-
Array with scope codes.
Return values
array<string|int, mixed>prepareAutomatedSolutionMenuItem()
Get array of menu items to embed in top menu.
public
prepareAutomatedSolutionMenuItem(string $code) : array<string|int, mixed>
Parameters
- $code : string
-
Code of CRM automated solution.
Return values
array<string|int, mixed>prepareScopeMenuItem()
Get array of menu items to embed in zone top menu.
public
prepareScopeMenuItem(string $scopeCode[, array<string|int, mixed> $urlParams = [] ]) : array<string|int, mixed>
Parameters
- $scopeCode : string
-
Code of zone where BI Builder menu item will be added.
- $urlParams : array<string|int, mixed> = []
Return values
array<string|int, mixed>saveDashboardScopes()
Saves scope codes of dashboard given by id.
public
saveDashboardScopes(int $dashboardId, array<string|int, string> $scopeCodes) : Result
Parameters
- $dashboardId : int
-
Dashboard id.
- $scopeCodes : array<string|int, string>
-
Array of stringified scope codes.