A05 Backend Api Doc

UnitsConverter

Conventidor de unidades para los endpoints. La salida siempre será en el sistema contrario al elegido.

La tabla en la que se basa esta clase es system_units

Tags
author

Gilberto Rodríguez de la Cruz

Table of Contents

Constants

IMP  = 'Imperial'
INTL  = 'International'

Methods

convert()  : array{m: float|int, inches: float|int}|array{kg: float|int, lb: float|int}
Desc: Convierte las medidas según el tipo de medidas.
convertBySymbol()  : array{m: float|int, inches: float|int}|array{kg: float|int, lb: float|int}
Desc: Convierte las medidas según el tipo de medidas usando símbolo como parámetro.
area()  : array{m2: float, in2: float}
Desc: Convierte las medidas de area
distance()  : array{m: float|int, inches: float|int}
Desc: Convierte las medidas de distancia
mass()  : array<string|int, mixed>
Desc: Convierte las medidas de peso/masa
truncateVal()  : float
Desc: Trunca el valor de un float para formatearlo q dos decimales.
volume()  : array{m3: float, ft3: float}|array{l: float, gal: float}
Desc: Convierte las medidas de volumen

Constants

Methods

convert()

Desc: Convierte las medidas según el tipo de medidas.

public convert(array{from: int, val: float|int} $data) : array{m: float|int, inches: float|int}|array{kg: float|int, lb: float|int}

Note: n/a,

ref: SystemUnits

Date: 2025-07-31, Version: v0.2507.01

Example:

$unitsConverter = Yii::$app->unitsConverter;
$id = 1; //From tb system_units
$unitsConverter->convert([
 'from' => $id,
 'val' => 12.5
]);
Parameters
$data : array{from: int, val: float|int}
Tags
throws
InvalidConfigException
Return values
array{m: float|int, inches: float|int}|array{kg: float|int, lb: float|int}

convertBySymbol()

Desc: Convierte las medidas según el tipo de medidas usando símbolo como parámetro.

public convertBySymbol(array{symbol: string, val: float|int} $data) : array{m: float|int, inches: float|int}|array{kg: float|int, lb: float|int}

Note: n/a,

ref: SystemUnits

Date: 2025-12-31, Version: v0.2601.03

Parameters
$data : array{symbol: string, val: float|int}
Return values
array{m: float|int, inches: float|int}|array{kg: float|int, lb: float|int}

area()

Desc: Convierte las medidas de area

private area(SystemUnits $input, float $value) : array{m2: float, in2: float}

Note: n/a,

ref: SystemUnits

Date: 2026-01-05, Version: v0.2601.10

Example: n/a

Parameters
$input : SystemUnits
$value : float
Return values
array{m2: float, in2: float}

distance()

Desc: Convierte las medidas de distancia

private distance(SystemUnits $input, float $value) : array{m: float|int, inches: float|int}

Note: n/a,

ref: SystemUnits

Date: 2025-07-31, Version: v0.2507.01

Example: n/a

Parameters
$input : SystemUnits
$value : float
Return values
array{m: float|int, inches: float|int}

mass()

Desc: Convierte las medidas de peso/masa

private mass(SystemUnits $input, float $value) : array<string|int, mixed>

Note: n/a,

ref: SystemUnits

Date: 2025-07-31, Version: v0.2507.01

Example: n/a

Parameters
$input : SystemUnits
$value : float
Tags
@return

array{kg: float|int, lb: float|int}|[]

Return values
array<string|int, mixed>

truncateVal()

Desc: Trunca el valor de un float para formatearlo q dos decimales.

private truncateVal(float $number) : float

Note: n/a, ref: n/a

Date: 2025-07-31, Version: v0.2507.01

Example: n/a

Parameters
$number : float
Return values
float

volume()

Desc: Convierte las medidas de volumen

private volume(SystemUnits $input, float $value) : array{m3: float, ft3: float}|array{l: float, gal: float}

Note: n/a,

ref: SystemUnits

Date: 2025-07-31, Version: v0.2507.01

Example: n/a

Parameters
$input : SystemUnits
$value : float
Return values
array{m3: float, ft3: float}|array{l: float, gal: float} 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results