ICanBoogie/Facets 0.4.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Facets
      • RecordCollection

Classes

  • BooleanCriterion
  • Criterion
  • CriterionList
  • CriterionNotDefined
  • CriterionValue
  • Fetcher
  • IntervalCriterionValue
  • QueryString
  • QueryStringWord
  • RecordCollection
  • SetCriterionValue

Interfaces

  • CriterionInterface
  • FetcherInterface

Traits

  • CriterionTrait
  • FetcherTrait
  • HumanizePairsTrait
  • ModelBindings
  • ParseQueryStringTrait
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Facets;

/**
 * Representation of a generic criterion value.
 *
 * @package ICanBoogie\Facets
 */
class CriterionValue
{
    /**
     * Creates an instance from the specified criterion value.
     *
     * Only instances of {@link SetCriterionValue} and {@link IntervalCriterionValue} are currently
     * supported. The criterion value is returned as is if it cannot be represented by either one
     * of these classes.
     *
     * Note: {@link IntervalCriterionValue} instances are replaced with simpler values whenever
     * possible. For instance `1..1` or `[ 'min' => 1, 'max' => 1 ]` are both replaced by `1`.
     *
     * @param mixed $value
     *
     * @return SetCriterionValue|IntervalCriterionValue|mixed
     */
    static public function from($value)
    {
        if ((!$value && $value !== 0 && $value !== '0')
        || $value === SetCriterionValue::SEPARATOR
        || $value === IntervalCriterionValue::SEPARATOR)
        {
            return null;
        }

        #

        $instance = IntervalCriterionValue::from($value);

        if ($instance instanceof IntervalCriterionValue)
        {
            if ($instance->min == $instance->max)
            {
                return $instance->min;
            }

            return $instance;
        }

        #

        $instance = SetCriterionValue::from($value);

        if ($instance instanceof SetCriterionValue)
        {
            if ($instance->count() !== 1)
            {
                return $instance;
            }

            $value = (string) $instance;
        }

        #

        return trim($value);
    }

    protected $value;

    public function __construct($value)
    {
        $this->value = $value;
    }

    public function __toString()
    {
        return (string) $this->value;
    }
}
ICanBoogie/Facets 0.4.x API documentation generated by ApiGen