From 1c421e57a73fd6aa752887ae715631b40862c828 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Fri, 27 Jan 2023 18:14:14 +0100 Subject: Document $status->station --- lib/Travel/Status/DE/HAFAS.pm | 12 ++++++++++++ lib/Travel/Status/DE/HAFAS/Journey.pm | 1 + 2 files changed, 13 insertions(+) diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm index 2d9ba87..6e9f3e2 100644 --- a/lib/Travel/Status/DE/HAFAS.pm +++ b/lib/Travel/Status/DE/HAFAS.pm @@ -928,6 +928,18 @@ If no result was found or the parser / http request failed, returns undef. 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->station + +Returns a hashref describing the most common departure station in all requested +journeys. Note that this may be different from the station for which departures +were requested, as HAFAS uses different identifiers for train stations, bus +stops, and other modes of transit even if they are interlinked. + +The hashref contains two entries: B (station name) and B (UIC / EVA +ID). These are subject to change. + +Not available in journey mode. + =item $status->similar_stops Returns a list of hashrefs describing stops whose name is similar to the one diff --git a/lib/Travel/Status/DE/HAFAS/Journey.pm b/lib/Travel/Status/DE/HAFAS/Journey.pm index 2faaf92..06a71df 100644 --- a/lib/Travel/Status/DE/HAFAS/Journey.pm +++ b/lib/Travel/Status/DE/HAFAS/Journey.pm @@ -547,6 +547,7 @@ Name of the station at which this journey was requested. =item $journey->station_uic (station only) UIC/EVA ID of the station at which this journey was requested. +May be renamed in future releases. =item $journey->route -- cgit v1.2.3