method
public
Signer::sign()
Сигнатура
public sign(string $value[, string|null $salt = null ]) : stringОписание
Простой пример:
// Если нужна соль
$foo = (new Signer)->sign('test', 'my_salt');
// Иначе
$bar = (new Signer)->sign('test');
Параметры
$value
string
Сообщение для подписи.
$salt
string|null
= null
Соль, если нужна.
Возвращаемое значение
string
Как применяется в Signer
Signer::sign() — метод класса \Bitrix\Main\Security\Sign\Signer модуля «Главный модуль».
Метод объекта: сначала нужен экземпляр Signer.
use Bitrix\Main\Security\Sign\Signer;
/** @var Signer $object */
$value = '';
$result = $object->sign($value);
// $result: stringДругие методы Signer
getSeparator()Возвращает разделитель, используемый для упаковки/распаковки.getSignature()Возвращает подпись сообщения.pack()Упаковывает значения массива в одну строку: pack(['test', 'all', 'values']) -> 'test.all.values'setKey()Устанавливает ключ для подписи.setSeparator()Устанавливает разделитель, используемый для упаковки/распаковки.unpack()Распаковывает значения из строки (нечто вроде rsplit).unsign()Проверяет подпись сообщения и возвращает исходное сообщение.validate()Простая проверка подписи сообщения.
sign() есть и у других классов модуля «Главный модуль»: JWT, TimeSigner, UrlPreview.
Исходный файл: source/main/lib/security/sign/signer.php:122
