Module: Vpim::Icalendar::Property::Base

Included in:
Vevent, Vjournal, Vtodo
Defined in:
lib/vpim/property/base.rb

Overview

FIXME - rename Base to Util

Instance Method Summary collapse

Instance Method Details

#propinteger(name) ⇒ Object

:nodoc:



108
109
110
111
112
113
114
# File 'lib/vpim/property/base.rb', line 108

def propinteger(name) #:nodoc:
  prop = @properties.detect { |f| f.name? name }
  if prop
    prop = Vpim.decode_integer(prop.value)
  end
  prop
end

#proptext(name) ⇒ Object

Value as TEXT of first property with name name



141
142
143
144
145
146
147
# File 'lib/vpim/property/base.rb', line 141

def proptext(name) #:nodoc:
  prop = @properties.detect { |f| f.name? name }
  if prop
    prop = prop.to_text
  end
  prop
end

#proptextarray(name) ⇒ Object

Array of values as TEXT of all properties with name name



150
151
152
# File 'lib/vpim/property/base.rb', line 150

def proptextarray(name) #:nodoc:
  @properties.select{ |f| f.name? name }.map{ |p| p.to_text }
end

#proptextlistarray(name) ⇒ Object

Array of values as TEXT list of all properties with name name



155
156
157
# File 'lib/vpim/property/base.rb', line 155

def proptextlistarray(name) #:nodoc:
  @properties.select{ |f| f.name? name }.map{ |p| Vpim.decode_text_list(p.value_raw) }.flatten
end

#proptime(name) ⇒ Object

Value as DATE-TIME or DATE of object of first property with name name



132
133
134
135
136
137
138
# File 'lib/vpim/property/base.rb', line 132

def proptime(name) #:nodoc:
  prop = @properties.detect { |f| f.name? name }
  if prop
    prop = prop.to_time.first
  end
  prop
end

#proptoken(name, allowed, default_token = nil) ⇒ Object

:nodoc:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/vpim/property/base.rb', line 116

def proptoken(name, allowed, default_token = nil) #:nodoc:
  prop = propvalue name

  if prop
    prop = prop.to_str.upcase
    unless allowed.include?(prop)
      raise Vpim::InvalidEncodingError, "Invalid #{name} value '#{prop}'"
    end
  else
    prop = default_token
  end

  prop
end

#propvalue(name) ⇒ Object

Value of first property with name name



94
95
96
97
98
99
100
# File 'lib/vpim/property/base.rb', line 94

def propvalue(name) #:nodoc:
  prop = @properties.detect { |f| f.name? name }
  if prop
    prop = prop.value
  end
  prop
end

#propvaluearray(name) ⇒ Object

Array of values of all properties with name name



103
104
105
# File 'lib/vpim/property/base.rb', line 103

def propvaluearray(name) #:nodoc:
  @properties.select{ |f| f.name? name }.map{ |p| p.value }
end