module Wpxf::OutputEmitters

Provides methods for emitting events that should output information to the user interface of the calling application.

Public Instance Methods

emit_error(message, verbose = false) click to toggle source

Emit an error event. @param message [String] the message to output. @param verbose [Boolean] the verbose level flag.

# File lib/wpxf/core/output_emitters.rb, line 46
def emit_error(message, verbose = false)
  event_emitter.emit(
    event: :output,
    verbose: verbose,
    type: :error,
    msg: message
  )
end
emit_info(message, verbose = false) click to toggle source

Emit a general info event. @param message [String] the message to output. @param verbose [Boolean] the verbose level flag.

# File lib/wpxf/core/output_emitters.rb, line 22
def emit_info(message, verbose = false)
  event_emitter.emit(
    event: :output,
    verbose: verbose,
    type: :info,
    msg: message
  )
end
emit_success(message, verbose = false) click to toggle source

Emit a successful operation event. @param message [String] the message to output. @param verbose [Boolean] the verbose level flag.

# File lib/wpxf/core/output_emitters.rb, line 10
def emit_success(message, verbose = false)
  event_emitter.emit(
    event: :output,
    verbose: verbose,
    type: :success,
    msg: message
  )
end
emit_table(rows, verbose = false) click to toggle source

Emit an event containing tabular data. @param rows [Array] an array of hashes containing the row data. @param verbose [Boolean] the verbose level flag.

# File lib/wpxf/core/output_emitters.rb, line 58
def emit_table(rows, verbose = false)
  event_emitter.emit(
    event: :output,
    verbose: verbose,
    type: :table,
    rows: rows
  )
end
emit_warning(message, verbose = false) click to toggle source

Emit a warning event. @param message [String] the message to output. @param verbose [Boolean] the verbose level flag.

# File lib/wpxf/core/output_emitters.rb, line 34
def emit_warning(message, verbose = false)
  event_emitter.emit(
    event: :output,
    verbose: verbose,
    type: :warning,
    msg: message
  )
end