mirror of
https://github.com/predis/predis.git
synced 2026-08-24 10:59:27 +00:00
Daniele Alessandri
09895f27bf
We also changed our wording to indentify this kind of abstraction so instead of using "scripted commands" (kind of broken English) we now use "scriptable commands".
77 lines
1.8 KiB
PHP
77 lines
1.8 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\Command;
|
|
|
|
/**
|
|
* Base class used to implement an higher level abstraction for "virtual"
|
|
* commands for Lua scripting based on EVAL and EVALSHA.
|
|
*
|
|
* @link http://redis.io/commands/eval
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
abstract class ScriptCommand extends ServerEvalSHA
|
|
{
|
|
/**
|
|
* Gets the body of a Lua script.
|
|
*
|
|
* @return string
|
|
*/
|
|
public abstract function getScript();
|
|
|
|
/**
|
|
* Specifies the number of arguments that should be considered as keys.
|
|
*
|
|
* The default behaviour for the base class is to return 0 to indicate that
|
|
* all the elements of the arguments array should be considered as keys, but
|
|
* subclasses can enforce a static number of keys.
|
|
*
|
|
* @return int
|
|
*/
|
|
protected function getKeysCount()
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Returns the elements from the arguments that are identified as keys.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getKeys()
|
|
{
|
|
return array_slice($this->getArguments(), 2, $this->getKeysCount());
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function filterArguments(array $arguments)
|
|
{
|
|
if (($numkeys = $this->getKeysCount()) && $numkeys < 0) {
|
|
$numkeys = count($arguments) + $numkeys;
|
|
}
|
|
|
|
return array_merge(array(sha1($this->getScript()), (int) $numkeys), $arguments);
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getEvalArguments()
|
|
{
|
|
$arguments = $this->getArguments();
|
|
$arguments[0] = $this->getScript();
|
|
|
|
return $arguments;
|
|
}
|
|
}
|