dtl/time-distance-bundle

Provides TWIG helpers for distance and time stuff

dev-master 2013-04-15 10:55 UTC

Requires

• frost/distance: dev-master

MIT

• Daniel Leech

• time
• distance

README

This bundle adds some useful time and distance integrations:

• Twig filters
  • format_distance
  • seconds_to_stopwatch
  • average_pace
  • average_speed
• Form types
  • Distance form type
  • Stopwatch form type

Note that when we talk about "stopwatch" here it refers to the format of the text, ie. hh:mm:ss.

Configuration

By default all distances are assumed to be normalized as meters, you can change this value in the configuration as follows:

dtl_time_distance:
    normalized_distance_unit: m

Twig Filters

format_distance

Convert the given normalized distance to the specified unit:

    {# Format 20km (in meters) to miles #}
    {{ 2000|format_distance('miles') }}

    {# Format 20km (in meters) to foot with a precision of 4 #}
    {{ 2000|format_distance('ft', 4) }}

seconds_to_stopwatch
-------------------

Format a given number of seconds as "stopwatch" (hh:mm:ss):

    {# 1 hour will display as 01:00:00 #}
    {{ 3600|seconds_to_stopwatch }}

    {# 2 seconds will display as 00:00:02 #}
    {{ 2|seconds_to_stopwatch }}

    {# 1 week will display as 168:00:00 #}
    {{ 604800|seconds_to_stopwatch }}
 
average_pace
------------

Format average pace (i.e. time per distance unit) for given time and distance:

    {# If you ran 10k in 47 minutes you would do 00:07:34 - 7 minutes, 34 seconds per mile #}
    {{ 2820|average_pace(10, 'miles') }}

    {# Default is km, but will accept any of the distance units #}
    {{ 2820|average_pace(10) }}

average_speed
-------------

Format average speed acccording to given distance unit:

    {# If you ran 10k in 47 minutes you run at 7.93 miles per hour #}
    {{ 2820|average_speed(10, 'miles') }}

Form Types
==========

distance
--------

The distance form type accepts the following formats

- 12k - 12 kilometers
- 12km - 12 kilometers
- 12 miles - 12 miles
- 12m - 12 miles
- 12 - 12 kilometers

All values are converted to *kilometers* internally.

stopwatch
---------

The stopwatch type accepts all values accepted by `mktime`
with the addition of the stopwatch format `hh:mm:ss`.