Someshwer\WorldCountries\Lib\TimeZones

Complexity

Total Complexity

13

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Test Coverage

Coverage

92.5%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	timezonesByRegion()	0	13	3
A	__construct()	0	4	1
A	prepareTimezones()	0	13	2
A	timezones()	0	3	1
A	timezoneRegions()	0	12	3
A	searchTimezone()	0	11	3

<?php

namespace Someshwer\WorldCountries\Lib;

use Someshwer\WorldCountries\Data\DataRepository;

/**
 * Author: Someshwer Bandapally
 * Date: 14-07-2018.
 *
 * This class provides timezones info
 *
 * Class TimeZones
 */
class TimeZones extends Currencies
{
    /**
     * @var DataRepository
     */
    private $data;

    /**
     * TimeZones constructor.
     *
     * @param DataRepository $dataRepository
     */
    public function __construct(DataRepository $dataRepository)
    {
        parent::__construct($dataRepository);
        $this->data = $dataRepository;
    }

    /**
     * This method prepares timezones.
     *
     * @return array
     */
    private function prepareTimezones()
    {
        $timezone_identifiers_list = $this->data->timezones();
        $zones_array = [];
        $timestamp = time();
        foreach ($timezone_identifiers_list as $key => $zone) {
            date_default_timezone_set($zone);
            $zones_array[$key]['region'] = $zones_array[$key]['region'] = substr($zone, 0, strpos($zone, '/'));
            $zones_array[$key]['zone'] = $zone;
            $zones_array[$key]['diff_from_GMT'] = 'UTC/GMT '.date('P', $timestamp);
        }

        return $zones_array;
    }

    /**
     * Returns all timezones.
     *
     * @return array
     */
    public function timezones()
    {
        return $this->prepareTimezones();
    }

    /**
     * Returns all timezones regions.
     *
     * @return array
     */
    public function timezoneRegions()
    {
        $timezone_regions = $this->prepareTimezones();
        $timezone_regions_group = collect($timezone_regions)->groupBy('region')->keys();
        $regions = [];
        foreach ($timezone_regions_group as $item) {
            if ($item != '') {
                $regions[] = $item;
            }
        }

        return $regions;
    }

    /**
     * Fetches and returns timezones by regions.
     *
     * @param null $region

Are you sure the doc-type for parameter $region is correct as it would always require null to be passed?

     *
     * @return array|mixed
     */
    public function timezonesByRegion($region = null)
    {
        if (!$region) {

$region is of type null, thus it always evaluated to false.

            return [];
        }
        $timezone_regions = $this->prepareTimezones();
        $timezone_regions_group = collect($timezone_regions)->groupBy('region');
        $regional_timezones = $timezone_regions_group->get($region);
        if (!$regional_timezones) {
            return [];
        }

        return $regional_timezones;
    }

    /**
     * Searches timezones by name.
     *
     * @param $search_key
     *
     * @return array|static
     */
    public function searchTimezone($search_key)
    {
        if (!$search_key || ($search_key == '/')) {
            return [];
        }
        $timezones = $this->prepareTimezones();
        $filtered_timezones = collect($timezones)->filter(function ($item) use ($search_key) {
            return strpos(strtolower($item['zone']), strtolower($search_key)) !== false;
        })->values();

        return $filtered_timezones;

The expression return $filtered_timezones returns the type Illuminate\Support\Collection which is incompatible with the documented return type Someshwer\WorldCountries\Lib\TimeZones|array.

    }
}