CSDashboardTileCategory
in package
This class is part of the Dashboard module. It is used to read categories from the tile.
It handle the category and tile mapping also.
Tags
Table of Contents
- $_oCategoryRecord : mixed
- addMappingForTile() : int
- This method adds tile-category mapping for particular tile, user and category.
- delete() : mixed
- This method deletes the current tile category from the database.
- deleteCategoriesForTile() : void
- This method is used to delete all existing tile categories for any tile.
- deleteMappingForTile() : mixed
- This method deletes tile-category mapping for particular tile.
- deleteTileCategory() : void
- This method is used to delete an existing tile categories.
- getCategoriesForTile() : string
- This method is used to get an existing tile categories.
- getCategory() : CSDashboardTileCategory
- This method is used to get an existing tile category.
- getCategoryForValue() : CSDashboardTileCategory
- This method is used to get an existing tile category object for particular value.
- getID() : int
- This method is used to get an id of tile category.
- getValue() : string
- This method is used to return the value of the tile category.
- isMappingAvailableForCategory() : int
- This method checks whether tile-category mapping is available for particular category or not.
- isUserCategoryAvailableForAdminTile() : bool
- This method checks whether user specific categories are available for admin tile.
- setCategoriesForTile() : mixed
- This method is used to set value of tile categories.
- setValue() : mixed
- This method is used set value of the tile category.
Properties
$_oCategoryRecord
public
mixed
$_oCategoryRecord
= \null
Tags
Methods
addMappingForTile()
This method adds tile-category mapping for particular tile, user and category.
public
static addMappingForTile(int $iTileID, int $iCategoryId, int $iUserId) : int
Parameters
- $iTileID : int
-
the id of the tile for which mapping is added
- $iCategoryId : int
-
the id of the tile category
- $iUserId : int
-
the user id of the tile
Tags
Return values
int —id of mapping class if found
delete()
This method deletes the current tile category from the database.
public
delete() : mixed
Tags
Return values
mixed —deleteCategoriesForTile()
This method is used to delete all existing tile categories for any tile.
public
static deleteCategoriesForTile(int $iTileID, int $iUserId) : void
Parameters
- $iTileID : int
-
the id of the tile
- $iUserId : int
-
the user id of the tile
Tags
Return values
void —deleteMappingForTile()
This method deletes tile-category mapping for particular tile.
public
static deleteMappingForTile(int $iTileID, int $iUserId) : mixed
Parameters
- $iTileID : int
-
the id of the tile
- $iUserId : int
-
the user id of the tile
Tags
Return values
mixed —deleteTileCategory()
This method is used to delete an existing tile categories.
public
static deleteTileCategory(int $iCategoryId) : void
Parameters
- $iCategoryId : int
-
the id of the tile category
Tags
Return values
void —getCategoriesForTile()
This method is used to get an existing tile categories.
public
static getCategoriesForTile(int $iTileID, int $iUserId[, bool $bGetTranslatedValue = true ]) : string
Parameters
- $iTileID : int
-
the id of the tile category
- $iUserId : int
-
the user id
- $bGetTranslatedValue : bool = true
-
should value returned is translated or not
Tags
Return values
string —concatenated string of tile categories seperated by ','
getCategory()
This method is used to get an existing tile category.
public
static getCategory(int $iTileCategoryId) : CSDashboardTileCategory
Parameters
- $iTileCategoryId : int
-
the id of the tile category
Tags
Return values
CSDashboardTileCategory —a object of the requested tile parameter
getCategoryForValue()
This method is used to get an existing tile category object for particular value.
public
static getCategoryForValue(string $sCategory) : CSDashboardTileCategory
Parameters
- $sCategory : string
-
the value of category
Tags
Return values
CSDashboardTileCategory —object of the requested tile category if found otherwise null
getID()
This method is used to get an id of tile category.
public
getID() : int
Tags
Return values
int —CategoryID if found
getValue()
This method is used to return the value of the tile category.
public
getValue() : string
Tags
Return values
string —isMappingAvailableForCategory()
This method checks whether tile-category mapping is available for particular category or not.
public
static isMappingAvailableForCategory(int $iCategoryId) : int
Parameters
- $iCategoryId : int
-
the id of the tile category
Tags
Return values
int —id of mapping class if found
isUserCategoryAvailableForAdminTile()
This method checks whether user specific categories are available for admin tile.
public
static isUserCategoryAvailableForAdminTile(int $iTileID) : bool
Parameters
- $iTileID : int
-
the id of the tile category
Tags
Return values
bool —setCategoriesForTile()
This method is used to set value of tile categories.
public
static setCategoriesForTile(string $sCategory, int $iTileID, int $iUserId) : mixed
Parameters
- $sCategory : string
-
concatenated string of tile categories seperated by ','
- $iTileID : int
-
the id of the tile category
- $iUserId : int
-
the user id
Tags
Return values
mixed —setValue()
This method is used set value of the tile category.
public
setValue(string $sCategory) : mixed
Parameters
- $sCategory : string
-
the value of category