\iXgapVarConvert

Interfaz para convertir una variable en otro formato.

Summary

Methods
Constants
encode()
decode()
getCharacterEncoding()
formatName()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

encode()

encode(mixed  $var) : mixed

Codifica <var>$var</var> en un formato específico definido por la implementación.

Parameters

mixed $var

la variable a codificar, dada en la codificación de caracteres interna de PHP

Throws

\ExcepcionXGAP

si hay un error durante la operación

Returns

mixed —

el valor codificado, con la codificación de caracteres indicada por {@link iXgapVarConvert::getCharacterEncoding()}

decode()

decode(mixed  $encoded) : mixed

Decodifica un valor dado en el formato generado por {@link iXgapVarConvert::encode()}.

Parameters

mixed $encoded

valor codificado, con la codificación de caracteres indicada por {@link iXgapVarConvert::getCharacterEncoding()}

Throws

\ExcepcionXGAP

si hay un error durante la operación

Returns

mixed —

el valor decodificado, usando la codificación de caracteres interna de PHP

getCharacterEncoding()

getCharacterEncoding() : string

Permite consultar la codificación de caracteres que tiene el valor de retorno de {@link iXgapVarConvert::encode()} y el parámetro <var>$encoded</var> de {@link iXgapVarConvert::decode()}.

Returns

string

formatName()

formatName() : string

Nombre identificatorio para el formato con que opera la implementación.

Returns

string