Documentation

TSLOutMessage
in

Clase que define el mensaje de salida el cul sera armado o recopilado a traves del data transfer object .

Table of Contents

$m_processErrors Arreglo con los errores de proceso. array
$m_fieldErrors Arreglo con los errores de validacion de campos o parametros. array
$m_success True indicara que el mensaje contiene solo data de salida, no errores. bool
$m_answerMessage Opcional para enviar un mensaje de respuesta. string
$m_errorCode Codigo de identificacion en caso que $m_answerMessage sea un mensaje de error. int
$m_resultData Contendra los datos de salida. object
$m_outParams Contendra un arreglo de datos extras si fuera necesario tales como numero de registros, ultimo registro , o lo que se requiera. array
setSuccess() Setea si este mensaje de salida es de error o no , si el parametro es false , se considerara como error. void
addProcessError() Agrega un error de proceso void
addFieldError() Agrega un error de campo , bascamente provienen de erores en la validacion previa de campos o parametros. void
addOutputParameter() Agrega un prametro al arreglo de parametros de salida. mixed
getOutputparameters() Retorna el arreglo de parametros de salida si es que existen. array
setResultData() Cuando se realiza una operacion correcta , los datos de respuesta deberan ser indicados a raves de este metodo, los datos contenidos seran interpretados por contexto por la fncion que espera los resultados. void
getResultData() Retorna los datos resultado. mixed
setAnswerMessage() Si se requiriera enviar un mensaje en caso de un error que no es de proceso o validaion de modelo o un mensaje de salida comoe "Operacion Realizada con exito" dicho mensaje podria ser colocado aqui , asi mismo si el eror proviniera de una excepcion o requiriera un codigo especial (SQL ERROR CODE por ejemplo) podria inidicarse en el segundo pramtero. mixed
getAnswerMesage() Retorna el mensaje de salida. string
getErrorCode() Retorna el codigo de error global. int
getProcessErrors() Retorna los errores de proceso. \TSLProcessErrorMessage[]
getFieldErrors() Retorna la lista de mensajes de error de validacion de campos o parametros. \TSLFieldErrorMessage[]
hasProcessErrors() Retorna si tiene o no tiene mensajes de error de proceso esta instancia. bool
hasFieldErrors() Retorna si tiene o no tiene mensajes de error de campos esta instancia. bool
isSuccess() Retorna si el resultado de la operacion fue correcta. bool

Properties

$m_processErrors

Arreglo con los errores de proceso.

private array $m_processErrors

$m_fieldErrors

Arreglo con los errores de validacion de campos o parametros.

private array $m_fieldErrors
.

$m_success

True indicara que el mensaje contiene solo data de salida, no errores.

private bool $m_success = \true

$m_answerMessage

Opcional para enviar un mensaje de respuesta.

private string $m_answerMessage

$m_errorCode

Codigo de identificacion en caso que $m_answerMessage sea un mensaje de error.

private int $m_errorCode = ""

$m_resultData

Contendra los datos de salida.

private object $m_resultData

$m_outParams

Contendra un arreglo de datos extras si fuera necesario tales como numero de registros, ultimo registro , o lo que se requiera.

private array $m_outParams
.

Methods

setSuccess()

Setea si este mensaje de salida es de error o no , si el parametro es false , se considerara como error.

public setSuccess( $success : bool ) : void
Parameters
$success : bool

true si no hay error de lo contrario false

addFieldError()

Agrega un error de campo , bascamente provienen de erores en la validacion previa de campos o parametros.

public addFieldError( $fieldError : TSLFieldErrorMessage ) : void
Parameters
$fieldError : TSLFieldErrorMessage

un error de campo o parametro

addOutputParameter()

Agrega un prametro al arreglo de parametros de salida.

public addOutputParameter( $paramName : string , $paramValue : mixed ) : mixed
Parameters
$paramName : string

nombre de parametro.

$paramValue : mixed

valor del parametor

Return values
mixed

getOutputparameters()

Retorna el arreglo de parametros de salida si es que existen.

public getOutputparameters( ) : array
Return values
array —

con los parametros de salida

setResultData()

Cuando se realiza una operacion correcta , los datos de respuesta deberan ser indicados a raves de este metodo, los datos contenidos seran interpretados por contexto por la fncion que espera los resultados.

public setResultData( &$resultData : mixed ) : void
Parameters
$resultData : mixed

los datos resultado.

getResultData()

Retorna los datos resultado.

public getResultData( ) : mixed
Return values
mixed —

con los resultados.

setAnswerMessage()

Si se requiriera enviar un mensaje en caso de un error que no es de proceso o validaion de modelo o un mensaje de salida comoe "Operacion Realizada con exito" dicho mensaje podria ser colocado aqui , asi mismo si el eror proviniera de una excepcion o requiriera un codigo especial (SQL ERROR CODE por ejemplo) podria inidicarse en el segundo pramtero.

public setAnswerMessage( $errorMessage : string , $errorCode : int ) : mixed
Parameters
$errorMessage : string

el mensaje de salida

$errorCode : int

codigo de error.

Return values
mixed

getAnswerMesage()

Retorna el mensaje de salida.

public getAnswerMesage( ) : string
Return values
string —

con el mensaje de salida.

getErrorCode()

Retorna el codigo de error global.

public getErrorCode( ) : int
Return values
int —

con el codigo de error

getProcessErrors()

Retorna los errores de proceso.

public getProcessErrors( ) : \TSLProcessErrorMessage[]
Return values
\TSLProcessErrorMessage[] —

con los mensajes de procesos.

getFieldErrors()

Retorna la lista de mensajes de error de validacion de campos o parametros.

public getFieldErrors( ) : \TSLFieldErrorMessage[]
Return values
\TSLFieldErrorMessage[] —

con los mensajes de error de campo o parametros

hasProcessErrors()

Retorna si tiene o no tiene mensajes de error de proceso esta instancia.

public hasProcessErrors( ) : bool
Return values
bool —

true tiene mensajes de proceso, false no.

hasFieldErrors()

Retorna si tiene o no tiene mensajes de error de campos esta instancia.

public hasFieldErrors( ) : bool
Return values
bool —

true tiene mensajes de campos, false no.

isSuccess()

Retorna si el resultado de la operacion fue correcta.

public isSuccess( ) : bool
Return values
bool —

true si fue exitosa , false si hubo errores.

Search results