Files
predis/src/Command/ScriptCommand.php
T
Daniele Alessandri 4b47639f9e Rename command classes using command ID as name.
Some notable exceptions are EVAL and ECHO because having these names
as class names would raise a syntax error.
2016-06-04 20:54:41 +02:00

82 lines
1.9 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;
use Predis\Command\Redis\EVALSHA;
/**
* Base class used to implement an higher level abstraction for commands based
* on Lua scripting with EVAL and EVALSHA.
*
* @link http://redis.io/commands/eval
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
abstract class ScriptCommand extends EVALSHA
{
/**
* Gets the body of a Lua script.
*
* @return string
*/
abstract public 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}
*/
public function setArguments(array $arguments)
{
if (($numkeys = $this->getKeysCount()) && $numkeys < 0) {
$numkeys = count($arguments) + $numkeys;
}
$arguments = array_merge(array(sha1($this->getScript()), (int) $numkeys), $arguments);
parent::setArguments($arguments);
}
/**
* @return array
*/
public function getEvalArguments()
{
$arguments = $this->getArguments();
$arguments[0] = $this->getScript();
return $arguments;
}
}