ridvanbaluyos / mmda

src/Ridvanbaluyos/Mmda/MMDA.php

<?php 

namespace Ridvanbaluyos\Mmda;

/**
 * Metro Manila Development Authority - Traffic Data
 * http://mmdatraffic.interaksyon.com/livefeed/
 *
 * @package    MMDA Traffic Data
 * @author     Ridvan Baluyos <ridvan@baluyos.net>
 * @link       https://github.com/ridvanbaluyos/mmda
 * @license    MIT
 */
class MMDA
{
    const FEED_URL = 'http://mmdatraffic.interaksyon.com';

    private $trafficData;
    private $channel;

    /**
     * MMDA constructor.
     */
    public function __construct()
    {
        $metroManilaFeedUrl = self::FEED_URL . '/livefeed/';
        $nlexFeedUrl = self::FEED_URL . '/nlex/livefeed/';
        
        $metroManilaTrafficData = $this->getTrafficData($metroManilaFeedUrl);
        $nlexTrafficData = $this->getTrafficData($nlexFeedUrl);
        
        $this->trafficData = array_merge($metroManilaTrafficData, $nlexTrafficData);
    }

    /**
     * This function retrieves the traffic data.
     * @return array
     */
    public function traffic()
    {
        $traffic = $this->trafficData;

        return $traffic;
    }

    /**
     * This function returns the list of highways.
     *
     * @return array|null
     */
    public function highways()
    {
        if ($this->trafficData) {

The expression $this->trafficData of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            return array_keys($this->trafficData);
        }

        return null;
    }

    /**
     * This function returns the list of segments in a given highway.
     *
     * @param $highway
     * @return array|null
     */
    public function segments($highway = NULL)
    {
        if ($highway && isset($this->trafficData[$highway]['segments'])) {
            return array_keys($this->trafficData[$highway]['segments']);
        }

        return null;
    }

    /**
     * This function retrieves the traffic data from the MMDA Traffic API.
     *
     * @return array
     */
    final private function getTrafficData($feedUrl)
    {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $feedUrl);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        $response = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

        curl_close($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_close() does only seem to accept resource, maybe add an additional type check?

        $xml = simplexml_load_string($response);

        return $this->sanitizeTrafficData($this->parseTrafficData($xml));
    }

    /**
     * This function parses the XML response from the MMDA Traffic API into JSON.
     *
     * @param $xml
     * @return array
     */
    final private function parseTrafficData($xml)
    {
        $traffic = [];

        foreach ($xml->channel->item as $item) {
            $item = get_object_vars($item);
            $title = $item['title'];
            $description = $item['description'];
            $pubDate = $item['pubDate'];

            $highway = explode('-', $title, 2)[0];
            $segment = substr(explode('-', $title, 2)[1], 0, -3);
            $direction = substr(explode('-', $title, 2)[1], -2);

            if (empty($traffic[$highway])) $traffic[$highway] = [];
            if (empty($traffic[$highway][$segment])) $traffic[$highway][$segment] = [];

            $traffic[$highway][$segment][$direction] = $description;
            $traffic[$highway][$segment]['pubDate'] = $pubDate;
        }

        return $traffic;
    }

    /**
     * This function sanitizes the traffic data and organizes them into an envelope
     *
     * @param array $trafficData
     * @return array
     */
    final private function sanitizeTrafficData(Array $trafficData)
    {
        $traffic = [];
        foreach ($trafficData as $highway=>$segments) {
            $traffic[$highway] = [
                'name' => $highway,
                'label' => $this->convertToTitle($highway),
            ];
            $traffic[$highway]['segments'] = [];
            $dataSegments = [];

            foreach ($segments as $segment=>$status) {
                $dataSegments[$segment] = [
                    'name' => $segment,
                    'label' => $this->convertToTitle($segment),
                    'status' => $this->convertToStatus($status),

                ];
                $traffic[$highway]['segments'] = $dataSegments;
            }
        }

        return $traffic;
    }

    /**
     * This function converts traffic data status to readable format.
     *
     * @param array $data
     * @return array
     */
    final private function convertToStatus(Array $data)
    {
        $statusMatrix = [
            '-'  => 'No data',
            'L'  => 'Light',
            'ML' => 'Light to Moderate',
            'M'  => 'Moderate',
            'MH' => 'Moderate to Heavy',
            'H'  => 'Heavy'
        ];

        $northBound = ($data['SB']) ?? '-';
        $southBound = ($data['SB']) ?? '-';

        $status = [
            'NB' => [
                'name' => $northBound,
                'label' => $statusMatrix[$northBound] . ' Traffic',
                'last_updated' => $data['pubDate']
            ],
            'SB' => [
                'name' => $southBound,
                'label' => $statusMatrix[$southBound] . ' Traffic',
                'last_updated' => $data['pubDate']
            ]
        ];

        return $status;
    }

    /**
     * This function sanitizes certain abbreviations into readable format.
     *
     * @param $string
     * @return string
     */
    final private function convertToTitle($string)
    {
        $string2 = [];
        $string = str_replace(['_', 'AVE.', 'BLVD.'], [' ', 'AVENUE', 'BOULEVARD'], $string);
        $words = explode(' ', $string);

        foreach ($words as $word) {
            if (!in_array($word, ['EDSA', 'U.N.'])) {
                $word = ucwords(mb_strtolower($word));
            }
            array_push($string2, $word);
        }

        return implode(' ', $string2);
    }
}