FloSports\ScaleEngine\Model\Factory\AbstractScaleEngineModelFactory

Complexity

Total Complexity

5

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	create()	0	5	1
	parseData()	0	1	?
A	convertDate()	0	14	3

<?php
namespace FloSports\ScaleEngine\Model\Factory;

use DateTime;
use DateTimeZone;
use FloSports\ScaleEngine\ScaleEngineClient;
use Guzzle\Service\Resource\Model;

/**
 * Collects shared functionality used by all ScaleEngine models.
 */
abstract class AbstractScaleEngineModelFactory
{
    /** @type string The model class name. **/
    private $_model;

    /** @type array A map of keys from ScaleEngine's API to exposed model. **/
    private $_keyMap;

    /**
     * Create the model factory for a specific type of model.
     *
     * @param string $model The full class name for the model to construct.
     * @param array $keyMap A map of keys from ScaleEngine's API to exposed model.
     */
    public function __construct($model, array $keyMap)
    {
        $this->_model = $model;
        $this->_keyMap = $keyMap;
    }

    /**
     * Create a Ticket model using the provided data.
     *
     * The data given will be parsed and any missing keys will result in
     * failure.
     *
     * @param array $data The data to use to populate the model.
     * @return \Guzzle\Service\Resource\Model The parsed model.
     */
    public function create(array $data)
    {
        $model = $this->_model;
        return $model::fromConfig($this->parseData($data), [], $this->_keyMap);
    }

    /**
     * Parse the data given into correct types and changes keys based on the
     * key map.
     *
     * @param array $data The ticket data to parse.
     * @return array The data after being converted to the parsed form.
     */
    abstract public function parseData(array $data);

    /**
     * Convert a date from ScaleEngine's format into a PHP DateTime.
     *
     * ScaleEngine uses an all-zeros response for null dates, and this will
     * convert those into null itself.
     *
     * This also considers that ScaleEngine uses UTC for its timezone and makes
     * sure that the time returned is correct considering that behavior.
     *
     * @param string $date The date as returned from ScaleEngine.
     * @return DateTime The converted date/time object.
     */
    public function convertDate($date)
    {
        if ($date === ScaleEngineClient::SCALEENGINE_NULL_DATE) {
            return null;
        }

        $dateTime = DateTime::createFromFormat(
            ScaleEngineClient::SCALEENGINE_DATE_FORMAT,
            $date,
            new DateTimeZone(ScaleEngineClient::SCALEENGINE_TIMEZONE)
        );

        return $dateTime ?: null;
    }
}