CommentRecord
extends AbstractBase
in package
implements
TranslatorAwareInterface
Uses
TranslatorAwareTrait
AJAX handler to comment on a record.
Tags
Interfaces, Classes, Traits and Enums
- TranslatorAwareInterface
- Lightweight translator aware marker interface (used as an alternative to \Laminas\I18n\Translator\TranslatorAwareInterface, which requires an excessive number of methods to be implemented).
Table of Contents
- $accountCapabilities : AccountCapabilities
- $captcha : Captcha
- $commentsService : CommentsServiceInterface
- $enabled : bool
- $ratingsService : RatingsService
- $recordLoader : Loader
- $resourcePopulator : ResourcePopulator
- $sessionSettings : Settings
- Session settings
- $translator : TranslatorInterface
- Translator
- $user : UserEntityInterface|null
- __construct() : mixed
- Constructor
- getTranslator() : TranslatorInterface
- Get translator object.
- getTranslatorLocale() : string
- Get the locale from the translator.
- handleRequest() : array<string|int, mixed>
- Handle a request.
- setTranslator() : TranslatorAwareInterface
- Set a translator
- translate() : string
- Translate a string (or string-castable object)
- translateWithPrefix() : string
- Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
- checkCaptcha() : bool
- Is CAPTCHA valid? (Also returns true if CAPTCHA is disabled).
- disableSessionWrites() : void
- Prevent session writes -- this is designed to be called prior to time- consuming AJAX operations to help reduce the odds of a timing-related bug that causes the wrong version of session data to be written to disk (see VUFIND-716 for more details).
- extractTextDomain() : array<string|int, mixed>
- Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
- formatResponse() : array<string|int, mixed>
- Format a response array.
- getDebugTranslation() : string
- Build a debug-mode translation
- sanitizeTranslationKey() : string
- Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
- translateString() : string
- Get translation for a string
Properties
$accountCapabilities
protected
AccountCapabilities
$accountCapabilities
$captcha
protected
Captcha
$captcha
$commentsService
protected
CommentsServiceInterface
$commentsService
$enabled
protected
bool
$enabled
$ratingsService
protected
RatingsService
$ratingsService
$recordLoader
protected
Loader
$recordLoader
$resourcePopulator
protected
ResourcePopulator
$resourcePopulator
$sessionSettings
Session settings
protected
Settings
$sessionSettings
= null
$translator
Translator
protected
TranslatorInterface
$translator
= null
$user
protected
UserEntityInterface|null
$user
Methods
__construct()
Constructor
public
__construct(ResourcePopulator $resourcePopulator, CommentsServiceInterface $commentsService, Captcha $captcha, UserEntityInterface|null $user, bool $enabled, Loader $recordLoader, AccountCapabilities $accountCapabilities, RatingsService $ratingsService) : mixed
Parameters
- $resourcePopulator : ResourcePopulator
-
Resource populator service
- $commentsService : CommentsServiceInterface
-
Comments database service
- $captcha : Captcha
-
Captcha controller plugin
- $user : UserEntityInterface|null
-
Logged in user (or null)
- $enabled : bool
-
Are comments enabled?
- $recordLoader : Loader
-
Record loader
- $accountCapabilities : AccountCapabilities
-
Account capabilities helper
- $ratingsService : RatingsService
-
Ratings service
Return values
mixed —getTranslator()
Get translator object.
public
getTranslator() : TranslatorInterface
Return values
TranslatorInterface —getTranslatorLocale()
Get the locale from the translator.
public
getTranslatorLocale([string $default = 'en' ]) : string
Parameters
- $default : string = 'en'
-
Default to use if translator absent.
Return values
string —handleRequest()
Handle a request.
public
handleRequest(Params $params) : array<string|int, mixed>
Parameters
- $params : Params
-
Parameter helper from controller
Return values
array<string|int, mixed> —[response data, HTTP status code]
setTranslator()
Set a translator
public
setTranslator(TranslatorInterface $translator) : TranslatorAwareInterface
Parameters
- $translator : TranslatorInterface
-
Translator
Return values
TranslatorAwareInterface —translate()
Translate a string (or string-castable object)
public
translate(string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —translateWithPrefix()
Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
public
translateWithPrefix(string $prefix, string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $prefix : string
-
Translation key prefix
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —checkCaptcha()
Is CAPTCHA valid? (Also returns true if CAPTCHA is disabled).
protected
checkCaptcha() : bool
Return values
bool —disableSessionWrites()
Prevent session writes -- this is designed to be called prior to time- consuming AJAX operations to help reduce the odds of a timing-related bug that causes the wrong version of session data to be written to disk (see VUFIND-716 for more details).
protected
disableSessionWrites() : void
Return values
void —extractTextDomain()
Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
protected
extractTextDomain(string|object|array<string|int, mixed> $target) : array<string|int, mixed>
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
Return values
array<string|int, mixed> —formatResponse()
Format a response array.
protected
formatResponse(mixed $response[, int $httpCode = null ]) : array<string|int, mixed>
Parameters
- $response : mixed
-
Response data
- $httpCode : int = null
-
HTTP status code (omit for default)
Return values
array<string|int, mixed> —getDebugTranslation()
Build a debug-mode translation
protected
getDebugTranslation(string $domain, string $str, array<string|int, mixed> $tokens) : string
Parameters
- $domain : string
-
Text domain
- $str : string
-
String to translate
- $tokens : array<string|int, mixed>
-
Tokens to inject into the translated string
Return values
string —sanitizeTranslationKey()
Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
protected
sanitizeTranslationKey(string $key) : string
Parameters
- $key : string
-
Key to sanitize
Return values
string —Sanitized key
translateString()
Get translation for a string
protected
translateString(string $rawStr[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, string $domain = 'default' ][, bool $useIcuFormatter = false ]) : string
Parameters
- $rawStr : string
-
String to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $domain : string = 'default'
-
Text domain (omit for default)
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?