FormComments extends Element
in package
Uses ElementTrait

This is the 'FormComments' class, a DTO class for the form configuration data.

The items stored in this class will remain immutable (only get methods are available).
This class extends SDK\Core\Dtos\Element, see this class.

Tags
see
FormComments::getMinRatingAmount()
see
FormComments::getMaxRatingAmount()
see
FormComments::getUserFields()
see
FormComments::getDefaultRatingAmount()
see
FormComments::getCommentFieldRequired()
see
FormComments::getRatingsAllowed()
see
FormComments::getFormClass()
see
FormComments::getAnonymousRatingEnabled()
see
FormComments::getCaptchaEnabled()
see
FormComments::getIpStrictEnabled()
see
Element
see
ElementTrait

Table of Contents

ANONYMOUS_RATING_ENABLED  = 'anonymousRatingEnabled'
CAPTCHA_ENABLED  = 'captchaEnabled'
COMMENT_FIELD_REQUIRED  = 'commentFieldRequired'
DEFAULT_RATING_AMOUNT  = 'defaultRatingAmount'
FORM_CLASS  = 'formClass'
IP_STRICT_ENABLED  = 'ipStrictEnabled'
MAX_RATING_AMOUNT  = 'maxRatingAmount'
MIN_RATING_AMOUNT  = 'minRatingAmount'
RATINGS_ALLOWED  = 'ratingsAllowed'
getAnonymousRatingEnabled() This method returns if the rating is enabled for anonymous users .  : bool
getCaptchaEnabled() This method returns if is required the captcha.  : bool
getCommentFieldRequired() This method returns if the comment filed is required.  : bool
getDefaultRatingAmount() This method returns the default rating amount.  : int
getFormClass() This method returns the class to set in the comment form.  : string
getIpStrictEnabled() This method returns if the ip strict is enabled.  : bool
getMaxRatingAmount() This method returns the maximum rating amount.  : int
getMinRatingAmount() This method returns the minimum rating amount.  : int
getRatingsAllowed() This method returns the number of ratings allowed by user.  : int

Constants

ANONYMOUS_RATING_ENABLED

public mixed ANONYMOUS_RATING_ENABLED = 'anonymousRatingEnabled'

CAPTCHA_ENABLED

public mixed CAPTCHA_ENABLED = 'captchaEnabled'

COMMENT_FIELD_REQUIRED

public mixed COMMENT_FIELD_REQUIRED = 'commentFieldRequired'

DEFAULT_RATING_AMOUNT

public mixed DEFAULT_RATING_AMOUNT = 'defaultRatingAmount'

IP_STRICT_ENABLED

public mixed IP_STRICT_ENABLED = 'ipStrictEnabled'

MAX_RATING_AMOUNT

public mixed MAX_RATING_AMOUNT = 'maxRatingAmount'

MIN_RATING_AMOUNT

public mixed MIN_RATING_AMOUNT = 'minRatingAmount'

RATINGS_ALLOWED

public mixed RATINGS_ALLOWED = 'ratingsAllowed'

Methods

getAnonymousRatingEnabled()

This method returns if the rating is enabled for anonymous users .

public getAnonymousRatingEnabled() : bool
Return values
bool —

getCaptchaEnabled()

This method returns if is required the captcha.

public getCaptchaEnabled() : bool
Return values
bool —

getCommentFieldRequired()

This method returns if the comment filed is required.

public getCommentFieldRequired() : bool
Return values
bool —

getDefaultRatingAmount()

This method returns the default rating amount.

public getDefaultRatingAmount() : int
Return values
int —

getFormClass()

This method returns the class to set in the comment form.

public getFormClass() : string
Return values
string —

getIpStrictEnabled()

This method returns if the ip strict is enabled.

public getIpStrictEnabled() : bool
Return values
bool —

getMaxRatingAmount()

This method returns the maximum rating amount.

public getMaxRatingAmount() : int
Return values
int —

getMinRatingAmount()

This method returns the minimum rating amount.

public getMinRatingAmount() : int
Return values
int —

getRatingsAllowed()

This method returns the number of ratings allowed by user.

public getRatingsAllowed() : int
Return values
int —

Search results