mirror of
https://github.com/predis/predis.git
synced 2026-08-24 09:19:39 +00:00
Daniele Alessandri
48 lines
1.2 KiB
PHP
48 lines
1.2 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Predis package.
|
|
*
|
|
* (c) Daniele Alessandri <suppakilla@gmail.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Predis\Option;
|
|
|
|
/**
|
|
* Interface that defines a client option.
|
|
*
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
interface OptionInterface
|
|
{
|
|
/**
|
|
* Filters (and optionally converts) the passed value.
|
|
*
|
|
* @param ClientOptionsInterface $options Options container.
|
|
* @param mixed $value Input value.
|
|
* @return mixed
|
|
*/
|
|
public function filter(ClientOptionsInterface $options, $value);
|
|
|
|
/**
|
|
* Returns a default value for the option.
|
|
*
|
|
* @param ClientOptionsInterface $options Options container.
|
|
* @return mixed
|
|
*/
|
|
public function getDefault(ClientOptionsInterface $options);
|
|
|
|
/**
|
|
* Filters a value and, if no value is specified, returns the default one
|
|
* defined by the option.
|
|
*
|
|
* @param ClientOptionsInterface $options Options container.
|
|
* @param mixed $value Input value.
|
|
* @return mixed
|
|
*/
|
|
public function __invoke(ClientOptionsInterface $options, $value);
|
|
}
|