Interface lispa\amos\dashboard\interfaces\SubDashboardInterface

Interface CommunityContextInterface

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getAdditionalAssociationTargetQuery() Active query to search the users to associate in the additional association page lispa\amos\dashboard\interfaces\SubDashboardInterface
getBaseRole() The name of the basic member role lispa\amos\dashboard\interfaces\SubDashboardInterface
getCommunityModel() The community created by the context model (community related to project-management, events or a community itself) lispa\amos\dashboard\interfaces\SubDashboardInterface
getManagerRole() The name of the greatest role a member can have lispa\amos\dashboard\interfaces\SubDashboardInterface
getNextRole() Array containing the next level for a given initial role lispa\amos\dashboard\interfaces\SubDashboardInterface
getPluginController() For m2m widget actions: return the plugin controller name to construct redirect URL lispa\amos\dashboard\interfaces\SubDashboardInterface
getPluginModule() For m2m widget actions: return the plugin module name to construct redirect URL lispa\amos\dashboard\interfaces\SubDashboardInterface
getRedirectAction() For m2m widget actions: return the controller action name to construct redirect URL lispa\amos\dashboard\interfaces\SubDashboardInterface
getRolePermissions() Array containing user permission for a given role lispa\amos\dashboard\interfaces\SubDashboardInterface
setModuleSubDashboard() Array containing the classname of the widget to be present in the sub-dashboard lispa\amos\dashboard\interfaces\SubDashboardInterface

Method Details

getAdditionalAssociationTargetQuery() public abstract method

Active query to search the users to associate in the additional association page

public abstract yii\db\ActiveQuery getAdditionalAssociationTargetQuery ( $communityId )
$communityId integer

Id of the community created by the context model

getBaseRole() public abstract method

The name of the basic member role

public abstract string getBaseRole ( )
getCommunityModel() public abstract method

The community created by the context model (community related to project-management, events or a community itself)

public abstract \lispa\amos\dashboard\interfaces\Community getCommunityModel ( )
getManagerRole() public abstract method

The name of the greatest role a member can have

public abstract string getManagerRole ( )
getNextRole() public abstract method

Array containing the next level for a given initial role

public abstract string getNextRole ( $role )
$role string
getPluginController() public abstract method

For m2m widget actions: return the plugin controller name to construct redirect URL

public abstract string getPluginController ( )
getPluginModule() public abstract method

For m2m widget actions: return the plugin module name to construct redirect URL

public abstract string getPluginModule ( )
getRedirectAction() public abstract method

For m2m widget actions: return the controller action name to construct redirect URL

public abstract string getRedirectAction ( )
getRolePermissions() public abstract method

Array containing user permission for a given role

public abstract array getRolePermissions ( $role )
$role string
setModuleSubDashboard() public abstract method

Array containing the classname of the widget to be present in the sub-dashboard

public abstract void setModuleSubDashboard ( $config )
$config array