App\Models\BaseModel::asDateTime()

Complexity

Conditions	8
Paths	7

Size

Total Lines	46
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	8.0877

Importance

Changes

0

<?php
    protected function asDateTime($value)

Method \App\Models\BaseModel::asDateTime() does not have return type hint for its return value but it should be possible to add it based on @return annotation "Date".

    {
        $timezone = Config::get('app.timezone');

        // If this value is already a Carbon instance, we shall just return it as is.
        // This prevents us having to re-instantiate a Carbon instance when we know
        // it already is one, which wouldn't be fulfilled by the DateTime check.
        if ($value instanceof Carbon) {
            return Date::parse($value, $timezone);
        }
        if ($value instanceof Date) {
            return $value;
        }
        // If the value is already a DateTime instance, we will just skip the rest of
        // these checks since they will be a waste of time, and hinder performance
        // when checking the field. We will just return the DateTime right away.
        if ($value instanceof DateTimeInterface) {
            return new Date(
                //$value->format('Y-m-d H:i:s.u'), $value->getTimeZone()

No space found before comment text; expected "// $value->format('Y-m-d H:i:s.u'), $value->getTimeZone()" but found "//$value->format('Y-m-d H:i:s.u'), $value->getTimeZone()"

                $value->format('Y-m-d H:i:s.u'), $timezone
            );
        }
        // If this value is an integer, we will assume it is a UNIX timestamp's value
        // and format a Carbon object from this timestamp. This allows flexibility
        // when defining your date fields as they might be UNIX timestamps here.
        if (is_numeric($value)) {
            return Date::createFromTimestamp($value, $timezone);
        }
        // If the value is in simply year, month, day format, we will instantiate the
        // Carbon instances from that format. Again, this provides for simple date
        // fields on the database, while still supporting Carbonized conversion.
        if (preg_match('/^(\d{4})-(\d{1,2})-(\d{1,2})$/', $value)) {
            return Date::createFromFormat('Y-m-d', $value, $timezone)->startOfDay();
        }

        // If the date follows the api configured date format, use that.
        $apiFormat = Config::get('app.api_datetime_format');
        $date = DateTime::createFromFormat($apiFormat, $value);
        if ($date && $date->format($apiFormat) == $value) {
            return $date;
        }

        // Finally, we will just assume this date is in the format used by default on
        // the database connection and use that format to create the Carbon object
        // that is returned back out to the developers after we convert it here.
        return Date::createFromFormat($this->getDateFormat(), $value, $timezone);
    }