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  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 
<?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;

use ICanBoogie\ToArray;

/**
 * Representation of a set of values, suitable for the SQL `IN()` function.
 *
 * A set of values is created by concatenating values with the pipe sign ("|") e.g. "1|2|3".
 */
class SetCriterionValue implements ToArray, \Countable
{
    const SEPARATOR = '|';

    /**
     * Instantiate a {@link SetCriterionValue} instance from a value.
     *
     * @param mixed $value
     *
     * @return SetCriterionValue|null
     */
    static public function from($value)
    {
        if (!$value)
        {
            return null;
        }

        if (is_array($value))
        {
            if (current($value) !== 'on')
            {
                return new static($value);
            }

            $set = array_keys($value);
        }
        else
        {
            $value = trim($value);

            if ($value === SetCriterionValue::SEPARATOR || strpos($value, SetCriterionValue::SEPARATOR) === false)
            {
                return null;
            }

            $set = explode(self::SEPARATOR, $value);
        }

        $set = array_map('trim', $set);
        $set = array_unique($set);
        $set = array_values($set);

        return new static($set);
    }

    protected $set;

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

    /**
     * Formats the set into a string.
     *
     * @return string
     */
    public function __toString()
    {
        return implode(self::SEPARATOR, $this->set);
    }

    /**
     * Returns the number of members in the set.
     *
     * @return int
     */
    public function count()
    {
        return count($this->set);
    }

    /**
     * Returns the set as an array.
     *
     * @return array
     */
    public function to_array()
    {
        return $this->set;
    }
}
ICanBoogie/Facets 0.4.x API documentation generated by ApiGen