Clicksign_DAO
extends DAO
in package
Realiza a integração de assinatura de documentos do GED através da API do Clicksign.
Leia a documentação completa da API do Clicksign em: https://developers.clicksign.com/docs/introducao-a-documentacao
Table of Contents
Properties
- $_erp_empresa : mixed
- $_erp_filial : mixed
- $_erp_grupo : mixed
- $api_token : mixed
- $dir_dao : mixed
- $emp : mixed
- $idioma : mixed
- $instance_token : mixed
- $login_anonimo : mixed
- $token_job : mixed
- $viewcode : mixed
Methods
- __construct() : mixed
- Construtor do Clicksign_DAO
- api_token() : mixed
- ativar_envelope() : mixed
- AutoLoad() : mixed
- buscar_documento_key() : mixed
- cancelar_assinatura() : void
- Cancela a assinatura de um documento
- ConvertBase64() : mixed
- criar_envelope() : mixed
- criar_requisito() : mixed
- criar_signatario() : mixed
- Delete_Token_JOB() : mixed
- DxParamsAddFilter() : mixed
- emp() : mixed
- enviar_documento_assinatura() : mixed
- get_login_anonimo() : mixed
- getFormData() : mixed
- getJsonData() : mixed
- instance_token() : mixed
- isJsonRequest() : mixed
- listar_pastas() : mixed
- LoadDAO() : mixed
- LoadHTML() : mixed
- LoadMail() : mixed
- LoadModel() : mixed
- LoadPDF() : mixed
- notificar_signatarios() : mixed
- ReadBodyParams() : mixed
- ReadDxParams() : mixed
- ReadFile() : mixed
- ReadFiles() : mixed
- ReadGet() : mixed
- ReadPost() : mixed
- ReadRequest() : mixed
- realizar_download_documento_assinado_ou_cancelado() : mixed
- registrar_evento() : mixed
- registrar_webhook() : mixed
- reprocessar_finalizados_sem_download() : mixed
- retornar_dados_documento_assinado_ou_cancelado() : mixed
- retornar_path_arquivo_assinado() : mixed
- salva_evento_log() : null
- Registra os eventos pelo qual a assinatura de um documento passou
- set_login_anonimo() : mixed
- solicitar_assinaturas() : object
- Realiza a assinatura de um documento
- Start_Token_JOB() : mixed
- upload_documento() : mixed
- vincular_signatario_documento() : mixed
- WhatRequest() : mixed
Properties
$_erp_empresa
protected
mixed
$_erp_empresa
$_erp_filial
protected
mixed
$_erp_filial
$_erp_grupo
protected
mixed
$_erp_grupo
$api_token
protected
static mixed
$api_token
$dir_dao
protected
static mixed
$dir_dao
= NULL
$emp
protected
mixed
$emp
$idioma
protected
mixed
$idioma
$instance_token
protected
static mixed
$instance_token
$login_anonimo
protected
static mixed
$login_anonimo
= false
$token_job
protected
static mixed
$token_job
$viewcode
protected
mixed
$viewcode
Methods
__construct()
Construtor do Clicksign_DAO
public
__construct() : mixed
api_token()
public
static api_token() : mixed
ativar_envelope()
public
static ativar_envelope(string $envelope_id) : mixed
Parameters
- $envelope_id : string
AutoLoad()
public
static AutoLoad(mixed $className) : mixed
Parameters
- $className : mixed
buscar_documento_key()
public
buscar_documento_key(mixed $clicksign_document_key) : mixed
Parameters
- $clicksign_document_key : mixed
cancelar_assinatura()
Cancela a assinatura de um documento
public
cancelar_assinatura(string $clicksign_document_key) : void
Parameters
- $clicksign_document_key : string
-
Chave do documento retornado pelo Clicksign
Return values
void —Sem retorno
ConvertBase64()
public
static ConvertBase64(mixed $name, mixed &$request_params) : mixed
Parameters
- $name : mixed
- $request_params : mixed
criar_envelope()
public
static criar_envelope(mixed $nome[, mixed $intervalo_lembrete = 3 ]) : mixed
Parameters
- $nome : mixed
- $intervalo_lembrete : mixed = 3
criar_requisito()
public
static criar_requisito(mixed $documentKey, mixed $signerKey[, mixed $action = "sign" ]) : mixed
Parameters
- $documentKey : mixed
- $signerKey : mixed
- $action : mixed = "sign"
criar_signatario()
public
static criar_signatario(mixed $nome, mixed $email, mixed $telefone, mixed $nascimento, mixed $cpf, mixed $envelope_id[, mixed $tipo_notificacao = 'email' ]) : mixed
Parameters
- $nome : mixed
- $email : mixed
- $telefone : mixed
- $nascimento : mixed
- $cpf : mixed
- $envelope_id : mixed
- $tipo_notificacao : mixed = 'email'
Delete_Token_JOB()
public
static Delete_Token_JOB() : mixed
DxParamsAddFilter()
public
DxParamsAddFilter(mixed &$params, mixed $campo, mixed $condicao, mixed $valor) : mixed
Parameters
- $params : mixed
- $campo : mixed
- $condicao : mixed
- $valor : mixed
emp()
public
emp() : mixed
enviar_documento_assinatura()
public
static enviar_documento_assinatura(mixed $parametros) : mixed
Parameters
- $parametros : mixed
get_login_anonimo()
public
static get_login_anonimo() : mixed
getFormData()
public
static getFormData([mixed $param = null ]) : mixed
Parameters
- $param : mixed = null
getJsonData()
public
static getJsonData([mixed $param = null ]) : mixed
Parameters
- $param : mixed = null
instance_token()
public
static instance_token() : mixed
isJsonRequest()
public
static isJsonRequest() : mixed
listar_pastas()
public
static listar_pastas([mixed $clicksign_api_url = null ][, mixed $clicksign_access_token = null ]) : mixed
Parameters
- $clicksign_api_url : mixed = null
- $clicksign_access_token : mixed = null
LoadDAO()
public
static LoadDAO(mixed $dao_class_required[, mixed $auto_construct = false ][, mixed $auto_load = false ]) : mixed
Parameters
- $dao_class_required : mixed
- $auto_construct : mixed = false
- $auto_load : mixed = false
LoadHTML()
public
static LoadHTML(mixed $html_class_required[, mixed $auto_construct = false ][, mixed $auto_load = false ]) : mixed
Parameters
- $html_class_required : mixed
- $auto_construct : mixed = false
- $auto_load : mixed = false
LoadMail()
public
static LoadMail(mixed $mail_class_required[, mixed $auto_construct = false ][, mixed $auto_load = false ]) : mixed
Parameters
- $mail_class_required : mixed
- $auto_construct : mixed = false
- $auto_load : mixed = false
LoadModel()
public
static LoadModel(mixed $model_class_required[, mixed $auto_construct = false ][, mixed $auto_load = false ]) : mixed
Parameters
- $model_class_required : mixed
- $auto_construct : mixed = false
- $auto_load : mixed = false
LoadPDF()
public
static LoadPDF(mixed $pdf_class_required[, mixed $auto_construct = false ][, mixed $auto_load = false ]) : mixed
Parameters
- $pdf_class_required : mixed
- $auto_construct : mixed = false
- $auto_load : mixed = false
notificar_signatarios()
public
static notificar_signatarios(string $envelope_id) : mixed
Parameters
- $envelope_id : string
ReadBodyParams()
public
ReadBodyParams([mixed $param = null ]) : mixed
Parameters
- $param : mixed = null
ReadDxParams()
public
ReadDxParams() : mixed
ReadFile()
public
ReadFile(mixed $name[, mixed $default = null ][, mixed $arrAcceptedMimeTypes = [] ]) : mixed
Parameters
- $name : mixed
- $default : mixed = null
- $arrAcceptedMimeTypes : mixed = []
ReadFiles()
public
ReadFiles(mixed $name) : mixed
Parameters
- $name : mixed
ReadGet()
public
ReadGet(mixed $name[, mixed $default = null ]) : mixed
Parameters
- $name : mixed
- $default : mixed = null
ReadPost()
public
ReadPost(mixed $name[, mixed $default = null ]) : mixed
Parameters
- $name : mixed
- $default : mixed = null
ReadRequest()
public
ReadRequest(mixed $name[, mixed $default = null ]) : mixed
Parameters
- $name : mixed
- $default : mixed = null
realizar_download_documento_assinado_ou_cancelado()
public
realizar_download_documento_assinado_ou_cancelado(mixed &$documento_revisao_assinatura_model) : mixed
Parameters
- $documento_revisao_assinatura_model : mixed
registrar_evento()
public
registrar_evento(mixed $header, mixed $body) : mixed
Parameters
- $header : mixed
- $body : mixed
registrar_webhook()
public
static registrar_webhook(mixed $api_token[, mixed $url = "https://portal.nextsi.com.br/webservice/index.php/clicksign/webhook/" ]) : mixed
Parameters
- $api_token : mixed
- $url : mixed = "https://portal.nextsi.com.br/webservice/index.php/clicksign/webhook/"
reprocessar_finalizados_sem_download()
public
reprocessar_finalizados_sem_download() : mixed
retornar_dados_documento_assinado_ou_cancelado()
public
retornar_dados_documento_assinado_ou_cancelado(mixed $uuid_document) : mixed
Parameters
- $uuid_document : mixed
retornar_path_arquivo_assinado()
public
retornar_path_arquivo_assinado(mixed $documento_revisao_assinatura_model) : mixed
Parameters
- $documento_revisao_assinatura_model : mixed
salva_evento_log()
Registra os eventos pelo qual a assinatura de um documento passou
public
salva_evento_log(string $evento, string $arquivo_assinado_key) : null
Parameters
- $evento : string
- $arquivo_assinado_key : string
-
Chave do documento retornado pelo Clicksign
Return values
null —Sem retorno
set_login_anonimo()
public
static set_login_anonimo(mixed $value) : mixed
Parameters
- $value : mixed
solicitar_assinaturas()
Realiza a assinatura de um documento
public
solicitar_assinaturas(int $documento_revisao_id, int $solicitante_usuario_id, array<string|int, mixed> $arr_signatarios, string $mensagem_signatarios[, mixed $solicitar_assinaturas_ordem = false ][, mixed $intervalo_lembrete = 3 ][, mixed $mensagem_envelope = null ]) : object
Parameters
- $documento_revisao_id : int
-
ID da revisão do documento
- $solicitante_usuario_id : int
-
ID do usuário solicitante das assinaturas
- $arr_signatarios : array<string|int, mixed>
- $mensagem_signatarios : string
-
Mensagem que será exibida no email de registro de assinatura
- $solicitar_assinaturas_ordem : mixed = false
- $intervalo_lembrete : mixed = 3
- $mensagem_envelope : mixed = null
Return values
object —$resultado Retorno um objeto com informações vindas do clicksign
Start_Token_JOB()
public
static Start_Token_JOB(mixed $new_token) : mixed
Parameters
- $new_token : mixed
upload_documento()
public
static upload_documento(mixed $arquivo_base_64, mixed $nome_arquivo, mixed $envelope_id) : mixed
Parameters
- $arquivo_base_64 : mixed
- $nome_arquivo : mixed
- $envelope_id : mixed
vincular_signatario_documento()
public
static vincular_signatario_documento(mixed $documento_id, mixed $signatario_id, mixed $envelope_id) : mixed
Parameters
- $documento_id : mixed
- $signatario_id : mixed
- $envelope_id : mixed
WhatRequest()
public
WhatRequest(mixed $name[, mixed $default = null ]) : mixed
Parameters
- $name : mixed
- $default : mixed = null