SmileyFavorites Class Reference
Collaboration diagram for SmileyFavorites:
Public Member Functions | |
| __construct ($user_id) | |
| get () | |
| set ($favorites=[]) | |
| contain ($smiley_id) | |
| toggle ($smiley_id, $favorite=null) | |
Static Public Member Functions | |
| static | isEnabled () |
| static | getUsage () |
| static | gc () |
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | $user_id | ) |
Initializes an user's favorites
- Parameters
-
String $user_id Id of the user
Here is the call graph for this function:
Member Function Documentation
◆ contain()
| contain | ( | $smiley_id | ) |
Returns whether the smiley with the given id is favored by the user.
- Parameters
-
int $smiley_id Id of the smiley
- Returns
- bool True if the smiley is favored by the user, false otherwise
Here is the caller graph for this function:
◆ gc()
|
static |
Garbage collector. Removes all smiley ids from the users' favorites that are no longer in the database.
- Returns
- int Number of changed records
Here is the call graph for this function:
Here is the caller graph for this function:
◆ get()
| get | ( | ) |
Returns the user's favored smileys' ids.
- Returns
- Array Ids of the smileys the user has vaored
◆ getUsage()
|
static |
Returns a list of how often a smiley has been favored.
- Returns
- Array Associative array with smiley name as key and according favored numbers as value
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isEnabled()
|
static |
Returns whether the ability to favor smiley is enabled.
- Returns
- bool
Here is the call graph for this function:
Here is the caller graph for this function:
◆ set()
| set | ( | $favorites = [] | ) |
Updates the user's favored smileys.
- Parameters
-
Array $favorites Ids of the user's favored smileys
Here is the call graph for this function:
◆ toggle()
| toggle | ( | $smiley_id, | |
$favorite = null |
|||
| ) |
Toggles whether a smiley is favored by the user. You can either provide an acutal state or omit the state to toggle the current state.
- Parameters
-
int $smiley_id Id of the smiley to favor/disfavor mixed $favorite Either a boolean state or null to toggle current state
- Returns
- bool True if the smiley is favored by the user, false otherwise
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- app/models/smiley_favorites.php
