Your IP : 216.73.216.43
<?php
declare(strict_types=1);
namespace Laminas\Filter;
use function array_reduce;
use function count;
use function is_array;
use function is_iterable;
use function ksort;
use function sprintf;
use function vsprintf;
/**
* @psalm-type Options = array{
* null_on_empty?: bool,
* null_on_all_empty?: bool,
* ...
* }
* @template TOptions of Options
* @template-extends AbstractFilter<TOptions>
*/
abstract class AbstractDateDropdown extends AbstractFilter
{
/**
* If true, the filter will return null if any date field is empty
*
* @var bool
*/
protected $nullOnEmpty = false;
/**
* If true, the filter will return null if all date fields are empty
*
* @var bool
*/
protected $nullOnAllEmpty = false;
/**
* Sprintf format string to use for formatting the date, fields will be used in alphabetical order.
*
* @var string
*/
protected $format = '';
/** @var int */
protected $expectedInputs;
/**
* @param mixed $options If array or Traversable, passes value to
* setOptions().
*/
public function __construct(mixed $options = null)
{
if (is_iterable($options)) {
$this->setOptions($options);
}
}
/**
* @param bool $nullOnAllEmpty
* @return self
*/
public function setNullOnAllEmpty($nullOnAllEmpty)
{
$this->nullOnAllEmpty = $nullOnAllEmpty;
return $this;
}
/**
* @return bool
*/
public function isNullOnAllEmpty()
{
return $this->nullOnAllEmpty;
}
/**
* @param bool $nullOnEmpty
* @return self
*/
public function setNullOnEmpty($nullOnEmpty)
{
$this->nullOnEmpty = $nullOnEmpty;
return $this;
}
/**
* @return bool
*/
public function isNullOnEmpty()
{
return $this->nullOnEmpty;
}
/**
* Attempts to filter an array of date/time information to a formatted
* string.
*
* @param mixed $value input to the filter
* @return mixed|string|null
* @throws Exception\RuntimeException If filtering $value is impossible.
* @psalm-return ($value is array ? string|null : mixed)
*/
public function filter($value)
{
if (! is_array($value)) {
// nothing to do
return $value;
}
// Convert the date to a specific format
if (
$this->isNullOnEmpty()
&& array_reduce($value, self::class . '::reduce', false)
) {
return null;
}
if (
$this->isNullOnAllEmpty()
&& array_reduce($value, self::class . '::reduce', true)
) {
return null;
}
$this->filterable($value);
ksort($value);
$value = vsprintf($this->format, $value);
return $value;
}
/**
* Ensures there are enough inputs in the array to properly format the date.
*
* @param array $value
* @throws Exception\RuntimeException
*/
protected function filterable($value)
{
if (count($value) !== $this->expectedInputs) {
throw new Exception\RuntimeException(
sprintf(
'There are not enough values in the array to filter this date (Required: %d, Received: %d)',
$this->expectedInputs,
count($value)
)
);
}
}
/**
* Reduce to a single value
*
* @param string $soFar
* @param string $value
* @return bool
*/
public static function reduce($soFar, $value)
{
return $soFar || empty($value);
}
}