mirror of
https://github.com/predis/predis.git
synced 2026-08-20 20:42:13 +00:00
Daniele Alessandri
68 lines
1.8 KiB
PHP
68 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\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();
|
|
|
|
/**
|
|
* Specifies the number of arguments that should be considered as keys.
|
|
*
|
|
* The default behaviour for the base class is to return FALSE to indicate that
|
|
* all the elements of the arguments array should be considered as keys, but
|
|
* subclasses can enforce a static number of keys.
|
|
*
|
|
* @todo How about returning 1 by default to make scripted commands act like
|
|
* variadic ones where the first argument is the key (KEYS[1]) and the
|
|
* rest are values (ARGV)?
|
|
*
|
|
* @return int|Boolean
|
|
*/
|
|
protected function getKeysCount()
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* 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)
|
|
{
|
|
$header = array($this->getScript(), ($keys = $this->getKeysCount()) !== false ? $keys : count($arguments));
|
|
|
|
return array_merge($header, $arguments);
|
|
}
|
|
}
|