sfneal / models

src/Builders/Traits/WhereBetweenSplitter.php

<?php

namespace Sfneal\Builders\Traits;

use Illuminate\Database\Eloquent\Builder;
use Sfneal\Helpers\Strings\StringHelpers;

trait WhereBetweenSplitter
{
    /**
     * whereBetween clause extension that accepts a string value instead of array.
     *
     * @param  string  $column  DB column
     * @param  string|mixed  $values  Two 'between' values with a separator
     * @param  string  $sep  separator character
     * @param  bool  $allow_where  Allow for standard 'where' clause $values cannot be split
     * @param  string  $where_operator
     * @return WhereBetweenSplitter|Builder
     */
    public function whereBetweenSplitter(string $column, $values, string $sep = '-', bool $allow_where = true, $where_operator = '=')
    {
        // Use standard whereBetween if $values is an array
        if (self::isArrayValue($values)) {
            $this->whereBetween($column, $values);

The method whereBetween() does not exist on Sfneal\Builders\Traits\WhereBetweenSplitter. Did you maybe mean whereBetweenSplitter()?

        }

        // Determine if the $value is splitable
        elseif (! self::isSplitableValue($values, $sep) && $allow_where) {
            $this->where($column, $where_operator, $values);

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

        }

        // $values is a string and that $sep is in $values
        else {
            $this->whereBetween($column, array_map(function ($str) {
                return trim($str);
            }, explode($sep, $values)));
        }

        return $this;
    }

    /**
     * Determine if the values to be split are 'splitable'.
     *
     * Value is splittable if...
     *  - A standard 'where' clause can be used
     *  - $values is not a string
     *  - $sep is found not in $values
     *
     * @param  $values
     * @param  string  $sep
     * @return bool
     */
    private static function isSplitableValue($values, string $sep = '-'): bool
    {
        return is_string($values) && (new StringHelpers($values))->inString($sep);
    }

    /**
     * Determine if the values are valid for use in standard 'whereBetween' clause.
     *
     * @param  $values
     * @return bool
     */
    private static function isArrayValue($values): bool
    {
        return is_array($values) && count($values) > 1;
    }
}