OptionInterface.php 987 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <?php
  2. /*
  3. * This file is part of the Predis package.
  4. *
  5. * (c) Daniele Alessandri <suppakilla@gmail.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Predis\Configuration;
  11. /**
  12. * Defines an handler used by Predis\Configuration\Options to filter, validate
  13. * or return default values for a given option.
  14. *
  15. * @author Daniele Alessandri <suppakilla@gmail.com>
  16. */
  17. interface OptionInterface
  18. {
  19. /**
  20. * Filters and validates the passed value.
  21. *
  22. * @param OptionsInterface $options Options container.
  23. * @param mixed $value Input value.
  24. *
  25. * @return mixed
  26. */
  27. public function filter(OptionsInterface $options, $value);
  28. /**
  29. * Returns the default value for the option.
  30. *
  31. * @param OptionsInterface $options Options container.
  32. *
  33. * @return mixed
  34. */
  35. public function getDefault(OptionsInterface $options);
  36. }