mirror of
https://github.com/predis/predis.git
synced 2026-08-24 18:29:34 +00:00
Daniele Alessandri
4e6ed3f26d
This is a starting point to add a documentation of the whole set of APIs and classes of Predis. The next step will be to actually improve and extend it.
46 lines
979 B
PHP
46 lines
979 B
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\Options;
|
|
|
|
/**
|
|
* Interface that defines a client option.
|
|
*
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
interface IOption
|
|
{
|
|
/**
|
|
* Validates (and optionally converts) the passed value.
|
|
*
|
|
* @param mixed $value Input value.
|
|
* @return mixed
|
|
*/
|
|
public function validate($value);
|
|
|
|
/**
|
|
* Returns a default value for the option.
|
|
*
|
|
* @param mixed $value Input value.
|
|
* @return mixed
|
|
*/
|
|
public function getDefault();
|
|
|
|
/**
|
|
* Validates a value and, if no value is specified, returns
|
|
* the default one defined by the option.
|
|
*
|
|
* @param mixed $value Input value.
|
|
* @return mixed
|
|
*/
|
|
public function __invoke($value);
|
|
}
|