Weather::Com::Finder - finder class to search for I location's


Weather-Com documentation  | view source Contained in the Weather-Com distribution.

Index


NAME

Top

Weather::Com::Finder - finder class to search for weather.com location's

SYNOPSIS

Top

  #!/usr/bin/perl -w
  use Weather::Com::Finder;

  # you have to fill in your ids from weather.com here
  my $PartnerId  = 'somepartnerid';
  my $LicenseKey = 'mylicense';

  my %weatherargs = (
	'partner_id' => $PartnerId,
	'license'    => $LicenseKey,
  );

  my $finder = Weather::Com::Finder->new(%weatherargs);

  # if you want an array of locations:
  my @locations = $finder->find('Heidelberg');

  # or if you prefer an arrayref:
  my $locations = $finder->find('Heidelberg');

  foreach my $location (@locations) {
    print "Found weather for city: ", $location->name(), "\n";
    print "Current Conditions are ", 
      $location->current_conditions()->description(), "\n";
  }

DESCRIPTION

Top

The usual way to use the Weather::Com module would be to instantiate a Weather::Com::Finder that allows you to search for a location by providing a search string or postal code or any other search string that weather.com understands.

The finder returns an arrayref or an array of locations (depending on how you call the find() method). Each location is an object of Weather::Com::Location.

CONSTRUCTOR

Top

new(hash or hashref)

The constructor takes a configuration hash or hashref as described in the Weather::Com POD. Please refer to that documentation for further details.

METHODS

Top

find(search string)

Once you've instantiated a finder object, you can perform find() calls to search for locations in the weather.com database.

The find() method returns an array of Weather::Com::Location objects if you call it in list context, else an arrayref.

Returns undef if no matching location could be found.

SEE ALSO

Top

See also documentation of Weather::Com and Weather::Com::Location.

AUTHOR

Top

Thomas Schnuecker, <thomas@schnuecker.de>

COPYRIGHT AND LICENSE

Top


Weather-Com documentation  | view source Contained in the Weather-Com distribution.