SheaDawson\Rateable\Extensions\Likeable
Synopsis
class Likeable
extends Rateable
{
- // members
- private static integer $rateable_rating_max = 1;
- private static boolean $rateable_can_change_rating = true;
- private static array $rateable_templates = ;
- // Inherited members from Rateable
- public RateableService $rateableService;
- // Inherited methods from Rateable
- public static array get_extra_config()
- public void updateSettingsFields()
- public void updateCMSFields()
- public Int getAverageScore()
- public ArrayList getRatingOptions()
- public int getNumberOfRatings()
- public int getMaxRating()
- public Boolean UserHasRated()
- public String RateableUI()
- public String getRatingHTMLID()
- public String getRatingCSSClass()
- public Boolean checkRatingsEnabled()
- public boolean canChangeRating()
- public String RatePath()
Hierarchy
Members
private
-
$rateable_can_change_rating
{@inheritdoc} -
$rateable_rating_max
{@inheritdoc} -
$rateable_templates
{@inheritdoc}
public
- $rateableService — SheaDawson\Rateable\Services\RateableService
Methods
Inherited from SheaDawson\Rateable\Extensions\Rateable
public
- RatePath() — return the url path for rating this object
- RateableUI() — returns the JS and HTML required for the star rating UI
- UserHasRated() — checks to see if the current user has rated this object by checking against the rating SessionID and MemberID
- canChangeRating() — Check whether the user can take back a rating or not.
- checkRatingsEnabled() — Checks whether ratings should be enabled on this object
- getAverageScore() — gets the average rating score
- getMaxRating() — Get the maximum rating
- getNumberOfRatings() — gets the number of ratings
- getRatingCSSClass() — returns a string to be used in the RatableUI's css class attribute
- getRatingHTMLID() — returns a unique HTML ID for each RateableUI div
- getRatingOptions() — Get the available ratings.
- get_extra_config() — Setting up DB / has_one / defaults with "get_extra_config" allows you to extend an extension class without breaking the $db configs.
- updateCMSFields()
- updateSettingsFields()