mirror of
https://github.com/predis/predis.git
synced 2026-08-21 09:30:57 +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.
58 lines
1.3 KiB
PHP
58 lines
1.3 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\Commands;
|
|
|
|
/**
|
|
* Base class used to implement an higher level abstraction for "virtual"
|
|
* commands based on EVAL.
|
|
*
|
|
* @link http://redis.io/commands/eval
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
abstract class ScriptedCommand extends ServerEval
|
|
{
|
|
/**
|
|
* Gets the body of a Lua script.
|
|
*
|
|
* @return string
|
|
*/
|
|
public abstract function getScript();
|
|
|
|
/*
|
|
* Gets the number of arguments that should be considered as keys.
|
|
*
|
|
* @return int
|
|
*/
|
|
protected function keysCount()
|
|
{
|
|
// The default behaviour for the base class is to use all the arguments
|
|
// passed to a scripted command to populate the KEYS table in Lua.
|
|
return count($this->getArguments());
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function filterArguments(Array $arguments)
|
|
{
|
|
return array_merge(array($this->getScript(), $this->keysCount()), $arguments);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function getKeys()
|
|
{
|
|
return array_slice($this->getArguments(), 2, $this->keysCount());
|
|
}
|
|
}
|