spekulatius/silverstripe-timezones

Provides time zone data as well as a pre-populated dropdown field for SilverStripe

Installs: 2 897

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 6

Open Issues: 2

Type:silverstripe-vendormodule

1.0.1 2020-08-03 09:16 UTC

This package is auto-updated.

Last update: 2024-06-20 01:11:37 UTC


README

SilverStripe Time zones FormField module

Build Status Latest Stable Version Latest Unstable Version Scrutinizer Code Quality Total Downloads License

Provides a reusable model and data of the time zones worldwide. In addition a dropdown field for a time zones selection is included.

Requirements

  • SilverStripe Framework 4.0

Installation

For the installation you can either download the package, unzip it into your project directory and run dev build manually or run the following commands in your project directory:

composer require spekulatius/silverstripe-timezones
./vendor/bin/sake dev/build

The data will automatically populated on dev build.

Provided Data

The provided data comes from PHPs built-in function timezone_identifiers_list(). Before the data gets saved in the db it will be prepared so its ready to be used.

Dropdown Field

If you want to use the dropdown field you can simply add a timezone to your db fields:

<?php
use Spekulatius\TimeZones\Model\FieldType\TimeZone;
use Spekulatius\TimeZones\Forms\TimeZoneField;

class MyPage extends Page
{
    /**
     * @var array
     */
    private static $db = array(
        'UserTimeZone' => TimeZone::class
    );

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        // ...

        $fields->addFieldToTab(
            'Root.Main',
            TimeZoneField::create(
                'TimeZone',
                'My time zone'
            )
        );

        return $fields;
    }
}

Format of time zone

You can change the default format of the time zone in the dropdown menu by creating a file mysite/_config/timezone.yml and adding e.g.

SilverStripe\Core\Injector\Injector:
  Spekulatius\TimeZones\Model\TimeZoneData:
    properties:
      format: '%Name (%Region)'

You can use 'Name', 'Region' and 'Identifier' in the string and it will be replaced proper.

* [Future ideas/development, issues](https://github.com/spekulat/silverstripe-timezones/issues),
* [Contributing](https://github.com/spekulat/silverstripe-timezones/blob/master/CONTRIBUTING.md),
* [License](https://github.com/spekulat/silverstripe-timezones/blob/master/license.md)

This project is supported by bring your own ideas Ltd.. Bring Your Own Ideas Ltd. helps you to make your project ideas to reality.

bring your own ideas