Flugg\Responder\Traits\ConvertsToSnakeCase

Complexity

Total Complexity

19

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	ConvertsParameters::__isset()	0	4	1
A	ConvertsParameters::__get()	0	4	1
A	ConvertsParameters::getValidatorInstance()	0	6	1
	ConvertsParameters::getInputSource()	0	1	?
A	ConvertsParameters::getConvertedParameters()	0	12	2
	ConvertsParameters::all()	0	1	?
A	ConvertsParameters::castBooleans()	0	14	4
B	ConvertsParameters::castValueToBoolean()	0	12	5
A	ConvertsParameters::convertToSnakeCase()	0	10	3
A	ConvertsParameters::convertArrayToSnakeCase()	0	10	2

<?php

namespace Flugg\Responder\Traits;

/**
 * Use this trait in your base form request to convert all camel cased parameters to
 * snake case and boolean strings to PHP booleans when accessing the input from
 * the controller.
 *
 * @package Laravel Responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
trait ConvertsParameters
{
    /**
     * Check if an input element is set on the request.
     *
     * @param  string $key
     * @return bool
     */
    public function __isset( $key )
    {
        return parent::__isset( snake_case( $key ) );
    }

    /**
     * Get an input element from the request.
     *
     * @param  string $key
     * @return mixed
     */
    public function __get( $key )
    {
        return parent::__get( snake_case( $key ) );
    }

    /**
     * Get the validator instance for the request.
     *
     * @return \Illuminate\Contracts\Validation\Validator
     */
    protected function getValidatorInstance()
    {
        $this->getInputSource()->replace( $this->getConvertedParameters() );

        return parent::getValidatorInstance();
    }

    /**
     * Get the input source for the request.
     *
     * @return \Symfony\Component\HttpFoundation\ParameterBag
     */
    abstract protected function getInputSource();

    /**
     * Cast and convert parameters.
     *
     * @return array
     */
    protected function getConvertedParameters():array
    {
        $parameters = $this->all();
        $parameters = $this->castBooleans( $parameters );
        $parameters = $this->convertToSnakeCase( $parameters );

        if ( method_exists( $this, 'convertParameters' ) ) {
            $parameters = $this->convertParameters( $parameters );

It seems like convertParameters() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $parameters;
    }

    /**
     * Get all of the input and files for the request.
     *
     * @return array
     */
    abstract public function all();

    /**
     * Cast all string booleans to real boolean values.
     *
     * @param  mixed $input
     * @return array
     */
    protected function castBooleans( $input ):array
    {
        if ( isset( $this->castBooleans ) && ! $this->castBooleans ) {
            return;
        }

        $casted = [ ];

        foreach ( $input as $key => $value ) {
            $casted[ $key ] = $this->castValueToBoolean( $value );
        }

        return $casted;
    }

    /**
     * Cast a given value to a boolean if it is in fact a boolean.
     *
     * @param  mixed $value
     * @return mixed
     */
    protected function castValueToBoolean( $value )
    {
        if ( isset( $this->convertToSnakeCase ) && ! $this->convertToSnakeCase ) {
            return;
        }

        if ( $value === 'true' || $value === 'false' ) {
            return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
        }

        return $value;
    }

    /**
     * Convert a string or array to snake case.
     *
     * @param  mixed $input
     * @return mixed
     */
    protected function convertToSnakeCase( $input )
    {
        if ( is_null( $input ) ) {
            return null;
        } elseif ( is_array( $input ) ) {
            return $this->convertArrayToSnakeCase( $input );
        }

        return snake_case( $input );
    }

    /**
     * Convert all keys of an array to snake case.
     *
     * @param  array $input
     * @return array
     */
    protected function convertArrayToSnakeCase( array $input ):array
    {
        $converted = [ ];

        foreach ( $input as $key => $value ) {
            $converted[ snake_case( $key ) ] = $value;
        }

        return $converted;
    }
}