Class WWW::Mechanize::Form
In: lib/mechanize/form.rb
Parent: GlobalForm
Mechanize\n[lib/mechanize.rb\nlib/mechanize/cookie.rb\nlib/mechanize/errors.rb\nlib/mechanize/form.rb\nlib/mechanize/form_elements.rb\nlib/mechanize/history.rb\nlib/mechanize/list.rb\nlib/mechanize/page.rb\nlib/mechanize/page_elements.rb\nlib/mechanize/pluggable_parsers.rb] lib/mechanize.rb WWW dot/m_19_0.png

Synopsis

This class encapsulates a form parsed out of an HTML page. Each type of input fields available in a form can be accessed through this object. See GlobalForm for more methods.

Example

Find a form and print out its fields 

 form = page.forms.first # => WWW::Mechanize::Form
 form.fields.each { |f| puts f.name }

Set the input field ‘name’ to "Aaron" 

 form['name'] = 'Aaron'
 puts form['name']

Methods

[]   []=   add_field!   field   has_field?   has_key?   has_value?   keys   method_missing   new   set_fields   submit   values  

Attributes

node  [R] 
page  [R] 

Public Class methods

new(node, mech=nil, page=nil)

[Source]

     # File lib/mechanize/form.rb, line 222
222:       def initialize(node, mech=nil, page=nil)
223:         super(node, node)
224:         @page = page
225:         @mech = mech
226:       end

Public Instance methods

[](field_name)

Fetch the value of the first input field with the name passed in

Example

Fetch the value set in the input field ‘name‘ 

 puts form['name']

[Source]

     # File lib/mechanize/form.rb, line 277
277:       def [](field_name)
278:         f = field(field_name)
279:         f && f.value
280:       end
[]=(field_name, value)

Set the value of the first input field with the name passed in

Example

Set the value in the input field ‘name’ to "Aaron" 

 form['name'] = 'Aaron'

[Source]

     # File lib/mechanize/form.rb, line 286
286:       def []=(field_name, value)
287:         f = field(field_name)
288:         if f.nil?
289:           add_field!(field_name, value)
290:         else
291:           f.value = value
292:         end
293:       end
add_field!(field_name, value = nil)

Add a field with field_name and value

[Source]

     # File lib/mechanize/form.rb, line 249
249:       def add_field!(field_name, value = nil)
250:         fields << WWW::Mechanize::Field.new(field_name, value)
251:       end
field(field_name)

Fetch the first field whose name is equal to field_name

[Source]

     # File lib/mechanize/form.rb, line 244
244:       def field(field_name)
245:         fields.find { |f| f.name.eql? field_name }
246:       end
has_field?(field_name)

Returns whether or not the form contains a field with field_name

[Source]

     # File lib/mechanize/form.rb, line 229
229:       def has_field?(field_name)
230:         ! fields.find { |f| f.name.eql? field_name }.nil?
231:       end
has_key?(field_name)

Alias for has_field?

has_value?(value)

[Source]

     # File lib/mechanize/form.rb, line 235
235:       def has_value?(value)
236:         ! fields.find { |f| f.value.eql? value }.nil?
237:       end
keys()

[Source]

     # File lib/mechanize/form.rb, line 239
239:       def keys; fields.map { |f| f.name }; end
method_missing(id,*args)

Treat form fields like accessors.

[Source]

     # File lib/mechanize/form.rb, line 296
296:       def method_missing(id,*args)
297:         method = id.to_s.gsub(/=$/, '')
298:         if field(method)
299:           return field(method).value if args.empty?
300:           return field(method).value = args[0]
301:         end
302:         super
303:       end
set_fields(fields = {})

This method sets multiple fields on the form. It takes a list of field name, value pairs. If there is more than one field found with the same name, this method will set the first one found. If you want to set the value of a duplicate field, use a value which is an Array with the second value of the array as the index in to the form. The index is zero based. For example, to set the second field named ‘foo’, you could do the following: 

 form.set_fields( :foo => ['bar', 1] )

[Source]

     # File lib/mechanize/form.rb, line 261
261:       def set_fields(fields = {})
262:         fields.each do |k,v|
263:           value = nil
264:           index = 0
265:           v.each do |val|
266:             index = val.to_i unless value.nil?
267:             value = val if value.nil?
268:           end
269:           self.fields.name(k.to_s).[](index).value = value
270:         end
271:       end
submit(button=nil)

Submit this form with the button passed in

[Source]

     # File lib/mechanize/form.rb, line 306
306:       def submit(button=nil)
307:         @mech.submit(self, button)
308:       end
values()

[Source]

     # File lib/mechanize/form.rb, line 241
241:       def values; fields.map { |f| f.value }; end

[Validate]