Class: SleepingKingStudios::Tools::Messages::Strategies::FileStrategy

Parent Namespace

SleepingKingStudios::Tools::Messages::Strategies

Inherited Classes

SleepingKingStudios::Tools::Messages::Strategies::HashStrategy > SleepingKingStudios::Tools::Messages::Strategy > Object

Defined In

lib/sleeping_king_studios/tools/messages/strategies/file_strategy.rb

Table Of Contents

• Overview
• Defined Under Namespace
• Constructor
• Instance Attributes
  • file_name
  • templates
• Instance Methods
  • call
  • initialize

Overview

Messaging strategy that loads message templates from the given file.

Back To Top

Defined Under Namespace

Classes

FileError

Back To Top

Constructor

#initialize(file_name) => FileStrategy

Parameters

• file_name (String) — the full path to the file with the templates data.

Returns

• (FileStrategy) — a new instance of FileStrategy

Back To Top

Instance Attributes

#file_name => String (readonly)

Returns

• (String) — the full path to the file with the templates data.

#templates => Hash (readonly)

Inherited From

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

Returns

• (Hash) — the templates used to generate messages.

Back To Top

Instance Methods

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

Inherited From

SleepingKingStudios::Tools::Messages::Strategy

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 | SleepingKingStudios::Tools::Messages::Strategies