Unverified Commit e2445f36 authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

HAFAS: Document ->messages; sort functions

parent 6c328434

lib/Travel/Status/DE/HAFAS.pm

+59 −39
Original line number Diff line number Diff line 
package Travel::Status::DE::HAFAS;



# vim:foldmethod=marker



use strict;

use warnings;

use 5.014;
@@ -23,6 +25,8 @@ use Travel::Status::DE::HAFAS::StopFinder; 


our $VERSION = '3.01';



# {{{ Endpoint Definition



my %hafas_instance = (

	DB => {

		stopfinder  => 'https://reiseauskunft.bahn.de/bin/ajax-getstop.exe',
@@ -175,6 +179,9 @@ my %hafas_instance = ( 
	},

);



# }}}

# {{{ Constructors



sub new {

	my ( $obj, %conf ) = @_;

	my $service = $conf{service};
@@ -400,6 +407,9 @@ sub new_p { 
	return $promise;

}



# }}}

# {{{ Internal Helpers



sub post_with_cache {

	my ( $self, $url ) = @_;

	my $cache = $self->{cache};
@@ -519,40 +529,6 @@ sub check_mgate { 
	return $self;

}



sub errcode {

	my ($self) = @_;



	return $self->{errcode};

}



sub errstr {

	my ($self) = @_;



	return $self->{errstr};

}



sub similar_stops {

	my ($self) = @_;



	my $service = $self->{active_service};



	if ( $service and exists $hafas_instance{$service}{stopfinder} ) {



		my $sf = Travel::Status::DE::HAFAS::StopFinder->new(

			url            => $hafas_instance{$service}{stopfinder},

			input          => $self->{station},

			ua             => $self->{ua},

			developer_mode => $self->{developer_mode},

		);

		if ( my $err = $sf->errstr ) {

			$self->{errstr} = $err;

			return;

		}

		return $sf->results;

	}

	return;

}



sub add_message {

	my ( $self, $json, $is_him ) = @_;
@@ -590,11 +566,6 @@ sub add_message { 
	return $message;

}



sub messages {

	my ($self) = @_;

	return @{ $self->{messages} };

}



sub parse_journey {

	my ($self) = @_;
@@ -649,6 +620,48 @@ sub parse_board { 
	return $self;

}



# }}}

# {{{ Public Functions



sub errcode {

	my ($self) = @_;



	return $self->{errcode};

}



sub errstr {

	my ($self) = @_;



	return $self->{errstr};

}



sub similar_stops {

	my ($self) = @_;



	my $service = $self->{active_service};



	if ( $service and exists $hafas_instance{$service}{stopfinder} ) {



		my $sf = Travel::Status::DE::HAFAS::StopFinder->new(

			url            => $hafas_instance{$service}{stopfinder},

			input          => $self->{station},

			ua             => $self->{ua},

			developer_mode => $self->{developer_mode},

		);

		if ( my $err = $sf->errstr ) {

			$self->{errstr} = $err;

			return;

		}

		return $sf->results;

	}

	return;

}



sub messages {

	my ($self) = @_;

	return @{ $self->{messages} };

}



sub results {

	my ($self) = @_;

	return @{ $self->{results} };
@@ -689,6 +702,8 @@ sub get_active_service { 
	return;

}



# }}}



1;



__END__
@@ -856,6 +871,11 @@ the requested journey. Unavailable in station board mode. 


If no result was found or the parser / http request failed, returns undef.



=item $status->messages



Returns a list of Travel::Status::DE::HAFAS::Message(3pm) objects with

service messages. Each message belongs to at least one arrival/departure.



=item $status->similar_stops



Returns a list of hashrefs describing stops whose name is similar to the one