Class: Delivery::QueryParameters::QueryString

Inherits:
Object
  • Object
show all
Defined in:
lib/delivery/query_parameters/query_string.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ QueryString

Returns a new instance of QueryString.



6
7
8
 
# File 'lib/delivery/query_parameters/query_string.rb', line 6

def initialize
  @params = []
end

Instance Method Details

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/delivery/query_parameters/query_string.rb', line 40

def empty?
  @params.empty?
end

#param(key) ⇒ Object 



36
37
38
 
# File 'lib/delivery/query_parameters/query_string.rb', line 36

def param(key)
  @params.select { |p| p.key.eql? key }
end

#remove_param(key) ⇒ Object 



32
33
34
 
# File 'lib/delivery/query_parameters/query_string.rb', line 32

def remove_param(key)
  @params.delete_if { |i| i.key.eql? key }
end

#set_param(param, values = '', operator = '') ⇒ Object

Adds a parameter to the query string

Parameters:

  • param (String) —

    Either a string representing the key for the parameter, or a complete ParameterBase object

  • values (String) (defaults to: '') —

    A string or array of strings representing the values for the parameter

  • operator (String) (defaults to: '') —

    Kentico Cloud filtering parameter, placed after the key, before the equal sign



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/delivery/query_parameters/query_string.rb', line 14

def set_param(param, values = '', operator = '')
  parameter_base =
    if param.is_a? String
      Delivery::QueryParameters::ParameterBase.new(
        param,
        operator,
        values
      )
    else
      param
    end
  # Ensure we have a ParameterBase object
  return unless parameter_base.respond_to? 'provide_query_string_parameter'

  remove_param parameter_base.key
  @params << parameter_base
end

#to_s ⇒ Object 



44
45
46
 
# File 'lib/delivery/query_parameters/query_string.rb', line 44

def to_s
  '?' + @params.map(&:provide_query_string_parameter).join('&')
end