\iFirmaOperacion

Interfaz para clases que permiten realizar firma electrónica de operaciones.

Summary

Methods

Constants

usuarioFirmante()
siguienteSerialOperacion()
prepararDatosAFirmar()
firmaRequiereCertificado()
firmar()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

usuarioFirmante()

usuarioFirmante() : mixed

El usuario que realiza la firma.

Throws

\ExcepcionXGAPFirmaOperacion: si no se puede obtener el usuario

Returns

mixed —

el usuario; el tipo está determinado por la aplicación

siguienteSerialOperacion()

siguienteSerialOperacion() : string

Devuelve un número de serie único para usar en la siguiente operación.

Returns

string

prepararDatosAFirmar()

prepararDatosAFirmar(string  $serial_operacion, integer  $timestamp, string  $operacion, mixed  $datos_operacion) : mixed

Prepara el valor final a firmar, componiendo todos los datos necesarios y convirtiendo el conjunto en el formato definido por el parámetro de configuración <var>codificador_datos_firmaoperacion</var>.

Parameters

string	$serial_operacion	número de serie único para identificar la operación
integer	$timestamp	momento en que se realizó la operación
string	$operacion	nombre de la operación; por ejemplo: 'Alta de usuario'
mixed	$datos_operacion	los datos que componen la operación, en un formato definido por la aplicación

Throws

\ExcepcionXGAPFirmaOperacion: si hay algún problema al realizar la operación

Returns

mixed —

los datos convertidos

firmaRequiereCertificado()

firmaRequiereCertificado() : boolean

Usado para que la implementación indique si {@link iFirmaOperacion::firmar() operación de firma} requiere que el certificado {@link iXgapPublicKeyInfrastructure::isCertificateAvailable() esté cargado} previamente.

Returns

boolean

firmar()

firmar(string  $serial_operacion, integer  $timestamp, string  $operacion, mixed  $datos_operacion,   $datos_firmados,   $firma)

Realiza la operación de firma.

Esta operación puede consistir, por ejemplo, en guardar los datos y la firma en archivos en disco o en una base de datos, o enviarlos a un registro externo mediante un servicio web.

Parameters

string	$serial_operacion	número de serie único para identificar la operación
integer	$timestamp	momento en que se realizó la operación
string	$operacion	nombre de la operación; por ejemplo: 'Alta de usuario'
mixed	$datos_operacion	los datos que componen la operación, en un formato definido por la aplicación
	$datos_firmados
	$firma

Throws

\ExcepcionXGAPSeguridadFirmaOperacion: si se detecta un problema de seguridad al realizar la operación
\ExcepcionXGAPFirmaOperacion: si hay algún problema al realizar la operación