IndraGunawan\RestService\ValueFormatter

Complexity

Total Complexity

24

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	isValueEmpty()	0	4	2
A	getValue()	0	8	2
A	format()	0	10	2
A	formatInteger()	0	4	1
A	formatFloat()	0	4	1
A	formatString()	0	4	2
A	formatBoolean()	0	4	4
B	formatNumber()	0	13	5
B	formatDatetime()	0	16	5

<?php

namespace IndraGunawan\RestService;

class ValueFormatter
{
    /**
     * Evaluates if the given value is to be treated as empty.
     *
     * @param mixed $value
     *
     * @return bool
     */
    public function isValueEmpty($value)
    {
        return null === $value || '' === $value;
    }

    /**
     * Get $value if not empty, $defaultValue otherwise.
     *
     * @param mixed      $value
     * @param mixed|null $defaultValue
     *
     * @return mixed|null
     */
    public function getValue($value, $defaultValue = null)
    {
        if (!$this->isValueEmpty($value)) {
            return $value;
        }

        return $defaultValue;
    }

    /**
     * Get formatted value base on type and format.
     *
     * @param string     $type
     * @param string     $format
     * @param mixed      $value
     * @param mixed|null $defaultValue
     *
     * @return mixed
     */
    public function format($type, $format, $value, $defaultValue = null)
    {
        $value = $this->getValue($value, $defaultValue);

        if (method_exists($this, 'format'.ucfirst(strtolower($type)))) {
            return $this->{'format'.ucfirst(strtolower($type))}($value, $format);
        }

        return $value;
    }

    /**
     * Format Integer.
     *
     * @param mixed      $value
     * @param mixed|null $format
     *
     * @return int
     */
    private function formatInteger($value, $format = null)

The parameter $format is not used and could be removed.

    {
        return (int) (string) $value;
    }

    /**
     * Format Float.
     *
     * @param mixed      $value
     * @param mixed|null $format
     *
     * @return float
     */
    private function formatFloat($value, $format = null)

The parameter $format is not used and could be removed.

    {
        return (float) (string) $value;
    }

    /**
     * Format String.
     *
     * @param mixed      $value
     * @param mixed|null $format
     *
     * @return string
     */
    private function formatString($value, $format = null)
    {
        return sprintf($format ?: '%s', (string) $value);
    }

    /**
     * Format Boolean.
     *
     * @param mixed      $value
     * @param mixed|null $format
     *
     * @return bool
     */
    private function formatBoolean($value, $format = null)

The parameter $format is not used and could be removed.

    {
        return ('false' === $value || false === $value || 0 === $value) ? false : true;
    }

    /**
     * Format Number.
     *
     * @param mixed      $value
     * @param mixed|null $format
     *
     * @return string
     */
    private function formatNumber($value, $format = null)
    {
        if ($format) {
            $format = explode('|', $format);
            $decimal = isset($format[0]) ? $format[0] : 0;
            $decimalPoint = isset($format[1]) ? $format[1] : '.';
            $thousandsSeparator = isset($format[2]) ? $format[2] : ',';

            return number_format((float) (string) $value, $decimal, $decimalPoint, $thousandsSeparator);
        }

        return (string) $value;
    }

    /**
     * Format Datetime.
     *
     * @param mixed      $value
     * @param mixed|null $format
     *
     * @return \DateTime|string
     */
    private function formatDatetime($value, $format = null)
    {
        if ($this->isValueEmpty($value)) {
            return;
        }

        if ($value instanceof \DateTime) {
            return $value->format($format ?: 'Y-m-d\TH:i:s\Z');
        }

        if ($format) {
            return \DateTime::createFromFormat($format, $value);

The expression \DateTime::createFromFormat($format, $value); of type DateTime|false adds false to the return on line 150 which is incompatible with the return type documented by IndraGunawan\RestService\ValueFormatter::formatDatetime of type string|DateTime. It seems like you forgot to handle an error condition.

        }

        return new \DateTime($value);
    }
}