Class: SleepingKingStudios::Tools::Messages::Strategy

Parent Namespace

SleepingKingStudios::Tools::Messages

Defined In

lib/sleeping_king_studios/tools/messages/strategy.rb

Table Of Contents

• Overview
• Direct Subclasses
• Instance Methods
  • call

Overview

Abstract class for converting parameterized keys to user-readable messages.

Back To Top

Direct Subclasses

SleepingKingStudios::Tools::Messages::Strategies::HashStrategy

Back To Top

Instance Methods

#call(key, parameters: {}, scope: nil, **options) => String

Generates a formatted string for the given key, parameters, and options.

Parameters

• key (String, Symbol) — the key used to resolve the message.
• parameters (Hash) — the parameters used to generate the message, such as values for a template string.
• scope (String) — the namespace for the key. Combined with the given key to generate the scoped key value.
• options (Hash) — additional options for resolving or generating the message.

Returns

• (String) — the generated template string, or a generic error string if a message is not defined for the given key and parameters.

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Tools | SleepingKingStudios::Tools::Messages