Class cfDashboardMgr

cfDashboardMgr Class

Manage the dashboard groups and icons.

Package: clearFusionCMS
Copyright: Copyright (c) 2012 - 2015 clearFusionCMS. All rights reserved.
Located at system/app/cfDashboardMgr.php

Methods summary

`public`	# `__construct( flDb $db )` Construct the object. Construct the object. Parameters `$db` The database object to use.
`public boolean`	# `addGroup( string $name, integer $displayOrder, string $displayName, string $textDomain = '' )` Add a group to the dashboard. Add a group to the dashboard. Parameters `$name` The name of the group. `$displayOrder` Value used to sort the order of groups. `$displayName` The display name of the group. `$textDomain` The text domain for translations. Returns boolean true if added; else false.
`public`	# `delGroup( string $name )` Delete a dashboard group if it contains no icons. Delete a dashboard group if it contains no icons. Parameters `$name` The name of the group to delete.
`public`	# `getGroups( )` Get the list of groups. Get the list of groups. Result array Array of group id to display names.
`public array`	# `getGroupFAIcons( )` Get the Font Awesome group icons. Get the Font Awesome group icons. Returns array
`public array`	# `getGroupMDIcons( )` Get the Google Material icons for each group. Get the Google Material icons for each group. Returns array
`public integer`	# `getGroupOrder( string $grpName )` Get the group display order number. Get the group display order number. Parameters `$grpName` The name of the group to get the order of. Returns integer The order number for the group.
`public boolean`	# `setGroupOrder( string $grpName, integer $order )` Set the group display order number. Set the group display order number. Parameters `$grpName` The name of the group. `$order` The new display order for the group. Returns boolean true if the order was updated; else false.
`public boolean`	# `setGroupName( string $name, string $displayName, string $textDomain = '' )` Set the display name of a group. Set the display name of a group. Parameters `$name` The name of the group to update. `$displayName` The new display name of the group. `$textDomain` The text domain for translations. Returns boolean true if updated; else false.
`public boolean`	# `setGroupFAIcon( string $name, string $iconName )` Set the Font Awesome icon to use for the group. Set the Font Awesome icon to use for the group. Parameters `$name` The name of the group to update. `$iconName` The name of the icon to use. Returns boolean true if updated; else false.
`public boolean`	# `setGroupMDIcon( string $name, string $iconName )` Set the Google Material icon to use for the group. Set the Google Material icon to use for the group. Parameters `$name` The name of the group to update. `$iconName` The name of the icon to use. Returns boolean true if updated; else false.
`public boolean`	# `addIcon( string $grpName, string $name, string $permission, string $displayName, string $desc, string $icon, string $module, string $action, string $textDomain = '' )` Add an icon to a dashboard group. Add an icon to a dashboard group. Parameters `$grpName` The name of the grouop to add the icon to. `$name` The unique name of the icon. `$permission` The permission required to access that icon. `$displayName` The name to display with the icon. `$desc` The description of the icon function. `$icon` The location of the icon to show. `$module` The module to invoke the action on. `$action` The module action to invoke. `$textDomain` The text domain for translations. Returns boolean true if the icon was added else false.
`public`	# `delIcon( string $name )` Delete an icon, if there are no other icons in the group then the group is deleted as well. Delete an icon, if there are no other icons in the group then the group is deleted as well. Parameters `$name` The name of the icon to delete.
`public boolean`	# `setIconFile( string $name, string $file )` Set the name of the icon file. Set the name of the icon file. Parameters `$name` The name of the icon to set. `$file` The new icon file name. Returns boolean true if updated; else false.
`public boolean`	# `setIconName( string $name, string $displayName, string $textDomain = '' )` Set the display name of the icon. Set the display name of the icon. Parameters `$name` The name of the icon to set. `$displayName` The new display name of the icon. `$textDomain` The text domain for translations. Returns boolean true if updated; else false.
`public boolean`	# `setIconDesc( string $name, string $desc, string $textDomain = '' )` Set the description of the icon. Set the description of the icon. Parameters `$name` The name of the icon to set. `$desc` The new description of the icon. `$textDomain` The text domain for translations. Returns boolean true if updated; else false.
`public boolean`	# `setIconGroup( string $name, string $newGrp )` Set the group for the icon. Set the group for the icon. Parameters `$name` The name of the icon to set the group for. `$newGrp` The name of the new group for the icon. Returns boolean true if updated; else false.
`public array`	# `getIcons( string $grpName, flUser $user = null )` Get all the icons in a given group. Get all the icons in a given group. Parameters `$grpName` The name of the group to get. `$user` The user object for access control or null. If given the permission of each icon will be tested and only those that the user has permission for will be returned. Returns array The array of icons.